Birth And Fetal Death (BFDR) 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/fhir-bfdr/ and changes regularly. See the Directory of published versions

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

Resource Profile: Patient - Decedent Fetus

A stillborn for whom clinical data is included in the report.

Usage:

• Refer to this Resource Profile: Composition - Coded Cause of Fetal Death, Composition - Coded Industry and Occupation, Composition - Coded Race and Ethnicity, Composition - Jurisdiction Fetal Death Report... Show 16 more, Composition - Provider Fetal Death Report, Condition - Fetal Death Initiating Cause or Condition, Condition - Fetal Death Other Cause or Condition, Observation - Autopsy or Histological Exam Results Used, Observation - Birth Weight, Observation - Coded Initiating Fetal Death Cause or Condition, Observation - Coded Other Fetal Death Cause or Condition, Observation - Date of First Prenatal Care Visit, Observation - Fetal Death Time Point, Observation - Fetal Presentation at Birth/Delivery, Observation - Fetal Remains Disposition Method, Observation - Gestational Age at Delivery, Observation - Histological Placental Exam Performed, Observation - Labor Trial Attempted, Observation - Mother Recieved WIC Food and Observation - Planned to Deliver at Home
• Examples for this Resource Profile: Patient/patient-decedent-fetus-not-named-w-edit and Patient/patient-decedent-fetus-not-named

Formal Views of Profile Content

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

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

