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
| Official URL: http://hl7.org/fhir/us/bfdr/StructureDefinition/Patient-decedent-fetus | Version: 2.0.0 | ||||
| Standards status: Draft | Computable Name: PatientDecedentFetus | ||||
| Other Identifiers: OID:2.16.840.1.113883.4.642.40.13.42.83 | |||||
A stillborn for whom clinical data is included in the report.
Note: The PatientDecedentFetus profile is based on the US Core Patient Profile which requires gender. A value of 'unknown' will satisfy this requirement. Complete fetal death record submissions may fail FHIR validation due to lack of a value for gender.
| Use Case | # | Description | IJE Name | Field | Type | Value Set/Comments |
|---|---|---|---|---|---|---|
| Fetal Death | 1 | Date of Delivery (Fetus)--Year | FDOD_YR | birthDate.value | date | See note on birth date and time |
| Fetal Death | 2 | State, U.S. Territory or Canadian Province of Place of Delivery - code | DSTATE | extension[birthPlace].value[x].state or extension[birthPlace].value[x].state.extension[nationalReportingJurisdictionId] | string | ValueSetStatesTerritoriesAndProvincesVitalRecords in state field or ValueSetJurisdictionVitalRecords in extension |
| Fetal Death | 6 | Time of Delivery | TD | birthDate.extension[patient-birthTime] | dateTime | See note on birth date and time |
| Fetal Death | 7 | Sex | FSEX | extension[birthsex].value | codeable | ValueSetSexAssignedAtBirthVitalRecords |
| Fetal Death | Gender | *NO IJE MAPPING* | gender | codeable | USCorePatient requires gender - can be 'unknown'. See Note on Gender | |
| Fetal Death | 8 | Date of Delivery (Fetus)--Month | FDOD_MO | birthDate.value | date | See note on birth date and time |
| Fetal Death | 9 | Date of Delivery (Fetus)--Day | FDOD_DY | birthDate.value | date | See note on birth date and time |
| Fetal Death | 10 | County of Delivery | CNTYO | extension[birthPlace].value[x].district.extension[districtCode] | integer | See CountyCodes |
| Fetal Death | 151 | Plurality | PLUR | extension[patient-multipleBirthTotal].valuePositiveInt | integer | |
| Fetal Death | 152 | Set Order | SORD | multipleBirth[x] | integer | |
| Fetal Death | 155 | Plurality--Edit Flag | PLUR_BYPASS | multipleBirth.extension[bypassEditFlag].value | codeable | ValueSetPluralityEditFlagsVitalRecords, See Handling of edit flags |
| Fetal Death | 171 | Mother's Reported Age | MAGER | extension[parentReportedAgeAtDelivery].extension[reportedAge].value, extension[parentReportedAgeAtDelivery].extension[motherOrFather].value='MTH' |
quantity | |
| Fetal Death | 172 | Father's Reported Age | FAGER | extension[parentReportedAgeAtDelivery].extension[reportedAge].value, extension[parentReportedAgeAtDelivery].extension[motherOrFather].value='FTH' |
quantity | |
| Fetal Death | 219 | Fetus First Name | FETFNAME | name.given, name.use = official |
string | See note on Child and Decedent Fetus name |
| Fetal Death | 220 | Fetus Middle Name | FETMNAME | name.given, name.use = official |
string | See note on Child and Decedent Fetus name |
| Fetal Death | 221 | Fetus Last Name | FETLNAME | name.family, name.use = official. (absence is equivalent to ‘UNKNOWN’.) | string | See note on Child and Decedent Fetus name |
| Fetal Death | 222 | Fetus Surname Suffix | SUFFIX | name.suffix, name.use = official |
string |
| Item # | Form Field | FHIR Profile Field | Reference |
|---|---|---|---|
| 1 | Name of Fetus | name | Report of Fetal Death |
| 2 | Time of Delivery | Patient-decedent-fetus.birthDate.extension:birthTime | Report of Fetal Death |
| 3 | Sex | Patient-decedent-fetus.extension:birthsex | Report of Fetal Death |
| 4 | Date of Delivery | birthDate | Report of Fetal Death |
| 5a | City, Town, or Location of Delivery | Patient-decedent-fetus.extension:birthPlace | Report of Fetal Death |
| 5b | Zip Code of Delivery | Patient-decedent-fetus.extension:birthPlace | Report of Fetal Death |
| 6 | County of Delivery | Patient-decedent-fetus.extension:birthPlace | Report of Fetal Death |
| 33 | Plurality | Patient-decedent-fetus.multipleBirthInteger.extension:multipleBirthTotal | Report of Fetal Death |
| 34 | If Not Single Birth-Born First, Second, Third, etc. | multipleBirthInteger | Report of Fetal Death |
| 3 | City, Town or Location of delivery | Patient-decedent-fetus.extension:birthPlace | Facility Worksheet for the Report of Fetal Death |
| 4 | County of delivery | Patient-decedent-fetus.extension:birthPlace | Facility Worksheet for the Report of Fetal Death |
| 12 | Date of delivery | birthDate | Facility Worksheet for the Report of Fetal Death |
| 13 | Time of delivery | Patient-decedent-fetus.extension:birthTime | Facility Worksheet for the Report of Fetal Death |
| 21 | Sex | Patient-decedent-fetus.extension:birthsex | Facility Worksheet for the Report of Fetal Death |
| 22 | Plurality | Patient-decedent-fetus.multipleBirth[x].extension:multipleBirthTotal | Facility Worksheet for the Report of Fetal Death |
| 23 | If not single delivery, order delivered in the pregnancy | multipleBirthInteger | Facility Worksheet for the Report of Fetal Death |
| 1 | Would you like to name the child? | name | Patient’s Worksheet for the Report of Fetal Death |
Usages:
You can also check for usages in the FHIR IG Statistics
Description Differentials, Snapshots, and other representations.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | PatientVitalRecords | Information about an individual or animal receiving health care services Constraints: us-core-6 |
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
0..1 | (Complex) | US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race | |
![]() ![]() ![]() |
0..1 | (Complex) | US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity | |
![]() ![]() ![]() |
0..1 | (Complex) | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex | |
![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex" | |
![]() ![]() ![]() ![]() |
1..1 | code | Value of extension Binding: Value Set - Sex Assigned At Birth Vital Records (required) | |
![]() ![]() ![]() |
0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity Binding: Gender Identity (extensible) | |
![]() ![]() ![]() |
0..1 | (Complex) | Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace | |
![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-birthPlace" | |
![]() ![]() ![]() ![]() |
1..1 | Address | Value of extension | |
![]() ![]() ![]() ![]() ![]() |
0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | State Binding: Value Set - States, Territories and Provinces Vital Records (required) | |
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
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) | |
![]() ![]() ![]() |
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 | |
![]() ![]() ![]() ![]() |
2..3 | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
1..1 | Extension | Age of the parent at the time of delivery reported by another person. | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "reportedAge" | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Quantity | Parent's reported age | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | decimal | Numerical value (with implicit precision) | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | code | year Fixed Value: a (no extensions allowed) | |
![]() ![]() ![]() ![]() ![]() |
1..1 | Extension | Mother or Father | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "motherOrFather" | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Indicates mother/Father code Binding: Value Set - Role Vital Records (extensible): Vital Records Role | |
![]() ![]() ![]() ![]() ![]() |
0..1 | Extension | Reference to the person who reported the parent's age. | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "reporter" | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Reference(US Core Patient Profile | US Core RelatedPerson Profile) | Value of extension | |
![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-reported-parent-age-at-delivery-vr" | |
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |
![]() ![]() |
1..* | Identifier | An identifier for this patient Slice: Unordered, Open by pattern:type Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |
![]() ![]() ![]() ![]() |
1..1 | string | The value that is unique within the system. Example General: 123456 | |
![]() ![]() ![]() |
0..* | Identifier | Medical Record Number | |
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
![]() ![]() ![]() ![]() |
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: | |
![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |
![]() ![]() ![]() ![]() |
1..1 | string | The value that is unique within the system. Example General: 123456 | |
![]() ![]() ![]() |
0..1 | Identifier | SSN if available and appropriate to send | |
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
![]() ![]() ![]() ![]() |
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: | |
![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Required Pattern: http://hl7.org/fhir/sid/us-ssn (extensions allowed) | |
![]() ![]() ![]() ![]() |
1..1 | string | The value that is unique within the system. Example General: 123456 | |
![]() ![]() |
0..1 | boolean | Whether this patient's record is in active use | |
![]() ![]() |
1..* | HumanName | A name associated with the patient Slice: Unordered, Open by value:use Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..1 | code | The use of a human name Binding: NameUse (required): The use of a human name. | |
![]() ![]() ![]() ![]() |
C | 1..1 | string | Family name (often called 'Surname') |
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | code | When fetus not named use code "unknown" URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required) | |
![]() ![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | code | When fetus not named use code "unknown" URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required) | |
![]() ![]() ![]() ![]() |
0..* | string | Surname suffix This repeating element order: Suffixes appear in the correct order for presenting the name | |
![]() ![]() ![]() |
0..1 | HumanName | current legal name | |
![]() ![]() ![]() ![]() |
1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: official (no extensions allowed) | |
![]() ![]() ![]() ![]() |
C | 1..1 | string | Family name (often called 'Surname') |
![]() ![]() ![]() ![]() |
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 |
![]() ![]() ![]() |
0..1 | HumanName | Name prior to first marriage | |
![]() ![]() ![]() ![]() |
1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: maiden (no extensions allowed) | |
![]() ![]() ![]() ![]() |
C | 1..1 | string | Family name (often called 'Surname') |
![]() ![]() ![]() ![]() |
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 |
![]() ![]() |
0..* | ContactPoint | A contact detail for the individual | |
![]() ![]() ![]() |
C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
![]() ![]() ![]() |
1..1 | string | The actual contact point details | |
![]() ![]() ![]() |
0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) | |
![]() ![]() |
1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required) | |
![]() ![]() |
1..1 | date | The date of birth for the individual | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | partialDateTIme URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-partial-date-time-vr | |
![]() ![]() ![]() ![]() |
0..1 | dateTime | Time of day of birth URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime | |
![]() ![]() ![]() ![]() |
0..1 | (Complex) | BypassEditFlag Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag | |
![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag" | |
![]() ![]() ![]() ![]() ![]() |
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) | |
![]() ![]() |
1..1 | boolean | Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this | |
![]() ![]() ![]() |
C | 1..1 | boolean | The fetus is deceased Constraints: fetalDeathOnlyIfDeceased Required Pattern: true (extensions allowed) |
![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
1..1 | (Complex) | fetal death indicator URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-patient-fetal-death-vr | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-patient-fetal-death-vr" | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | boolean | Value of extension Required Pattern: true (extensions allowed) | |
![]() ![]() |
0..* | Address | An address for the individual | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
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) | |
![]() ![]() ![]() ![]() |
0..1 | string | PreDirectional Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PreDirectional | |
![]() ![]() ![]() ![]() |
0..1 | string | StreetNumber Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetNumber | |
![]() ![]() ![]() ![]() |
0..1 | string | StreetName Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetName | |
![]() ![]() ![]() ![]() |
0..1 | string | StreetDesignator Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetDesignator | |
![]() ![]() ![]() ![]() |
0..1 | string | PostDirectional Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PostDirectional | |
![]() ![]() ![]() ![]() |
0..1 | string | UnitOrAptNumber Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/UnitOrAptNumber | |
![]() ![]() ![]() |
0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | |
![]() ![]() ![]() |
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 | |
![]() ![]() ![]() |
0..1 | string | Name of city, town etc. Example General: Erewhon | |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
0..1 | positiveInt | City Code URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode | |
![]() ![]() ![]() |
0..1 | string | Sub-unit of country (abbreviations ok) Binding: Value Set - States, Territories and Provinces Vital Records (required) | |
![]() ![]() ![]() |
0..1 | string | US Zip Codes Example General: 9132 | |
![]() ![]() ![]() |
0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | |
![]() ![]() |
0..1 | integer | If not single birth - born first, second, third, etc. | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | BypassEditFlag Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag | |
![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag" | |
![]() ![]() ![]() ![]() ![]() |
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) | |
![]() ![]() ![]() ![]() |
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 | |
![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-multipleBirthTotal" | |
![]() ![]() ![]() ![]() ![]() |
1..1 | positiveInt | Plurality | |
![]() ![]() |
0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health | |
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() |
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) | |
![]() ![]() |
0..* | BackboneElement | Link to another patient resource that concerns the same actual person | |
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() |
1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | |
![]() ![]() ![]() |
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 | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Patient.extension:birthsex.value[x] | Base | required | Value Set - Sex Assigned At Birth Vital Records | 📦2.0.0 | Vital Records Common Library v2.0 |
| Patient.extension:birthPlace.value[x].use | Base | required | AddressUse | 📍4.0.1 | FHIR Std. |
| Patient.extension:birthPlace.value[x].state | Base | required | Value Set - States, Territories and Provinces Vital Records | 📦2.0.0 | Vital Records Common Library v2.0 |
| Patient.extension:parentReportedAgeAtDelivery.extension:reportedAge.value[x].comparator | Base | required | QuantityComparator | 📍4.0.1 | FHIR Std. |
| Patient.extension:parentReportedAgeAtDelivery.extension:motherOrFather.value[x] | Base | extensible | Value Set - Role Vital Records | 📦2.0.0 | Vital Records Common Library v2.0 |
| Patient.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Patient.identifier:MRN.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Patient.identifier:MRN.type | Base | extensible | IdentifierType | 📦4.0.1 | FHIR Std. |
| Patient.identifier:SSN.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Patient.identifier:SSN.type | Base | extensible | IdentifierType | 📦4.0.1 | FHIR Std. |
| Patient.name.use | Base | required | NameUse | 📍4.0.1 | FHIR Std. |
| Patient.name:currentLegalName.use | Base | required | NameUse | 📍4.0.1 | FHIR Std. |
| Patient.name:namePriorToFirstMarriage.use | Base | required | NameUse | 📍4.0.1 | FHIR Std. |
| Patient.telecom.system | Base | required | ContactPointSystem | 📦4.0.1 | FHIR Std. |
| Patient.telecom.use | Base | required | ContactPointUse | 📦4.0.1 | FHIR Std. |
| Patient.gender | Base | required | AdministrativeGender | 📦4.0.1 | FHIR Std. |
| Patient.birthDate.extension:bypassEditFlag.value[x] | Base | required | Value Set - Date of Birth Edit Flags (NCHS) Vital Records | 📦2.0.0 | Vital Records Common Library v2.0 |
| Patient.address.use | Base | required | AddressUse | 📍4.0.1 | FHIR Std. |
| Patient.address.state | Base | required | Value Set - States, Territories and Provinces Vital Records | 📦2.0.0 | Vital Records Common Library v2.0 |
| Patient.multipleBirth[x].extension:bypassEditFlag.value[x] | Base | required | Value Set - Plurality Edit Flags (NCHS) Vital Records | 📦2.0.0 | Vital Records Common Library v2.0 |
| Patient.communication.language | Base | extensible | Language codes with language and optionally a region modifier | 📦5.0.1 | US Core v5.0 |
| Patient.link.type | Base | required | LinkType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from PatientVitalRecords
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
0..* | PatientVitalRecords | Information about an individual or animal receiving health care services | |
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
0..1 | USCoreBirthSexExtension | Extension | |
![]() ![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() ![]() |
1..1 | code | Value of extension Binding: Value Set - Sex Assigned At Birth Vital Records (required) | |
![]() ![]() ![]() |
0..1 | PatBirthPlace(5.4.0) | Place of Birth for patient | |
![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | ExtensionDistrictCodeVitalRecords | County | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | State | |
![]() ![]() ![]() |
0..2 | ExtensionReportedParentAgeAtDeliveryVitalRecords | The mother or father's reported age at the time of delivery of the child | |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
1..1 | Extension | Age of the parent at the time of delivery reported by another person. | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Quantity | Parent's reported age | |
![]() ![]() ![]() ![]() ![]() |
1..1 | Extension | Mother or Father | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Indicates mother/Father code | |
![]() ![]() |
1..* | HumanName | A name associated with the patient | |
![]() ![]() ![]() |
0..1 | code | The use of a human name | |
![]() ![]() ![]() |
1..1 | string | Family name (often called 'Surname') | |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
0..1 | DataAbsentReason(5.4.0) | When fetus not named use code "unknown" | |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
0..1 | DataAbsentReason(5.4.0) | When fetus not named use code "unknown" | |
![]() ![]() ![]() |
0..* | string | Surname suffix | |
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
0..1 | HumanName | current legal name | |
![]() ![]() ![]() ![]() |
1..1 | string | Family name (often called 'Surname') | |
![]() ![]() ![]() |
0..1 | HumanName | Name prior to first marriage | |
![]() ![]() ![]() ![]() |
1..1 | string | Family name (often called 'Surname') | |
![]() ![]() |
1..1 | date | The date of birth for the individual | |
![]() ![]() |
1..1 | boolean | Indicates if the individual is deceased or not | |
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
1..1 | boolean | The fetus is deceased Required Pattern: true (extensions allowed) | |
![]() ![]() ![]() ![]() |
1..* | Extension | Extension | |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
1..1 | ExtensionPatientFetalDeathVitalRecords | fetal death indicator | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | boolean | Value of extension Required Pattern: true (extensions allowed) | |
![]() ![]() |
0..1 | integer | If not single birth - born first, second, third, etc. | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..1 | ExtensionBypassEditFlagVitalRecords | BypassEditFlag Vital Records | |
![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | To reflect the relevant edit possibilities for plurality. | |
![]() ![]() ![]() ![]() |
0..1 | PatMultipleBirthTotal(5.4.0) | Where a patient is a part of a multiple delivery, this is the total number of deliveries that occurred in this pregnancy. | |
![]() ![]() ![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() ![]() ![]() |
1..1 | positiveInt | Plurality | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Patient.extension:birthsex.value[x] | Base | required | Value Set - Sex Assigned At Birth Vital Records | 📦2.0.0 | Vital Records Common Library v2.0 |
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | PatientVitalRecords | Information about an individual or animal receiving health care services Constraints: us-core-6 | ||||
![]() ![]() |
0..1 | id | Logical id of this artifact | |||||
![]() ![]() |
0..1 | Meta | Metadata about the resource | |||||
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
0..1 | (Complex) | US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race | |||||
![]() ![]() ![]() |
0..1 | (Complex) | US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity | |||||
![]() ![]() ![]() |
0..1 | (Complex) | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex" | |||||
![]() ![]() ![]() ![]() |
1..1 | code | Value of extension Binding: Value Set - Sex Assigned At Birth Vital Records (required) | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity Binding: Gender Identity (extensible) | |||||
![]() ![]() ![]() |
0..1 | (Complex) | Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace | |||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-birthPlace" | |||||
![]() ![]() ![]() ![]() |
1..1 | Address | Value of extension | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | |||||
![]() ![]() ![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Name of city, town etc. Example General: Erewhon | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | positiveInt | City Code Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | District name (aka county) Example General: Madison | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | positiveInt | County URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/DistrictCode | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | State Binding: Value Set - States, Territories and Provinces Vital Records (required) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
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) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Postal code for area Example General: 9132 | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) Binding: Value Set - Birthplace Country Vital Records (required) | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | |||||
![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
2..3 | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | Extension | Age of the parent at the time of delivery reported by another person. | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "reportedAge" | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Quantity | Parent's reported age | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | decimal | Numerical value (with implicit precision) | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unit representation | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
C | 0..1 | uri | System that defines coded unit form | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | code | year Fixed Value: a (no extensions allowed) | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | Extension | Mother or Father | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "motherOrFather" | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Indicates mother/Father code Binding: Value Set - Role Vital Records (extensible): Vital Records Role | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Extension | Reference to the person who reported the parent's age. | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "reporter" | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Reference(US Core Patient Profile | US Core RelatedPerson Profile) | Value of extension | |||||
![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-reported-parent-age-at-delivery-vr" | |||||
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |||||
![]() ![]() |
1..* | Identifier | An identifier for this patient Slice: Unordered, Open by pattern:type Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |||||
![]() ![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |||||
![]() ![]() ![]() ![]() |
1..1 | string | The value that is unique within the system. Example General: 123456 | |||||
![]() ![]() ![]() ![]() |
0..1 | Period | Time period when id is/was valid for use | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
![]() ![]() ![]() |
0..* | Identifier | Medical Record Number | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |||||
![]() ![]() ![]() ![]() |
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: | |||||
![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |||||
![]() ![]() ![]() ![]() |
1..1 | string | The value that is unique within the system. Example General: 123456 | |||||
![]() ![]() ![]() ![]() |
0..1 | Period | Time period when id is/was valid for use | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
![]() ![]() ![]() |
0..1 | Identifier | SSN if available and appropriate to send | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |||||
![]() ![]() ![]() ![]() |
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: | |||||
![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Required Pattern: http://hl7.org/fhir/sid/us-ssn (extensions allowed) | |||||
![]() ![]() ![]() ![]() |
1..1 | string | The value that is unique within the system. Example General: 123456 | |||||
![]() ![]() ![]() ![]() |
0..1 | Period | Time period when id is/was valid for use | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
![]() ![]() |
0..1 | boolean | Whether this patient's record is in active use | |||||
![]() ![]() |
1..* | HumanName | A name associated with the patient Slice: Unordered, Open by value:use Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..1 | code | The use of a human name Binding: NameUse (required): The use of a human name. | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Text representation of the full name | |||||
![]() ![]() ![]() ![]() |
C | 1..1 | string | Family name (often called 'Surname') | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | code | When fetus not named use code "unknown" URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required) | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
![]() ![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | code | When fetus not named use code "unknown" URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required) | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
![]() ![]() ![]() ![]() |
0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | |||||
![]() ![]() ![]() ![]() |
0..* | string | Surname suffix This repeating element order: Suffixes appear in the correct order for presenting the name | |||||
![]() ![]() ![]() ![]() |
0..1 | Period | Time period when name was/is in use | |||||
![]() ![]() ![]() |
0..1 | HumanName | current legal name | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: official (no extensions allowed) | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Text representation of the full name | |||||
![]() ![]() ![]() ![]() |
C | 1..1 | string | Family name (often called 'Surname') | ||||
![]() ![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() ![]() |
0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | |||||
![]() ![]() ![]() ![]() |
0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | |||||
![]() ![]() ![]() ![]() |
0..1 | Period | Time period when name was/is in use | |||||
![]() ![]() ![]() |
0..1 | HumanName | Name prior to first marriage | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: maiden (no extensions allowed) | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Text representation of the full name | |||||
![]() ![]() ![]() ![]() |
C | 1..1 | string | Family name (often called 'Surname') | ||||
![]() ![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() ![]() |
0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | |||||
![]() ![]() ![]() ![]() |
0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | |||||
![]() ![]() ![]() ![]() |
0..1 | Period | Time period when name was/is in use | |||||
![]() ![]() |
0..* | ContactPoint | A contact detail for the individual | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
![]() ![]() ![]() |
1..1 | string | The actual contact point details | |||||
![]() ![]() ![]() |
0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) | |||||
![]() ![]() ![]() |
0..1 | positiveInt | Specify preferred order of use (1 = highest) | |||||
![]() ![]() ![]() |
0..1 | Period | Time period when the contact point was/is in use | |||||
![]() ![]() |
1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required) | |||||
![]() ![]() |
1..1 | date | The date of birth for the individual | |||||
![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | partialDateTIme URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-partial-date-time-vr | |||||
![]() ![]() ![]() ![]() |
0..1 | dateTime | Time of day of birth URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime | |||||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | BypassEditFlag Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag" | |||||
![]() ![]() ![]() ![]() ![]() |
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) | |||||
![]() ![]() ![]() |
0..1 | date | Primitive value for date | |||||
![]() ![]() |
1..1 | boolean | Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this | |||||
![]() ![]() ![]() |
C | 1..1 | boolean | The fetus is deceased Constraints: fetalDeathOnlyIfDeceased Required Pattern: true (extensions allowed) | ||||
![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | (Complex) | fetal death indicator URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-patient-fetal-death-vr | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-patient-fetal-death-vr" | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | boolean | Value of extension Required Pattern: true (extensions allowed) | |||||
![]() ![]() ![]() ![]() |
0..1 | boolean | Primitive value for boolean | |||||
![]() ![]() |
0..* | Address | An address for the individual | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
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) | |||||
![]() ![]() ![]() ![]() |
0..1 | string | PreDirectional Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PreDirectional | |||||
![]() ![]() ![]() ![]() |
0..1 | string | StreetNumber Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetNumber | |||||
![]() ![]() ![]() ![]() |
0..1 | string | StreetName Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetName | |||||
![]() ![]() ![]() ![]() |
0..1 | string | StreetDesignator Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetDesignator | |||||
![]() ![]() ![]() ![]() |
0..1 | string | PostDirectional Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PostDirectional | |||||
![]() ![]() ![]() ![]() |
0..1 | string | UnitOrAptNumber Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/UnitOrAptNumber | |||||
![]() ![]() ![]() |
0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | |||||
![]() ![]() ![]() |
0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | |||||
![]() ![]() ![]() |
0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | |||||
![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() |
0..1 | string | Name of city, town etc. Example General: Erewhon | |||||
![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | positiveInt | City Code URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
![]() ![]() ![]() |
0..1 | string | District name (aka county) Example General: Madison | |||||
![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | positiveInt | County code URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/DistrictCode | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
![]() ![]() ![]() |
0..1 | string | Sub-unit of country (abbreviations ok) Binding: Value Set - States, Territories and Provinces Vital Records (required) | |||||
![]() ![]() ![]() |
0..1 | string | US Zip Codes Example General: 9132 | |||||
![]() ![]() ![]() |
0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) Binding: Value Set - Residence Country Vital Records (required) | |||||
![]() ![]() ![]() |
0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | |||||
![]() ![]() |
0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person. | |||||
![]() ![]() |
0..1 | integer | If not single birth - born first, second, third, etc. | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | BypassEditFlag Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag" | |||||
![]() ![]() ![]() ![]() ![]() |
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) | |||||
![]() ![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-multipleBirthTotal" | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | positiveInt | Plurality | |||||
![]() ![]() |
0..* | Attachment | Image of the patient | |||||
![]() ![]() |
C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1 | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. | |||||
![]() ![]() ![]() |
0..1 | HumanName | A name associated with the contact person | |||||
![]() ![]() ![]() |
0..* | ContactPoint | A contact detail for the person | |||||
![]() ![]() ![]() |
0..1 | Address | Address for the contact person | |||||
![]() ![]() ![]() |
0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |||||
![]() ![]() ![]() |
C | 0..1 | Reference(Organization) | Organization that is associated with the contact | ||||
![]() ![]() ![]() |
0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |||||
![]() ![]() |
0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() |
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) | |||||
![]() ![]() ![]() |
0..1 | boolean | Language preference indicator | |||||
![]() ![]() |
0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider | |||||
![]() ![]() |
0..1 | Reference(Organization) | Organization that is the custodian of the patient record | |||||
![]() ![]() |
0..* | BackboneElement | Link to another patient resource that concerns the same actual person | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() |
1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | |||||
![]() ![]() ![]() |
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 | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Patient.language | Base | preferred | Common Languages | 📦4.0.1 | FHIR Std. |
| Patient.extension:birthsex.value[x] | Base | required | Value Set - Sex Assigned At Birth Vital Records | 📦2.0.0 | Vital Records Common Library v2.0 |
| Patient.extension:birthPlace.value[x].use | Base | required | AddressUse | 📍4.0.1 | FHIR Std. |
| Patient.extension:birthPlace.value[x].type | Base | required | AddressType | 📍4.0.1 | FHIR Std. |
| Patient.extension:birthPlace.value[x].state | Base | required | Value Set - States, Territories and Provinces Vital Records | 📦2.0.0 | Vital Records Common Library v2.0 |
| Patient.extension:birthPlace.value[x].country | Base | required | Value Set - Birthplace Country Vital Records | 📦2.0.0 | Vital Records Common Library v2.0 |
| Patient.extension:parentReportedAgeAtDelivery.extension:reportedAge.value[x].comparator | Base | required | QuantityComparator | 📍4.0.1 | FHIR Std. |
| Patient.extension:parentReportedAgeAtDelivery.extension:motherOrFather.value[x] | Base | extensible | Value Set - Role Vital Records | 📦2.0.0 | Vital Records Common Library v2.0 |
| Patient.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Patient.identifier.type | Base | extensible | IdentifierType | 📦4.0.1 | FHIR Std. |
| Patient.identifier:MRN.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Patient.identifier:MRN.type | Base | extensible | IdentifierType | 📦4.0.1 | FHIR Std. |
| Patient.identifier:SSN.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Patient.identifier:SSN.type | Base | extensible | IdentifierType | 📦4.0.1 | FHIR Std. |
| Patient.name.use | Base | required | NameUse | 📍4.0.1 | FHIR Std. |
| Patient.name:currentLegalName.use | Base | required | NameUse | 📍4.0.1 | FHIR Std. |
| Patient.name:namePriorToFirstMarriage.use | Base | required | NameUse | 📍4.0.1 | FHIR Std. |
| Patient.telecom.system | Base | required | ContactPointSystem | 📦4.0.1 | FHIR Std. |
| Patient.telecom.use | Base | required | ContactPointUse | 📦4.0.1 | FHIR Std. |
| Patient.gender | Base | required | AdministrativeGender | 📦4.0.1 | FHIR Std. |
| Patient.birthDate.extension:bypassEditFlag.value[x] | Base | required | Value Set - Date of Birth Edit Flags (NCHS) Vital Records | 📦2.0.0 | Vital Records Common Library v2.0 |
| Patient.address.use | Base | required | AddressUse | 📍4.0.1 | FHIR Std. |
| Patient.address.type | Base | required | AddressType | 📍4.0.1 | FHIR Std. |
| Patient.address.state | Base | required | Value Set - States, Territories and Provinces Vital Records | 📦2.0.0 | Vital Records Common Library v2.0 |
| Patient.address.country | Base | required | Value Set - Residence Country Vital Records | 📦2.0.0 | Vital Records Common Library v2.0 |
| Patient.maritalStatus | Base | extensible | MaritalStatus | 📦4.0.1 | FHIR Std. |
| Patient.multipleBirth[x].extension:bypassEditFlag.value[x] | Base | required | Value Set - Plurality Edit Flags (NCHS) Vital Records | 📦2.0.0 | Vital Records Common Library v2.0 |
| Patient.contact.relationship | Base | extensible | Patient Contact Relationship | 📦4.0.1 | FHIR Std. |
| Patient.contact.gender | Base | required | AdministrativeGender | 📍4.0.1 | FHIR Std. |
| Patient.communication.language | Base | extensible | Language codes with language and optionally a region modifier | 📦5.0.1 | US Core v5.0 |
| Patient.link.type | Base | required | LinkType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from PatientVitalRecords
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | PatientVitalRecords | Information about an individual or animal receiving health care services Constraints: us-core-6 |
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
0..1 | (Complex) | US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race | |
![]() ![]() ![]() |
0..1 | (Complex) | US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity | |
![]() ![]() ![]() |
0..1 | (Complex) | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex | |
![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex" | |
![]() ![]() ![]() ![]() |
1..1 | code | Value of extension Binding: Value Set - Sex Assigned At Birth Vital Records (required) | |
![]() ![]() ![]() |
0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity Binding: Gender Identity (extensible) | |
![]() ![]() ![]() |
0..1 | (Complex) | Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace | |
![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-birthPlace" | |
![]() ![]() ![]() ![]() |
1..1 | Address | Value of extension | |
![]() ![]() ![]() ![]() ![]() |
0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | State Binding: Value Set - States, Territories and Provinces Vital Records (required) | |
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
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) | |
![]() ![]() ![]() |
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 | |
![]() ![]() ![]() ![]() |
2..3 | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
1..1 | Extension | Age of the parent at the time of delivery reported by another person. | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "reportedAge" | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Quantity | Parent's reported age | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | decimal | Numerical value (with implicit precision) | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | code | year Fixed Value: a (no extensions allowed) | |
![]() ![]() ![]() ![]() ![]() |
1..1 | Extension | Mother or Father | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "motherOrFather" | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Indicates mother/Father code Binding: Value Set - Role Vital Records (extensible): Vital Records Role | |
![]() ![]() ![]() ![]() ![]() |
0..1 | Extension | Reference to the person who reported the parent's age. | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "reporter" | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Reference(US Core Patient Profile | US Core RelatedPerson Profile) | Value of extension | |
![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-reported-parent-age-at-delivery-vr" | |
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |
![]() ![]() |
1..* | Identifier | An identifier for this patient Slice: Unordered, Open by pattern:type Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |
![]() ![]() ![]() ![]() |
1..1 | string | The value that is unique within the system. Example General: 123456 | |
![]() ![]() ![]() |
0..* | Identifier | Medical Record Number | |
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
![]() ![]() ![]() ![]() |
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: | |
![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |
![]() ![]() ![]() ![]() |
1..1 | string | The value that is unique within the system. Example General: 123456 | |
![]() ![]() ![]() |
0..1 | Identifier | SSN if available and appropriate to send | |
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |
![]() ![]() ![]() ![]() |
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: | |
![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Required Pattern: http://hl7.org/fhir/sid/us-ssn (extensions allowed) | |
![]() ![]() ![]() ![]() |
1..1 | string | The value that is unique within the system. Example General: 123456 | |
![]() ![]() |
0..1 | boolean | Whether this patient's record is in active use | |
![]() ![]() |
1..* | HumanName | A name associated with the patient Slice: Unordered, Open by value:use Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..1 | code | The use of a human name Binding: NameUse (required): The use of a human name. | |
![]() ![]() ![]() ![]() |
C | 1..1 | string | Family name (often called 'Surname') |
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | code | When fetus not named use code "unknown" URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required) | |
![]() ![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | code | When fetus not named use code "unknown" URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required) | |
![]() ![]() ![]() ![]() |
0..* | string | Surname suffix This repeating element order: Suffixes appear in the correct order for presenting the name | |
![]() ![]() ![]() |
0..1 | HumanName | current legal name | |
![]() ![]() ![]() ![]() |
1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: official (no extensions allowed) | |
![]() ![]() ![]() ![]() |
C | 1..1 | string | Family name (often called 'Surname') |
![]() ![]() ![]() ![]() |
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 |
![]() ![]() ![]() |
0..1 | HumanName | Name prior to first marriage | |
![]() ![]() ![]() ![]() |
1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: maiden (no extensions allowed) | |
![]() ![]() ![]() ![]() |
C | 1..1 | string | Family name (often called 'Surname') |
![]() ![]() ![]() ![]() |
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 |
![]() ![]() |
0..* | ContactPoint | A contact detail for the individual | |
![]() ![]() ![]() |
C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
![]() ![]() ![]() |
1..1 | string | The actual contact point details | |
![]() ![]() ![]() |
0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) | |
![]() ![]() |
1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required) | |
![]() ![]() |
1..1 | date | The date of birth for the individual | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | partialDateTIme URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-partial-date-time-vr | |
![]() ![]() ![]() ![]() |
0..1 | dateTime | Time of day of birth URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime | |
![]() ![]() ![]() ![]() |
0..1 | (Complex) | BypassEditFlag Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag | |
![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag" | |
![]() ![]() ![]() ![]() ![]() |
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) | |
![]() ![]() |
1..1 | boolean | Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this | |
![]() ![]() ![]() |
C | 1..1 | boolean | The fetus is deceased Constraints: fetalDeathOnlyIfDeceased Required Pattern: true (extensions allowed) |
![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
1..1 | (Complex) | fetal death indicator URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-patient-fetal-death-vr | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-patient-fetal-death-vr" | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | boolean | Value of extension Required Pattern: true (extensions allowed) | |
![]() ![]() |
0..* | Address | An address for the individual | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
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) | |
![]() ![]() ![]() ![]() |
0..1 | string | PreDirectional Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PreDirectional | |
![]() ![]() ![]() ![]() |
0..1 | string | StreetNumber Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetNumber | |
![]() ![]() ![]() ![]() |
0..1 | string | StreetName Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetName | |
![]() ![]() ![]() ![]() |
0..1 | string | StreetDesignator Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetDesignator | |
![]() ![]() ![]() ![]() |
0..1 | string | PostDirectional Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PostDirectional | |
![]() ![]() ![]() ![]() |
0..1 | string | UnitOrAptNumber Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/UnitOrAptNumber | |
![]() ![]() ![]() |
0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | |
![]() ![]() ![]() |
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 | |
![]() ![]() ![]() |
0..1 | string | Name of city, town etc. Example General: Erewhon | |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
0..1 | positiveInt | City Code URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode | |
![]() ![]() ![]() |
0..1 | string | Sub-unit of country (abbreviations ok) Binding: Value Set - States, Territories and Provinces Vital Records (required) | |
![]() ![]() ![]() |
0..1 | string | US Zip Codes Example General: 9132 | |
![]() ![]() ![]() |
0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | |
![]() ![]() |
0..1 | integer | If not single birth - born first, second, third, etc. | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | BypassEditFlag Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag | |
![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag" | |
![]() ![]() ![]() ![]() ![]() |
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) | |
![]() ![]() ![]() ![]() |
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 | |
![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-multipleBirthTotal" | |
![]() ![]() ![]() ![]() ![]() |
1..1 | positiveInt | Plurality | |
![]() ![]() |
0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health | |
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() |
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) | |
![]() ![]() |
0..* | BackboneElement | Link to another patient resource that concerns the same actual person | |
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() |
1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | |
![]() ![]() ![]() |
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 | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Patient.extension:birthsex.value[x] | Base | required | Value Set - Sex Assigned At Birth Vital Records | 📦2.0.0 | Vital Records Common Library v2.0 |
| Patient.extension:birthPlace.value[x].use | Base | required | AddressUse | 📍4.0.1 | FHIR Std. |
| Patient.extension:birthPlace.value[x].state | Base | required | Value Set - States, Territories and Provinces Vital Records | 📦2.0.0 | Vital Records Common Library v2.0 |
| Patient.extension:parentReportedAgeAtDelivery.extension:reportedAge.value[x].comparator | Base | required | QuantityComparator | 📍4.0.1 | FHIR Std. |
| Patient.extension:parentReportedAgeAtDelivery.extension:motherOrFather.value[x] | Base | extensible | Value Set - Role Vital Records | 📦2.0.0 | Vital Records Common Library v2.0 |
| Patient.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Patient.identifier:MRN.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Patient.identifier:MRN.type | Base | extensible | IdentifierType | 📦4.0.1 | FHIR Std. |
| Patient.identifier:SSN.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Patient.identifier:SSN.type | Base | extensible | IdentifierType | 📦4.0.1 | FHIR Std. |
| Patient.name.use | Base | required | NameUse | 📍4.0.1 | FHIR Std. |
| Patient.name:currentLegalName.use | Base | required | NameUse | 📍4.0.1 | FHIR Std. |
| Patient.name:namePriorToFirstMarriage.use | Base | required | NameUse | 📍4.0.1 | FHIR Std. |
| Patient.telecom.system | Base | required | ContactPointSystem | 📦4.0.1 | FHIR Std. |
| Patient.telecom.use | Base | required | ContactPointUse | 📦4.0.1 | FHIR Std. |
| Patient.gender | Base | required | AdministrativeGender | 📦4.0.1 | FHIR Std. |
| Patient.birthDate.extension:bypassEditFlag.value[x] | Base | required | Value Set - Date of Birth Edit Flags (NCHS) Vital Records | 📦2.0.0 | Vital Records Common Library v2.0 |
| Patient.address.use | Base | required | AddressUse | 📍4.0.1 | FHIR Std. |
| Patient.address.state | Base | required | Value Set - States, Territories and Provinces Vital Records | 📦2.0.0 | Vital Records Common Library v2.0 |
| Patient.multipleBirth[x].extension:bypassEditFlag.value[x] | Base | required | Value Set - Plurality Edit Flags (NCHS) Vital Records | 📦2.0.0 | Vital Records Common Library v2.0 |
| Patient.communication.language | Base | extensible | Language codes with language and optionally a region modifier | 📦5.0.1 | US Core v5.0 |
| Patient.link.type | Base | required | LinkType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
Differential View
This structure is derived from PatientVitalRecords
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
0..* | PatientVitalRecords | Information about an individual or animal receiving health care services | |
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
0..1 | USCoreBirthSexExtension | Extension | |
![]() ![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() ![]() |
1..1 | code | Value of extension Binding: Value Set - Sex Assigned At Birth Vital Records (required) | |
![]() ![]() ![]() |
0..1 | PatBirthPlace(5.4.0) | Place of Birth for patient | |
![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | ExtensionDistrictCodeVitalRecords | County | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | State | |
![]() ![]() ![]() |
0..2 | ExtensionReportedParentAgeAtDeliveryVitalRecords | The mother or father's reported age at the time of delivery of the child | |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
1..1 | Extension | Age of the parent at the time of delivery reported by another person. | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Quantity | Parent's reported age | |
![]() ![]() ![]() ![]() ![]() |
1..1 | Extension | Mother or Father | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Indicates mother/Father code | |
![]() ![]() |
1..* | HumanName | A name associated with the patient | |
![]() ![]() ![]() |
0..1 | code | The use of a human name | |
![]() ![]() ![]() |
1..1 | string | Family name (often called 'Surname') | |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
0..1 | DataAbsentReason(5.4.0) | When fetus not named use code "unknown" | |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
0..1 | DataAbsentReason(5.4.0) | When fetus not named use code "unknown" | |
![]() ![]() ![]() |
0..* | string | Surname suffix | |
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
0..1 | HumanName | current legal name | |
![]() ![]() ![]() ![]() |
1..1 | string | Family name (often called 'Surname') | |
![]() ![]() ![]() |
0..1 | HumanName | Name prior to first marriage | |
![]() ![]() ![]() ![]() |
1..1 | string | Family name (often called 'Surname') | |
![]() ![]() |
1..1 | date | The date of birth for the individual | |
![]() ![]() |
1..1 | boolean | Indicates if the individual is deceased or not | |
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
1..1 | boolean | The fetus is deceased Required Pattern: true (extensions allowed) | |
![]() ![]() ![]() ![]() |
1..* | Extension | Extension | |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
1..1 | ExtensionPatientFetalDeathVitalRecords | fetal death indicator | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | boolean | Value of extension Required Pattern: true (extensions allowed) | |
![]() ![]() |
0..1 | integer | If not single birth - born first, second, third, etc. | |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..1 | ExtensionBypassEditFlagVitalRecords | BypassEditFlag Vital Records | |
![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | To reflect the relevant edit possibilities for plurality. | |
![]() ![]() ![]() ![]() |
0..1 | PatMultipleBirthTotal(5.4.0) | Where a patient is a part of a multiple delivery, this is the total number of deliveries that occurred in this pregnancy. | |
![]() ![]() ![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() ![]() ![]() |
1..1 | positiveInt | Plurality | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Patient.extension:birthsex.value[x] | Base | required | Value Set - Sex Assigned At Birth Vital Records | 📦2.0.0 | Vital Records Common Library v2.0 |
Snapshot ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | PatientVitalRecords | Information about an individual or animal receiving health care services Constraints: us-core-6 | ||||
![]() ![]() |
0..1 | id | Logical id of this artifact | |||||
![]() ![]() |
0..1 | Meta | Metadata about the resource | |||||
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
0..1 | (Complex) | US Core Race Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race | |||||
![]() ![]() ![]() |
0..1 | (Complex) | US Core ethnicity Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity | |||||
![]() ![]() ![]() |
0..1 | (Complex) | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex" | |||||
![]() ![]() ![]() ![]() |
1..1 | code | Value of extension Binding: Value Set - Sex Assigned At Birth Vital Records (required) | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity Binding: Gender Identity (extensible) | |||||
![]() ![]() ![]() |
0..1 | (Complex) | Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace | |||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-birthPlace" | |||||
![]() ![]() ![]() ![]() |
1..1 | Address | Value of extension | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | |||||
![]() ![]() ![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Name of city, town etc. Example General: Erewhon | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | positiveInt | City Code Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | District name (aka county) Example General: Madison | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | positiveInt | County URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/DistrictCode | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | State Binding: Value Set - States, Territories and Provinces Vital Records (required) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
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) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Postal code for area Example General: 9132 | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) Binding: Value Set - Birthplace Country Vital Records (required) | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | |||||
![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
2..3 | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | Extension | Age of the parent at the time of delivery reported by another person. | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "reportedAge" | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Quantity | Parent's reported age | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | decimal | Numerical value (with implicit precision) | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | code | < | <= | >= | > - how to understand the value Binding: QuantityComparator (required): How the Quantity should be understood and represented. | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unit representation | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
C | 0..1 | uri | System that defines coded unit form | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | code | year Fixed Value: a (no extensions allowed) | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | Extension | Mother or Father | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "motherOrFather" | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Indicates mother/Father code Binding: Value Set - Role Vital Records (extensible): Vital Records Role | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Extension | Reference to the person who reported the parent's age. | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "reporter" | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Reference(US Core Patient Profile | US Core RelatedPerson Profile) | Value of extension | |||||
![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-reported-parent-age-at-delivery-vr" | |||||
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |||||
![]() ![]() |
1..* | Identifier | An identifier for this patient Slice: Unordered, Open by pattern:type Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |||||
![]() ![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |||||
![]() ![]() ![]() ![]() |
1..1 | string | The value that is unique within the system. Example General: 123456 | |||||
![]() ![]() ![]() ![]() |
0..1 | Period | Time period when id is/was valid for use | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
![]() ![]() ![]() |
0..* | Identifier | Medical Record Number | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |||||
![]() ![]() ![]() ![]() |
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: | |||||
![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |||||
![]() ![]() ![]() ![]() |
1..1 | string | The value that is unique within the system. Example General: 123456 | |||||
![]() ![]() ![]() ![]() |
0..1 | Period | Time period when id is/was valid for use | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
![]() ![]() ![]() |
0..1 | Identifier | SSN if available and appropriate to send | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |||||
![]() ![]() ![]() ![]() |
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: | |||||
![]() ![]() ![]() ![]() |
1..1 | uri | The namespace for the identifier value Required Pattern: http://hl7.org/fhir/sid/us-ssn (extensions allowed) | |||||
![]() ![]() ![]() ![]() |
1..1 | string | The value that is unique within the system. Example General: 123456 | |||||
![]() ![]() ![]() ![]() |
0..1 | Period | Time period when id is/was valid for use | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
![]() ![]() |
0..1 | boolean | Whether this patient's record is in active use | |||||
![]() ![]() |
1..* | HumanName | A name associated with the patient Slice: Unordered, Open by value:use Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..1 | code | The use of a human name Binding: NameUse (required): The use of a human name. | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Text representation of the full name | |||||
![]() ![]() ![]() ![]() |
C | 1..1 | string | Family name (often called 'Surname') | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | code | When fetus not named use code "unknown" URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required) | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
![]() ![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | code | When fetus not named use code "unknown" URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required) | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
![]() ![]() ![]() ![]() |
0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | |||||
![]() ![]() ![]() ![]() |
0..* | string | Surname suffix This repeating element order: Suffixes appear in the correct order for presenting the name | |||||
![]() ![]() ![]() ![]() |
0..1 | Period | Time period when name was/is in use | |||||
![]() ![]() ![]() |
0..1 | HumanName | current legal name | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: official (no extensions allowed) | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Text representation of the full name | |||||
![]() ![]() ![]() ![]() |
C | 1..1 | string | Family name (often called 'Surname') | ||||
![]() ![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() ![]() |
0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | |||||
![]() ![]() ![]() ![]() |
0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | |||||
![]() ![]() ![]() ![]() |
0..1 | Period | Time period when name was/is in use | |||||
![]() ![]() ![]() |
0..1 | HumanName | Name prior to first marriage | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: maiden (no extensions allowed) | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Text representation of the full name | |||||
![]() ![]() ![]() ![]() |
C | 1..1 | string | Family name (often called 'Surname') | ||||
![]() ![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() ![]() |
0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | |||||
![]() ![]() ![]() ![]() |
0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | |||||
![]() ![]() ![]() ![]() |
0..1 | Period | Time period when name was/is in use | |||||
![]() ![]() |
0..* | ContactPoint | A contact detail for the individual | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
![]() ![]() ![]() |
1..1 | string | The actual contact point details | |||||
![]() ![]() ![]() |
0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) | |||||
![]() ![]() ![]() |
0..1 | positiveInt | Specify preferred order of use (1 = highest) | |||||
![]() ![]() ![]() |
0..1 | Period | Time period when the contact point was/is in use | |||||
![]() ![]() |
1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required) | |||||
![]() ![]() |
1..1 | date | The date of birth for the individual | |||||
![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | partialDateTIme URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-partial-date-time-vr | |||||
![]() ![]() ![]() ![]() |
0..1 | dateTime | Time of day of birth URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime | |||||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | BypassEditFlag Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag" | |||||
![]() ![]() ![]() ![]() ![]() |
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) | |||||
![]() ![]() ![]() |
0..1 | date | Primitive value for date | |||||
![]() ![]() |
1..1 | boolean | Indicates if the individual is deceased or not Slice: Unordered, Closed by type:$this | |||||
![]() ![]() ![]() |
C | 1..1 | boolean | The fetus is deceased Constraints: fetalDeathOnlyIfDeceased Required Pattern: true (extensions allowed) | ||||
![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | (Complex) | fetal death indicator URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-patient-fetal-death-vr | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-patient-fetal-death-vr" | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | boolean | Value of extension Required Pattern: true (extensions allowed) | |||||
![]() ![]() ![]() ![]() |
0..1 | boolean | Primitive value for boolean | |||||
![]() ![]() |
0..* | Address | An address for the individual | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
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) | |||||
![]() ![]() ![]() ![]() |
0..1 | string | PreDirectional Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PreDirectional | |||||
![]() ![]() ![]() ![]() |
0..1 | string | StreetNumber Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetNumber | |||||
![]() ![]() ![]() ![]() |
0..1 | string | StreetName Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetName | |||||
![]() ![]() ![]() ![]() |
0..1 | string | StreetDesignator Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetDesignator | |||||
![]() ![]() ![]() ![]() |
0..1 | string | PostDirectional Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PostDirectional | |||||
![]() ![]() ![]() ![]() |
0..1 | string | UnitOrAptNumber Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/UnitOrAptNumber | |||||
![]() ![]() ![]() |
0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | |||||
![]() ![]() ![]() |
0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | |||||
![]() ![]() ![]() |
0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | |||||
![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() |
0..1 | string | Name of city, town etc. Example General: Erewhon | |||||
![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | positiveInt | City Code URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
![]() ![]() ![]() |
0..1 | string | District name (aka county) Example General: Madison | |||||
![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | positiveInt | County code URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/DistrictCode | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Primitive value for string Max Length:1048576 | |||||
![]() ![]() ![]() |
0..1 | string | Sub-unit of country (abbreviations ok) Binding: Value Set - States, Territories and Provinces Vital Records (required) | |||||
![]() ![]() ![]() |
0..1 | string | US Zip Codes Example General: 9132 | |||||
![]() ![]() ![]() |
0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) Binding: Value Set - Residence Country Vital Records (required) | |||||
![]() ![]() ![]() |
0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | |||||
![]() ![]() |
0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person. | |||||
![]() ![]() |
0..1 | integer | If not single birth - born first, second, third, etc. | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | BypassEditFlag Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag" | |||||
![]() ![]() ![]() ![]() ![]() |
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) | |||||
![]() ![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-multipleBirthTotal" | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | positiveInt | Plurality | |||||
![]() ![]() |
0..* | Attachment | Image of the patient | |||||
![]() ![]() |
C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1 | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. | |||||
![]() ![]() ![]() |
0..1 | HumanName | A name associated with the contact person | |||||
![]() ![]() ![]() |
0..* | ContactPoint | A contact detail for the person | |||||
![]() ![]() ![]() |
0..1 | Address | Address for the contact person | |||||
![]() ![]() ![]() |
0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |||||
![]() ![]() ![]() |
C | 0..1 | Reference(Organization) | Organization that is associated with the contact | ||||
![]() ![]() ![]() |
0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |||||
![]() ![]() |
0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() |
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) | |||||
![]() ![]() ![]() |
0..1 | boolean | Language preference indicator | |||||
![]() ![]() |
0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider | |||||
![]() ![]() |
0..1 | Reference(Organization) | Organization that is the custodian of the patient record | |||||
![]() ![]() |
0..* | BackboneElement | Link to another patient resource that concerns the same actual person | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() |
1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | |||||
![]() ![]() ![]() |
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 | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Patient.language | Base | preferred | Common Languages | 📦4.0.1 | FHIR Std. |
| Patient.extension:birthsex.value[x] | Base | required | Value Set - Sex Assigned At Birth Vital Records | 📦2.0.0 | Vital Records Common Library v2.0 |
| Patient.extension:birthPlace.value[x].use | Base | required | AddressUse | 📍4.0.1 | FHIR Std. |
| Patient.extension:birthPlace.value[x].type | Base | required | AddressType | 📍4.0.1 | FHIR Std. |
| Patient.extension:birthPlace.value[x].state | Base | required | Value Set - States, Territories and Provinces Vital Records | 📦2.0.0 | Vital Records Common Library v2.0 |
| Patient.extension:birthPlace.value[x].country | Base | required | Value Set - Birthplace Country Vital Records | 📦2.0.0 | Vital Records Common Library v2.0 |
| Patient.extension:parentReportedAgeAtDelivery.extension:reportedAge.value[x].comparator | Base | required | QuantityComparator | 📍4.0.1 | FHIR Std. |
| Patient.extension:parentReportedAgeAtDelivery.extension:motherOrFather.value[x] | Base | extensible | Value Set - Role Vital Records | 📦2.0.0 | Vital Records Common Library v2.0 |
| Patient.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Patient.identifier.type | Base | extensible | IdentifierType | 📦4.0.1 | FHIR Std. |
| Patient.identifier:MRN.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Patient.identifier:MRN.type | Base | extensible | IdentifierType | 📦4.0.1 | FHIR Std. |
| Patient.identifier:SSN.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Patient.identifier:SSN.type | Base | extensible | IdentifierType | 📦4.0.1 | FHIR Std. |
| Patient.name.use | Base | required | NameUse | 📍4.0.1 | FHIR Std. |
| Patient.name:currentLegalName.use | Base | required | NameUse | 📍4.0.1 | FHIR Std. |
| Patient.name:namePriorToFirstMarriage.use | Base | required | NameUse | 📍4.0.1 | FHIR Std. |
| Patient.telecom.system | Base | required | ContactPointSystem | 📦4.0.1 | FHIR Std. |
| Patient.telecom.use | Base | required | ContactPointUse | 📦4.0.1 | FHIR Std. |
| Patient.gender | Base | required | AdministrativeGender | 📦4.0.1 | FHIR Std. |
| Patient.birthDate.extension:bypassEditFlag.value[x] | Base | required | Value Set - Date of Birth Edit Flags (NCHS) Vital Records | 📦2.0.0 | Vital Records Common Library v2.0 |
| Patient.address.use | Base | required | AddressUse | 📍4.0.1 | FHIR Std. |
| Patient.address.type | Base | required | AddressType | 📍4.0.1 | FHIR Std. |
| Patient.address.state | Base | required | Value Set - States, Territories and Provinces Vital Records | 📦2.0.0 | Vital Records Common Library v2.0 |
| Patient.address.country | Base | required | Value Set - Residence Country Vital Records | 📦2.0.0 | Vital Records Common Library v2.0 |
| Patient.maritalStatus | Base | extensible | MaritalStatus | 📦4.0.1 | FHIR Std. |
| Patient.multipleBirth[x].extension:bypassEditFlag.value[x] | Base | required | Value Set - Plurality Edit Flags (NCHS) Vital Records | 📦2.0.0 | Vital Records Common Library v2.0 |
| Patient.contact.relationship | Base | extensible | Patient Contact Relationship | 📦4.0.1 | FHIR Std. |
| Patient.contact.gender | Base | required | AdministrativeGender | 📍4.0.1 | FHIR Std. |
| Patient.communication.language | Base | extensible | Language codes with language and optionally a region modifier | 📦5.0.1 | US Core v5.0 |
| Patient.link.type | Base | required | LinkType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from PatientVitalRecords
Other representations of profile: CSV, Excel, Schematron