Vital Records Common Library (VRCL) FHIR Implementation Guide, published by HL7 International / Public Health. This guide is not an authorized publication; it is the continuous build for version 2.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/vr-common-library/ and changes regularly. See the Directory of published versions

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

Resource Profile: Patient - Vital Records ( Abstract )

Usages:

• Derived from this Profile: Patient - Child Vital Records and Patient - Mother Vital Records
• Refer to this Profile: Observation - Education Level Vital Records, Observation - Emerging Issues Vital Records, Related Person - Parent Vital Records, Observation - Coded Race and Ethnicity Vital Records and Observation - Input Race and Ethnicity Vital Records

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient	C	0..*	USCorePatientProfile	This is an abstract profile. Child profiles: PatientChildVitalRecords, PatientMotherVitalRecords Information about an individual or animal receiving health care services Constraints: us-core-6
Patient.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Patient.Slices for extension				Content/Rules for all slices
Patient.Slices for extension.extension:race		0..1	(Complex)	US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
Patient.Slices for extension.extension:ethnicity		0..1	(Complex)	US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
Patient.Slices for extension.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
Patient.Slices for extension.extension:genderIdentity		0..1	CodeableConcept	Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity Binding: Gender Identity (extensible)
Patient.Slices for extension.extension:birthPlace		0..1	(Complex)	Place of Birth for the patient should include the state and/or country URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
Patient.Slices for extension.extension:birthPlace.extension		0..0		Extension Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:birthPlace.url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
Patient.Slices for extension.extension:birthPlace.value[x]		1..1	Address	Value of extension
Patient.Slices for extension.extension:birthPlace.value[x].use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
Patient.Slices for extension.extension:birthPlace.value[x].state	Σ This element is included in summaries.	0..1	string	State/Jurisdiction of birth. Provide only for US or Canadian states/provinces/territories. Use value in Jurisdiction if present. Binding: Value Set - States, Territories and Provinces Vital Records (required)
Patient.Slices for extension.extension:birthPlace.value[x].state.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for extension.extension:birthPlace.value[x].state.Slices for extension				Content/Rules for all slices
Patient.Slices for extension.extension:birthPlace.value[x].state.Slices for extension.extension:nationalReportingJurisdictionId		0..1	string	Location Jurisdiction Id Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-jurisdiction-id-vr Binding: Value Set - Jurisdictions Vital Records (required)
Patient.Slices for extension.extension:birthPlace.value[x].country	Σ This element is included in summaries.	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code) Binding: Value Set - Birthplace Country Vital Records (required)
Patient.Slices for extension.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
Patient.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Patient.Slices for identifier	S This element must be supported. Σ This element is included in summaries.	1..*	Identifier	An identifier for this patient Slice: Unordered, Open by pattern:type Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for identifier.identifier:All Slices				Content/Rules for all slices
Patient.Slices for identifier.identifier:All Slices.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:All Slices.system	S This element must be supported. Σ This element is included in summaries.	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
Patient.Slices for identifier.identifier:All Slices.value	S This element must be supported. Σ This element is included in summaries.	1..1	string	The value that is unique within the system. Example General: 123456
Patient.Slices for identifier.identifier:MRN	S This element must be supported. Σ This element is included in summaries.	0..*	Identifier	Medical Record Number
Patient.Slices for identifier.identifier:MRN.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:MRN.type	Σ This element is included in summaries.	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: { "coding" : [ { "system" : "http://terminology.hl7.org/CodeSystem/v2-0203", "code" : "MR" } ] }
Patient.Slices for identifier.identifier:MRN.system	S This element must be supported. Σ This element is included in summaries.	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
Patient.Slices for identifier.identifier:MRN.value	S This element must be supported. Σ This element is included in summaries.	1..1	string	The value that is unique within the system. Example General: 123456
Patient.Slices for identifier.identifier:SSN	S This element must be supported. Σ This element is included in summaries.	0..1	Identifier	SSN if available and appropriate to send
Patient.Slices for identifier.identifier:SSN.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:SSN.type	Σ This element is included in summaries.	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: { "coding" : [ { "system" : "http://terminology.hl7.org/CodeSystem/v2-0203", "code" : "SS" } ] }
Patient.Slices for identifier.identifier:SSN.system	S This element must be supported. Σ This element is included in summaries.	1..1	uri	The namespace for the identifier value Required Pattern: http://hl7.org/fhir/sid/us-ssn (extensions allowed)
Patient.Slices for identifier.identifier:SSN.value	S This element must be supported. Σ This element is included in summaries.	1..1	string	The value that is unique within the system. Example General: 123456
Patient.active	?! This element is a modifier element. Σ This element is included in summaries.	0..1	boolean	Whether this patient's record is in active use
Patient.Slices for name	S This element must be supported. Σ This element is included in summaries.	1..*	HumanName	A name associated with the patient Slice: Unordered, Open by value:use Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for name.name:All Slices				Content/Rules for all slices
Patient.Slices for name.name:All Slices.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
Patient.Slices for name.name:All Slices.family	S This element must be supported. Σ This element is included in summaries. C	0..1	string	Family name (often called 'Surname')
Patient.Slices for name.name:All Slices.family.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for name.name:All Slices.family.Slices for extension.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)
Patient.Slices for name.name:All Slices.given	S This element must be supported. Σ This element is included in summaries. 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
Patient.Slices for name.name:All Slices.given.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for name.name:All Slices.given.Slices for extension.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)
Patient.Slices for name.name:currentLegalName	S This element must be supported. Σ This element is included in summaries.	0..1	HumanName	current legal name
Patient.Slices for name.name:currentLegalName.use	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: official (no extensions allowed)
Patient.Slices for name.name:currentLegalName.family	S This element must be supported. Σ This element is included in summaries. C	0..1	string	Family name (often called 'Surname')
Patient.Slices for name.name:currentLegalName.given	S This element must be supported. Σ This element is included in summaries. 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
Patient.Slices for name.name:namePriorToFirstMarriage	S This element must be supported. Σ This element is included in summaries.	0..1	HumanName	Name prior to first marriage
Patient.Slices for name.name:namePriorToFirstMarriage.use	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: maiden (no extensions allowed)
Patient.Slices for name.name:namePriorToFirstMarriage.family	S This element must be supported. Σ This element is included in summaries. C	0..1	string	Family name (often called 'Surname')
Patient.Slices for name.name:namePriorToFirstMarriage.given	S This element must be supported. Σ This element is included in summaries. 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
Patient.telecom	Σ This element is included in summaries.	0..*	ContactPoint	A contact detail for the individual
Patient.telecom.system	S This element must be supported. Σ This element is included in summaries. C	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
Patient.telecom.value	S This element must be supported. Σ This element is included in summaries.	1..1	string	The actual contact point details
Patient.telecom.use	?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries.	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
Patient.gender	S This element must be supported. Σ This element is included in summaries.	1..1	code	male | female | other | unknown Binding: AdministrativeGender (required)
Patient.birthDate	S This element must be supported. Σ This element is included in summaries.	0..1	date	The date of birth for the individual
Patient.birthDate.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.birthDate.Slices for extension.extension:partialDateTime		0..1	(Complex)	partialDateTIme URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-partial-date-time-vr
Patient.birthDate.Slices for extension.extension:birthTime		0..1	dateTime	Time of day of birth URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
Patient.birthDate.Slices for extension.extension:bypassEditFlag		0..1	(Complex)	BypassEditFlag Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag
Patient.birthDate.Slices for extension.extension:bypassEditFlag.extension		0..0		Extension Slice: Unordered, Open by value:url
Patient.birthDate.Slices for extension.extension:bypassEditFlag.url		1..1	uri	"http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag"
Patient.birthDate.Slices for extension.extension:bypassEditFlag.value[x]		1..1	CodeableConcept	To reflect the relevant edit possibilities for date of birth. Binding: Value Set - Date of Birth Edit Flags (NCHS) Vital Records (required): Date of Birth Edit Flags (NCHS)
Patient.Slices for deceased[x]	?! This element is a modifier element. Σ This element is included in summaries.	0..1		Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view
Patient.Slices for deceased[x].deceasedBoolean			boolean
Patient.Slices for deceased[x].deceasedDateTime			dateTime
Patient.Slices for deceased[x].deceased[x]:deceasedBoolean	?! This element is a modifier element. Σ This element is included in summaries. C	0..1	boolean	Boolean indicator. True if the individual is deceased. Constraints: fetalDeathOnlyIfDeceased
Patient.Slices for deceased[x].deceased[x]:deceasedBoolean.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for deceased[x].deceased[x]:deceasedBoolean.Slices for extension				Content/Rules for all slices
Patient.Slices for deceased[x].deceased[x]:deceasedBoolean.Slices for extension.extension:fetalDeath		0..1	boolean	Boolean indicator. True if the Patient died as a fetus. URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-patient-fetal-death-vr
Patient.address	S This element must be supported. Σ This element is included in summaries.	0..*	Address	An address for the individual
Patient.address.Slices for extension				Content/Rules for all slices
Patient.address.Slices for extension.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: Value Set - Yes No Unknown Vital Records (required): Yes No Unknown (YNU)
Patient.address.Slices for extension.extension:predir		0..1	string	PreDirectional Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PreDirectional
Patient.address.Slices for extension.extension:stnum		0..1	string	StreetNumber Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetNumber
Patient.address.Slices for extension.extension:stname		0..1	string	StreetName Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetName
Patient.address.Slices for extension.extension:stdesig		0..1	string	StreetDesignator Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetDesignator
Patient.address.Slices for extension.extension:postdir		0..1	string	PostDirectional Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PostDirectional
Patient.address.Slices for extension.extension:unitnumber		0..1	string	UnitOrAptNumber Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/UnitOrAptNumber
Patient.address.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
Patient.address.line	S This element must be supported. Σ This element is included in summaries.	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
Patient.address.city	S This element must be supported. Σ This element is included in summaries.	0..1	string	Name of city, town etc. Example General: Erewhon
Patient.address.city.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.address.city.Slices for extension.extension:cityCode		0..1	positiveInt	City Code URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode
Patient.address.state	S This element must be supported. Σ This element is included in summaries.	0..1	string	Sub-unit of country (abbreviations ok) Binding: Value Set - States, Territories and Provinces Vital Records (required)
Patient.address.postalCode	S This element must be supported. Σ This element is included in summaries.	0..1	string	US Zip Codes Example General: 9132
Patient.address.country	Σ This element is included in summaries.	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code) Binding: Value Set - Residence Country Vital Records (required)
Patient.address.period	S This element must be supported. Σ This element is included in summaries.	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
Patient.multipleBirth[x]		0..1		If not single birth - born first, second, third, etc.
Patient.multipleBirth[x].multipleBirth[x]All Types				Content/Rules for all Types
Patient.multipleBirth[x].multipleBirth[x]All Types.Slices for extension				Content/Rules for all slices
Patient.multipleBirth[x].multipleBirth[x]All Types.Slices for extension.extension:bypassEditFlag		0..1	(Complex)	BypassEditFlag Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag
Patient.multipleBirth[x].multipleBirth[x]All Types.Slices for extension.extension:bypassEditFlag.extension		0..0		Extension Slice: Unordered, Open by value:url
Patient.multipleBirth[x].multipleBirth[x]All Types.Slices for extension.extension:bypassEditFlag.url		1..1	uri	"http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag"
Patient.multipleBirth[x].multipleBirth[x]All Types.Slices for extension.extension:bypassEditFlag.value[x]		1..1	CodeableConcept	Value of extension Binding: Value Set - Plurality Edit Flags (NCHS) Vital Records (required): Plurality Edit Flags (NCHS)
Patient.multipleBirth[x].multipleBirth[x]All Types.Slices for extension.extension:multipleBirthTotal		0..1	positiveInt	Total births in this pregnancy URL: http://hl7.org/fhir/StructureDefinition/patient-multipleBirthTotal
Patient.multipleBirth[x].multipleBirthBoolean			boolean
Patient.multipleBirth[x].multipleBirthInteger			integer
Patient.communication		0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health
Patient.communication.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Patient.communication.language	S This element must be supported.	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)
Patient.link	?! This element is a modifier element. Σ This element is included in summaries.	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
Patient.link.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Patient.link.other	Σ This element is included in summaries.	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
Patient.link.type	Σ This element is included in summaries.	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	Status	Usage	ValueSet	Version	Source
Patient.extension:birthPlace.​value[x].use	Base	required	AddressUse	📍4.0.1	FHIR Std.
Patient.extension:birthPlace.​value[x].state	Base	required	Value Set - States, Territories and Provinces Vital Records	📦2.0.0	This IG
Patient.extension:birthPlace.​value[x].country	Base	required	Value Set - Birthplace Country Vital Records	📦2.0.0	This IG
Patient.identifier.use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Patient.identifier:MRN.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Patient.identifier:MRN.​type	Base	extensible	IdentifierType	📦4.0.1	FHIR Std.
Patient.identifier:SSN.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Patient.identifier:SSN.​type	Base	extensible	IdentifierType	📦4.0.1	FHIR Std.
Patient.name.use	Base	required	NameUse	📍4.0.1	FHIR Std.
Patient.name:currentLegalName.​use	Base	required	NameUse	📍4.0.1	FHIR Std.
Patient.name:namePriorToFirstMarriage.​use	Base	required	NameUse	📍4.0.1	FHIR Std.
Patient.telecom.system	Base	required	ContactPointSystem	📦4.0.1	FHIR Std.
Patient.telecom.use	Base	required	ContactPointUse	📦4.0.1	FHIR Std.
Patient.gender	Base	required	AdministrativeGender	📦4.0.1	FHIR Std.
Patient.birthDate.extension:bypassEditFlag.​value[x]	Base	required	Value Set - Date of Birth Edit Flags (NCHS) Vital Records	📦2.0.0	This IG
Patient.address.use	Base	required	AddressUse	📍4.0.1	FHIR Std.
Patient.address.state	Base	required	Value Set - States, Territories and Provinces Vital Records	📦2.0.0	This IG
Patient.address.country	Base	required	Value Set - Residence Country Vital Records	📦2.0.0	This IG
Patient.multipleBirth[x].​extension:bypassEditFlag.​value[x]	Base	required	Value Set - Plurality Edit Flags (NCHS) Vital Records	📦2.0.0	This IG
Patient.communication.​language	Base	extensible	Language codes with language and optionally a region modifier	📦5.0.1	US Core v5.0
Patient.link.type	Base	required	LinkType	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
fetalDeathOnlyIfDeceased	error	Patient.deceased[x]:deceasedBoolean	Fetal death should only be indicated if Patient is deceased.	(extension.where(url = 'http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-patient-fetal-death-vr').exists(value.exists() and value = 'true')) implies (value.exists() and value = 'true')

