nvdrsig - Local Development build (v0.3.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON
• TTL

Resource Profile: NVDRS Decedent

Defines constraints on the VRDR Decedent profile to address the needs of VDRS data.

Usage:

• This Resource Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

• Key Elements Table
• Differential Table
• Snapshot Table
• Statistics/References
• All

Name	Flags	Card.	Type	Description & Constraints
Patient	C	0..*	Decedent	Information about an individual or animal receiving health care services dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management us-core-6: Either Patient.name.given and/or Patient.name.family SHALL be present or a Data Absent Reason Extension SHALL be present.
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
Slices for extension				Content/Rules for all slices
extension:race		0..1	(Complex)	US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:ethnicity		0..1	(Complex)	US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:birthsex		0..1	code	Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex Binding: Birth Sex (required): Code for sex assigned at birth ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:genderIdentity		0..1	CodeableConcept	Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity Binding: Gender Identity (extensible) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:birthPlace		0..1	(Complex)	Decedent birthplace URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
value[x]		1..1	Address	Value of extension ele-1: All FHIR elements must have a @value or children
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. ele-1: All FHIR elements must have a @value or children Example General: home
extension:parentReportedAgeAtDelivery		0..2	(Complex)	Extension - Reported Parent Age at Delivery - Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-reported-parent-age-at-delivery-vr ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:fetalDeath		0..1	Coding	fetal-death URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-patient-fetal-death-vr ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:NVSS-SexAtDeath		0..1	CodeableConcept	NVSS Sex at Death URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/NVSS-SexAtDeath Binding: Administrative Gender ValueSet (preferred) Additional Bindings Purpose Administrative Gender ValueSet - Max Max Binding ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:Spouse-Alive		0..1	CodeableConcept	Spouse Alive? URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/SpouseAlive Binding: Spouse Alive ValueSet (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
Slices for identifier	SΣ	1..*	Identifier	An identifier for this patient Slice: Unordered, Open by pattern:type ele-1: All FHIR elements must have a @value or children
identifier:MRN	SΣ	0..*	Identifier	Medical Record Number ele-1: All FHIR elements must have a @value or children
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children
type	Σ	1..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
code		1..1	code	Symbol in syntax defined by the system Fixed Value: MR
system	SΣ	1..1	uri	The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	The value that is unique within the system. ele-1: All FHIR elements must have a @value or children Example General: 123456
identifier:SSN	SΣ	0..1	Identifier	Decedent's Social Security Number ele-1: All FHIR elements must have a @value or children
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children
type	Σ	1..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
code		1..1	code	Symbol in syntax defined by the system Fixed Value: SS
system	SΣ	1..1	uri	The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Required Pattern: http://hl7.org/fhir/sid/us-ssn
value	SΣ	1..1	string	The value that is unique within the system. ele-1: All FHIR elements must have a @value or children Example General: 123456
identifier:SB	SΣ	0..1	Identifier	**Deprecated** Decedent's Social Security Number for Compatibility. Use SSN. ele-1: All FHIR elements must have a @value or children
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children
type	Σ	1..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
code		1..1	code	Symbol in syntax defined by the system Fixed Value: SB
active	?!Σ	0..1	boolean	Whether this patient's record is in active use ele-1: All FHIR elements must have a @value or children
Slices for name	SΣ	1..*	HumanName	A name associated with the patient Slice: Unordered, Open by value:use ele-1: All FHIR elements must have a @value or children
name:All Slices				Content/Rules for all slices
use	?!Σ	1..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. ele-1: All FHIR elements must have a @value or children
family	SΣC	1..1	string	Family name (often called 'Surname') ele-1: All FHIR elements must have a @value or children
Slices for extension				Content/Rules for all slices
extension:dataAbsentReason		0..1	code	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
given	SΣC	0..*	string	Given names (not always 'first'). Includes middle names ele-1: All FHIR elements must have a @value or children This repeating element order: Given Names appear in the correct order for presenting the name
Slices for extension				Content/Rules for all slices
extension:dataAbsentReason		0..1	code	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name:currentLegalName	SΣ	0..1	HumanName	current legal name ele-1: All FHIR elements must have a @value or children
use	?!Σ	1..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. ele-1: All FHIR elements must have a @value or children Fixed Value: official
family	SΣC	1..1	string	Family name (often called 'Surname') ele-1: All FHIR elements must have a @value or children
given	SΣC	0..*	string	Given names (not always 'first'). Includes middle names ele-1: All FHIR elements must have a @value or children This repeating element order: Given Names appear in the correct order for presenting the name
name:namePriorToFirstMarriage	SΣ	0..1	HumanName	Name prior to first marriage ele-1: All FHIR elements must have a @value or children
use	?!Σ	1..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. ele-1: All FHIR elements must have a @value or children Fixed Value: maiden
family	SΣC	1..1	string	Family name (often called 'Surname') ele-1: All FHIR elements must have a @value or children
given	SΣC	0..*	string	Given names (not always 'first'). Includes middle names ele-1: All FHIR elements must have a @value or children This repeating element order: Given Names appear in the correct order for presenting the name
telecom	Σ	0..*	ContactPoint	A contact detail for the individual ele-1: All FHIR elements must have a @value or children
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. ele-1: All FHIR elements must have a @value or children
value	SΣ	1..1	string	The actual contact point details ele-1: All FHIR elements must have a @value or children
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) ele-1: All FHIR elements must have a @value or children
gender	SΣ	1..1	code	male | female | other | unknown Binding: AdministrativeGender (required) ele-1: All FHIR elements must have a @value or children
birthDate	SΣ	0..1	date	Date of Birth ele-1: All FHIR elements must have a @value or children
Slices for extension				Content/Rules for all slices
extension:partialDateTime		0..1	(Complex)	partialDateTIme URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/ExtensionPartialDateTimeVitalRecords ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:birthTime		0..1	dateTime	Time of day of birth URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:bypassEditFlag		0..1	(Complex)	Extension - BypassEditFlag Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag"
value[x]		1..1	CodeableConcept	To reflect the relevant edit possibilities for date of birth. Binding: ValueSet - Mothers Date of Birth Edit Flags (NCHS) Vital Records (required): Date of Birth Edit Flags (NCHS) ele-1: All FHIR elements must have a @value or children
Slices for deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not Slice: Unordered, Open by type:$this ele-1: All FHIR elements must have a @value or children
deceasedBoolean			boolean
deceasedDateTime			dateTime
deceased[x]:deceasedBoolean	?!Σ	0..1	boolean	Indicates if the individual is deceased or not ele-1: All FHIR elements must have a @value or children Required Pattern: true
address	SΣ	0..*	Address	Decedent's Residence ele-1: All FHIR elements must have a @value or children
Slices for extension				Content/Rules for all slices
extension:withinCityLimitsIndicator		0..1	Coding	Used to indicate whether or not an address is within city limits. URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-within-city-limits-indicator-vr Binding: ValueSet - Yes No Unknown Vital Records (required): Yes No Unknown (YNU) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:predir		0..1	string	Extension - PreDirectional Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PreDirectional ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:stnum		0..1	string	Extension - StreetNumber Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetNumber ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:stname		0..1	string	Extension - StreetName Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetName ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:stdesig		0..1	string	Extension - StreetDesignator Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetDesignator ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:postdir		0..1	string	Extension - PostDirectional Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PostDirectional ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:unitnumber		0..1	string	Extension - UnitOrAptNumber Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/UnitOrAptNumber ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. ele-1: All FHIR elements must have a @value or children Example General: home
line	SΣ	0..*	string	Street name, number, direction & P.O. Box etc. ele-1: All FHIR elements must have a @value or children This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city	SΣ	0..1	string	Name of city, town etc. ele-1: All FHIR elements must have a @value or children Example General: Erewhon
Slices for extension				Content/Rules for all slices
extension:cityCode		0..1	positiveInt	City Code URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
state	SΣ	0..1	string	State/Jurisdiction of residence. Provide both state and jurisdiction if different. Binding: ValueSet - States, Territories and Provinces Vital Records (required) ele-1: All FHIR elements must have a @value or children
Slices for extension				Content/Rules for all slices
extension:residenceJurisdictionId		0..1	string	Extension URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/Extension-jurisdiction-id-vr Binding: ValueSet - Jurisdictions Vital Records (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
postalCode	SΣ	0..1	string	US Zip Codes ele-1: All FHIR elements must have a @value or children Example General: 9132
period	SΣ	0..1	Period	Time period when address was/is in use ele-1: All FHIR elements must have a @value or children Example General: {"start":"2010-03-23","end":"2010-07-01"}
communication		0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
language	S	1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her health Binding: Language codes with language and optionally a region modifier (extensible) ele-1: All FHIR elements must have a @value or children
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
other	Σ	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to ele-1: All FHIR elements must have a @value or children
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Patient.extension:birthPlace.value[x].use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Patient.identifier:MRN.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.identifier:MRN.type	extensible	Pattern: MR http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Patient.identifier:SSN.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.identifier:SSN.type	extensible	Pattern: SS http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Patient.identifier:SB.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.identifier:SB.type	extensible	Pattern: SB http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Patient.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
Patient.name:currentLegalName.use	required	Fixed Value: official http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
Patient.name:namePriorToFirstMarriage.use	required	Fixed Value: maiden http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
Patient.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system from the FHIR Standard
Patient.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use from the FHIR Standard
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender from the FHIR Standard
Patient.birthDate.extension:bypassEditFlag.value[x]	required	ValueSetMothersDateOfBirthEditFlagsVitalRecords http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-mothers-date-of-birth-edit-flags-vr
Patient.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Patient.address.state	required	ValueSetStatesTerritoriesAndProvincesVitalRecords http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-states-territories-provinces-vr
Patient.communication.language	extensible	LanguageCodesWithLanguageAndOptionallyARegionModifier http://hl7.org/fhir/us/core/ValueSet/simple-language
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Patient	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Patient	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Patient	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Patient	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Patient	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
us-core-6	error	Patient	Either Patient.name.given and/or Patient.name.family SHALL be present or a Data Absent Reason Extension SHALL be present. : (name.family.exists() or name.given.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()

This structure is derived from Decedent

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	Decedent	Information about an individual or animal receiving health care services
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Patient	C	0..*	Decedent	Information about an individual or animal receiving health care services us-core-6: Either Patient.name.given and/or Patient.name.family SHALL be present or a Data Absent Reason Extension SHALL be present.
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:race		0..1	(Complex)	US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
extension:ethnicity		0..1	(Complex)	US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
extension:birthsex		0..1	code	Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex Binding: Birth Sex (required): Code for sex assigned at birth
extension:genderIdentity		0..1	CodeableConcept	Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity Binding: Gender Identity (extensible)
extension:birthPlace		0..1	(Complex)	Decedent birthplace URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
value[x]		1..1	Address	Value of extension
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
type	Σ	0..1	code	postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
text	Σ	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line	Σ	0..*	string	Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city	Σ	0..1	string	Name of city, town etc. Example General: Erewhon
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:cityCode		0..1	positiveInt	Extension - City Code Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode
value		0..1	string	Primitive value for string Max Length:1048576
district	Σ	0..1	string	District name (aka county) Example General: Madison
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:districtCode		0..1	positiveInt	County code URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/DistrictCode
value		0..1	string	Primitive value for string Max Length:1048576
state	Σ	0..1	string	Sub-unit of country (abbreviations ok) Binding: ValueSet - States, Territories and Provinces Vital Records (required)
postalCode	Σ	0..1	string	Postal code for area Example General: 9132
country	Σ	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code) Binding: ValueSet - Birthplace Country Vital Records (required)
period	Σ	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
extension:parentReportedAgeAtDelivery		0..2	(Complex)	Extension - Reported Parent Age at Delivery - Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-reported-parent-age-at-delivery-vr
extension:fetalDeath		0..1	Coding	fetal-death URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-patient-fetal-death-vr
extension:NVSS-SexAtDeath		0..1	CodeableConcept	NVSS Sex at Death URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/NVSS-SexAtDeath Binding: Administrative Gender ValueSet (preferred) Additional Bindings Purpose Administrative Gender ValueSet - Max Max Binding
extension:Spouse-Alive		0..1	CodeableConcept	Spouse Alive? URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/SpouseAlive Binding: Spouse Alive ValueSet (required)
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SΣ	1..*	Identifier	An identifier for this patient Slice: Unordered, Open by pattern:type
identifier:MRN	SΣ	0..*	Identifier	Medical Record Number
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	1..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: MR
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
system	SΣ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	The value that is unique within the system. Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier:SSN	SΣ	0..1	Identifier	Decedent's Social Security Number
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	1..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: SS
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
system	SΣ	1..1	uri	The namespace for the identifier value Required Pattern: http://hl7.org/fhir/sid/us-ssn
value	SΣ	1..1	string	The value that is unique within the system. Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier:SB	SΣ	0..1	Identifier	**Deprecated** Decedent's Social Security Number for Compatibility. Use SSN.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	1..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: SB
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
system	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	0..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
Slices for name	SΣ	1..*	HumanName	A name associated with the patient Slice: Unordered, Open by value:use
name:All Slices				Content/Rules for all slices
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	1..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text	Σ	0..1	string	Text representation of the full name
family	SΣC	1..1	string	Family name (often called 'Surname')
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:dataAbsentReason		0..1	code	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
value		0..1	string	Primitive value for string Max Length:1048576
given	SΣC	0..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:dataAbsentReason		0..1	code	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
value		0..1	string	Primitive value for string Max Length:1048576
prefix	Σ	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	Σ	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period	Σ	0..1	Period	Time period when name was/is in use
name:currentLegalName	SΣ	0..1	HumanName	current legal name
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	1..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: official
text	Σ	0..1	string	Text representation of the full name
family	SΣC	1..1	string	Family name (often called 'Surname')
given	SΣC	0..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
prefix	Σ	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	Σ	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period	Σ	0..1	Period	Time period when name was/is in use
name:namePriorToFirstMarriage	SΣ	0..1	HumanName	Name prior to first marriage
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	1..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: maiden
text	Σ	0..1	string	Text representation of the full name
family	SΣC	1..1	string	Family name (often called 'Surname')
given	SΣC	0..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
prefix	Σ	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	Σ	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period	Σ	0..1	Period	Time period when name was/is in use
telecom	Σ	0..*	ContactPoint	A contact detail for the individual
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	SΣ	1..1	string	The actual contact point details
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
rank	Σ	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	Σ	0..1	Period	Time period when the contact point was/is in use
gender	SΣ	1..1	code	male | female | other | unknown Binding: AdministrativeGender (required)
birthDate	SΣ	0..1	date	Date of Birth
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:partialDateTime		0..1	(Complex)	partialDateTIme URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/ExtensionPartialDateTimeVitalRecords
extension:birthTime		0..1	dateTime	Time of day of birth URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
extension:bypassEditFlag		0..1	(Complex)	Extension - BypassEditFlag Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag"
value[x]		1..1	CodeableConcept	To reflect the relevant edit possibilities for date of birth. Binding: ValueSet - Mothers Date of Birth Edit Flags (NCHS) Vital Records (required): Date of Birth Edit Flags (NCHS)
value		0..1	date	Primitive value for date
Slices for deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not Slice: Unordered, Open by type:$this
deceasedBoolean			boolean
deceasedDateTime			dateTime
deceased[x]:deceasedBoolean	?!Σ	0..1	boolean	Indicates if the individual is deceased or not Required Pattern: true
address	SΣ	0..*	Address	Decedent's Residence
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:withinCityLimitsIndicator		0..1	Coding	Used to indicate whether or not an address is within city limits. URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-within-city-limits-indicator-vr Binding: ValueSet - Yes No Unknown Vital Records (required): Yes No Unknown (YNU)
extension:predir		0..1	string	Extension - PreDirectional Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PreDirectional
extension:stnum		0..1	string	Extension - StreetNumber Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetNumber
extension:stname		0..1	string	Extension - StreetName Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetName
extension:stdesig		0..1	string	Extension - StreetDesignator Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetDesignator
extension:postdir		0..1	string	Extension - PostDirectional Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PostDirectional
extension:unitnumber		0..1	string	Extension - UnitOrAptNumber Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/UnitOrAptNumber
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
type	Σ	0..1	code	postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
text	Σ	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line	SΣ	0..*	string	Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city	SΣ	0..1	string	Name of city, town etc. Example General: Erewhon
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:cityCode		0..1	positiveInt	City Code URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode
value		0..1	string	Primitive value for string Max Length:1048576
district	Σ	0..1	string	District name (aka county) Example General: Madison
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:districtCode		0..1	positiveInt	County code URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/DistrictCode
value		0..1	string	Primitive value for string Max Length:1048576
state	SΣ	0..1	string	State/Jurisdiction of residence. Provide both state and jurisdiction if different. Binding: ValueSet - States, Territories and Provinces Vital Records (required)
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:residenceJurisdictionId		0..1	string	Extension URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/Extension-jurisdiction-id-vr Binding: ValueSet - Jurisdictions Vital Records (required)
value		0..1	string	Primitive value for string Max Length:1048576
postalCode	SΣ	0..1	string	US Zip Codes Example General: 9132
country	Σ	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code) Binding: ValueSet - Residence Country Vital Records (required)
period	SΣ	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
maritalStatus		0..1	CodeableConcept	Marital (civil) status of a patient Binding: Marital Status Vital Records (required)
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:bypassEditFlag		0..1	(Complex)	Extension - BypassEditFlag Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag"
value[x]		1..1	CodeableConcept	Value of extension Binding: Edit Bypass 0124 (required)
coding	Σ	0..*	Coding	Code defined by a terminology system
text	Σ	0..1	string	Marital Description
multipleBirth[x]		0..1		If not single birth - born first, second, third, etc.
multipleBirth[x]All Types				Content/Rules for all Types
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:bypassEditFlag		0..1	(Complex)	Extension - BypassEditFlag Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag"
value[x]		1..1	CodeableConcept	Value of extension Binding: ValueSet - Plurality Edit Flags (NCHS) Vital Records (required): Plurality Edit Flags (NCHS)
extension:multipleBirthTotal		0..1	positiveInt	Total births in this pregnancy URL: http://hl7.org/fhir/StructureDefinition/patient-multipleBirthTotal
multipleBirthBoolean			boolean
multipleBirthInteger			integer
photo		0..*	Attachment	Image of the patient
contact	C	0..*	BackboneElement	Informant information pat-1: SHALL at least contain a contact's details or a reference to an organization
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
relationship		0..1	CodeableConcept	Informant Relationship (INFORMRELATE) Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
text	Σ	0..1	string	Informant Relationship (INFORMRELATE) - first 30 characters will be used
name		0..1	HumanName	A name associated with the contact person
telecom		0..*	ContactPoint	A contact detail for the person
address		0..1	Address	Address for the contact person
gender		0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
organization	C	0..1	Reference(Organization)	Organization that is associated with the contact
period		0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient
communication		0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
language	S	1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her health Binding: Language codes with language and optionally a region modifier (extensible)
preferred		0..1	boolean	Language preference indicator
generalPractitioner		0..*	Reference(Organization | Practitioner | PractitionerRole)	Patient's nominated primary care provider
managingOrganization	Σ	0..1	Reference(Organization)	Organization that is the custodian of the patient record
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
other	Σ	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Patient.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Patient.extension:birthPlace.value[x].use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Patient.extension:birthPlace.value[x].type	required	AddressType http://hl7.org/fhir/ValueSet/address-type|4.0.1 from the FHIR Standard
Patient.extension:birthPlace.value[x].state	required	ValueSetStatesTerritoriesAndProvincesVitalRecords http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-states-territories-provinces-vr
Patient.extension:birthPlace.value[x].country	required	ValueSetBirthplaceCountryVitalRecords http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-birthplace-country-vr
Patient.identifier:MRN.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.identifier:MRN.type	extensible	Pattern: MR http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Patient.identifier:SSN.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.identifier:SSN.type	extensible	Pattern: SS http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Patient.identifier:SB.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.identifier:SB.type	extensible	Pattern: SB http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Patient.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
Patient.name:currentLegalName.use	required	Fixed Value: official http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
Patient.name:namePriorToFirstMarriage.use	required	Fixed Value: maiden http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
Patient.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system from the FHIR Standard
Patient.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use from the FHIR Standard
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender from the FHIR Standard
Patient.birthDate.extension:bypassEditFlag.value[x]	required	ValueSetMothersDateOfBirthEditFlagsVitalRecords http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-mothers-date-of-birth-edit-flags-vr
Patient.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Patient.address.type	required	AddressType http://hl7.org/fhir/ValueSet/address-type|4.0.1 from the FHIR Standard
Patient.address.state	required	ValueSetStatesTerritoriesAndProvincesVitalRecords http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-states-territories-provinces-vr
Patient.address.country	required	ValueSetResidenceCountryVitalRecords http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-residence-country-vr
Patient.maritalStatus	required	ValueSetMaritalStatusVitalRecords http://hl7.org/fhir/us/vrdr/ValueSet/ValueSet-marital-status-vr
Patient.maritalStatus.extension:bypassEditFlag.value[x]	required	EditBypass0124VS http://hl7.org/fhir/us/vrdr/ValueSet/vrdr-edit-bypass-0124-vs
Patient.multipleBirth[x].extension:bypassEditFlag.value[x]	required	ValueSetPluralityEditFlagsVitalRecords http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-plurality-edit-flags-vr
Patient.contact.relationship	extensible	PatientContactRelationship http://hl7.org/fhir/ValueSet/patient-contactrelationship from the FHIR Standard
Patient.contact.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
Patient.communication.language	extensible	LanguageCodesWithLanguageAndOptionallyARegionModifier http://hl7.org/fhir/us/core/ValueSet/simple-language
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Patient	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Patient	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Patient	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Patient	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Patient	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
pat-1	error	Patient.contact	SHALL at least contain a contact's details or a reference to an organization : name.exists() or telecom.exists() or address.exists() or organization.exists()
us-core-6	error	Patient	Either Patient.name.given and/or Patient.name.family SHALL be present or a Data Absent Reason Extension SHALL be present. : (name.family.exists() or name.given.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()

This structure is derived from Decedent

Summary

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Patient	C	0..*	Decedent	Information about an individual or animal receiving health care services dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management us-core-6: Either Patient.name.given and/or Patient.name.family SHALL be present or a Data Absent Reason Extension SHALL be present.
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
Slices for extension				Content/Rules for all slices
extension:race		0..1	(Complex)	US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:ethnicity		0..1	(Complex)	US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:birthsex		0..1	code	Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex Binding: Birth Sex (required): Code for sex assigned at birth ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:genderIdentity		0..1	CodeableConcept	Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity Binding: Gender Identity (extensible) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:birthPlace		0..1	(Complex)	Decedent birthplace URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
value[x]		1..1	Address	Value of extension ele-1: All FHIR elements must have a @value or children
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. ele-1: All FHIR elements must have a @value or children Example General: home
extension:parentReportedAgeAtDelivery		0..2	(Complex)	Extension - Reported Parent Age at Delivery - Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-reported-parent-age-at-delivery-vr ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:fetalDeath		0..1	Coding	fetal-death URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-patient-fetal-death-vr ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:NVSS-SexAtDeath		0..1	CodeableConcept	NVSS Sex at Death URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/NVSS-SexAtDeath Binding: Administrative Gender ValueSet (preferred) Additional Bindings Purpose Administrative Gender ValueSet - Max Max Binding ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:Spouse-Alive		0..1	CodeableConcept	Spouse Alive? URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/SpouseAlive Binding: Spouse Alive ValueSet (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
Slices for identifier	SΣ	1..*	Identifier	An identifier for this patient Slice: Unordered, Open by pattern:type ele-1: All FHIR elements must have a @value or children
identifier:MRN	SΣ	0..*	Identifier	Medical Record Number ele-1: All FHIR elements must have a @value or children
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children
type	Σ	1..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
code		1..1	code	Symbol in syntax defined by the system Fixed Value: MR
system	SΣ	1..1	uri	The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	The value that is unique within the system. ele-1: All FHIR elements must have a @value or children Example General: 123456
identifier:SSN	SΣ	0..1	Identifier	Decedent's Social Security Number ele-1: All FHIR elements must have a @value or children
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children
type	Σ	1..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
code		1..1	code	Symbol in syntax defined by the system Fixed Value: SS
system	SΣ	1..1	uri	The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Required Pattern: http://hl7.org/fhir/sid/us-ssn
value	SΣ	1..1	string	The value that is unique within the system. ele-1: All FHIR elements must have a @value or children Example General: 123456
identifier:SB	SΣ	0..1	Identifier	**Deprecated** Decedent's Social Security Number for Compatibility. Use SSN. ele-1: All FHIR elements must have a @value or children
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children
type	Σ	1..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
code		1..1	code	Symbol in syntax defined by the system Fixed Value: SB
active	?!Σ	0..1	boolean	Whether this patient's record is in active use ele-1: All FHIR elements must have a @value or children
Slices for name	SΣ	1..*	HumanName	A name associated with the patient Slice: Unordered, Open by value:use ele-1: All FHIR elements must have a @value or children
name:All Slices				Content/Rules for all slices
use	?!Σ	1..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. ele-1: All FHIR elements must have a @value or children
family	SΣC	1..1	string	Family name (often called 'Surname') ele-1: All FHIR elements must have a @value or children
Slices for extension				Content/Rules for all slices
extension:dataAbsentReason		0..1	code	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
given	SΣC	0..*	string	Given names (not always 'first'). Includes middle names ele-1: All FHIR elements must have a @value or children This repeating element order: Given Names appear in the correct order for presenting the name
Slices for extension				Content/Rules for all slices
extension:dataAbsentReason		0..1	code	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
name:currentLegalName	SΣ	0..1	HumanName	current legal name ele-1: All FHIR elements must have a @value or children
use	?!Σ	1..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. ele-1: All FHIR elements must have a @value or children Fixed Value: official
family	SΣC	1..1	string	Family name (often called 'Surname') ele-1: All FHIR elements must have a @value or children
given	SΣC	0..*	string	Given names (not always 'first'). Includes middle names ele-1: All FHIR elements must have a @value or children This repeating element order: Given Names appear in the correct order for presenting the name
name:namePriorToFirstMarriage	SΣ	0..1	HumanName	Name prior to first marriage ele-1: All FHIR elements must have a @value or children
use	?!Σ	1..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. ele-1: All FHIR elements must have a @value or children Fixed Value: maiden
family	SΣC	1..1	string	Family name (often called 'Surname') ele-1: All FHIR elements must have a @value or children
given	SΣC	0..*	string	Given names (not always 'first'). Includes middle names ele-1: All FHIR elements must have a @value or children This repeating element order: Given Names appear in the correct order for presenting the name
telecom	Σ	0..*	ContactPoint	A contact detail for the individual ele-1: All FHIR elements must have a @value or children
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. ele-1: All FHIR elements must have a @value or children
value	SΣ	1..1	string	The actual contact point details ele-1: All FHIR elements must have a @value or children
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) ele-1: All FHIR elements must have a @value or children
gender	SΣ	1..1	code	male | female | other | unknown Binding: AdministrativeGender (required) ele-1: All FHIR elements must have a @value or children
birthDate	SΣ	0..1	date	Date of Birth ele-1: All FHIR elements must have a @value or children
Slices for extension				Content/Rules for all slices
extension:partialDateTime		0..1	(Complex)	partialDateTIme URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/ExtensionPartialDateTimeVitalRecords ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:birthTime		0..1	dateTime	Time of day of birth URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:bypassEditFlag		0..1	(Complex)	Extension - BypassEditFlag Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag"
value[x]		1..1	CodeableConcept	To reflect the relevant edit possibilities for date of birth. Binding: ValueSet - Mothers Date of Birth Edit Flags (NCHS) Vital Records (required): Date of Birth Edit Flags (NCHS) ele-1: All FHIR elements must have a @value or children
Slices for deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not Slice: Unordered, Open by type:$this ele-1: All FHIR elements must have a @value or children
deceasedBoolean			boolean
deceasedDateTime			dateTime
deceased[x]:deceasedBoolean	?!Σ	0..1	boolean	Indicates if the individual is deceased or not ele-1: All FHIR elements must have a @value or children Required Pattern: true
address	SΣ	0..*	Address	Decedent's Residence ele-1: All FHIR elements must have a @value or children
Slices for extension				Content/Rules for all slices
extension:withinCityLimitsIndicator		0..1	Coding	Used to indicate whether or not an address is within city limits. URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-within-city-limits-indicator-vr Binding: ValueSet - Yes No Unknown Vital Records (required): Yes No Unknown (YNU) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:predir		0..1	string	Extension - PreDirectional Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PreDirectional ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:stnum		0..1	string	Extension - StreetNumber Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetNumber ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:stname		0..1	string	Extension - StreetName Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetName ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:stdesig		0..1	string	Extension - StreetDesignator Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetDesignator ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:postdir		0..1	string	Extension - PostDirectional Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PostDirectional ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:unitnumber		0..1	string	Extension - UnitOrAptNumber Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/UnitOrAptNumber ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. ele-1: All FHIR elements must have a @value or children Example General: home
line	SΣ	0..*	string	Street name, number, direction & P.O. Box etc. ele-1: All FHIR elements must have a @value or children This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city	SΣ	0..1	string	Name of city, town etc. ele-1: All FHIR elements must have a @value or children Example General: Erewhon
Slices for extension				Content/Rules for all slices
extension:cityCode		0..1	positiveInt	City Code URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
state	SΣ	0..1	string	State/Jurisdiction of residence. Provide both state and jurisdiction if different. Binding: ValueSet - States, Territories and Provinces Vital Records (required) ele-1: All FHIR elements must have a @value or children
Slices for extension				Content/Rules for all slices
extension:residenceJurisdictionId		0..1	string	Extension URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/Extension-jurisdiction-id-vr Binding: ValueSet - Jurisdictions Vital Records (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
postalCode	SΣ	0..1	string	US Zip Codes ele-1: All FHIR elements must have a @value or children Example General: 9132
period	SΣ	0..1	Period	Time period when address was/is in use ele-1: All FHIR elements must have a @value or children Example General: {"start":"2010-03-23","end":"2010-07-01"}
communication		0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
language	S	1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her health Binding: Language codes with language and optionally a region modifier (extensible) ele-1: All FHIR elements must have a @value or children
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
other	Σ	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to ele-1: All FHIR elements must have a @value or children
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Patient.extension:birthPlace.value[x].use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Patient.identifier:MRN.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.identifier:MRN.type	extensible	Pattern: MR http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Patient.identifier:SSN.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.identifier:SSN.type	extensible	Pattern: SS http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Patient.identifier:SB.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.identifier:SB.type	extensible	Pattern: SB http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Patient.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
Patient.name:currentLegalName.use	required	Fixed Value: official http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
Patient.name:namePriorToFirstMarriage.use	required	Fixed Value: maiden http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
Patient.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system from the FHIR Standard
Patient.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use from the FHIR Standard
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender from the FHIR Standard
Patient.birthDate.extension:bypassEditFlag.value[x]	required	ValueSetMothersDateOfBirthEditFlagsVitalRecords http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-mothers-date-of-birth-edit-flags-vr
Patient.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Patient.address.state	required	ValueSetStatesTerritoriesAndProvincesVitalRecords http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-states-territories-provinces-vr
Patient.communication.language	extensible	LanguageCodesWithLanguageAndOptionallyARegionModifier http://hl7.org/fhir/us/core/ValueSet/simple-language
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Patient	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Patient	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Patient	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Patient	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Patient	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
us-core-6	error	Patient	Either Patient.name.given and/or Patient.name.family SHALL be present or a Data Absent Reason Extension SHALL be present. : (name.family.exists() or name.given.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()

Differential View

This structure is derived from Decedent

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	Decedent	Information about an individual or animal receiving health care services
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Patient	C	0..*	Decedent	Information about an individual or animal receiving health care services us-core-6: Either Patient.name.given and/or Patient.name.family SHALL be present or a Data Absent Reason Extension SHALL be present.
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:race		0..1	(Complex)	US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
extension:ethnicity		0..1	(Complex)	US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
extension:birthsex		0..1	code	Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex Binding: Birth Sex (required): Code for sex assigned at birth
extension:genderIdentity		0..1	CodeableConcept	Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity Binding: Gender Identity (extensible)
extension:birthPlace		0..1	(Complex)	Decedent birthplace URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
value[x]		1..1	Address	Value of extension
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
type	Σ	0..1	code	postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
text	Σ	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line	Σ	0..*	string	Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city	Σ	0..1	string	Name of city, town etc. Example General: Erewhon
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:cityCode		0..1	positiveInt	Extension - City Code Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode
value		0..1	string	Primitive value for string Max Length:1048576
district	Σ	0..1	string	District name (aka county) Example General: Madison
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:districtCode		0..1	positiveInt	County code URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/DistrictCode
value		0..1	string	Primitive value for string Max Length:1048576
state	Σ	0..1	string	Sub-unit of country (abbreviations ok) Binding: ValueSet - States, Territories and Provinces Vital Records (required)
postalCode	Σ	0..1	string	Postal code for area Example General: 9132
country	Σ	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code) Binding: ValueSet - Birthplace Country Vital Records (required)
period	Σ	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
extension:parentReportedAgeAtDelivery		0..2	(Complex)	Extension - Reported Parent Age at Delivery - Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-reported-parent-age-at-delivery-vr
extension:fetalDeath		0..1	Coding	fetal-death URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-patient-fetal-death-vr
extension:NVSS-SexAtDeath		0..1	CodeableConcept	NVSS Sex at Death URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/NVSS-SexAtDeath Binding: Administrative Gender ValueSet (preferred) Additional Bindings Purpose Administrative Gender ValueSet - Max Max Binding
extension:Spouse-Alive		0..1	CodeableConcept	Spouse Alive? URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/SpouseAlive Binding: Spouse Alive ValueSet (required)
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SΣ	1..*	Identifier	An identifier for this patient Slice: Unordered, Open by pattern:type
identifier:MRN	SΣ	0..*	Identifier	Medical Record Number
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	1..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: MR
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
system	SΣ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	The value that is unique within the system. Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier:SSN	SΣ	0..1	Identifier	Decedent's Social Security Number
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	1..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: SS
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
system	SΣ	1..1	uri	The namespace for the identifier value Required Pattern: http://hl7.org/fhir/sid/us-ssn
value	SΣ	1..1	string	The value that is unique within the system. Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier:SB	SΣ	0..1	Identifier	**Deprecated** Decedent's Social Security Number for Compatibility. Use SSN.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	1..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: SB
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
system	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	0..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
Slices for name	SΣ	1..*	HumanName	A name associated with the patient Slice: Unordered, Open by value:use
name:All Slices				Content/Rules for all slices
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	1..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text	Σ	0..1	string	Text representation of the full name
family	SΣC	1..1	string	Family name (often called 'Surname')
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:dataAbsentReason		0..1	code	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
value		0..1	string	Primitive value for string Max Length:1048576
given	SΣC	0..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:dataAbsentReason		0..1	code	unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required)
value		0..1	string	Primitive value for string Max Length:1048576
prefix	Σ	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	Σ	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period	Σ	0..1	Period	Time period when name was/is in use
name:currentLegalName	SΣ	0..1	HumanName	current legal name
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	1..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: official
text	Σ	0..1	string	Text representation of the full name
family	SΣC	1..1	string	Family name (often called 'Surname')
given	SΣC	0..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
prefix	Σ	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	Σ	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period	Σ	0..1	Period	Time period when name was/is in use
name:namePriorToFirstMarriage	SΣ	0..1	HumanName	Name prior to first marriage
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	1..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: maiden
text	Σ	0..1	string	Text representation of the full name
family	SΣC	1..1	string	Family name (often called 'Surname')
given	SΣC	0..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
prefix	Σ	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	Σ	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period	Σ	0..1	Period	Time period when name was/is in use
telecom	Σ	0..*	ContactPoint	A contact detail for the individual
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
value	SΣ	1..1	string	The actual contact point details
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
rank	Σ	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	Σ	0..1	Period	Time period when the contact point was/is in use
gender	SΣ	1..1	code	male | female | other | unknown Binding: AdministrativeGender (required)
birthDate	SΣ	0..1	date	Date of Birth
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:partialDateTime		0..1	(Complex)	partialDateTIme URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/ExtensionPartialDateTimeVitalRecords
extension:birthTime		0..1	dateTime	Time of day of birth URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
extension:bypassEditFlag		0..1	(Complex)	Extension - BypassEditFlag Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag"
value[x]		1..1	CodeableConcept	To reflect the relevant edit possibilities for date of birth. Binding: ValueSet - Mothers Date of Birth Edit Flags (NCHS) Vital Records (required): Date of Birth Edit Flags (NCHS)
value		0..1	date	Primitive value for date
Slices for deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not Slice: Unordered, Open by type:$this
deceasedBoolean			boolean
deceasedDateTime			dateTime
deceased[x]:deceasedBoolean	?!Σ	0..1	boolean	Indicates if the individual is deceased or not Required Pattern: true
address	SΣ	0..*	Address	Decedent's Residence
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:withinCityLimitsIndicator		0..1	Coding	Used to indicate whether or not an address is within city limits. URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-within-city-limits-indicator-vr Binding: ValueSet - Yes No Unknown Vital Records (required): Yes No Unknown (YNU)
extension:predir		0..1	string	Extension - PreDirectional Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PreDirectional
extension:stnum		0..1	string	Extension - StreetNumber Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetNumber
extension:stname		0..1	string	Extension - StreetName Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetName
extension:stdesig		0..1	string	Extension - StreetDesignator Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetDesignator
extension:postdir		0..1	string	Extension - PostDirectional Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PostDirectional
extension:unitnumber		0..1	string	Extension - UnitOrAptNumber Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/UnitOrAptNumber
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
type	Σ	0..1	code	postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
text	Σ	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line	SΣ	0..*	string	Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city	SΣ	0..1	string	Name of city, town etc. Example General: Erewhon
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:cityCode		0..1	positiveInt	City Code URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode
value		0..1	string	Primitive value for string Max Length:1048576
district	Σ	0..1	string	District name (aka county) Example General: Madison
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:districtCode		0..1	positiveInt	County code URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/DistrictCode
value		0..1	string	Primitive value for string Max Length:1048576
state	SΣ	0..1	string	State/Jurisdiction of residence. Provide both state and jurisdiction if different. Binding: ValueSet - States, Territories and Provinces Vital Records (required)
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:residenceJurisdictionId		0..1	string	Extension URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/Extension-jurisdiction-id-vr Binding: ValueSet - Jurisdictions Vital Records (required)
value		0..1	string	Primitive value for string Max Length:1048576
postalCode	SΣ	0..1	string	US Zip Codes Example General: 9132
country	Σ	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code) Binding: ValueSet - Residence Country Vital Records (required)
period	SΣ	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
maritalStatus		0..1	CodeableConcept	Marital (civil) status of a patient Binding: Marital Status Vital Records (required)
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:bypassEditFlag		0..1	(Complex)	Extension - BypassEditFlag Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag"
value[x]		1..1	CodeableConcept	Value of extension Binding: Edit Bypass 0124 (required)
coding	Σ	0..*	Coding	Code defined by a terminology system
text	Σ	0..1	string	Marital Description
multipleBirth[x]		0..1		If not single birth - born first, second, third, etc.
multipleBirth[x]All Types				Content/Rules for all Types
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:bypassEditFlag		0..1	(Complex)	Extension - BypassEditFlag Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag"
value[x]		1..1	CodeableConcept	Value of extension Binding: ValueSet - Plurality Edit Flags (NCHS) Vital Records (required): Plurality Edit Flags (NCHS)
extension:multipleBirthTotal		0..1	positiveInt	Total births in this pregnancy URL: http://hl7.org/fhir/StructureDefinition/patient-multipleBirthTotal
multipleBirthBoolean			boolean
multipleBirthInteger			integer
photo		0..*	Attachment	Image of the patient
contact	C	0..*	BackboneElement	Informant information pat-1: SHALL at least contain a contact's details or a reference to an organization
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
relationship		0..1	CodeableConcept	Informant Relationship (INFORMRELATE) Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
text	Σ	0..1	string	Informant Relationship (INFORMRELATE) - first 30 characters will be used
name		0..1	HumanName	A name associated with the contact person
telecom		0..*	ContactPoint	A contact detail for the person
address		0..1	Address	Address for the contact person
gender		0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
organization	C	0..1	Reference(Organization)	Organization that is associated with the contact
period		0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient
communication		0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
language	S	1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her health Binding: Language codes with language and optionally a region modifier (extensible)
preferred		0..1	boolean	Language preference indicator
generalPractitioner		0..*	Reference(Organization | Practitioner | PractitionerRole)	Patient's nominated primary care provider
managingOrganization	Σ	0..1	Reference(Organization)	Organization that is the custodian of the patient record
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
other	Σ	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Patient.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Patient.extension:birthPlace.value[x].use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Patient.extension:birthPlace.value[x].type	required	AddressType http://hl7.org/fhir/ValueSet/address-type|4.0.1 from the FHIR Standard
Patient.extension:birthPlace.value[x].state	required	ValueSetStatesTerritoriesAndProvincesVitalRecords http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-states-territories-provinces-vr
Patient.extension:birthPlace.value[x].country	required	ValueSetBirthplaceCountryVitalRecords http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-birthplace-country-vr
Patient.identifier:MRN.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.identifier:MRN.type	extensible	Pattern: MR http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Patient.identifier:SSN.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.identifier:SSN.type	extensible	Pattern: SS http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Patient.identifier:SB.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.identifier:SB.type	extensible	Pattern: SB http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Patient.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
Patient.name:currentLegalName.use	required	Fixed Value: official http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
Patient.name:namePriorToFirstMarriage.use	required	Fixed Value: maiden http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
Patient.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system from the FHIR Standard
Patient.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use from the FHIR Standard
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender from the FHIR Standard
Patient.birthDate.extension:bypassEditFlag.value[x]	required	ValueSetMothersDateOfBirthEditFlagsVitalRecords http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-mothers-date-of-birth-edit-flags-vr
Patient.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Patient.address.type	required	AddressType http://hl7.org/fhir/ValueSet/address-type|4.0.1 from the FHIR Standard
Patient.address.state	required	ValueSetStatesTerritoriesAndProvincesVitalRecords http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-states-territories-provinces-vr
Patient.address.country	required	ValueSetResidenceCountryVitalRecords http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-residence-country-vr
Patient.maritalStatus	required	ValueSetMaritalStatusVitalRecords http://hl7.org/fhir/us/vrdr/ValueSet/ValueSet-marital-status-vr
Patient.maritalStatus.extension:bypassEditFlag.value[x]	required	EditBypass0124VS http://hl7.org/fhir/us/vrdr/ValueSet/vrdr-edit-bypass-0124-vs
Patient.multipleBirth[x].extension:bypassEditFlag.value[x]	required	ValueSetPluralityEditFlagsVitalRecords http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-plurality-edit-flags-vr
Patient.contact.relationship	extensible	PatientContactRelationship http://hl7.org/fhir/ValueSet/patient-contactrelationship from the FHIR Standard
Patient.contact.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
Patient.communication.language	extensible	LanguageCodesWithLanguageAndOptionallyARegionModifier http://hl7.org/fhir/us/core/ValueSet/simple-language
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Patient	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Patient	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Patient	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Patient	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Patient	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
pat-1	error	Patient.contact	SHALL at least contain a contact's details or a reference to an organization : name.exists() or telecom.exists() or address.exists() or organization.exists()
us-core-6	error	Patient	Either Patient.name.given and/or Patient.name.family SHALL be present or a Data Absent Reason Extension SHALL be present. : (name.family.exists() or name.given.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()

This structure is derived from Decedent

Summary