This page is part of the Vital Records Birth and Fetal Death Reporting (v2.0.0-ballot: STU 2 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 1.1.0. For a full list of available versions, see the Directory of published versions
Official URL: http://hl7.org/fhir/us/bfdr/StructureDefinition/Patient-decedent-fetus | Version: 2.0.0-ballot | |||
Draft as of 2023-12-18 | Computable Name: PatientDecedentFetus |
A stillborn for whom clinical data is included in the report.
Profile conformance requires that gender be provided, see note on patient gender(https://hl7.org/fhir/us/vr-common-library/2024Jan/usage.html#gender).
Use Case | # | Description | IJE Name | Field | Type | Value Set/Comments |
---|---|---|---|---|---|---|
Fetal Death | 1 | Date of Delivery (Fetus)--Year | FDOD_YR | birthDate | 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[patient-birthPlace].value[x].state | codeable | ValueSetJurisdictionVitalRecords |
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 | ValueSetBirthSexFetusVitalRecords |
Fetal Death | 8 | Date of Delivery (Fetus)--Month | FDOD_MO | birthDate | date | See note on birth date and time |
Fetal Death | 9 | Date of Delivery (Fetus)--Day | FDOD_DY | birthDate | date | See note on birth date and time |
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 | PluralityEditFlagsVS, 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 | - | Report of Fetal Death |
3 | Sex | - | Report of Fetal Death |
4 | Date of Delivery | birthDate | Report of Fetal Death |
5a | City, Town, or Location of Delivery | - | Report of Fetal Death |
5b | Zip Code of Delivery | - | Report of Fetal Death |
6 | County of Delivery | - | 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 | - | Facility Worksheet for the Report of Fetal Death |
4 | County of delivery | - | 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 | - | Facility Worksheet for the Report of Fetal Death |
21 | Sex | - | Facility Worksheet for the Report of Fetal Death |
22 | Plurality | - | 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 | |||
extension | 1..* | Extension | Extension | |
extension:birthsex | 0..1 | USCoreBirthSexExtension | Extension | |
extension | 0..0 | |||
value[x] | 1..1 | code | Value of extension Binding: ValueSet - Birth Sex Fetus Vital Records (required) | |
extension:birthPlace | S | 0..1 | birthPlace | Place of Birth for patient |
extension:parentReportedAgeAtDelivery | S | 0..2 | ExtensionReportedParentAgeAtDeliveryVitalRecords | The mother or father's reported age at the time of delivery of the child |
extension:fetalDeath | S | 1..1 | ExtensionPatientFetalDeathVitalRecords | fetal-death |
name | 1..* | HumanName | A name associated with the patient | |
family | ||||
extension:dataAbsentReason | 0..1 | Data Absent Reason | When fetus not named use code "unknown" | |
given | ||||
extension:dataAbsentReason | 0..1 | Data Absent Reason | When fetus not named use code "unknown" | |
birthDate | 1..1 | date | The date of birth for the individual | |
extension:partialDateTime | S | 0..1 | ExtensionPartialDateTimeVitalRecords | Partial Date Time |
extension:birthTime | S | 0..1 | birthTime | Time of day of birth |
deceased[x] | S | 1..1 | boolean | Indicates if the individual is deceased or not, dateTime is preferred Fixed Value: true |
multipleBirth[x] | S | 0..1 | integer | If not single birth - born first, second, third, etc. |
extension:bypassEditFlag | 0..1 | ExtensionBypassEditFlagVitalRecords | Extension - BypassEditFlag Vital Records | |
value[x] | 1..1 | CodeableConcept | To reflect the relevant edit possibilities for plurality. | |
extension:multipleBirthTotal | S | 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. |
Documentation for this format |
Path | Conformance | ValueSet |
Patient.extension:birthsex.value[x] | required | ValueSetBirthSexFetusVitalRecords |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | C | 0..* | PatientVitalRecords | Information about an individual or animal receiving health care services |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | 1..* | 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 | code | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex Binding: Birth Sex (required): Code for sex assigned at birth | |
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: ValueSet - Birth Sex Fetus Vital Records (required) | |
genderIdentity | 0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity Binding: Gender Identity (extensible) | |
birthPlace | S | 0..1 | Address | 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 |
parentReportedAgeAtDelivery | S | 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 |
fetalDeath | S | 1..1 | Coding | fetal-death URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-patient-fetal-death-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 | ?!Σ | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. |
family | SΣC | 1..1 | string | Family name (often called 'Surname') |
dataAbsentReason | 0..1 | code | When fetus not named use code "unknown" URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. | |
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 |
dataAbsentReason | 0..1 | code | When fetus not named use code "unknown" URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. | |
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 |
partialDateTime | S | 0..1 | (Complex) | Partial Date Time URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/ExtensionPartialDateTimeVitalRecords |
birthTime | S | 0..1 | dateTime | Time of day of birth URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime |
bypassEditFlag | 0..1 | CodeableConcept | Extension - 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: ValueSet - Mothers Date of Birth Edit Flags (NCHS) Vital Records (required): Date of Birth Edit Flags (NCHS) | |
deceased[x] | ?!SΣ | 1..1 | boolean | Indicates if the individual is deceased or not, dateTime is preferred Fixed Value: true |
address | SΣ | 0..* | Address | An address for the individual |
withinCityLimitsIndicator | 0..1 | Coding | Used to indicate whether or not an address is within city limits. URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-within-city-limits-indicator-vr Binding: ValueSet - Yes No Unknown Vital Records (required): Yes No Unknown (YNU) | |
predir | 0..1 | string | Extension - PreDirectional Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PreDirectional | |
stnum | 0..1 | string | Extension - StreetNumber Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetNumber | |
stname | 0..1 | string | Extension - StreetName Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetName | |
stdesig | 0..1 | string | Extension - StreetDesignator Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetDesignator | |
postdir | 0..1 | string | Extension - PostDirectional Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PostDirectional | |
unitnumber | 0..1 | string | Extension - UnitOrAptNumber Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/UnitOrAptNumber | |
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
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 |
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: ValueSet - 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] | S | 0..1 | integer | If not single birth - born first, second, third, etc. |
bypassEditFlag | 0..1 | CodeableConcept | Extension - 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: ValueSet - Plurality Edit Flags (NCHS) Vital Records (required): Plurality Edit Flags (NCHS) | |
multipleBirthTotal | S | 0..1 | positiveInt | 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 |
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 |
Patient.extension:birthsex.value[x] | required | ValueSetBirthSexFetusVitalRecords |
Patient.extension:birthPlace.value[x].use | required | AddressUse |
Patient.identifier.use | required | IdentifierUse |
Patient.identifier:MRN.use | required | IdentifierUse |
Patient.identifier:MRN.type | extensible | Pattern: MR |
Patient.identifier:SSN.use | required | IdentifierUse |
Patient.identifier:SSN.type | extensible | Pattern: SS |
Patient.name.use | required | NameUse |
Patient.name:currentLegalName.use | required | Fixed Value: official |
Patient.name:namePriorToFirstMarriage.use | required | Fixed Value: maiden |
Patient.telecom.system | required | ContactPointSystem |
Patient.telecom.use | required | ContactPointUse |
Patient.gender | required | AdministrativeGender |
Patient.birthDate.extension:bypassEditFlag.value[x] | required | ValueSetMothersDateOfBirthEditFlagsVitalRecords |
Patient.address.use | required | AddressUse |
Patient.address.state | required | ValueSetStatesTerritoriesAndProvincesVitalRecords |
Patient.multipleBirth[x].extension:bypassEditFlag.value[x] | required | ValueSetPluralityEditFlagsVitalRecords |
Patient.communication.language | extensible | LanguageCodesWithLanguageAndOptionallyARegionModifier |
Patient.link.type | required | LinkType |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Patient | C | 0..* | PatientVitalRecords | Information about an individual or animal receiving health care services | ||||
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 | 1..* | 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 | code | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex Binding: Birth Sex (required): Code for sex assigned at birth | |||||
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: ValueSet - Birth Sex Fetus Vital Records (required) | |||||
genderIdentity | 0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity Binding: Gender Identity (extensible) | |||||
birthPlace | S | 0..1 | Address | Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/patient-birthPlace" | |||||
value[x] | 1..1 | Address | Value of extension | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | ||||
type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | ||||
text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
line | Σ | 0..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street | ||||
city | Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
cityCode | 0..1 | positiveInt | Extension - City Code Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode | |||||
value | 0..1 | string | Primitive value for string Max Length: 1048576 | |||||
district | Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
districtCode | 0..1 | positiveInt | County code URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/DistrictCode | |||||
value | 0..1 | string | Primitive value for string Max Length: 1048576 | |||||
state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: ValueSet - Jurisdictions Vital Records (required) | ||||
postalCode | Σ | 0..1 | string | Postal code for area Example General: 9132 | ||||
country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) Binding: ValueSet - Birthplace Country Vital Records (required) | ||||
period | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
parentReportedAgeAtDelivery | S | 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 | ||||
fetalDeath | S | 1..1 | Coding | fetal-death URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-patient-fetal-death-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 | ?!Σ | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | ||||
text | Σ | 0..1 | string | Text representation of the full name | ||||
family | SΣC | 1..1 | string | Family name (often called 'Surname') | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
dataAbsentReason | 0..1 | code | When fetus not named use code "unknown" URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. | |||||
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): Used to specify why the normally expected content of the data element is missing. | |||||
value | 0..1 | string | Primitive value for string Max Length: 1048576 | |||||
prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
period | Σ | 0..1 | Period | Time period when name was/is in use | ||||
name:currentLegalName | SΣ | 0..1 | HumanName | current legal name | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: official | ||||
text | Σ | 0..1 | string | Text representation of the full name | ||||
family | SΣC | 1..1 | string | Family name (often called 'Surname') | ||||
given | SΣC | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name | ||||
prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
period | Σ | 0..1 | Period | Time period when name was/is in use | ||||
name:namePriorToFirstMarriage | SΣ | 0..1 | HumanName | Name prior to first marriage | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: maiden | ||||
text | Σ | 0..1 | string | Text representation of the full name | ||||
family | SΣC | 1..1 | string | Family name (often called 'Surname') | ||||
given | SΣC | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name | ||||
prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
period | Σ | 0..1 | Period | Time period when name was/is in use | ||||
telecom | Σ | 0..* | ContactPoint | A contact detail for the individual | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
value | SΣ | 1..1 | string | The actual contact point details | ||||
use | ?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) | ||||
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
gender | SΣ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required) | ||||
birthDate | SΣ | 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 | S | 0..1 | (Complex) | Partial Date Time URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/ExtensionPartialDateTimeVitalRecords | ||||
birthTime | S | 0..1 | dateTime | Time of day of birth URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime | ||||
bypassEditFlag | 0..1 | CodeableConcept | Extension - BypassEditFlag Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag" | |||||
value[x] | 1..1 | CodeableConcept | To reflect the relevant edit possibilities for date of birth. Binding: ValueSet - Mothers Date of Birth Edit Flags (NCHS) Vital Records (required): Date of Birth Edit Flags (NCHS) | |||||
value | 0..1 | date | Primitive value for date | |||||
deceased[x] | ?!SΣ | 1..1 | boolean | Indicates if the individual is deceased or not, dateTime is preferred Fixed Value: true | ||||
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: ValueSet - Yes No Unknown Vital Records (required): Yes No Unknown (YNU) | |||||
predir | 0..1 | string | Extension - PreDirectional Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PreDirectional | |||||
stnum | 0..1 | string | Extension - StreetNumber Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetNumber | |||||
stname | 0..1 | string | Extension - StreetName Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetName | |||||
stdesig | 0..1 | string | Extension - StreetDesignator Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetDesignator | |||||
postdir | 0..1 | string | Extension - PostDirectional Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PostDirectional | |||||
unitnumber | 0..1 | string | Extension - UnitOrAptNumber Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/UnitOrAptNumber | |||||
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | ||||
type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | ||||
text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
line | SΣ | 0..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street | ||||
city | SΣ | 0..1 | string | Name of city, town etc. Example General: Erewhon | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
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: ValueSet - 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: ValueSet - Residence Country Vital Records (required) | ||||
period | SΣ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
maritalStatus | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person. | |||||
multipleBirth[x] | S | 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 | CodeableConcept | Extension - BypassEditFlag Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag" | |||||
value[x] | 1..1 | CodeableConcept | To reflect the relevant edit possibilities for plurality. Binding: ValueSet - Plurality Edit Flags (NCHS) Vital Records (required): Plurality Edit Flags (NCHS) | |||||
multipleBirthTotal | S | 0..1 | positiveInt | 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 | ||||
photo | 0..* | Attachment | Image of the patient | |||||
contact | C | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient | ||||
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 | ||||
Patient.language | preferred | CommonLanguages
| ||||
Patient.extension:birthsex.value[x] | required | ValueSetBirthSexFetusVitalRecords | ||||
Patient.extension:birthPlace.value[x].use | required | AddressUse | ||||
Patient.extension:birthPlace.value[x].type | required | AddressType | ||||
Patient.extension:birthPlace.value[x].state | required | ValueSetJurisdictionVitalRecords | ||||
Patient.extension:birthPlace.value[x].country | required | ValueSetBirthplaceCountryVitalRecords | ||||
Patient.identifier.use | required | IdentifierUse | ||||
Patient.identifier.type | extensible | Identifier Type Codes | ||||
Patient.identifier:MRN.use | required | IdentifierUse | ||||
Patient.identifier:MRN.type | extensible | Pattern: MR | ||||
Patient.identifier:SSN.use | required | IdentifierUse | ||||
Patient.identifier:SSN.type | extensible | Pattern: SS | ||||
Patient.name.use | required | NameUse | ||||
Patient.name:currentLegalName.use | required | Fixed Value: official | ||||
Patient.name:namePriorToFirstMarriage.use | required | Fixed Value: maiden | ||||
Patient.telecom.system | required | ContactPointSystem | ||||
Patient.telecom.use | required | ContactPointUse | ||||
Patient.gender | required | AdministrativeGender | ||||
Patient.birthDate.extension:bypassEditFlag.value[x] | required | ValueSetMothersDateOfBirthEditFlagsVitalRecords | ||||
Patient.address.use | required | AddressUse | ||||
Patient.address.type | required | AddressType | ||||
Patient.address.state | required | ValueSetStatesTerritoriesAndProvincesVitalRecords | ||||
Patient.address.country | required | ValueSetResidenceCountryVitalRecords | ||||
Patient.maritalStatus | extensible | Marital Status Codes | ||||
Patient.multipleBirth[x].extension:bypassEditFlag.value[x] | required | ValueSetPluralityEditFlagsVitalRecords | ||||
Patient.contact.relationship | extensible | PatientContactRelationship | ||||
Patient.contact.gender | required | AdministrativeGender | ||||
Patient.communication.language | extensible | LanguageCodesWithLanguageAndOptionallyARegionModifier | ||||
Patient.link.type | required | LinkType |
This structure is derived from PatientVitalRecords
Differential View
This structure is derived from PatientVitalRecords
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | PatientVitalRecords | |||
extension | 1..* | Extension | Extension | |
extension:birthsex | 0..1 | USCoreBirthSexExtension | Extension | |
extension | 0..0 | |||
value[x] | 1..1 | code | Value of extension Binding: ValueSet - Birth Sex Fetus Vital Records (required) | |
extension:birthPlace | S | 0..1 | birthPlace | Place of Birth for patient |
extension:parentReportedAgeAtDelivery | S | 0..2 | ExtensionReportedParentAgeAtDeliveryVitalRecords | The mother or father's reported age at the time of delivery of the child |
extension:fetalDeath | S | 1..1 | ExtensionPatientFetalDeathVitalRecords | fetal-death |
name | 1..* | HumanName | A name associated with the patient | |
family | ||||
extension:dataAbsentReason | 0..1 | Data Absent Reason | When fetus not named use code "unknown" | |
given | ||||
extension:dataAbsentReason | 0..1 | Data Absent Reason | When fetus not named use code "unknown" | |
birthDate | 1..1 | date | The date of birth for the individual | |
extension:partialDateTime | S | 0..1 | ExtensionPartialDateTimeVitalRecords | Partial Date Time |
extension:birthTime | S | 0..1 | birthTime | Time of day of birth |
deceased[x] | S | 1..1 | boolean | Indicates if the individual is deceased or not, dateTime is preferred Fixed Value: true |
multipleBirth[x] | S | 0..1 | integer | If not single birth - born first, second, third, etc. |
extension:bypassEditFlag | 0..1 | ExtensionBypassEditFlagVitalRecords | Extension - BypassEditFlag Vital Records | |
value[x] | 1..1 | CodeableConcept | To reflect the relevant edit possibilities for plurality. | |
extension:multipleBirthTotal | S | 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. |
Documentation for this format |
Path | Conformance | ValueSet |
Patient.extension:birthsex.value[x] | required | ValueSetBirthSexFetusVitalRecords |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | C | 0..* | PatientVitalRecords | Information about an individual or animal receiving health care services |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | 1..* | 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 | code | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex Binding: Birth Sex (required): Code for sex assigned at birth | |
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: ValueSet - Birth Sex Fetus Vital Records (required) | |
genderIdentity | 0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity Binding: Gender Identity (extensible) | |
birthPlace | S | 0..1 | Address | 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 |
parentReportedAgeAtDelivery | S | 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 |
fetalDeath | S | 1..1 | Coding | fetal-death URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-patient-fetal-death-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 | ?!Σ | 1..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. |
family | SΣC | 1..1 | string | Family name (often called 'Surname') |
dataAbsentReason | 0..1 | code | When fetus not named use code "unknown" URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. | |
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 |
dataAbsentReason | 0..1 | code | When fetus not named use code "unknown" URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing. | |
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 |
partialDateTime | S | 0..1 | (Complex) | Partial Date Time URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/ExtensionPartialDateTimeVitalRecords |
birthTime | S | 0..1 | dateTime | Time of day of birth URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime |
bypassEditFlag | 0..1 | CodeableConcept | Extension - 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: ValueSet - Mothers Date of Birth Edit Flags (NCHS) Vital Records (required): Date of Birth Edit Flags (NCHS) | |
deceased[x] | ?!SΣ | 1..1 | boolean | Indicates if the individual is deceased or not, dateTime is preferred Fixed Value: true |
address | SΣ | 0..* | Address | An address for the individual |
withinCityLimitsIndicator | 0..1 | Coding | Used to indicate whether or not an address is within city limits. URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-within-city-limits-indicator-vr Binding: ValueSet - Yes No Unknown Vital Records (required): Yes No Unknown (YNU) | |
predir | 0..1 | string | Extension - PreDirectional Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PreDirectional | |
stnum | 0..1 | string | Extension - StreetNumber Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetNumber | |
stname | 0..1 | string | Extension - StreetName Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetName | |
stdesig | 0..1 | string | Extension - StreetDesignator Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetDesignator | |
postdir | 0..1 | string | Extension - PostDirectional Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PostDirectional | |
unitnumber | 0..1 | string | Extension - UnitOrAptNumber Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/UnitOrAptNumber | |
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
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 |
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: ValueSet - 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] | S | 0..1 | integer | If not single birth - born first, second, third, etc. |
bypassEditFlag | 0..1 | CodeableConcept | Extension - 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: ValueSet - Plurality Edit Flags (NCHS) Vital Records (required): Plurality Edit Flags (NCHS) | |
multipleBirthTotal | S | 0..1 | positiveInt | 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 |
communication | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health | |