This structure is derived from USCorePatientProfile

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient		0..*	USCorePatientProfile	This is an abstract profile. Child profiles: PatientChildVitalRecords, PatientMotherVitalRecords Information about an individual or animal receiving health care services
Patient.Slices for extension				Content/Rules for all slices
Patient.Slices for extension.extension:birthPlace		0..1	(Complex)	Place of Birth for the patient should include the state and/or country URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
Patient.Slices for extension.extension:birthPlace.value[x]
Patient.Slices for extension.extension:birthPlace.value[x].city
Patient.Slices for extension.extension:birthPlace.value[x].city.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for extension.extension:birthPlace.value[x].city.Slices for extension				Content/Rules for all slices
Patient.Slices for extension.extension:birthPlace.value[x].city.Slices for extension.extension:cityCode		0..1	positiveInt	City Code Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode
Patient.Slices for extension.extension:birthPlace.value[x].district
Patient.Slices for extension.extension:birthPlace.value[x].district.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for extension.extension:birthPlace.value[x].district.Slices for extension				Content/Rules for all slices
Patient.Slices for extension.extension:birthPlace.value[x].district.Slices for extension.extension:districtCode		0..1	positiveInt	County code URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/DistrictCode
Patient.Slices for extension.extension:birthPlace.value[x].state		0..1	string	State/Jurisdiction of birth. Provide only for US or Canadian states/provinces/territories. Use value in Jurisdiction if present. Binding: Value Set - States, Territories and Provinces Vital Records (required)
Patient.Slices for extension.extension:birthPlace.value[x].state.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for extension.extension:birthPlace.value[x].state.Slices for extension				Content/Rules for all slices
Patient.Slices for extension.extension:birthPlace.value[x].state.Slices for extension.extension:nationalReportingJurisdictionId		0..1	string	Location Jurisdiction Id Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-jurisdiction-id-vr Binding: Value Set - Jurisdictions Vital Records (required)
Patient.Slices for extension.extension:birthPlace.value[x].country		0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code) Binding: Value Set - Birthplace Country Vital Records (required)
Patient.Slices for extension.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
Patient.Slices for identifier		1..*	Identifier	An identifier for this patient Slice: Unordered, Open by pattern:type Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for identifier.identifier:MRN		0..*	Identifier	Medical Record Number
Patient.Slices for identifier.identifier:MRN.type		1..1	CodeableConcept	Description of identifier Required Pattern: { "coding" : [ { "system" : "http://terminology.hl7.org/CodeSystem/v2-0203", "code" : "MR" } ] }
Patient.Slices for identifier.identifier:SSN		0..1	Identifier	SSN if available and appropriate to send
Patient.Slices for identifier.identifier:SSN.type		1..1	CodeableConcept	Description of identifier Required Pattern: { "coding" : [ { "system" : "http://terminology.hl7.org/CodeSystem/v2-0203", "code" : "SS" } ] }
Patient.Slices for identifier.identifier:SSN.system		1..1	uri	The namespace for the identifier value Required Pattern: http://hl7.org/fhir/sid/us-ssn (extensions allowed)
Patient.Slices for name		1..*	HumanName	A name associated with the patient Slice: Unordered, Open by value:use Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for name.name:All Slices				Content/Rules for all slices
Patient.Slices for name.name:All Slices.family
Patient.Slices for name.name:All Slices.family.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for name.name:All Slices.family.Slices for extension.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)
Patient.Slices for name.name:All Slices.given
Patient.Slices for name.name:All Slices.given.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for name.name:All Slices.given.Slices for extension.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)
Patient.Slices for name.name:currentLegalName		0..1	HumanName	current legal name
Patient.Slices for name.name:currentLegalName.use		1..1	code	usual | official | temp | nickname | anonymous | old | maiden Fixed Value: official (no extensions allowed)
Patient.Slices for name.name:namePriorToFirstMarriage		0..1	HumanName	Name prior to first marriage
Patient.Slices for name.name:namePriorToFirstMarriage.use		1..1	code	usual | official | temp | nickname | anonymous | old | maiden Fixed Value: maiden (no extensions allowed)
Patient.birthDate
Patient.birthDate.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.birthDate.Slices for extension.extension:partialDateTime		0..1	(Complex)	partialDateTIme URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-partial-date-time-vr
Patient.birthDate.Slices for extension.extension:birthTime		0..1	dateTime	Time of day of birth URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
Patient.birthDate.Slices for extension.extension:bypassEditFlag		0..1	(Complex)	BypassEditFlag Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag
Patient.birthDate.Slices for extension.extension:bypassEditFlag.value[x]		1..1	CodeableConcept	To reflect the relevant edit possibilities for date of birth. Binding: Value Set - Date of Birth Edit Flags (NCHS) Vital Records (required): Date of Birth Edit Flags (NCHS)
Patient.Slices for deceased[x]		0..1	boolean, dateTime	Indicates if the individual is deceased or not Slice: Unordered, Open by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view
Patient.Slices for deceased[x].deceased[x]:deceasedBoolean	C	0..1	boolean	Boolean indicator. True if the individual is deceased. Constraints: fetalDeathOnlyIfDeceased
Patient.Slices for deceased[x].deceased[x]:deceasedBoolean.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for deceased[x].deceased[x]:deceasedBoolean.Slices for extension				Content/Rules for all slices
Patient.Slices for deceased[x].deceased[x]:deceasedBoolean.Slices for extension.extension:fetalDeath		0..1	boolean	Boolean indicator. True if the Patient died as a fetus. URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-patient-fetal-death-vr
Patient.address
Patient.address.Slices for extension				Content/Rules for all slices
Patient.address.Slices for extension.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: Value Set - Yes No Unknown Vital Records (required): Yes No Unknown (YNU)
Patient.address.Slices for extension.extension:predir		0..1	string	PreDirectional Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PreDirectional
Patient.address.Slices for extension.extension:stnum		0..1	string	StreetNumber Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetNumber
Patient.address.Slices for extension.extension:stname		0..1	string	StreetName Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetName
Patient.address.Slices for extension.extension:stdesig		0..1	string	StreetDesignator Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetDesignator
Patient.address.Slices for extension.extension:postdir		0..1	string	PostDirectional Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PostDirectional
Patient.address.Slices for extension.extension:unitnumber		0..1	string	UnitOrAptNumber Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/UnitOrAptNumber
Patient.address.city
Patient.address.city.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.address.city.Slices for extension.extension:cityCode		0..1	positiveInt	City Code URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode
Patient.address.district
Patient.address.district.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.address.district.Slices for extension.extension:districtCode		0..1	positiveInt	County code URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/DistrictCode
Patient.address.state		0..1	string	Sub-unit of country (abbreviations ok) Binding: Value Set - States, Territories and Provinces Vital Records (required)
Patient.address.country		0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code) Binding: Value Set - Residence Country Vital Records (required)
Patient.multipleBirth[x]		0..1	boolean, integer	If not single birth - born first, second, third, etc.
Patient.multipleBirth[x].Slices for extension				Content/Rules for all slices
Patient.multipleBirth[x].Slices for extension.extension:bypassEditFlag		0..1	(Complex)	BypassEditFlag Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag
Patient.multipleBirth[x].Slices for extension.extension:bypassEditFlag.value[x]		1..1	CodeableConcept	Value of extension Binding: Value Set - Plurality Edit Flags (NCHS) Vital Records (required): Plurality Edit Flags (NCHS)
Patient.multipleBirth[x].Slices for extension.extension:multipleBirthTotal		0..1	positiveInt	Total births in this pregnancy URL: http://hl7.org/fhir/StructureDefinition/patient-multipleBirthTotal
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
Patient.extension:birthPlace.​value[x].state	Base	required	Value Set - States, Territories and Provinces Vital Records	📦2.0.0	This IG
Patient.extension:birthPlace.​value[x].country	Base	required	Value Set - Birthplace Country Vital Records	📦2.0.0	This IG
Patient.birthDate.extension:bypassEditFlag.​value[x]	Base	required	Value Set - Date of Birth Edit Flags (NCHS) Vital Records	📦2.0.0	This IG
Patient.address.state	Base	required	Value Set - States, Territories and Provinces Vital Records	📦2.0.0	This IG
Patient.address.country	Base	required	Value Set - Residence Country Vital Records	📦2.0.0	This IG
Patient.multipleBirth[x].​extension:bypassEditFlag.​value[x]	Base	required	Value Set - Plurality Edit Flags (NCHS) Vital Records	📦2.0.0	This IG

Constraints