Name	Flags	Card.	Type	Description & Constraints
Patient	C	0..*	PatientVitalRecords	Information about an individual or animal receiving health care services dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management us-core-6: Either Patient.name.given and/or Patient.name.family SHALL be present or a Data Absent Reason Extension SHALL be present.
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
Slices for extension				Content/Rules for all slices
race		0..1	(Complex)	US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
ethnicity		0..1	(Complex)	US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
birthsex		0..1	(Complex)	Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex"
value[x]		1..1	code	Value of extension Binding: Value Set - Sex Assigned At Birth Vital Records (required) ele-1: All FHIR elements must have a @value or children
genderIdentity		0..1	CodeableConcept	Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity Binding: Gender Identity (extensible) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
birthPlace		0..1	(Complex)	Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
value[x]		1..1	Address	Value of extension ele-1: All FHIR elements must have a @value or children
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. ele-1: All FHIR elements must have a @value or children Example General: home
state	Σ	0..1	string	State Binding: Value Set - States, Territories and Provinces Vital Records (required) ele-1: All FHIR elements must have a @value or children
Slices for extension				Content/Rules for all slices
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) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
parentReportedAgeAtDelivery		0..2	(Complex)	The mother or father's reported age at the time of delivery of the child URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-reported-parent-age-at-delivery-vr ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
Slices for extension		2..3	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:reportedAge		1..1	Extension	Extension ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"reportedAge"
value[x]		1..1	Quantity	Parent's reported age ele-1: All FHIR elements must have a @value or children
value	Σ	1..1	decimal	Numerical value (with implicit precision) ele-1: All FHIR elements must have a @value or children
comparator	?!Σ	0..1	code	< | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. ele-1: All FHIR elements must have a @value or children
code	Σ	0..1	code	year ele-1: All FHIR elements must have a @value or children Fixed Value: a
extension:motherOrFather		1..1	Extension	Extension ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"motherOrFather"
value[x]		1..1	CodeableConcept	Indicates mother/Father code Binding: Value Set - Role Vital Records (extensible): Vital Records Role ele-1: All FHIR elements must have a @value or children
extension:reporter		0..1	Extension	Reference to the person who reported the parent's age. ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"reporter"
value[x]		1..1	Reference(US Core Patient Profile | US Core RelatedPerson Profile)	Value of extension ele-1: All FHIR elements must have a @value or children
url		1..1	uri	"http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-reported-parent-age-at-delivery-vr"
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
Slices for identifier	SΣ	1..*	Identifier	An identifier for this patient Slice: Unordered, Open by pattern:type ele-1: All FHIR elements must have a @value or children
identifier:All Slices				Content/Rules for all slices
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children
system	SΣ	1..1	uri	The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	The value that is unique within the system. ele-1: All FHIR elements must have a @value or children Example General: 123456
identifier:MRN	SΣ	0..*	Identifier	Medical Record Number ele-1: All FHIR elements must have a @value or children
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children
type	Σ	1..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
code		1..1	code	Symbol in syntax defined by the system Fixed Value: MR
system	SΣ	1..1	uri	The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	The value that is unique within the system. ele-1: All FHIR elements must have a @value or children Example General: 123456
identifier:SSN	SΣ	0..1	Identifier	SSN if available and appropriate to send ele-1: All FHIR elements must have a @value or children
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children
type	Σ	1..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
code		1..1	code	Symbol in syntax defined by the system Fixed Value: SS
system	SΣ	1..1	uri	The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Required Pattern: http://hl7.org/fhir/sid/us-ssn
value	SΣ	1..1	string	The value that is unique within the system. ele-1: All FHIR elements must have a @value or children Example General: 123456
active	?!Σ	0..1	boolean	Whether this patient's record is in active use ele-1: All FHIR elements must have a @value or children
Slices for name	SΣ	1..*	HumanName	A name associated with the patient Slice: Unordered, Open by value:use ele-1: All FHIR elements must have a @value or children
name:All Slices				Content/Rules for all slices
use	?!Σ	0..1	code	The use of a human name Binding: NameUse (required): The use of a human name. ele-1: All FHIR elements must have a @value or children
family	SΣC	1..1	string	Family name (often called 'Surname') ele-1: All FHIR elements must have a @value or children
Slices for extension				Content/Rules for all slices
dataAbsentReason		0..1	code	When fetus not named use code "unknown" URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
given	SΣC	0..*	string	Given names (not always 'first'). Includes middle names ele-1: All FHIR elements must have a @value or children This repeating element order: Given Names appear in the correct order for presenting the name
Slices for extension				Content/Rules for all slices
dataAbsentReason		0..1	code	When fetus not named use code "unknown" URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
suffix	Σ	0..*	string	Surname suffix ele-1: All FHIR elements must have a @value or children This repeating element order: Suffixes appear in the correct order for presenting the name
name:currentLegalName	SΣ	0..1	HumanName	current legal name ele-1: All FHIR elements must have a @value or children
use	?!Σ	1..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. ele-1: All FHIR elements must have a @value or children Fixed Value: official
family	SΣC	1..1	string	Family name (often called 'Surname') ele-1: All FHIR elements must have a @value or children
given	SΣC	0..*	string	Given names (not always 'first'). Includes middle names ele-1: All FHIR elements must have a @value or children This repeating element order: Given Names appear in the correct order for presenting the name
name:namePriorToFirstMarriage	SΣ	0..1	HumanName	Name prior to first marriage ele-1: All FHIR elements must have a @value or children
use	?!Σ	1..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. ele-1: All FHIR elements must have a @value or children Fixed Value: maiden
family	SΣC	1..1	string	Family name (often called 'Surname') ele-1: All FHIR elements must have a @value or children
given	SΣC	0..*	string	Given names (not always 'first'). Includes middle names ele-1: All FHIR elements must have a @value or children This repeating element order: Given Names appear in the correct order for presenting the name
telecom	Σ	0..*	ContactPoint	A contact detail for the individual ele-1: All FHIR elements must have a @value or children
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. ele-1: All FHIR elements must have a @value or children
value	SΣ	1..1	string	The actual contact point details ele-1: All FHIR elements must have a @value or children
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) ele-1: All FHIR elements must have a @value or children
gender	SΣ	1..1	code	male | female | other | unknown Binding: AdministrativeGender (required) ele-1: All FHIR elements must have a @value or children
birthDate	SΣ	1..1	date	The date of birth for the individual ele-1: All FHIR elements must have a @value or children
Slices for extension				Content/Rules for all slices
partialDateTime		0..1	(Complex)	partialDateTIme URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-partial-date-time-vr ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
birthTime		0..1	dateTime	Time of day of birth URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
bypassEditFlag		0..1	(Complex)	BypassEditFlag Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag"
value[x]		1..1	CodeableConcept	To reflect the relevant edit possibilities for date of birth. Binding: Value Set - Date of Birth Edit Flags (NCHS) Vital Records (required): Date of Birth Edit Flags (NCHS) ele-1: All FHIR elements must have a @value or children
Slices for deceased[x]	?!Σ	1..1	boolean	Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this ele-1: All FHIR elements must have a @value or children
deceased[x]:deceasedBoolean	?!ΣC	1..1	boolean	The fetus is deceased ele-1: All FHIR elements must have a @value or children fetalDeathOnlyIfDeceased: Fetal death should only be indicated if Patient is deceased. Required Pattern: true
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
fetalDeath		1..1	(Complex)	fetal death indicator URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-patient-fetal-death-vr ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-patient-fetal-death-vr"
value[x]		1..1	boolean	Value of extension ele-1: All FHIR elements must have a @value or children Required Pattern: true
address	SΣ	0..*	Address	An address for the individual ele-1: All FHIR elements must have a @value or children
Slices for extension				Content/Rules for all slices
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) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
predir		0..1	string	PreDirectional Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PreDirectional ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
stnum		0..1	string	StreetNumber Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetNumber ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
stname		0..1	string	StreetName Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetName ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
stdesig		0..1	string	StreetDesignator Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetDesignator ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
postdir		0..1	string	PostDirectional Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PostDirectional ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
unitnumber		0..1	string	UnitOrAptNumber Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/UnitOrAptNumber ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. ele-1: All FHIR elements must have a @value or children Example General: home
line	SΣ	0..*	string	Street name, number, direction & P.O. Box etc. ele-1: All FHIR elements must have a @value or children This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city	SΣ	0..1	string	Name of city, town etc. ele-1: All FHIR elements must have a @value or children Example General: Erewhon
Slices for extension				Content/Rules for all slices
cityCode		0..1	positiveInt	City Code URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
state	SΣ	0..1	string	Sub-unit of country (abbreviations ok) Binding: Value Set - States, Territories and Provinces Vital Records (required) ele-1: All FHIR elements must have a @value or children
postalCode	SΣ	0..1	string	US Zip Codes ele-1: All FHIR elements must have a @value or children Example General: 9132
period	SΣ	0..1	Period	Time period when address was/is in use ele-1: All FHIR elements must have a @value or children Example General: {"start":"2010-03-23","end":"2010-07-01"}
multipleBirth[x]		0..1	integer	If not single birth - born first, second, third, etc. ele-1: All FHIR elements must have a @value or children
Slices for extension				Content/Rules for all slices
bypassEditFlag		0..1	(Complex)	BypassEditFlag Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag"
value[x]		1..1	CodeableConcept	To reflect the relevant edit possibilities for plurality. Binding: Value Set - Plurality Edit Flags (NCHS) Vital Records (required): Plurality Edit Flags (NCHS) ele-1: All FHIR elements must have a @value or children
multipleBirthTotal		0..1	(Complex)	Where a patient is a part of a multiple delivery, this is the total number of deliveries that occurred in this pregnancy. URL: http://hl7.org/fhir/StructureDefinition/patient-multipleBirthTotal ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-multipleBirthTotal"
value[x]		1..1	positiveInt	Plurality ele-1: All FHIR elements must have a @value or children
communication		0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
language	S	1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her health Binding: Language codes with language and optionally a region modifier (extensible) ele-1: All FHIR elements must have a @value or children
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
other	Σ	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to ele-1: All FHIR elements must have a @value or children
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Patient.extension:birthsex.value[x]	required	ValueSetSexAssignedAtBirthVitalRecords http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-sex-assigned-at-birth-vr
Patient.extension:birthPlace.value[x].use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Patient.extension:birthPlace.value[x].state	required	ValueSetStatesTerritoriesAndProvincesVitalRecords http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-states-territories-provinces-vr
Patient.extension:parentReportedAgeAtDelivery.extension:reportedAge.value[x].comparator	required	QuantityComparator http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1 from the FHIR Standard
Patient.extension:parentReportedAgeAtDelivery.extension:motherOrFather.value[x]	extensible	ValueSetRoleVitalRecords http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-role-vr
Patient.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.identifier:MRN.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.identifier:MRN.type	extensible	Pattern: MR http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Patient.identifier:SSN.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.identifier:SSN.type	extensible	Pattern: SS http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Patient.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
Patient.name:currentLegalName.use	required	Fixed Value: official http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
Patient.name:namePriorToFirstMarriage.use	required	Fixed Value: maiden http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
Patient.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system from the FHIR Standard
Patient.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use from the FHIR Standard
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender from the FHIR Standard
Patient.birthDate.extension:bypassEditFlag.value[x]	required	ValueSetDateOfBirthEditFlagsVitalRecords http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-date-of-birth-edit-flags-vr
Patient.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Patient.address.state	required	ValueSetStatesTerritoriesAndProvincesVitalRecords http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-states-territories-provinces-vr
Patient.multipleBirth[x].extension:bypassEditFlag.value[x]	required	ValueSetPluralityEditFlagsVitalRecords http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-plurality-edit-flags-vr
Patient.communication.language	extensible	LanguageCodesWithLanguageAndOptionallyARegionModifier http://hl7.org/fhir/us/core/ValueSet/simple-language
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard

This structure is derived from PatientVitalRecords

Name	Flags	Card.	Type	Description & Constraints
Patient			PatientVitalRecords
Slices for extension				Content/Rules for all slices
extension:birthsex		0..1	USCoreBirthSexExtension	Extension
extension		0..0
value[x]		1..1	code	Value of extension Binding: Value Set - Sex Assigned At Birth Vital Records (required)
extension:birthPlace		0..1	PatBirthPlace(5.2.0)	Place of Birth for patient
value[x]
district
Slices for extension				Content/Rules for all slices
extension:districtCode		0..1	ExtensionDistrictCodeVitalRecords	County
state		0..1	string	State
extension:parentReportedAgeAtDelivery		0..2	ExtensionReportedParentAgeAtDeliveryVitalRecords	The mother or father's reported age at the time of delivery of the child
Slices for extension				Content/Rules for all slices
extension:reportedAge		1..1	Extension	Extension
value[x]		1..1	Quantity	Parent's reported age
extension:motherOrFather		1..1	Extension	Extension
value[x]		1..1	CodeableConcept	Indicates mother/Father code
name		1..*	HumanName	A name associated with the patient
use		0..1	code	The use of a human name
family		1..1	string	Family name (often called 'Surname')
Slices for extension				Content/Rules for all slices
extension:dataAbsentReason		0..1	DataAbsentReason(5.2.0)	When fetus not named use code "unknown"
given
Slices for extension				Content/Rules for all slices
extension:dataAbsentReason		0..1	DataAbsentReason(5.2.0)	When fetus not named use code "unknown"
suffix		0..*	string	Surname suffix
Slices for name				Content/Rules for all slices
name:currentLegalName		0..1	HumanName	current legal name
family		1..1	string	Family name (often called 'Surname')
name:namePriorToFirstMarriage		0..1	HumanName	Name prior to first marriage
family		1..1	string	Family name (often called 'Surname')
birthDate		1..1	date	The date of birth for the individual
deceased[x]		1..1	boolean	Indicates if the individual is deceased or not
Slices for deceased[x]				Content/Rules for all slices
deceased[x]:deceasedBoolean		1..1	boolean	The fetus is deceased Required Pattern: true
extension		1..*	Extension	Extension
Slices for extension				Content/Rules for all slices
extension:fetalDeath		1..1	ExtensionPatientFetalDeathVitalRecords	fetal death indicator
value[x]		1..1	boolean	Value of extension Required Pattern: true
multipleBirth[x]		0..1	integer	If not single birth - born first, second, third, etc.
Slices for extension				Content/Rules for all slices
extension:bypassEditFlag		0..1	ExtensionBypassEditFlagVitalRecords	BypassEditFlag Vital Records
value[x]		1..1	CodeableConcept	To reflect the relevant edit possibilities for plurality.
extension:multipleBirthTotal		0..1	PatMultipleBirthTotal(5.2.0)	Where a patient is a part of a multiple delivery, this is the total number of deliveries that occurred in this pregnancy.
extension		0..0
value[x]		1..1	positiveInt	Plurality
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Patient.extension:birthsex.value[x]	required	ValueSetSexAssignedAtBirthVitalRecords http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-sex-assigned-at-birth-vr

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

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Patient.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Patient.extension:birthsex.value[x]	required	ValueSetSexAssignedAtBirthVitalRecords http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-sex-assigned-at-birth-vr
Patient.extension:birthPlace.value[x].use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Patient.extension:birthPlace.value[x].type	required	AddressType http://hl7.org/fhir/ValueSet/address-type|4.0.1 from the FHIR Standard
Patient.extension:birthPlace.value[x].state	required	ValueSetStatesTerritoriesAndProvincesVitalRecords http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-states-territories-provinces-vr
Patient.extension:birthPlace.value[x].country	required	ValueSetBirthplaceCountryVitalRecords http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-birthplace-country-vr
Patient.extension:parentReportedAgeAtDelivery.extension:reportedAge.value[x].comparator	required	QuantityComparator http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1 from the FHIR Standard
Patient.extension:parentReportedAgeAtDelivery.extension:motherOrFather.value[x]	extensible	ValueSetRoleVitalRecords http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-role-vr
Patient.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Patient.identifier:MRN.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.identifier:MRN.type	extensible	Pattern: MR http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Patient.identifier:SSN.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.identifier:SSN.type	extensible	Pattern: SS http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Patient.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
Patient.name:currentLegalName.use	required	Fixed Value: official http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
Patient.name:namePriorToFirstMarriage.use	required	Fixed Value: maiden http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
Patient.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system from the FHIR Standard
Patient.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use from the FHIR Standard
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender from the FHIR Standard
Patient.birthDate.extension:bypassEditFlag.value[x]	required	ValueSetDateOfBirthEditFlagsVitalRecords http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-date-of-birth-edit-flags-vr
Patient.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Patient.address.type	required	AddressType http://hl7.org/fhir/ValueSet/address-type|4.0.1 from the FHIR Standard
Patient.address.state	required	ValueSetStatesTerritoriesAndProvincesVitalRecords http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-states-territories-provinces-vr
Patient.address.country	required	ValueSetResidenceCountryVitalRecords http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-residence-country-vr
Patient.maritalStatus	extensible	Marital Status Codes http://hl7.org/fhir/ValueSet/marital-status from the FHIR Standard
Patient.multipleBirth[x].extension:bypassEditFlag.value[x]	required	ValueSetPluralityEditFlagsVitalRecords http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-plurality-edit-flags-vr
Patient.contact.relationship	extensible	PatientContactRelationship http://hl7.org/fhir/ValueSet/patient-contactrelationship from the FHIR Standard
Patient.contact.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
Patient.communication.language	extensible	LanguageCodesWithLanguageAndOptionallyARegionModifier http://hl7.org/fhir/us/core/ValueSet/simple-language
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard

This structure is derived from PatientVitalRecords

Summary

Mandatory: 6 elements(2 nested mandatory elements)
Prohibited: 2 elements

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Patient	C	0..*	PatientVitalRecords	Information about an individual or animal receiving health care services dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management us-core-6: Either Patient.name.given and/or Patient.name.family SHALL be present or a Data Absent Reason Extension SHALL be present.
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
Slices for extension				Content/Rules for all slices
race		0..1	(Complex)	US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
ethnicity		0..1	(Complex)	US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
birthsex		0..1	(Complex)	Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex"
value[x]		1..1	code	Value of extension Binding: Value Set - Sex Assigned At Birth Vital Records (required) ele-1: All FHIR elements must have a @value or children
genderIdentity		0..1	CodeableConcept	Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity Binding: Gender Identity (extensible) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
birthPlace		0..1	(Complex)	Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
value[x]		1..1	Address	Value of extension ele-1: All FHIR elements must have a @value or children
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. ele-1: All FHIR elements must have a @value or children Example General: home
state	Σ	0..1	string	State Binding: Value Set - States, Territories and Provinces Vital Records (required) ele-1: All FHIR elements must have a @value or children
Slices for extension				Content/Rules for all slices
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) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
parentReportedAgeAtDelivery		0..2	(Complex)	The mother or father's reported age at the time of delivery of the child URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-reported-parent-age-at-delivery-vr ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
Slices for extension		2..3	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:reportedAge		1..1	Extension	Extension ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"reportedAge"
value[x]		1..1	Quantity	Parent's reported age ele-1: All FHIR elements must have a @value or children
value	Σ	1..1	decimal	Numerical value (with implicit precision) ele-1: All FHIR elements must have a @value or children
comparator	?!Σ	0..1	code	< | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. ele-1: All FHIR elements must have a @value or children
code	Σ	0..1	code	year ele-1: All FHIR elements must have a @value or children Fixed Value: a
extension:motherOrFather		1..1	Extension	Extension ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"motherOrFather"
value[x]		1..1	CodeableConcept	Indicates mother/Father code Binding: Value Set - Role Vital Records (extensible): Vital Records Role ele-1: All FHIR elements must have a @value or children
extension:reporter		0..1	Extension	Reference to the person who reported the parent's age. ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"reporter"
value[x]		1..1	Reference(US Core Patient Profile | US Core RelatedPerson Profile)	Value of extension ele-1: All FHIR elements must have a @value or children
url		1..1	uri	"http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-reported-parent-age-at-delivery-vr"
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
Slices for identifier	SΣ	1..*	Identifier	An identifier for this patient Slice: Unordered, Open by pattern:type ele-1: All FHIR elements must have a @value or children
identifier:All Slices				Content/Rules for all slices
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children
system	SΣ	1..1	uri	The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	The value that is unique within the system. ele-1: All FHIR elements must have a @value or children Example General: 123456
identifier:MRN	SΣ	0..*	Identifier	Medical Record Number ele-1: All FHIR elements must have a @value or children
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children
type	Σ	1..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
code		1..1	code	Symbol in syntax defined by the system Fixed Value: MR
system	SΣ	1..1	uri	The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Example General: http://www.acme.com/identifiers/patient
value	SΣ	1..1	string	The value that is unique within the system. ele-1: All FHIR elements must have a @value or children Example General: 123456
identifier:SSN	SΣ	0..1	Identifier	SSN if available and appropriate to send ele-1: All FHIR elements must have a @value or children
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children
type	Σ	1..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
code		1..1	code	Symbol in syntax defined by the system Fixed Value: SS
system	SΣ	1..1	uri	The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Required Pattern: http://hl7.org/fhir/sid/us-ssn
value	SΣ	1..1	string	The value that is unique within the system. ele-1: All FHIR elements must have a @value or children Example General: 123456
active	?!Σ	0..1	boolean	Whether this patient's record is in active use ele-1: All FHIR elements must have a @value or children
Slices for name	SΣ	1..*	HumanName	A name associated with the patient Slice: Unordered, Open by value:use ele-1: All FHIR elements must have a @value or children
name:All Slices				Content/Rules for all slices
use	?!Σ	0..1	code	The use of a human name Binding: NameUse (required): The use of a human name. ele-1: All FHIR elements must have a @value or children
family	SΣC	1..1	string	Family name (often called 'Surname') ele-1: All FHIR elements must have a @value or children
Slices for extension				Content/Rules for all slices
dataAbsentReason		0..1	code	When fetus not named use code "unknown" URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
given	SΣC	0..*	string	Given names (not always 'first'). Includes middle names ele-1: All FHIR elements must have a @value or children This repeating element order: Given Names appear in the correct order for presenting the name
Slices for extension				Content/Rules for all slices
dataAbsentReason		0..1	code	When fetus not named use code "unknown" URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
suffix	Σ	0..*	string	Surname suffix ele-1: All FHIR elements must have a @value or children This repeating element order: Suffixes appear in the correct order for presenting the name
name:currentLegalName	SΣ	0..1	HumanName	current legal name ele-1: All FHIR elements must have a @value or children
use	?!Σ	1..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. ele-1: All FHIR elements must have a @value or children Fixed Value: official
family	SΣC	1..1	string	Family name (often called 'Surname') ele-1: All FHIR elements must have a @value or children
given	SΣC	0..*	string	Given names (not always 'first'). Includes middle names ele-1: All FHIR elements must have a @value or children This repeating element order: Given Names appear in the correct order for presenting the name
name:namePriorToFirstMarriage	SΣ	0..1	HumanName	Name prior to first marriage ele-1: All FHIR elements must have a @value or children
use	?!Σ	1..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. ele-1: All FHIR elements must have a @value or children Fixed Value: maiden
family	SΣC	1..1	string	Family name (often called 'Surname') ele-1: All FHIR elements must have a @value or children
given	SΣC	0..*	string	Given names (not always 'first'). Includes middle names ele-1: All FHIR elements must have a @value or children This repeating element order: Given Names appear in the correct order for presenting the name
telecom	Σ	0..*	ContactPoint	A contact detail for the individual ele-1: All FHIR elements must have a @value or children
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. ele-1: All FHIR elements must have a @value or children
value	SΣ	1..1	string	The actual contact point details ele-1: All FHIR elements must have a @value or children
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) ele-1: All FHIR elements must have a @value or children
gender	SΣ	1..1	code	male | female | other | unknown Binding: AdministrativeGender (required) ele-1: All FHIR elements must have a @value or children
birthDate	SΣ	1..1	date	The date of birth for the individual ele-1: All FHIR elements must have a @value or children
Slices for extension				Content/Rules for all slices
partialDateTime		0..1	(Complex)	partialDateTIme URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-partial-date-time-vr ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
birthTime		0..1	dateTime	Time of day of birth URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
bypassEditFlag		0..1	(Complex)	BypassEditFlag Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag"
value[x]		1..1	CodeableConcept	To reflect the relevant edit possibilities for date of birth. Binding: Value Set - Date of Birth Edit Flags (NCHS) Vital Records (required): Date of Birth Edit Flags (NCHS) ele-1: All FHIR elements must have a @value or children
Slices for deceased[x]	?!Σ	1..1	boolean	Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this ele-1: All FHIR elements must have a @value or children
deceased[x]:deceasedBoolean	?!ΣC	1..1	boolean	The fetus is deceased ele-1: All FHIR elements must have a @value or children fetalDeathOnlyIfDeceased: Fetal death should only be indicated if Patient is deceased. Required Pattern: true
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
fetalDeath		1..1	(Complex)	fetal death indicator URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-patient-fetal-death-vr ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-patient-fetal-death-vr"
value[x]		1..1	boolean	Value of extension ele-1: All FHIR elements must have a @value or children Required Pattern: true
address	SΣ	0..*	Address	An address for the individual ele-1: All FHIR elements must have a @value or children
Slices for extension				Content/Rules for all slices
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) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
predir		0..1	string	PreDirectional Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PreDirectional ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
stnum		0..1	string	StreetNumber Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetNumber ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
stname		0..1	string	StreetName Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetName ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
stdesig		0..1	string	StreetDesignator Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetDesignator ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
postdir		0..1	string	PostDirectional Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PostDirectional ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
unitnumber		0..1	string	UnitOrAptNumber Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/UnitOrAptNumber ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. ele-1: All FHIR elements must have a @value or children Example General: home
line	SΣ	0..*	string	Street name, number, direction & P.O. Box etc. ele-1: All FHIR elements must have a @value or children This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city	SΣ	0..1	string	Name of city, town etc. ele-1: All FHIR elements must have a @value or children Example General: Erewhon
Slices for extension				Content/Rules for all slices
cityCode		0..1	positiveInt	City Code URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
state	SΣ	0..1	string	Sub-unit of country (abbreviations ok) Binding: Value Set - States, Territories and Provinces Vital Records (required) ele-1: All FHIR elements must have a @value or children
postalCode	SΣ	0..1	string	US Zip Codes ele-1: All FHIR elements must have a @value or children Example General: 9132
period	SΣ	0..1	Period	Time period when address was/is in use ele-1: All FHIR elements must have a @value or children Example General: {"start":"2010-03-23","end":"2010-07-01"}
multipleBirth[x]		0..1	integer	If not single birth - born first, second, third, etc. ele-1: All FHIR elements must have a @value or children
Slices for extension				Content/Rules for all slices
bypassEditFlag		0..1	(Complex)	BypassEditFlag Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag"
value[x]		1..1	CodeableConcept	To reflect the relevant edit possibilities for plurality. Binding: Value Set - Plurality Edit Flags (NCHS) Vital Records (required): Plurality Edit Flags (NCHS) ele-1: All FHIR elements must have a @value or children
multipleBirthTotal		0..1	(Complex)	Where a patient is a part of a multiple delivery, this is the total number of deliveries that occurred in this pregnancy. URL: http://hl7.org/fhir/StructureDefinition/patient-multipleBirthTotal ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-multipleBirthTotal"
value[x]		1..1	positiveInt	Plurality ele-1: All FHIR elements must have a @value or children
communication		0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
language	S	1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her health Binding: Language codes with language and optionally a region modifier (extensible) ele-1: All FHIR elements must have a @value or children
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
other	Σ	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to ele-1: All FHIR elements must have a @value or children
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Patient.extension:birthsex.value[x]	required	ValueSetSexAssignedAtBirthVitalRecords http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-sex-assigned-at-birth-vr
Patient.extension:birthPlace.value[x].use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Patient.extension:birthPlace.value[x].state	required	ValueSetStatesTerritoriesAndProvincesVitalRecords http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-states-territories-provinces-vr
Patient.extension:parentReportedAgeAtDelivery.extension:reportedAge.value[x].comparator	required	QuantityComparator http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1 from the FHIR Standard
Patient.extension:parentReportedAgeAtDelivery.extension:motherOrFather.value[x]	extensible	ValueSetRoleVitalRecords http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-role-vr
Patient.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.identifier:MRN.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.identifier:MRN.type	extensible	Pattern: MR http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Patient.identifier:SSN.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.identifier:SSN.type	extensible	Pattern: SS http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Patient.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
Patient.name:currentLegalName.use	required	Fixed Value: official http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
Patient.name:namePriorToFirstMarriage.use	required	Fixed Value: maiden http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
Patient.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system from the FHIR Standard
Patient.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use from the FHIR Standard
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender from the FHIR Standard
Patient.birthDate.extension:bypassEditFlag.value[x]	required	ValueSetDateOfBirthEditFlagsVitalRecords http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-date-of-birth-edit-flags-vr
Patient.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Patient.address.state	required	ValueSetStatesTerritoriesAndProvincesVitalRecords http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-states-territories-provinces-vr
Patient.multipleBirth[x].extension:bypassEditFlag.value[x]	required	ValueSetPluralityEditFlagsVitalRecords http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-plurality-edit-flags-vr
Patient.communication.language	extensible	LanguageCodesWithLanguageAndOptionallyARegionModifier http://hl7.org/fhir/us/core/ValueSet/simple-language
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard

Differential View

This structure is derived from PatientVitalRecords

Name	Flags	Card.	Type	Description & Constraints
Patient			PatientVitalRecords
Slices for extension				Content/Rules for all slices
extension:birthsex		0..1	USCoreBirthSexExtension	Extension
extension		0..0
value[x]		1..1	code	Value of extension Binding: Value Set - Sex Assigned At Birth Vital Records (required)
extension:birthPlace		0..1	PatBirthPlace(5.2.0)	Place of Birth for patient
value[x]
district
Slices for extension				Content/Rules for all slices
extension:districtCode		0..1	ExtensionDistrictCodeVitalRecords	County
state		0..1	string	State
extension:parentReportedAgeAtDelivery		0..2	ExtensionReportedParentAgeAtDeliveryVitalRecords	The mother or father's reported age at the time of delivery of the child
Slices for extension				Content/Rules for all slices
extension:reportedAge		1..1	Extension	Extension
value[x]		1..1	Quantity	Parent's reported age
extension:motherOrFather		1..1	Extension	Extension
value[x]		1..1	CodeableConcept	Indicates mother/Father code
name		1..*	HumanName	A name associated with the patient
use		0..1	code	The use of a human name
family		1..1	string	Family name (often called 'Surname')
Slices for extension				Content/Rules for all slices
extension:dataAbsentReason		0..1	DataAbsentReason(5.2.0)	When fetus not named use code "unknown"
given
Slices for extension				Content/Rules for all slices
extension:dataAbsentReason		0..1	DataAbsentReason(5.2.0)	When fetus not named use code "unknown"
suffix		0..*	string	Surname suffix
Slices for name				Content/Rules for all slices
name:currentLegalName		0..1	HumanName	current legal name
family		1..1	string	Family name (often called 'Surname')
name:namePriorToFirstMarriage		0..1	HumanName	Name prior to first marriage
family		1..1	string	Family name (often called 'Surname')
birthDate		1..1	date	The date of birth for the individual
deceased[x]		1..1	boolean	Indicates if the individual is deceased or not
Slices for deceased[x]				Content/Rules for all slices
deceased[x]:deceasedBoolean		1..1	boolean	The fetus is deceased Required Pattern: true
extension		1..*	Extension	Extension
Slices for extension				Content/Rules for all slices
extension:fetalDeath		1..1	ExtensionPatientFetalDeathVitalRecords	fetal death indicator
value[x]		1..1	boolean	Value of extension Required Pattern: true
multipleBirth[x]		0..1	integer	If not single birth - born first, second, third, etc.
Slices for extension				Content/Rules for all slices
extension:bypassEditFlag		0..1	ExtensionBypassEditFlagVitalRecords	BypassEditFlag Vital Records
value[x]		1..1	CodeableConcept	To reflect the relevant edit possibilities for plurality.
extension:multipleBirthTotal		0..1	PatMultipleBirthTotal(5.2.0)	Where a patient is a part of a multiple delivery, this is the total number of deliveries that occurred in this pregnancy.
extension		0..0
value[x]		1..1	positiveInt	Plurality
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Patient.extension:birthsex.value[x]	required	ValueSetSexAssignedAtBirthVitalRecords http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-sex-assigned-at-birth-vr

