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