Id	Grade	Path(s)	Description	Expression
fetalDeathOnlyIfDeceased	error	Patient.deceased[x]:deceasedBoolean	Fetal death should only be indicated if Patient is deceased.	(extension.where(url = 'http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-patient-fetal-death-vr').exists(value.exists() and value = 'true')) implies (value.exists() and value = 'true')

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient	C	0..*	USCorePatientProfile	This is an abstract profile. Child profiles: PatientChildVitalRecords, PatientMotherVitalRecords Information about an individual or animal receiving health care services Constraints: us-core-6
Patient.id	Σ This element is included in summaries.	0..1	id	Logical id of this artifact
Patient.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
Patient.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Patient.language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
Patient.text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Patient.contained		0..*	Resource	Contained, inline Resources
Patient.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:race		0..1	(Complex)	US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
Patient.Slices for extension.extension:ethnicity		0..1	(Complex)	US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
Patient.Slices for extension.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
Patient.Slices for extension.extension:genderIdentity		0..1	CodeableConcept	Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity Binding: Gender Identity (extensible)
Patient.Slices for extension.extension:birthPlace		0..1	(Complex)	Place of Birth for the patient should include the state and/or country URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
Patient.Slices for extension.extension:birthPlace.id		0..1	string	Unique id for inter-element referencing
Patient.Slices for extension.extension:birthPlace.extension		0..0		Extension Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:birthPlace.url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
Patient.Slices for extension.extension:birthPlace.value[x]		1..1	Address	Value of extension
Patient.Slices for extension.extension:birthPlace.value[x].id		0..1	string	Unique id for inter-element referencing
Patient.Slices for extension.extension:birthPlace.value[x].extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:birthPlace.value[x].use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
Patient.Slices for extension.extension:birthPlace.value[x].type	Σ This element is included in summaries.	0..1	code	postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
Patient.Slices for extension.extension:birthPlace.value[x].text	Σ This element is included in summaries.	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
Patient.Slices for extension.extension:birthPlace.value[x].line	Σ This element is included in summaries.	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
Patient.Slices for extension.extension:birthPlace.value[x].city	Σ This element is included in summaries.	0..1	string	Name of city, town etc. Example General: Erewhon
Patient.Slices for extension.extension:birthPlace.value[x].city.id		0..1	string	xml:id (or equivalent in JSON)
Patient.Slices for extension.extension:birthPlace.value[x].city.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for extension.extension:birthPlace.value[x].city.Slices for extension				Content/Rules for all slices
Patient.Slices for extension.extension:birthPlace.value[x].city.Slices for extension.extension:cityCode		0..1	positiveInt	City Code Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode
Patient.Slices for extension.extension:birthPlace.value[x].city.value		0..1	string	Primitive value for string Max Length:1048576
Patient.Slices for extension.extension:birthPlace.value[x].district	Σ This element is included in summaries.	0..1	string	District name (aka county) Example General: Madison
Patient.Slices for extension.extension:birthPlace.value[x].district.id		0..1	string	xml:id (or equivalent in JSON)
Patient.Slices for extension.extension:birthPlace.value[x].district.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for extension.extension:birthPlace.value[x].district.Slices for extension				Content/Rules for all slices
Patient.Slices for extension.extension:birthPlace.value[x].district.Slices for extension.extension:districtCode		0..1	positiveInt	County code URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/DistrictCode
Patient.Slices for extension.extension:birthPlace.value[x].district.value		0..1	string	Primitive value for string Max Length:1048576
Patient.Slices for extension.extension:birthPlace.value[x].state	Σ This element is included in summaries.	0..1	string	State/Jurisdiction of birth. Provide only for US or Canadian states/provinces/territories. Use value in Jurisdiction if present. Binding: Value Set - States, Territories and Provinces Vital Records (required)
Patient.Slices for extension.extension:birthPlace.value[x].state.id		0..1	string	xml:id (or equivalent in JSON)
Patient.Slices for extension.extension:birthPlace.value[x].state.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for extension.extension:birthPlace.value[x].state.Slices for extension				Content/Rules for all slices
Patient.Slices for extension.extension:birthPlace.value[x].state.Slices for extension.extension:nationalReportingJurisdictionId		0..1	string	Location Jurisdiction Id Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-jurisdiction-id-vr Binding: Value Set - Jurisdictions Vital Records (required)
Patient.Slices for extension.extension:birthPlace.value[x].state.value		0..1	string	Primitive value for string Max Length:1048576
Patient.Slices for extension.extension:birthPlace.value[x].postalCode	Σ This element is included in summaries.	0..1	string	Postal code for area Example General: 9132
Patient.Slices for extension.extension:birthPlace.value[x].country	Σ This element is included in summaries.	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code) Binding: Value Set - Birthplace Country Vital Records (required)
Patient.Slices for extension.extension:birthPlace.value[x].period	Σ This element is included in summaries.	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
Patient.Slices for extension.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
Patient.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Patient.Slices for identifier	S This element must be supported. Σ This element is included in summaries.	1..*	Identifier	An identifier for this patient Slice: Unordered, Open by pattern:type Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for identifier.identifier:All Slices				Content/Rules for all slices
Patient.Slices for identifier.identifier:All Slices.id		0..1	string	Unique id for inter-element referencing
Patient.Slices for identifier.identifier:All Slices.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:All Slices.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:All Slices.type	Σ This element is included in summaries.	0..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.
Patient.Slices for identifier.identifier:All Slices.system	S This element must be supported. Σ This element is included in summaries.	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
Patient.Slices for identifier.identifier:All Slices.value	S This element must be supported. Σ This element is included in summaries.	1..1	string	The value that is unique within the system. Example General: 123456
Patient.Slices for identifier.identifier:All Slices.period	Σ This element is included in summaries.	0..1	Period	Time period when id is/was valid for use
Patient.Slices for identifier.identifier:All Slices.assigner	Σ This element is included in summaries.	0..1	Reference(Organization)	Organization that issued id (may be just text)
Patient.Slices for identifier.identifier:MRN	S This element must be supported. Σ This element is included in summaries.	0..*	Identifier	Medical Record Number
Patient.Slices for identifier.identifier:MRN.id		0..1	string	Unique id for inter-element referencing
Patient.Slices for identifier.identifier:MRN.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:MRN.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:MRN.type	Σ This element is included in summaries.	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: { "coding" : [ { "system" : "http://terminology.hl7.org/CodeSystem/v2-0203", "code" : "MR" } ] }
Patient.Slices for identifier.identifier:MRN.system	S This element must be supported. Σ This element is included in summaries.	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
Patient.Slices for identifier.identifier:MRN.value	S This element must be supported. Σ This element is included in summaries.	1..1	string	The value that is unique within the system. Example General: 123456
Patient.Slices for identifier.identifier:MRN.period	Σ This element is included in summaries.	0..1	Period	Time period when id is/was valid for use
Patient.Slices for identifier.identifier:MRN.assigner	Σ This element is included in summaries.	0..1	Reference(Organization)	Organization that issued id (may be just text)
Patient.Slices for identifier.identifier:SSN	S This element must be supported. Σ This element is included in summaries.	0..1	Identifier	SSN if available and appropriate to send
Patient.Slices for identifier.identifier:SSN.id		0..1	string	Unique id for inter-element referencing
Patient.Slices for identifier.identifier:SSN.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:SSN.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:SSN.type	Σ This element is included in summaries.	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: { "coding" : [ { "system" : "http://terminology.hl7.org/CodeSystem/v2-0203", "code" : "SS" } ] }
Patient.Slices for identifier.identifier:SSN.system	S This element must be supported. Σ This element is included in summaries.	1..1	uri	The namespace for the identifier value Required Pattern: http://hl7.org/fhir/sid/us-ssn (extensions allowed)
Patient.Slices for identifier.identifier:SSN.value	S This element must be supported. Σ This element is included in summaries.	1..1	string	The value that is unique within the system. Example General: 123456
Patient.Slices for identifier.identifier:SSN.period	Σ This element is included in summaries.	0..1	Period	Time period when id is/was valid for use
Patient.Slices for identifier.identifier:SSN.assigner	Σ This element is included in summaries.	0..1	Reference(Organization)	Organization that issued id (may be just text)
Patient.active	?! This element is a modifier element. Σ This element is included in summaries.	0..1	boolean	Whether this patient's record is in active use
Patient.Slices for name	S This element must be supported. Σ This element is included in summaries.	1..*	HumanName	A name associated with the patient Slice: Unordered, Open by value:use Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for name.name:All Slices				Content/Rules for all slices
Patient.Slices for name.name:All Slices.id		0..1	string	Unique id for inter-element referencing
Patient.Slices for name.name:All Slices.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Patient.Slices for name.name:All Slices.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
Patient.Slices for name.name:All Slices.text	Σ This element is included in summaries.	0..1	string	Text representation of the full name
Patient.Slices for name.name:All Slices.family	S This element must be supported. Σ This element is included in summaries. C	0..1	string	Family name (often called 'Surname')
Patient.Slices for name.name:All Slices.family.id		0..1	string	xml:id (or equivalent in JSON)
Patient.Slices for name.name:All Slices.family.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for name.name:All Slices.family.Slices for extension.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)
Patient.Slices for name.name:All Slices.family.value		0..1	string	Primitive value for string Max Length:1048576
Patient.Slices for name.name:All Slices.given	S This element must be supported. Σ This element is included in summaries. 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
Patient.Slices for name.name:All Slices.given.id		0..1	string	xml:id (or equivalent in JSON)
Patient.Slices for name.name:All Slices.given.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for name.name:All Slices.given.Slices for extension.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)
Patient.Slices for name.name:All Slices.given.value		0..1	string	Primitive value for string Max Length:1048576
Patient.Slices for name.name:All Slices.prefix	Σ This element is included in summaries.	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
Patient.Slices for name.name:All Slices.suffix	Σ This element is included in summaries.	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
Patient.Slices for name.name:All Slices.period	Σ This element is included in summaries.	0..1	Period	Time period when name was/is in use
Patient.Slices for name.name:currentLegalName	S This element must be supported. Σ This element is included in summaries.	0..1	HumanName	current legal name
Patient.Slices for name.name:currentLegalName.id		0..1	string	Unique id for inter-element referencing
Patient.Slices for name.name:currentLegalName.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Patient.Slices for name.name:currentLegalName.use	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: official (no extensions allowed)
Patient.Slices for name.name:currentLegalName.text	Σ This element is included in summaries.	0..1	string	Text representation of the full name
Patient.Slices for name.name:currentLegalName.family	S This element must be supported. Σ This element is included in summaries. C	0..1	string	Family name (often called 'Surname')
Patient.Slices for name.name:currentLegalName.given	S This element must be supported. Σ This element is included in summaries. 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
Patient.Slices for name.name:currentLegalName.prefix	Σ This element is included in summaries.	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
Patient.Slices for name.name:currentLegalName.suffix	Σ This element is included in summaries.	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
Patient.Slices for name.name:currentLegalName.period	Σ This element is included in summaries.	0..1	Period	Time period when name was/is in use
Patient.Slices for name.name:namePriorToFirstMarriage	S This element must be supported. Σ This element is included in summaries.	0..1	HumanName	Name prior to first marriage
Patient.Slices for name.name:namePriorToFirstMarriage.id		0..1	string	Unique id for inter-element referencing
Patient.Slices for name.name:namePriorToFirstMarriage.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Patient.Slices for name.name:namePriorToFirstMarriage.use	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: maiden (no extensions allowed)
Patient.Slices for name.name:namePriorToFirstMarriage.text	Σ This element is included in summaries.	0..1	string	Text representation of the full name
Patient.Slices for name.name:namePriorToFirstMarriage.family	S This element must be supported. Σ This element is included in summaries. C	0..1	string	Family name (often called 'Surname')
Patient.Slices for name.name:namePriorToFirstMarriage.given	S This element must be supported. Σ This element is included in summaries. 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
Patient.Slices for name.name:namePriorToFirstMarriage.prefix	Σ This element is included in summaries.	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
Patient.Slices for name.name:namePriorToFirstMarriage.suffix	Σ This element is included in summaries.	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
Patient.Slices for name.name:namePriorToFirstMarriage.period	Σ This element is included in summaries.	0..1	Period	Time period when name was/is in use
Patient.telecom	Σ This element is included in summaries.	0..*	ContactPoint	A contact detail for the individual
Patient.telecom.id		0..1	string	Unique id for inter-element referencing
Patient.telecom.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Patient.telecom.system	S This element must be supported. Σ This element is included in summaries. C	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
Patient.telecom.value	S This element must be supported. Σ This element is included in summaries.	1..1	string	The actual contact point details
Patient.telecom.use	?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries.	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
Patient.telecom.rank	Σ This element is included in summaries.	0..1	positiveInt	Specify preferred order of use (1 = highest)
Patient.telecom.period	Σ This element is included in summaries.	0..1	Period	Time period when the contact point was/is in use
Patient.gender	S This element must be supported. Σ This element is included in summaries.	1..1	code	male | female | other | unknown Binding: AdministrativeGender (required)
Patient.birthDate	S This element must be supported. Σ This element is included in summaries.	0..1	date	The date of birth for the individual
Patient.birthDate.id		0..1	string	xml:id (or equivalent in JSON)
Patient.birthDate.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.birthDate.Slices for extension.extension:partialDateTime		0..1	(Complex)	partialDateTIme URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-partial-date-time-vr
Patient.birthDate.Slices for extension.extension:birthTime		0..1	dateTime	Time of day of birth URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
Patient.birthDate.Slices for extension.extension:bypassEditFlag		0..1	(Complex)	BypassEditFlag Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag
Patient.birthDate.Slices for extension.extension:bypassEditFlag.id		0..1	string	Unique id for inter-element referencing
Patient.birthDate.Slices for extension.extension:bypassEditFlag.extension		0..0		Extension Slice: Unordered, Open by value:url
Patient.birthDate.Slices for extension.extension:bypassEditFlag.url		1..1	uri	"http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag"
Patient.birthDate.Slices for extension.extension:bypassEditFlag.value[x]		1..1	CodeableConcept	To reflect the relevant edit possibilities for date of birth. Binding: Value Set - Date of Birth Edit Flags (NCHS) Vital Records (required): Date of Birth Edit Flags (NCHS)
Patient.birthDate.value		0..1	date	Primitive value for date
Patient.Slices for deceased[x]	?! This element is a modifier element. Σ This element is included in summaries.	0..1		Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view
Patient.Slices for deceased[x].deceasedBoolean			boolean
Patient.Slices for deceased[x].deceasedDateTime			dateTime
Patient.Slices for deceased[x].deceased[x]:deceasedBoolean	?! This element is a modifier element. Σ This element is included in summaries. C	0..1	boolean	Boolean indicator. True if the individual is deceased. Constraints: fetalDeathOnlyIfDeceased
Patient.Slices for deceased[x].deceased[x]:deceasedBoolean.id		0..1	string	xml:id (or equivalent in JSON)
Patient.Slices for deceased[x].deceased[x]:deceasedBoolean.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for deceased[x].deceased[x]:deceasedBoolean.Slices for extension				Content/Rules for all slices
Patient.Slices for deceased[x].deceased[x]:deceasedBoolean.Slices for extension.extension:fetalDeath		0..1	boolean	Boolean indicator. True if the Patient died as a fetus. URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-patient-fetal-death-vr
Patient.Slices for deceased[x].deceased[x]:deceasedBoolean.value		0..1	boolean	Primitive value for boolean
Patient.address	S This element must be supported. Σ This element is included in summaries.	0..*	Address	An address for the individual
Patient.address.id		0..1	string	Unique id for inter-element referencing
Patient.address.Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Patient.address.Slices for extension.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: Value Set - Yes No Unknown Vital Records (required): Yes No Unknown (YNU)
Patient.address.Slices for extension.extension:predir		0..1	string	PreDirectional Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PreDirectional
Patient.address.Slices for extension.extension:stnum		0..1	string	StreetNumber Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetNumber
Patient.address.Slices for extension.extension:stname		0..1	string	StreetName Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetName
Patient.address.Slices for extension.extension:stdesig		0..1	string	StreetDesignator Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetDesignator
Patient.address.Slices for extension.extension:postdir		0..1	string	PostDirectional Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PostDirectional
Patient.address.Slices for extension.extension:unitnumber		0..1	string	UnitOrAptNumber Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/UnitOrAptNumber
Patient.address.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
Patient.address.type	Σ This element is included in summaries.	0..1	code	postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
Patient.address.text	Σ This element is included in summaries.	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
Patient.address.line	S This element must be supported. Σ This element is included in summaries.	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
Patient.address.city	S This element must be supported. Σ This element is included in summaries.	0..1	string	Name of city, town etc. Example General: Erewhon
Patient.address.city.id		0..1	string	xml:id (or equivalent in JSON)
Patient.address.city.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.address.city.Slices for extension.extension:cityCode		0..1	positiveInt	City Code URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode
Patient.address.city.value		0..1	string	Primitive value for string Max Length:1048576
Patient.address.district	Σ This element is included in summaries.	0..1	string	District name (aka county) Example General: Madison
Patient.address.district.id		0..1	string	xml:id (or equivalent in JSON)
Patient.address.district.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.address.district.Slices for extension.extension:districtCode		0..1	positiveInt	County code URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/DistrictCode
Patient.address.district.value		0..1	string	Primitive value for string Max Length:1048576
Patient.address.state	S This element must be supported. Σ This element is included in summaries.	0..1	string	Sub-unit of country (abbreviations ok) Binding: Value Set - States, Territories and Provinces Vital Records (required)
Patient.address.postalCode	S This element must be supported. Σ This element is included in summaries.	0..1	string	US Zip Codes Example General: 9132
Patient.address.country	Σ This element is included in summaries.	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code) Binding: Value Set - Residence Country Vital Records (required)
Patient.address.period	S This element must be supported. Σ This element is included in summaries.	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
Patient.maritalStatus		0..1	CodeableConcept	Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
Patient.multipleBirth[x]		0..1		If not single birth - born first, second, third, etc.
Patient.multipleBirth[x].multipleBirth[x]All Types				Content/Rules for all Types
Patient.multipleBirth[x].multipleBirth[x]All Types.id		0..1	string	Unique id for inter-element referencing
Patient.multipleBirth[x].multipleBirth[x]All Types.Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Patient.multipleBirth[x].multipleBirth[x]All Types.Slices for extension.extension:bypassEditFlag		0..1	(Complex)	BypassEditFlag Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag
Patient.multipleBirth[x].multipleBirth[x]All Types.Slices for extension.extension:bypassEditFlag.id		0..1	string	Unique id for inter-element referencing
Patient.multipleBirth[x].multipleBirth[x]All Types.Slices for extension.extension:bypassEditFlag.extension		0..0		Extension Slice: Unordered, Open by value:url
Patient.multipleBirth[x].multipleBirth[x]All Types.Slices for extension.extension:bypassEditFlag.url		1..1	uri	"http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag"
Patient.multipleBirth[x].multipleBirth[x]All Types.Slices for extension.extension:bypassEditFlag.value[x]		1..1	CodeableConcept	Value of extension Binding: Value Set - Plurality Edit Flags (NCHS) Vital Records (required): Plurality Edit Flags (NCHS)
Patient.multipleBirth[x].multipleBirth[x]All Types.Slices for extension.extension:multipleBirthTotal		0..1	positiveInt	Total births in this pregnancy URL: http://hl7.org/fhir/StructureDefinition/patient-multipleBirthTotal
Patient.multipleBirth[x].multipleBirthBoolean			boolean
Patient.multipleBirth[x].multipleBirthInteger			integer
Patient.photo		0..*	Attachment	Image of the patient
Patient.contact	C	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1
Patient.contact.id		0..1	string	Unique id for inter-element referencing
Patient.contact.extension		0..*	Extension	Additional content defined by implementations
Patient.contact.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Patient.contact.relationship		0..*	CodeableConcept	The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
Patient.contact.name		0..1	HumanName	A name associated with the contact person
Patient.contact.telecom		0..*	ContactPoint	A contact detail for the person
Patient.contact.address		0..1	Address	Address for the contact person
Patient.contact.gender		0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.contact.organization	C	0..1	Reference(Organization)	Organization that is associated with the contact
Patient.contact.period		0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient
Patient.communication		0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health
Patient.communication.id		0..1	string	Unique id for inter-element referencing
Patient.communication.extension		0..*	Extension	Additional content defined by implementations
Patient.communication.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Patient.communication.language	S This element must be supported.	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)
Patient.communication.preferred		0..1	boolean	Language preference indicator
Patient.generalPractitioner		0..*	Reference(Organization | Practitioner | PractitionerRole)	Patient's nominated primary care provider
Patient.managingOrganization	Σ This element is included in summaries.	0..1	Reference(Organization)	Organization that is the custodian of the patient record
Patient.link	?! This element is a modifier element. Σ This element is included in summaries.	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
Patient.link.id		0..1	string	Unique id for inter-element referencing
Patient.link.extension		0..*	Extension	Additional content defined by implementations
Patient.link.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Patient.link.other	Σ This element is included in summaries.	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
Patient.link.type	Σ This element is included in summaries.	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	Status	Usage	ValueSet	Version	Source
Patient.language	Base	preferred	Common Languages	📦4.0.1	FHIR Std.
Patient.extension:birthPlace.​value[x].use	Base	required	AddressUse	📍4.0.1	FHIR Std.
Patient.extension:birthPlace.​value[x].type	Base	required	AddressType	📍4.0.1	FHIR Std.
Patient.extension:birthPlace.​value[x].state	Base	required	Value Set - States, Territories and Provinces Vital Records	📦2.0.0	This IG
Patient.extension:birthPlace.​value[x].country	Base	required	Value Set - Birthplace Country Vital Records	📦2.0.0	This IG
Patient.identifier.use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Patient.identifier.type	Base	extensible	IdentifierType	📦4.0.1	FHIR Std.
Patient.identifier:MRN.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Patient.identifier:MRN.​type	Base	extensible	IdentifierType	📦4.0.1	FHIR Std.
Patient.identifier:SSN.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Patient.identifier:SSN.​type	Base	extensible	IdentifierType	📦4.0.1	FHIR Std.
Patient.name.use	Base	required	NameUse	📍4.0.1	FHIR Std.
Patient.name:currentLegalName.​use	Base	required	NameUse	📍4.0.1	FHIR Std.
Patient.name:namePriorToFirstMarriage.​use	Base	required	NameUse	📍4.0.1	FHIR Std.
Patient.telecom.system	Base	required	ContactPointSystem	📦4.0.1	FHIR Std.
Patient.telecom.use	Base	required	ContactPointUse	📦4.0.1	FHIR Std.
Patient.gender	Base	required	AdministrativeGender	📦4.0.1	FHIR Std.
Patient.birthDate.extension:bypassEditFlag.​value[x]	Base	required	Value Set - Date of Birth Edit Flags (NCHS) Vital Records	📦2.0.0	This IG
Patient.address.use	Base	required	AddressUse	📍4.0.1	FHIR Std.
Patient.address.type	Base	required	AddressType	📍4.0.1	FHIR Std.
Patient.address.state	Base	required	Value Set - States, Territories and Provinces Vital Records	📦2.0.0	This IG
Patient.address.country	Base	required	Value Set - Residence Country Vital Records	📦2.0.0	This IG
Patient.maritalStatus	Base	extensible	MaritalStatus	📦4.0.1	FHIR Std.
Patient.multipleBirth[x].​extension:bypassEditFlag.​value[x]	Base	required	Value Set - Plurality Edit Flags (NCHS) Vital Records	📦2.0.0	This IG
Patient.contact.relationship	Base	extensible	Patient Contact Relationship	📦4.0.1	FHIR Std.
Patient.contact.gender	Base	required	AdministrativeGender	📍4.0.1	FHIR Std.
Patient.communication.​language	Base	extensible	Language codes with language and optionally a region modifier	📦5.0.1	US Core v5.0
Patient.link.type	Base	required	LinkType	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
fetalDeathOnlyIfDeceased	error	Patient.deceased[x]:deceasedBoolean	Fetal death should only be indicated if Patient is deceased.	(extension.where(url = 'http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-patient-fetal-death-vr').exists(value.exists() and value = 'true')) implies (value.exists() and value = 'true')