Snapshot View

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

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Patient.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Patient.extension:birthsex.value[x]	required	ValueSetSexAssignedAtBirthVitalRecords http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-sex-assigned-at-birth-vr
Patient.extension:birthPlace.value[x].use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Patient.extension:birthPlace.value[x].type	required	AddressType http://hl7.org/fhir/ValueSet/address-type|4.0.1 from the FHIR Standard
Patient.extension:birthPlace.value[x].state	required	ValueSetStatesTerritoriesAndProvincesVitalRecords http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-states-territories-provinces-vr
Patient.extension:birthPlace.value[x].country	required	ValueSetBirthplaceCountryVitalRecords http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-birthplace-country-vr
Patient.extension:parentReportedAgeAtDelivery.extension:reportedAge.value[x].comparator	required	QuantityComparator http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1 from the FHIR Standard
Patient.extension:parentReportedAgeAtDelivery.extension:motherOrFather.value[x]	extensible	ValueSetRoleVitalRecords http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-role-vr
Patient.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Patient.identifier:MRN.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.identifier:MRN.type	extensible	Pattern: MR http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Patient.identifier:SSN.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.identifier:SSN.type	extensible	Pattern: SS http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Patient.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
Patient.name:currentLegalName.use	required	Fixed Value: official http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
Patient.name:namePriorToFirstMarriage.use	required	Fixed Value: maiden http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
Patient.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system from the FHIR Standard
Patient.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use from the FHIR Standard
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender from the FHIR Standard
Patient.birthDate.extension:bypassEditFlag.value[x]	required	ValueSetDateOfBirthEditFlagsVitalRecords http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-date-of-birth-edit-flags-vr
Patient.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Patient.address.type	required	AddressType http://hl7.org/fhir/ValueSet/address-type|4.0.1 from the FHIR Standard
Patient.address.state	required	ValueSetStatesTerritoriesAndProvincesVitalRecords http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-states-territories-provinces-vr
Patient.address.country	required	ValueSetResidenceCountryVitalRecords http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-residence-country-vr
Patient.maritalStatus	extensible	Marital Status Codes http://hl7.org/fhir/ValueSet/marital-status from the FHIR Standard
Patient.multipleBirth[x].extension:bypassEditFlag.value[x]	required	ValueSetPluralityEditFlagsVitalRecords http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-plurality-edit-flags-vr
Patient.contact.relationship	extensible	PatientContactRelationship http://hl7.org/fhir/ValueSet/patient-contactrelationship from the FHIR Standard
Patient.contact.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
Patient.communication.language	extensible	LanguageCodesWithLanguageAndOptionallyARegionModifier http://hl7.org/fhir/us/core/ValueSet/simple-language
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard

This structure is derived from PatientVitalRecords

Summary

Mandatory: 6 elements(2 nested mandatory elements)
Prohibited: 2 elements