This structure is derived from USCorePatientProfile

Summary

Mandatory: 0 element(4 nested mandatory elements)
Fixed: 2 elements

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/StructureDefinition/patient-birthPlace
• http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode
• http://hl7.org/fhir/us/vr-common-library/StructureDefinition/DistrictCode
• http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-jurisdiction-id-vr
• http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-reported-parent-age-at-delivery-vr
• http://hl7.org/fhir/StructureDefinition/data-absent-reason
• http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-partial-date-time-vr
• http://hl7.org/fhir/StructureDefinition/patient-birthTime
• http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag
• http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-patient-fetal-death-vr
• http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-within-city-limits-indicator-vr
• http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PreDirectional
• http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetNumber
• http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetName
• http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetDesignator
• http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PostDirectional
• http://hl7.org/fhir/us/vr-common-library/StructureDefinition/UnitOrAptNumber
• http://hl7.org/fhir/StructureDefinition/patient-multipleBirthTotal

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Patient.identifier
• The element 1 is sliced based on the value of Patient.name
• The element 1 is sliced based on the value of Patient.deceased[x]

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient	C	0..*	USCorePatientProfile	This is an abstract profile. Child profiles: PatientChildVitalRecords, PatientMotherVitalRecords Information about an individual or animal receiving health care services Constraints: us-core-6
Patient.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Patient.Slices for extension				Content/Rules for all slices
Patient.Slices for extension.extension:race		0..1	(Complex)	US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
Patient.Slices for extension.extension:ethnicity		0..1	(Complex)	US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
Patient.Slices for extension.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
Patient.Slices for extension.extension:genderIdentity		0..1	CodeableConcept	Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity Binding: Gender Identity (extensible)
Patient.Slices for extension.extension:birthPlace		0..1	(Complex)	Place of Birth for the patient should include the state and/or country URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
Patient.Slices for extension.extension:birthPlace.extension		0..0		Extension Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:birthPlace.url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
Patient.Slices for extension.extension:birthPlace.value[x]		1..1	Address	Value of extension
Patient.Slices for extension.extension:birthPlace.value[x].use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
Patient.Slices for extension.extension:birthPlace.value[x].state	Σ This element is included in summaries.	0..1	string	State/Jurisdiction of birth. Provide only for US or Canadian states/provinces/territories. Use value in Jurisdiction if present. Binding: Value Set - States, Territories and Provinces Vital Records (required)
Patient.Slices for extension.extension:birthPlace.value[x].state.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for extension.extension:birthPlace.value[x].state.Slices for extension				Content/Rules for all slices
Patient.Slices for extension.extension:birthPlace.value[x].state.Slices for extension.extension:nationalReportingJurisdictionId		0..1	string	Location Jurisdiction Id Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-jurisdiction-id-vr Binding: Value Set - Jurisdictions Vital Records (required)
Patient.Slices for extension.extension:birthPlace.value[x].country	Σ This element is included in summaries.	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code) Binding: Value Set - Birthplace Country Vital Records (required)
Patient.Slices for extension.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
Patient.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Patient.Slices for identifier	S This element must be supported. Σ This element is included in summaries.	1..*	Identifier	An identifier for this patient Slice: Unordered, Open by pattern:type Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for identifier.identifier:All Slices				Content/Rules for all slices
Patient.Slices for identifier.identifier:All Slices.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:All Slices.system	S This element must be supported. Σ This element is included in summaries.	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
Patient.Slices for identifier.identifier:All Slices.value	S This element must be supported. Σ This element is included in summaries.	1..1	string	The value that is unique within the system. Example General: 123456
Patient.Slices for identifier.identifier:MRN	S This element must be supported. Σ This element is included in summaries.	0..*	Identifier	Medical Record Number
Patient.Slices for identifier.identifier:MRN.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:MRN.type	Σ This element is included in summaries.	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: { "coding" : [ { "system" : "http://terminology.hl7.org/CodeSystem/v2-0203", "code" : "MR" } ] }
Patient.Slices for identifier.identifier:MRN.system	S This element must be supported. Σ This element is included in summaries.	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
Patient.Slices for identifier.identifier:MRN.value	S This element must be supported. Σ This element is included in summaries.	1..1	string	The value that is unique within the system. Example General: 123456
Patient.Slices for identifier.identifier:SSN	S This element must be supported. Σ This element is included in summaries.	0..1	Identifier	SSN if available and appropriate to send
Patient.Slices for identifier.identifier:SSN.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:SSN.type	Σ This element is included in summaries.	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: { "coding" : [ { "system" : "http://terminology.hl7.org/CodeSystem/v2-0203", "code" : "SS" } ] }
Patient.Slices for identifier.identifier:SSN.system	S This element must be supported. Σ This element is included in summaries.	1..1	uri	The namespace for the identifier value Required Pattern: http://hl7.org/fhir/sid/us-ssn (extensions allowed)
Patient.Slices for identifier.identifier:SSN.value	S This element must be supported. Σ This element is included in summaries.	1..1	string	The value that is unique within the system. Example General: 123456
Patient.active	?! This element is a modifier element. Σ This element is included in summaries.	0..1	boolean	Whether this patient's record is in active use
Patient.Slices for name	S This element must be supported. Σ This element is included in summaries.	1..*	HumanName	A name associated with the patient Slice: Unordered, Open by value:use Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for name.name:All Slices				Content/Rules for all slices
Patient.Slices for name.name:All Slices.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
Patient.Slices for name.name:All Slices.family	S This element must be supported. Σ This element is included in summaries. C	0..1	string	Family name (often called 'Surname')
Patient.Slices for name.name:All Slices.family.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for name.name:All Slices.family.Slices for extension.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)
Patient.Slices for name.name:All Slices.given	S This element must be supported. Σ This element is included in summaries. 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
Patient.Slices for name.name:All Slices.given.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for name.name:All Slices.given.Slices for extension.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)
Patient.Slices for name.name:currentLegalName	S This element must be supported. Σ This element is included in summaries.	0..1	HumanName	current legal name
Patient.Slices for name.name:currentLegalName.use	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: official (no extensions allowed)
Patient.Slices for name.name:currentLegalName.family	S This element must be supported. Σ This element is included in summaries. C	0..1	string	Family name (often called 'Surname')
Patient.Slices for name.name:currentLegalName.given	S This element must be supported. Σ This element is included in summaries. 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
Patient.Slices for name.name:namePriorToFirstMarriage	S This element must be supported. Σ This element is included in summaries.	0..1	HumanName	Name prior to first marriage
Patient.Slices for name.name:namePriorToFirstMarriage.use	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: maiden (no extensions allowed)
Patient.Slices for name.name:namePriorToFirstMarriage.family	S This element must be supported. Σ This element is included in summaries. C	0..1	string	Family name (often called 'Surname')
Patient.Slices for name.name:namePriorToFirstMarriage.given	S This element must be supported. Σ This element is included in summaries. 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
Patient.telecom	Σ This element is included in summaries.	0..*	ContactPoint	A contact detail for the individual
Patient.telecom.system	S This element must be supported. Σ This element is included in summaries. C	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
Patient.telecom.value	S This element must be supported. Σ This element is included in summaries.	1..1	string	The actual contact point details
Patient.telecom.use	?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries.	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
Patient.gender	S This element must be supported. Σ This element is included in summaries.	1..1	code	male | female | other | unknown Binding: AdministrativeGender (required)
Patient.birthDate	S This element must be supported. Σ This element is included in summaries.	0..1	date	The date of birth for the individual
Patient.birthDate.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.birthDate.Slices for extension.extension:partialDateTime		0..1	(Complex)	partialDateTIme URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-partial-date-time-vr
Patient.birthDate.Slices for extension.extension:birthTime		0..1	dateTime	Time of day of birth URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
Patient.birthDate.Slices for extension.extension:bypassEditFlag		0..1	(Complex)	BypassEditFlag Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag
Patient.birthDate.Slices for extension.extension:bypassEditFlag.extension		0..0		Extension Slice: Unordered, Open by value:url
Patient.birthDate.Slices for extension.extension:bypassEditFlag.url		1..1	uri	"http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag"
Patient.birthDate.Slices for extension.extension:bypassEditFlag.value[x]		1..1	CodeableConcept	To reflect the relevant edit possibilities for date of birth. Binding: Value Set - Date of Birth Edit Flags (NCHS) Vital Records (required): Date of Birth Edit Flags (NCHS)
Patient.Slices for deceased[x]	?! This element is a modifier element. Σ This element is included in summaries.	0..1		Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view
Patient.Slices for deceased[x].deceasedBoolean			boolean
Patient.Slices for deceased[x].deceasedDateTime			dateTime
Patient.Slices for deceased[x].deceased[x]:deceasedBoolean	?! This element is a modifier element. Σ This element is included in summaries. C	0..1	boolean	Boolean indicator. True if the individual is deceased. Constraints: fetalDeathOnlyIfDeceased
Patient.Slices for deceased[x].deceased[x]:deceasedBoolean.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for deceased[x].deceased[x]:deceasedBoolean.Slices for extension				Content/Rules for all slices
Patient.Slices for deceased[x].deceased[x]:deceasedBoolean.Slices for extension.extension:fetalDeath		0..1	boolean	Boolean indicator. True if the Patient died as a fetus. URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-patient-fetal-death-vr
Patient.address	S This element must be supported. Σ This element is included in summaries.	0..*	Address	An address for the individual
Patient.address.Slices for extension				Content/Rules for all slices
Patient.address.Slices for extension.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: Value Set - Yes No Unknown Vital Records (required): Yes No Unknown (YNU)
Patient.address.Slices for extension.extension:predir		0..1	string	PreDirectional Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PreDirectional
Patient.address.Slices for extension.extension:stnum		0..1	string	StreetNumber Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetNumber
Patient.address.Slices for extension.extension:stname		0..1	string	StreetName Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetName
Patient.address.Slices for extension.extension:stdesig		0..1	string	StreetDesignator Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetDesignator
Patient.address.Slices for extension.extension:postdir		0..1	string	PostDirectional Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PostDirectional
Patient.address.Slices for extension.extension:unitnumber		0..1	string	UnitOrAptNumber Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/UnitOrAptNumber
Patient.address.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
Patient.address.line	S This element must be supported. Σ This element is included in summaries.	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
Patient.address.city	S This element must be supported. Σ This element is included in summaries.	0..1	string	Name of city, town etc. Example General: Erewhon
Patient.address.city.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.address.city.Slices for extension.extension:cityCode		0..1	positiveInt	City Code URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode
Patient.address.state	S This element must be supported. Σ This element is included in summaries.	0..1	string	Sub-unit of country (abbreviations ok) Binding: Value Set - States, Territories and Provinces Vital Records (required)
Patient.address.postalCode	S This element must be supported. Σ This element is included in summaries.	0..1	string	US Zip Codes Example General: 9132
Patient.address.country	Σ This element is included in summaries.	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code) Binding: Value Set - Residence Country Vital Records (required)
Patient.address.period	S This element must be supported. Σ This element is included in summaries.	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
Patient.multipleBirth[x]		0..1		If not single birth - born first, second, third, etc.
Patient.multipleBirth[x].multipleBirth[x]All Types				Content/Rules for all Types
Patient.multipleBirth[x].multipleBirth[x]All Types.Slices for extension				Content/Rules for all slices
Patient.multipleBirth[x].multipleBirth[x]All Types.Slices for extension.extension:bypassEditFlag		0..1	(Complex)	BypassEditFlag Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag
Patient.multipleBirth[x].multipleBirth[x]All Types.Slices for extension.extension:bypassEditFlag.extension		0..0		Extension Slice: Unordered, Open by value:url
Patient.multipleBirth[x].multipleBirth[x]All Types.Slices for extension.extension:bypassEditFlag.url		1..1	uri	"http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag"
Patient.multipleBirth[x].multipleBirth[x]All Types.Slices for extension.extension:bypassEditFlag.value[x]		1..1	CodeableConcept	Value of extension Binding: Value Set - Plurality Edit Flags (NCHS) Vital Records (required): Plurality Edit Flags (NCHS)
Patient.multipleBirth[x].multipleBirth[x]All Types.Slices for extension.extension:multipleBirthTotal		0..1	positiveInt	Total births in this pregnancy URL: http://hl7.org/fhir/StructureDefinition/patient-multipleBirthTotal
Patient.multipleBirth[x].multipleBirthBoolean			boolean
Patient.multipleBirth[x].multipleBirthInteger			integer
Patient.communication		0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health
Patient.communication.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Patient.communication.language	S This element must be supported.	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)
Patient.link	?! This element is a modifier element. Σ This element is included in summaries.	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
Patient.link.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Patient.link.other	Σ This element is included in summaries.	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
Patient.link.type	Σ This element is included in summaries.	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	Status	Usage	ValueSet	Version	Source
Patient.extension:birthPlace.​value[x].use	Base	required	AddressUse	📍4.0.1	FHIR Std.
Patient.extension:birthPlace.​value[x].state	Base	required	Value Set - States, Territories and Provinces Vital Records	📦2.0.0	This IG
Patient.extension:birthPlace.​value[x].country	Base	required	Value Set - Birthplace Country Vital Records	📦2.0.0	This IG
Patient.identifier.use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Patient.identifier:MRN.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Patient.identifier:MRN.​type	Base	extensible	IdentifierType	📦4.0.1	FHIR Std.
Patient.identifier:SSN.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Patient.identifier:SSN.​type	Base	extensible	IdentifierType	📦4.0.1	FHIR Std.
Patient.name.use	Base	required	NameUse	📍4.0.1	FHIR Std.
Patient.name:currentLegalName.​use	Base	required	NameUse	📍4.0.1	FHIR Std.
Patient.name:namePriorToFirstMarriage.​use	Base	required	NameUse	📍4.0.1	FHIR Std.
Patient.telecom.system	Base	required	ContactPointSystem	📦4.0.1	FHIR Std.
Patient.telecom.use	Base	required	ContactPointUse	📦4.0.1	FHIR Std.
Patient.gender	Base	required	AdministrativeGender	📦4.0.1	FHIR Std.
Patient.birthDate.extension:bypassEditFlag.​value[x]	Base	required	Value Set - Date of Birth Edit Flags (NCHS) Vital Records	📦2.0.0	This IG
Patient.address.use	Base	required	AddressUse	📍4.0.1	FHIR Std.
Patient.address.state	Base	required	Value Set - States, Territories and Provinces Vital Records	📦2.0.0	This IG
Patient.address.country	Base	required	Value Set - Residence Country Vital Records	📦2.0.0	This IG
Patient.multipleBirth[x].​extension:bypassEditFlag.​value[x]	Base	required	Value Set - Plurality Edit Flags (NCHS) Vital Records	📦2.0.0	This IG
Patient.communication.​language	Base	extensible	Language codes with language and optionally a region modifier	📦5.0.1	US Core v5.0
Patient.link.type	Base	required	LinkType	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
fetalDeathOnlyIfDeceased	error	Patient.deceased[x]:deceasedBoolean	Fetal death should only be indicated if Patient is deceased.	(extension.where(url = 'http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-patient-fetal-death-vr').exists(value.exists() and value = 'true')) implies (value.exists() and value = 'true')

Differential View

This structure is derived from USCorePatientProfile

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient		0..*	USCorePatientProfile	This is an abstract profile. Child profiles: PatientChildVitalRecords, PatientMotherVitalRecords Information about an individual or animal receiving health care services
Patient.Slices for extension				Content/Rules for all slices
Patient.Slices for extension.extension:birthPlace		0..1	(Complex)	Place of Birth for the patient should include the state and/or country URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
Patient.Slices for extension.extension:birthPlace.value[x]
Patient.Slices for extension.extension:birthPlace.value[x].city
Patient.Slices for extension.extension:birthPlace.value[x].city.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for extension.extension:birthPlace.value[x].city.Slices for extension				Content/Rules for all slices
Patient.Slices for extension.extension:birthPlace.value[x].city.Slices for extension.extension:cityCode		0..1	positiveInt	City Code Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode
Patient.Slices for extension.extension:birthPlace.value[x].district
Patient.Slices for extension.extension:birthPlace.value[x].district.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for extension.extension:birthPlace.value[x].district.Slices for extension				Content/Rules for all slices
Patient.Slices for extension.extension:birthPlace.value[x].district.Slices for extension.extension:districtCode		0..1	positiveInt	County code URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/DistrictCode
Patient.Slices for extension.extension:birthPlace.value[x].state		0..1	string	State/Jurisdiction of birth. Provide only for US or Canadian states/provinces/territories. Use value in Jurisdiction if present. Binding: Value Set - States, Territories and Provinces Vital Records (required)
Patient.Slices for extension.extension:birthPlace.value[x].state.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for extension.extension:birthPlace.value[x].state.Slices for extension				Content/Rules for all slices
Patient.Slices for extension.extension:birthPlace.value[x].state.Slices for extension.extension:nationalReportingJurisdictionId		0..1	string	Location Jurisdiction Id Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-jurisdiction-id-vr Binding: Value Set - Jurisdictions Vital Records (required)
Patient.Slices for extension.extension:birthPlace.value[x].country		0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code) Binding: Value Set - Birthplace Country Vital Records (required)
Patient.Slices for extension.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
Patient.Slices for identifier		1..*	Identifier	An identifier for this patient Slice: Unordered, Open by pattern:type Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for identifier.identifier:MRN		0..*	Identifier	Medical Record Number
Patient.Slices for identifier.identifier:MRN.type		1..1	CodeableConcept	Description of identifier Required Pattern: { "coding" : [ { "system" : "http://terminology.hl7.org/CodeSystem/v2-0203", "code" : "MR" } ] }
Patient.Slices for identifier.identifier:SSN		0..1	Identifier	SSN if available and appropriate to send
Patient.Slices for identifier.identifier:SSN.type		1..1	CodeableConcept	Description of identifier Required Pattern: { "coding" : [ { "system" : "http://terminology.hl7.org/CodeSystem/v2-0203", "code" : "SS" } ] }
Patient.Slices for identifier.identifier:SSN.system		1..1	uri	The namespace for the identifier value Required Pattern: http://hl7.org/fhir/sid/us-ssn (extensions allowed)
Patient.Slices for name		1..*	HumanName	A name associated with the patient Slice: Unordered, Open by value:use Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for name.name:All Slices				Content/Rules for all slices
Patient.Slices for name.name:All Slices.family
Patient.Slices for name.name:All Slices.family.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for name.name:All Slices.family.Slices for extension.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)
Patient.Slices for name.name:All Slices.given
Patient.Slices for name.name:All Slices.given.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for name.name:All Slices.given.Slices for extension.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)
Patient.Slices for name.name:currentLegalName		0..1	HumanName	current legal name
Patient.Slices for name.name:currentLegalName.use		1..1	code	usual | official | temp | nickname | anonymous | old | maiden Fixed Value: official (no extensions allowed)
Patient.Slices for name.name:namePriorToFirstMarriage		0..1	HumanName	Name prior to first marriage
Patient.Slices for name.name:namePriorToFirstMarriage.use		1..1	code	usual | official | temp | nickname | anonymous | old | maiden Fixed Value: maiden (no extensions allowed)
Patient.birthDate
Patient.birthDate.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.birthDate.Slices for extension.extension:partialDateTime		0..1	(Complex)	partialDateTIme URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-partial-date-time-vr
Patient.birthDate.Slices for extension.extension:birthTime		0..1	dateTime	Time of day of birth URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
Patient.birthDate.Slices for extension.extension:bypassEditFlag		0..1	(Complex)	BypassEditFlag Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag
Patient.birthDate.Slices for extension.extension:bypassEditFlag.value[x]		1..1	CodeableConcept	To reflect the relevant edit possibilities for date of birth. Binding: Value Set - Date of Birth Edit Flags (NCHS) Vital Records (required): Date of Birth Edit Flags (NCHS)
Patient.Slices for deceased[x]		0..1	boolean, dateTime	Indicates if the individual is deceased or not Slice: Unordered, Open by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view
Patient.Slices for deceased[x].deceased[x]:deceasedBoolean	C	0..1	boolean	Boolean indicator. True if the individual is deceased. Constraints: fetalDeathOnlyIfDeceased
Patient.Slices for deceased[x].deceased[x]:deceasedBoolean.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for deceased[x].deceased[x]:deceasedBoolean.Slices for extension				Content/Rules for all slices
Patient.Slices for deceased[x].deceased[x]:deceasedBoolean.Slices for extension.extension:fetalDeath		0..1	boolean	Boolean indicator. True if the Patient died as a fetus. URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-patient-fetal-death-vr
Patient.address
Patient.address.Slices for extension				Content/Rules for all slices
Patient.address.Slices for extension.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: Value Set - Yes No Unknown Vital Records (required): Yes No Unknown (YNU)
Patient.address.Slices for extension.extension:predir		0..1	string	PreDirectional Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PreDirectional
Patient.address.Slices for extension.extension:stnum		0..1	string	StreetNumber Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetNumber
Patient.address.Slices for extension.extension:stname		0..1	string	StreetName Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetName
Patient.address.Slices for extension.extension:stdesig		0..1	string	StreetDesignator Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetDesignator
Patient.address.Slices for extension.extension:postdir		0..1	string	PostDirectional Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PostDirectional
Patient.address.Slices for extension.extension:unitnumber		0..1	string	UnitOrAptNumber Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/UnitOrAptNumber
Patient.address.city
Patient.address.city.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.address.city.Slices for extension.extension:cityCode		0..1	positiveInt	City Code URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode
Patient.address.district
Patient.address.district.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.address.district.Slices for extension.extension:districtCode		0..1	positiveInt	County code URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/DistrictCode
Patient.address.state		0..1	string	Sub-unit of country (abbreviations ok) Binding: Value Set - States, Territories and Provinces Vital Records (required)
Patient.address.country		0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code) Binding: Value Set - Residence Country Vital Records (required)
Patient.multipleBirth[x]		0..1	boolean, integer	If not single birth - born first, second, third, etc.
Patient.multipleBirth[x].Slices for extension				Content/Rules for all slices
Patient.multipleBirth[x].Slices for extension.extension:bypassEditFlag		0..1	(Complex)	BypassEditFlag Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag
Patient.multipleBirth[x].Slices for extension.extension:bypassEditFlag.value[x]		1..1	CodeableConcept	Value of extension Binding: Value Set - Plurality Edit Flags (NCHS) Vital Records (required): Plurality Edit Flags (NCHS)
Patient.multipleBirth[x].Slices for extension.extension:multipleBirthTotal		0..1	positiveInt	Total births in this pregnancy URL: http://hl7.org/fhir/StructureDefinition/patient-multipleBirthTotal
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
Patient.extension:birthPlace.​value[x].state	Base	required	Value Set - States, Territories and Provinces Vital Records	📦2.0.0	This IG
Patient.extension:birthPlace.​value[x].country	Base	required	Value Set - Birthplace Country Vital Records	📦2.0.0	This IG
Patient.birthDate.extension:bypassEditFlag.​value[x]	Base	required	Value Set - Date of Birth Edit Flags (NCHS) Vital Records	📦2.0.0	This IG
Patient.address.state	Base	required	Value Set - States, Territories and Provinces Vital Records	📦2.0.0	This IG
Patient.address.country	Base	required	Value Set - Residence Country Vital Records	📦2.0.0	This IG
Patient.multipleBirth[x].​extension:bypassEditFlag.​value[x]	Base	required	Value Set - Plurality Edit Flags (NCHS) Vital Records	📦2.0.0	This IG

Constraints

Id	Grade	Path(s)	Description	Expression
fetalDeathOnlyIfDeceased	error	Patient.deceased[x]:deceasedBoolean	Fetal death should only be indicated if Patient is deceased.	(extension.where(url = 'http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-patient-fetal-death-vr').exists(value.exists() and value = 'true')) implies (value.exists() and value = 'true')

Snapshot ViewView

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient	C	0..*	USCorePatientProfile	This is an abstract profile. Child profiles: PatientChildVitalRecords, PatientMotherVitalRecords Information about an individual or animal receiving health care services Constraints: us-core-6
Patient.id	Σ This element is included in summaries.	0..1	id	Logical id of this artifact
Patient.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
Patient.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
Patient.language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
Patient.text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Patient.contained		0..*	Resource	Contained, inline Resources
Patient.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:race		0..1	(Complex)	US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
Patient.Slices for extension.extension:ethnicity		0..1	(Complex)	US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
Patient.Slices for extension.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
Patient.Slices for extension.extension:genderIdentity		0..1	CodeableConcept	Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity Binding: Gender Identity (extensible)
Patient.Slices for extension.extension:birthPlace		0..1	(Complex)	Place of Birth for the patient should include the state and/or country URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
Patient.Slices for extension.extension:birthPlace.id		0..1	string	Unique id for inter-element referencing
Patient.Slices for extension.extension:birthPlace.extension		0..0		Extension Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:birthPlace.url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
Patient.Slices for extension.extension:birthPlace.value[x]		1..1	Address	Value of extension
Patient.Slices for extension.extension:birthPlace.value[x].id		0..1	string	Unique id for inter-element referencing
Patient.Slices for extension.extension:birthPlace.value[x].extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:birthPlace.value[x].use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
Patient.Slices for extension.extension:birthPlace.value[x].type	Σ This element is included in summaries.	0..1	code	postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
Patient.Slices for extension.extension:birthPlace.value[x].text	Σ This element is included in summaries.	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
Patient.Slices for extension.extension:birthPlace.value[x].line	Σ This element is included in summaries.	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
Patient.Slices for extension.extension:birthPlace.value[x].city	Σ This element is included in summaries.	0..1	string	Name of city, town etc. Example General: Erewhon
Patient.Slices for extension.extension:birthPlace.value[x].city.id		0..1	string	xml:id (or equivalent in JSON)
Patient.Slices for extension.extension:birthPlace.value[x].city.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for extension.extension:birthPlace.value[x].city.Slices for extension				Content/Rules for all slices
Patient.Slices for extension.extension:birthPlace.value[x].city.Slices for extension.extension:cityCode		0..1	positiveInt	City Code Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode
Patient.Slices for extension.extension:birthPlace.value[x].city.value		0..1	string	Primitive value for string Max Length:1048576
Patient.Slices for extension.extension:birthPlace.value[x].district	Σ This element is included in summaries.	0..1	string	District name (aka county) Example General: Madison
Patient.Slices for extension.extension:birthPlace.value[x].district.id		0..1	string	xml:id (or equivalent in JSON)
Patient.Slices for extension.extension:birthPlace.value[x].district.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for extension.extension:birthPlace.value[x].district.Slices for extension				Content/Rules for all slices
Patient.Slices for extension.extension:birthPlace.value[x].district.Slices for extension.extension:districtCode		0..1	positiveInt	County code URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/DistrictCode
Patient.Slices for extension.extension:birthPlace.value[x].district.value		0..1	string	Primitive value for string Max Length:1048576
Patient.Slices for extension.extension:birthPlace.value[x].state	Σ This element is included in summaries.	0..1	string	State/Jurisdiction of birth. Provide only for US or Canadian states/provinces/territories. Use value in Jurisdiction if present. Binding: Value Set - States, Territories and Provinces Vital Records (required)
Patient.Slices for extension.extension:birthPlace.value[x].state.id		0..1	string	xml:id (or equivalent in JSON)
Patient.Slices for extension.extension:birthPlace.value[x].state.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for extension.extension:birthPlace.value[x].state.Slices for extension				Content/Rules for all slices
Patient.Slices for extension.extension:birthPlace.value[x].state.Slices for extension.extension:nationalReportingJurisdictionId		0..1	string	Location Jurisdiction Id Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-jurisdiction-id-vr Binding: Value Set - Jurisdictions Vital Records (required)
Patient.Slices for extension.extension:birthPlace.value[x].state.value		0..1	string	Primitive value for string Max Length:1048576
Patient.Slices for extension.extension:birthPlace.value[x].postalCode	Σ This element is included in summaries.	0..1	string	Postal code for area Example General: 9132
Patient.Slices for extension.extension:birthPlace.value[x].country	Σ This element is included in summaries.	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code) Binding: Value Set - Birthplace Country Vital Records (required)
Patient.Slices for extension.extension:birthPlace.value[x].period	Σ This element is included in summaries.	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
Patient.Slices for extension.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
Patient.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
Patient.Slices for identifier	S This element must be supported. Σ This element is included in summaries.	1..*	Identifier	An identifier for this patient Slice: Unordered, Open by pattern:type Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for identifier.identifier:All Slices				Content/Rules for all slices
Patient.Slices for identifier.identifier:All Slices.id		0..1	string	Unique id for inter-element referencing
Patient.Slices for identifier.identifier:All Slices.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:All Slices.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:All Slices.type	Σ This element is included in summaries.	0..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.
Patient.Slices for identifier.identifier:All Slices.system	S This element must be supported. Σ This element is included in summaries.	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
Patient.Slices for identifier.identifier:All Slices.value	S This element must be supported. Σ This element is included in summaries.	1..1	string	The value that is unique within the system. Example General: 123456
Patient.Slices for identifier.identifier:All Slices.period	Σ This element is included in summaries.	0..1	Period	Time period when id is/was valid for use
Patient.Slices for identifier.identifier:All Slices.assigner	Σ This element is included in summaries.	0..1	Reference(Organization)	Organization that issued id (may be just text)
Patient.Slices for identifier.identifier:MRN	S This element must be supported. Σ This element is included in summaries.	0..*	Identifier	Medical Record Number
Patient.Slices for identifier.identifier:MRN.id		0..1	string	Unique id for inter-element referencing
Patient.Slices for identifier.identifier:MRN.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:MRN.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:MRN.type	Σ This element is included in summaries.	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: { "coding" : [ { "system" : "http://terminology.hl7.org/CodeSystem/v2-0203", "code" : "MR" } ] }
Patient.Slices for identifier.identifier:MRN.system	S This element must be supported. Σ This element is included in summaries.	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
Patient.Slices for identifier.identifier:MRN.value	S This element must be supported. Σ This element is included in summaries.	1..1	string	The value that is unique within the system. Example General: 123456
Patient.Slices for identifier.identifier:MRN.period	Σ This element is included in summaries.	0..1	Period	Time period when id is/was valid for use
Patient.Slices for identifier.identifier:MRN.assigner	Σ This element is included in summaries.	0..1	Reference(Organization)	Organization that issued id (may be just text)
Patient.Slices for identifier.identifier:SSN	S This element must be supported. Σ This element is included in summaries.	0..1	Identifier	SSN if available and appropriate to send
Patient.Slices for identifier.identifier:SSN.id		0..1	string	Unique id for inter-element referencing
Patient.Slices for identifier.identifier:SSN.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:SSN.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:SSN.type	Σ This element is included in summaries.	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: { "coding" : [ { "system" : "http://terminology.hl7.org/CodeSystem/v2-0203", "code" : "SS" } ] }
Patient.Slices for identifier.identifier:SSN.system	S This element must be supported. Σ This element is included in summaries.	1..1	uri	The namespace for the identifier value Required Pattern: http://hl7.org/fhir/sid/us-ssn (extensions allowed)
Patient.Slices for identifier.identifier:SSN.value	S This element must be supported. Σ This element is included in summaries.	1..1	string	The value that is unique within the system. Example General: 123456
Patient.Slices for identifier.identifier:SSN.period	Σ This element is included in summaries.	0..1	Period	Time period when id is/was valid for use
Patient.Slices for identifier.identifier:SSN.assigner	Σ This element is included in summaries.	0..1	Reference(Organization)	Organization that issued id (may be just text)
Patient.active	?! This element is a modifier element. Σ This element is included in summaries.	0..1	boolean	Whether this patient's record is in active use
Patient.Slices for name	S This element must be supported. Σ This element is included in summaries.	1..*	HumanName	A name associated with the patient Slice: Unordered, Open by value:use Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for name.name:All Slices				Content/Rules for all slices
Patient.Slices for name.name:All Slices.id		0..1	string	Unique id for inter-element referencing
Patient.Slices for name.name:All Slices.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Patient.Slices for name.name:All Slices.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
Patient.Slices for name.name:All Slices.text	Σ This element is included in summaries.	0..1	string	Text representation of the full name
Patient.Slices for name.name:All Slices.family	S This element must be supported. Σ This element is included in summaries. C	0..1	string	Family name (often called 'Surname')
Patient.Slices for name.name:All Slices.family.id		0..1	string	xml:id (or equivalent in JSON)
Patient.Slices for name.name:All Slices.family.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for name.name:All Slices.family.Slices for extension.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)
Patient.Slices for name.name:All Slices.family.value		0..1	string	Primitive value for string Max Length:1048576
Patient.Slices for name.name:All Slices.given	S This element must be supported. Σ This element is included in summaries. 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
Patient.Slices for name.name:All Slices.given.id		0..1	string	xml:id (or equivalent in JSON)
Patient.Slices for name.name:All Slices.given.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for name.name:All Slices.given.Slices for extension.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)
Patient.Slices for name.name:All Slices.given.value		0..1	string	Primitive value for string Max Length:1048576
Patient.Slices for name.name:All Slices.prefix	Σ This element is included in summaries.	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
Patient.Slices for name.name:All Slices.suffix	Σ This element is included in summaries.	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
Patient.Slices for name.name:All Slices.period	Σ This element is included in summaries.	0..1	Period	Time period when name was/is in use
Patient.Slices for name.name:currentLegalName	S This element must be supported. Σ This element is included in summaries.	0..1	HumanName	current legal name
Patient.Slices for name.name:currentLegalName.id		0..1	string	Unique id for inter-element referencing
Patient.Slices for name.name:currentLegalName.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Patient.Slices for name.name:currentLegalName.use	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: official (no extensions allowed)
Patient.Slices for name.name:currentLegalName.text	Σ This element is included in summaries.	0..1	string	Text representation of the full name
Patient.Slices for name.name:currentLegalName.family	S This element must be supported. Σ This element is included in summaries. C	0..1	string	Family name (often called 'Surname')
Patient.Slices for name.name:currentLegalName.given	S This element must be supported. Σ This element is included in summaries. 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
Patient.Slices for name.name:currentLegalName.prefix	Σ This element is included in summaries.	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
Patient.Slices for name.name:currentLegalName.suffix	Σ This element is included in summaries.	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
Patient.Slices for name.name:currentLegalName.period	Σ This element is included in summaries.	0..1	Period	Time period when name was/is in use
Patient.Slices for name.name:namePriorToFirstMarriage	S This element must be supported. Σ This element is included in summaries.	0..1	HumanName	Name prior to first marriage
Patient.Slices for name.name:namePriorToFirstMarriage.id		0..1	string	Unique id for inter-element referencing
Patient.Slices for name.name:namePriorToFirstMarriage.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Patient.Slices for name.name:namePriorToFirstMarriage.use	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: maiden (no extensions allowed)
Patient.Slices for name.name:namePriorToFirstMarriage.text	Σ This element is included in summaries.	0..1	string	Text representation of the full name
Patient.Slices for name.name:namePriorToFirstMarriage.family	S This element must be supported. Σ This element is included in summaries. C	0..1	string	Family name (often called 'Surname')
Patient.Slices for name.name:namePriorToFirstMarriage.given	S This element must be supported. Σ This element is included in summaries. 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
Patient.Slices for name.name:namePriorToFirstMarriage.prefix	Σ This element is included in summaries.	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
Patient.Slices for name.name:namePriorToFirstMarriage.suffix	Σ This element is included in summaries.	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
Patient.Slices for name.name:namePriorToFirstMarriage.period	Σ This element is included in summaries.	0..1	Period	Time period when name was/is in use
Patient.telecom	Σ This element is included in summaries.	0..*	ContactPoint	A contact detail for the individual
Patient.telecom.id		0..1	string	Unique id for inter-element referencing
Patient.telecom.extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Patient.telecom.system	S This element must be supported. Σ This element is included in summaries. C	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
Patient.telecom.value	S This element must be supported. Σ This element is included in summaries.	1..1	string	The actual contact point details
Patient.telecom.use	?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries.	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required)
Patient.telecom.rank	Σ This element is included in summaries.	0..1	positiveInt	Specify preferred order of use (1 = highest)
Patient.telecom.period	Σ This element is included in summaries.	0..1	Period	Time period when the contact point was/is in use
Patient.gender	S This element must be supported. Σ This element is included in summaries.	1..1	code	male | female | other | unknown Binding: AdministrativeGender (required)
Patient.birthDate	S This element must be supported. Σ This element is included in summaries.	0..1	date	The date of birth for the individual
Patient.birthDate.id		0..1	string	xml:id (or equivalent in JSON)
Patient.birthDate.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.birthDate.Slices for extension.extension:partialDateTime		0..1	(Complex)	partialDateTIme URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-partial-date-time-vr
Patient.birthDate.Slices for extension.extension:birthTime		0..1	dateTime	Time of day of birth URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
Patient.birthDate.Slices for extension.extension:bypassEditFlag		0..1	(Complex)	BypassEditFlag Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag
Patient.birthDate.Slices for extension.extension:bypassEditFlag.id		0..1	string	Unique id for inter-element referencing
Patient.birthDate.Slices for extension.extension:bypassEditFlag.extension		0..0		Extension Slice: Unordered, Open by value:url
Patient.birthDate.Slices for extension.extension:bypassEditFlag.url		1..1	uri	"http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag"
Patient.birthDate.Slices for extension.extension:bypassEditFlag.value[x]		1..1	CodeableConcept	To reflect the relevant edit possibilities for date of birth. Binding: Value Set - Date of Birth Edit Flags (NCHS) Vital Records (required): Date of Birth Edit Flags (NCHS)
Patient.birthDate.value		0..1	date	Primitive value for date
Patient.Slices for deceased[x]	?! This element is a modifier element. Σ This element is included in summaries.	0..1		Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view
Patient.Slices for deceased[x].deceasedBoolean			boolean
Patient.Slices for deceased[x].deceasedDateTime			dateTime
Patient.Slices for deceased[x].deceased[x]:deceasedBoolean	?! This element is a modifier element. Σ This element is included in summaries. C	0..1	boolean	Boolean indicator. True if the individual is deceased. Constraints: fetalDeathOnlyIfDeceased
Patient.Slices for deceased[x].deceased[x]:deceasedBoolean.id		0..1	string	xml:id (or equivalent in JSON)
Patient.Slices for deceased[x].deceased[x]:deceasedBoolean.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for deceased[x].deceased[x]:deceasedBoolean.Slices for extension				Content/Rules for all slices
Patient.Slices for deceased[x].deceased[x]:deceasedBoolean.Slices for extension.extension:fetalDeath		0..1	boolean	Boolean indicator. True if the Patient died as a fetus. URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-patient-fetal-death-vr
Patient.Slices for deceased[x].deceased[x]:deceasedBoolean.value		0..1	boolean	Primitive value for boolean
Patient.address	S This element must be supported. Σ This element is included in summaries.	0..*	Address	An address for the individual
Patient.address.id		0..1	string	Unique id for inter-element referencing
Patient.address.Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Patient.address.Slices for extension.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: Value Set - Yes No Unknown Vital Records (required): Yes No Unknown (YNU)
Patient.address.Slices for extension.extension:predir		0..1	string	PreDirectional Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PreDirectional
Patient.address.Slices for extension.extension:stnum		0..1	string	StreetNumber Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetNumber
Patient.address.Slices for extension.extension:stname		0..1	string	StreetName Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetName
Patient.address.Slices for extension.extension:stdesig		0..1	string	StreetDesignator Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetDesignator
Patient.address.Slices for extension.extension:postdir		0..1	string	PostDirectional Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PostDirectional
Patient.address.Slices for extension.extension:unitnumber		0..1	string	UnitOrAptNumber Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/UnitOrAptNumber
Patient.address.use	?! This element is a modifier element. Σ This element is included in summaries.	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
Patient.address.type	Σ This element is included in summaries.	0..1	code	postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
Patient.address.text	Σ This element is included in summaries.	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
Patient.address.line	S This element must be supported. Σ This element is included in summaries.	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
Patient.address.city	S This element must be supported. Σ This element is included in summaries.	0..1	string	Name of city, town etc. Example General: Erewhon
Patient.address.city.id		0..1	string	xml:id (or equivalent in JSON)
Patient.address.city.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.address.city.Slices for extension.extension:cityCode		0..1	positiveInt	City Code URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode
Patient.address.city.value		0..1	string	Primitive value for string Max Length:1048576
Patient.address.district	Σ This element is included in summaries.	0..1	string	District name (aka county) Example General: Madison
Patient.address.district.id		0..1	string	xml:id (or equivalent in JSON)
Patient.address.district.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.address.district.Slices for extension.extension:districtCode		0..1	positiveInt	County code URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/DistrictCode
Patient.address.district.value		0..1	string	Primitive value for string Max Length:1048576
Patient.address.state	S This element must be supported. Σ This element is included in summaries.	0..1	string	Sub-unit of country (abbreviations ok) Binding: Value Set - States, Territories and Provinces Vital Records (required)
Patient.address.postalCode	S This element must be supported. Σ This element is included in summaries.	0..1	string	US Zip Codes Example General: 9132
Patient.address.country	Σ This element is included in summaries.	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code) Binding: Value Set - Residence Country Vital Records (required)
Patient.address.period	S This element must be supported. Σ This element is included in summaries.	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
Patient.maritalStatus		0..1	CodeableConcept	Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
Patient.multipleBirth[x]		0..1		If not single birth - born first, second, third, etc.
Patient.multipleBirth[x].multipleBirth[x]All Types				Content/Rules for all Types
Patient.multipleBirth[x].multipleBirth[x]All Types.id		0..1	string	Unique id for inter-element referencing
Patient.multipleBirth[x].multipleBirth[x]All Types.Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Patient.multipleBirth[x].multipleBirth[x]All Types.Slices for extension.extension:bypassEditFlag		0..1	(Complex)	BypassEditFlag Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag
Patient.multipleBirth[x].multipleBirth[x]All Types.Slices for extension.extension:bypassEditFlag.id		0..1	string	Unique id for inter-element referencing
Patient.multipleBirth[x].multipleBirth[x]All Types.Slices for extension.extension:bypassEditFlag.extension		0..0		Extension Slice: Unordered, Open by value:url
Patient.multipleBirth[x].multipleBirth[x]All Types.Slices for extension.extension:bypassEditFlag.url		1..1	uri	"http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag"
Patient.multipleBirth[x].multipleBirth[x]All Types.Slices for extension.extension:bypassEditFlag.value[x]		1..1	CodeableConcept	Value of extension Binding: Value Set - Plurality Edit Flags (NCHS) Vital Records (required): Plurality Edit Flags (NCHS)
Patient.multipleBirth[x].multipleBirth[x]All Types.Slices for extension.extension:multipleBirthTotal		0..1	positiveInt	Total births in this pregnancy URL: http://hl7.org/fhir/StructureDefinition/patient-multipleBirthTotal
Patient.multipleBirth[x].multipleBirthBoolean			boolean
Patient.multipleBirth[x].multipleBirthInteger			integer
Patient.photo		0..*	Attachment	Image of the patient
Patient.contact	C	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1
Patient.contact.id		0..1	string	Unique id for inter-element referencing
Patient.contact.extension		0..*	Extension	Additional content defined by implementations
Patient.contact.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Patient.contact.relationship		0..*	CodeableConcept	The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
Patient.contact.name		0..1	HumanName	A name associated with the contact person
Patient.contact.telecom		0..*	ContactPoint	A contact detail for the person
Patient.contact.address		0..1	Address	Address for the contact person
Patient.contact.gender		0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.contact.organization	C	0..1	Reference(Organization)	Organization that is associated with the contact
Patient.contact.period		0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient
Patient.communication		0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health
Patient.communication.id		0..1	string	Unique id for inter-element referencing
Patient.communication.extension		0..*	Extension	Additional content defined by implementations
Patient.communication.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Patient.communication.language	S This element must be supported.	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)
Patient.communication.preferred		0..1	boolean	Language preference indicator
Patient.generalPractitioner		0..*	Reference(Organization | Practitioner | PractitionerRole)	Patient's nominated primary care provider
Patient.managingOrganization	Σ This element is included in summaries.	0..1	Reference(Organization)	Organization that is the custodian of the patient record
Patient.link	?! This element is a modifier element. Σ This element is included in summaries.	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
Patient.link.id		0..1	string	Unique id for inter-element referencing
Patient.link.extension		0..*	Extension	Additional content defined by implementations
Patient.link.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
Patient.link.other	Σ This element is included in summaries.	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
Patient.link.type	Σ This element is included in summaries.	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	Status	Usage	ValueSet	Version	Source
Patient.language	Base	preferred	Common Languages	📦4.0.1	FHIR Std.
Patient.extension:birthPlace.​value[x].use	Base	required	AddressUse	📍4.0.1	FHIR Std.
Patient.extension:birthPlace.​value[x].type	Base	required	AddressType	📍4.0.1	FHIR Std.
Patient.extension:birthPlace.​value[x].state	Base	required	Value Set - States, Territories and Provinces Vital Records	📦2.0.0	This IG
Patient.extension:birthPlace.​value[x].country	Base	required	Value Set - Birthplace Country Vital Records	📦2.0.0	This IG
Patient.identifier.use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Patient.identifier.type	Base	extensible	IdentifierType	📦4.0.1	FHIR Std.
Patient.identifier:MRN.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Patient.identifier:MRN.​type	Base	extensible	IdentifierType	📦4.0.1	FHIR Std.
Patient.identifier:SSN.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Patient.identifier:SSN.​type	Base	extensible	IdentifierType	📦4.0.1	FHIR Std.
Patient.name.use	Base	required	NameUse	📍4.0.1	FHIR Std.
Patient.name:currentLegalName.​use	Base	required	NameUse	📍4.0.1	FHIR Std.
Patient.name:namePriorToFirstMarriage.​use	Base	required	NameUse	📍4.0.1	FHIR Std.
Patient.telecom.system	Base	required	ContactPointSystem	📦4.0.1	FHIR Std.
Patient.telecom.use	Base	required	ContactPointUse	📦4.0.1	FHIR Std.
Patient.gender	Base	required	AdministrativeGender	📦4.0.1	FHIR Std.
Patient.birthDate.extension:bypassEditFlag.​value[x]	Base	required	Value Set - Date of Birth Edit Flags (NCHS) Vital Records	📦2.0.0	This IG
Patient.address.use	Base	required	AddressUse	📍4.0.1	FHIR Std.
Patient.address.type	Base	required	AddressType	📍4.0.1	FHIR Std.
Patient.address.state	Base	required	Value Set - States, Territories and Provinces Vital Records	📦2.0.0	This IG
Patient.address.country	Base	required	Value Set - Residence Country Vital Records	📦2.0.0	This IG
Patient.maritalStatus	Base	extensible	MaritalStatus	📦4.0.1	FHIR Std.
Patient.multipleBirth[x].​extension:bypassEditFlag.​value[x]	Base	required	Value Set - Plurality Edit Flags (NCHS) Vital Records	📦2.0.0	This IG
Patient.contact.relationship	Base	extensible	Patient Contact Relationship	📦4.0.1	FHIR Std.
Patient.contact.gender	Base	required	AdministrativeGender	📍4.0.1	FHIR Std.
Patient.communication.​language	Base	extensible	Language codes with language and optionally a region modifier	📦5.0.1	US Core v5.0
Patient.link.type	Base	required	LinkType	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
fetalDeathOnlyIfDeceased	error	Patient.deceased[x]:deceasedBoolean	Fetal death should only be indicated if Patient is deceased.	(extension.where(url = 'http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-patient-fetal-death-vr').exists(value.exists() and value = 'true')) implies (value.exists() and value = 'true')

This structure is derived from USCorePatientProfile

Summary

Mandatory: 0 element(4 nested mandatory elements)
Fixed: 2 elements

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/StructureDefinition/patient-birthPlace
• http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode
• http://hl7.org/fhir/us/vr-common-library/StructureDefinition/DistrictCode
• http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-jurisdiction-id-vr
• http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-reported-parent-age-at-delivery-vr
• http://hl7.org/fhir/StructureDefinition/data-absent-reason
• http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-partial-date-time-vr
• http://hl7.org/fhir/StructureDefinition/patient-birthTime
• http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag
• http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-patient-fetal-death-vr
• http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-within-city-limits-indicator-vr
• http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PreDirectional
• http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetNumber
• http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetName
• http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetDesignator
• http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PostDirectional
• http://hl7.org/fhir/us/vr-common-library/StructureDefinition/UnitOrAptNumber
• http://hl7.org/fhir/StructureDefinition/patient-multipleBirthTotal

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Patient.identifier
• The element 1 is sliced based on the value of Patient.name
• The element 1 is sliced based on the value of Patient.deceased[x]