Vital Records Common Library (VRCL) FHIR Implementation Guide, published by HL7 International / Public Health. This guide is not an authorized publication; it is the continuous build for version 2.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/vr-common-library/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Patient-mother-vr | Version: 2.0.0 | |||
Active as of 2024-10-11 | Computable Name: PatientMotherVitalRecords |
This Patient profile represents the woman who gave birth to, or delivered the infant.
Note: The PatientMother profile is based on the US Core Patient Profile which requires gender. A value of 'unknown' will satisfy this requirement. Complete vital record submissions may fail FHIR validation due to lack of a value for gender.
Use Case | # | Description | IJE Name | Field | Type | Value Set/Comments |
---|---|---|---|---|---|---|
Natality | 14 | Date of Birth (Mother)--Year | MDOB_YR | birthDate.value | date | See PartialDatesAndTimes |
Natality | 15 | Date of Birth (Mother)--Month | MDOB_MO | birthDate.value | date | See PartialDatesAndTimes |
Natality | 16 | Date of Birth (Mother)--Day | MDOB_DY | birthDate.value | date | See PartialDatesAndTimes |
Natality | 17 | Date of Birth (Mother)--Edit Flag | MAGE_BYPASS | birthDate.extension[bypassEditFlag].value | codeable | ValueSetDateOfBirthEditFlagsVitalRecords, See Handling of edit flags |
Natality | 18 | State, U.S. Territory or Canadian Province of Birth (Mother) - code | BPLACEC_ST_TER | extension[birthPlace].value[x].state | string | ValueSetStatesTerritoriesAndProvincesVitalRecords |
Natality | 19 | Birthplace of Mother--Country | BPLACEC_CNT | extension[birthPlace].value[x].country | string | ValueSetResidenceCountryVitalRecords |
Natality | 20 | Residence of Mother--City | CITYC | address.city.extension[cityCode] | integer | See CityCodes |
Natality | 21 | Residence of Mother--County | COUNTYC | address.district.extension[districtCode] | integer | See CountyCodes |
Natality | 22 | State, U.S. Territory or Canadian Province of Residence (Mother) - code | STATEC | address.state | string | ValueSetStatesTerritoriesAndProvincesVitalRecords |
Natality | 23 | Residence of Mother--Country | COUNTRYC | address.country | string | ValueSetResidenceCountryVitalRecords |
Natality | 24 | Residence of Mother--Inside City Limits | LIMITS | address.extension[withinCityLimitsIndicator].value | codeable | ValueSetYesNoUnknownVitalRecords |
Natality | 254 | Mother's First Name | MOMFNAME | name.given, name.use = official |
string | |
Natality | 255 | Mother's Middle Name | MOMMIDDL | name.given, name.use = official |
string | |
Natality | 256 | Mother's Last Name | MOMLNAME | name.family, name.use = official |
string | |
Natality | 257 | Mother's Surname Suffix | MOMSUFFX | name.suffix, name.use = official |
string | |
Natality | 258 | Mother's First Maiden Name | MOMFMNME | name.given, name.use = maiden |
string | |
Natality | 259 | Mother's Middle Maiden Name | MOMMMID | name.given, name.use = maiden |
string | |
Natality | 260 | Mother's Maiden Surname | MOMMAIDN | name.family, name.use = maiden |
string | |
Natality | 261 | Mother's Maiden Surname Suffix | MOMMSUFX | name.suffix, name.use = maiden |
string | |
Natality | Gender | *NO IJE MAPPING* | gender | codeable | USCorePatient requires gender - can be 'unknown'. See [Note on Gender] | |
Natality | 262 | Residence Street Number | STNUM | address.extension[stnum] | string | |
Natality | 263 | Residence Pre Directional | PREDIR | address.extension[predir] | string | |
Natality | 264 | Residence Street name | STNAME | address.extension[stname] | string | |
Natality | 265 | Residence Street designator | STDESIG | address.extension[stdesig] | string | |
Natality | 266 | Residence Post Directional | POSTDIR | address.extension[postdir] | string | |
Natality | 267 | Residence Unit or Apartment Number | UNUM | address.extension[unitnum] | string | |
Natality | 268 | Mother's Residence Street Address | ADDRESS | address.line | string | |
Natality | 269 | Mother's Residence Zip Code and Zip+4 | ZIPCODE | address.postalCode | string | |
Natality | 270 | Mother's Residence County (Literal) | COUNTYTXT | address.district | string | |
Natality | 271 | Mother's Residence City/Town (Literal) | CITYTEXT | address.city | string | |
Natality | 272 | State, U.S. Territory or Canadian Province of Residence (Mother) - literal | STATETXT | address.state (expanded from 2 letter code) | string | See StateLiterals |
Natality | 273 | Mother's Residence Country (Literal) | CNTRYTXT | address.country (expanded from 2 letter code) | string | See CountryLiterals |
Natality | 278 | Mother's Social Security Number | MOM_SSN | identifier.value where system = ‘http://terminology.hl7.org/CodeSystem/v2-0203' and type.coding.code=”SS” |
string | |
Natality | 305 | State, U.S. Territory or Canadian Province of Birth (Mother) - literal | MBPLACE_ST_TER_TXT | extension[patient-birthPlace].value[x].state | string | See StateLiterals |
Natality | 306 | Mother's Country of Birth (Literal) | MBPLACE_CNTRY_TXT | extension[patient-birthPlace].value[x].country (expanded from 2 letter code) | string | See CountryLiterals |
Natality | 309 | Mother's Mailing Address Street number | MAIL_STNUM | address.extension[stnum] | string | |
Natality | 310 | Mother's Mailing Address Pre Directional | MAIL_PREDIR | address.extension[predir] | string | |
Natality | 311 | Mother's Mailing Address Street name | MAIL_STNAME | address.extension[stname] | string | |
Natality | 312 | Mother's Mailing Address Street designator | MAIL_STDESIG | address.extension[stdesig] | string | |
Natality | 313 | Mother's Mailing Address Post Directional | MAIL_POSTDIR | address.extension[postdir] | string | |
Natality | 314 | Mother's Mailing Address Unit or Apartment Number | MAIL_UNUM | address.extension[unitnum] | string | |
Natality | 315 | Mother's Mailing Address Street Address | MAIL_ADDRESS | address.line | string | |
Natality | 316 | Mother's Mailing Address Zip Code and Zip+4 | MAIL_ZIPCODE | address.postalCode | string | |
Natality | 317 | Mother's Mailing Address County (Literal) | MAIL_COUNTYTXT | address.district | string | |
Natality | 318 | Mother's Mailing Address City/Town (Literal) | MAIL_CITYTEXT | address.city | string | |
Natality | 319 | Mother's Mailing Address State (Literal) | MAIL_STATETXT | address.state (expanded from 2 letter code) | string | See StateLiterals |
Natality | 320 | Mother's Mailing Address Country (Literal) | MAIL_CNTRYTXT | address.country (expanded from 2 letter code) | string | See CountryLiterals |
Natality | 333 | Mother's Medical Record Number | MOM_MED_REC_NUM | identifier.value where system = ‘http://terminology.hl7.org/CodeSystem/v2-0203' and type.coding.code=”MR” |
string | |
Natality | 340 | For use of jurisdictions with domestic partnerships, othertypes of relationships. | MARITAL_DESCRIP | maritalStatus.text | string |
Use Case | # | Description | IJE Name | Field | Type | Value Set/Comments |
---|---|---|---|---|---|---|
Fetal Death | 14 | Date of Birth (Mother)--Year | MDOB_YR | birthDate.value | date | See PartialDatesAndTimes |
Fetal Death | 15 | Date of Birth (Mother)--Month | MDOB_MO | birthDate.value | date | See PartialDatesAndTimes |
Fetal Death | 16 | Date of Birth (Mother)--Day | MDOB_DY | birthDate.value | date | See PartialDatesAndTimes |
Fetal Death | 17 | Date of Birth (Mother)--Edit Flag | MAGE_BYPASS | birthDate.extension[bypassEditFlag].value | codeable | ValueSetDateOfBirthEditFlagsVitalRecords, See Handling of edit flags |
Fetal Death | 18 | State, U.S. Territory or Canadian Province of Birth (Mother) - code | BPLACEC_ST_TER | extension[birthPlace].value[x].state | string | ValueSetStatesTerritoriesAndProvincesVitalRecords |
Fetal Death | 19 | Mother's Birthplace--Country | BPLACEC_CNT | extension[birthPlace].value[x].country | string | ValueSetResidenceCountryVitalRecords |
Fetal Death | 20 | Residence of Mother--City/Town | CITYC | address.city.extension[cityCode] | integer | See CityCodes |
Fetal Death | 21 | Residence of Mother--County | COUNTYC | address.district.extension[districtCode] | integer | See CountyCodes |
Fetal Death | 22 | State, U.S. Territory or Canadian Province of Residence (Mother) - code | STATEC | address.state | string | ValueSetStatesTerritoriesAndProvincesVitalRecords |
Fetal Death | 23 | Residence of Mother--Country | COUNTRYC | address.country | string | ValueSetResidenceCountryVitalRecords |
Fetal Death | 24 | Residence of Mother--Inside City/Town Limits | LIMITS | address.extension[withinCityLimitsIndicator].value | codeable | ValueSetYesNoUnknownVitalRecords |
Fetal Death | 239 | Mother's Legal First Name | MOMFNAME | name.given, name.use = official |
string | |
Fetal Death | 240 | Mother's Legal Middle Name | MOMMNAME | name.given, name.use = official |
string | |
Fetal Death | 241 | Mother's Legal Last Name | MOMLNAME | name.family, name.use = official |
string | |
Fetal Death | 242 | Mother's Legal Surname Suffix | MOMSUFFIX | name.suffix, name.use = official |
string | |
Fetal Death | 243 | Mother's First Maiden Name | MOMFMNME | name.given, name.use = maiden |
string | |
Fetal Death | 244 | Mother's Middle Maiden Name | MOMMMID | name.given, name.use = maiden |
string | |
Fetal Death | 245 | Mother's Last Maiden Name | MOMMAIDN | name.family, name.use = maiden |
string | |
Fetal Death | 246 | Mother's Maiden Surname Suffix | MOMMSUFFIX | name.suffix, name.use = maiden |
string | |
Fetal Death | Gender | *NO IJE MAPPING* | gender | codeable | USCorePatient requires gender - can be 'unknown'. See [Note on Gender] | |
Fetal Death | 247 | Mother's Residence Street number | STNUM | address.extension[stnum] | string | |
Fetal Death | 248 | Mother's Residence Pre Directional | PREDIR | address.extension[predir] | string | |
Fetal Death | 249 | Mother's Residence Street name | STNAME | address.extension[stname] | string | |
Fetal Death | 250 | Mother's Residence Street designator | STDESIG | address.extension[stdesig] | string | |
Fetal Death | 251 | Mother's Residence Post Directional | POSTDIR | address.extension[postdir] | string | |
Fetal Death | 252 | Mother's Residence Unit or Apartment Number | APTNUMB | address.extension[unitnum] | string | |
Fetal Death | 253 | Mother's Residence Street Address | ADDRESS | address.line | string | |
Fetal Death | 254 | Mother's Residence Zip code and Zip+4 | ZIPCODE | address.postalCode | string | |
Fetal Death | 255 | Mother's Residence County (literal) | COUNTYTXT | address.district | string | |
Fetal Death | 256 | Mother's Residence City/Town/Place (literal) | CITYTXT | address.city | string | |
Fetal Death | 257 | State, U.S. Territory or Canadian Province of Residence (Mother) - literal | STATETXT | address.state (expanded from 2 letter code) | string | See StateLiterals |
Fetal Death | 258 | Mother's Residence Country (literal) | CNTRYTXT | address.country (expanded from 2 letter code) | string | See CountryLiterals |
Fetal Death | 265 | Mother's Social Security Number | MOM_SSN | identifier.value where system = ‘http://terminology.hl7.org/CodeSystem/v2-0203' and type.coding.code=”SS” |
string | |
Fetal Death | 279 | State, U.S. Territory or Canadian Province of Birth (Mother) - literal | MBPLACE_ST_TER_TXT | extension[patient-birthPlace].value[x].state | string | See StateLiterals |
Fetal Death | 280 | Mother's Country of Birth (Literal) | MBPLACE_CNTRY_TXT | extension[patient-birthPlace].value[x].country (expanded from 2 letter code) | string | See CountryLiterals |
Item # | Form Field | FHIR Profile Field | Reference |
---|---|---|---|
8a | Mother’s Current Legal Name | name:currentLegalName | Certificate of Live Birth |
8b | Mother’s Date Of Birth | birthDate | Certificate of Live Birth |
8c | Mother’s Name Prior To First Marriage | name:namePriorToFirstMarriage | Certificate of Live Birth |
8d | Mother’s Birthplace | extension:birthPlace | Certificate of Live Birth |
9a | Residence of Mother - State | address.state | Certificate of Live Birth |
9b | Mother’s County | address.district | Certificate of Live Birth |
9c | Mother’s City, Town, or Location | address.city | Certificate of Live Birth |
9d | Mother’s Street And Number | address.line | Certificate of Live Birth |
9e | Mother’s Apt. No. | address.line | Certificate of Live Birth |
9f | Mother’s Zip Code | address.postalCode | Certificate of Live Birth |
9g | Mother’s Residence Inside City Limits? | extension:withinCityLimitsIndicator | Certificate of Live Birth |
14 | Mother’s Mailing Address | address | Certificate of Live Birth |
18 | Mother’s Social Security Number | identifier:SSN | Certificate of Live Birth |
40 | Mother’s Medical Record Number | identifier:MRN | Certificate of Live Birth |
- | Mother’s medical record # | identifier:MRN | Facility Worksheet for the Live Birth Certificate |
- | Mother’s name | name:currentLegalName | Facility Worksheet for the Live Birth Certificate |
- | Mother’s medical record # | identifier:MRN | Attachment to the Facility Worksheet for the Live Birth Certificate for Multiple Births |
- | Mother’s name | name:currentLegalName | Attachment to the Facility Worksheet for the Live Birth Certificate for Multiple Births |
1 | What is your current legal name? | name:currentLegalName | Mothers Worksheet for Child’s Birth Certificate |
3 | Where do you usually live--that is--where is your household/residence located? | address | Mothers Worksheet for Child’s Birth Certificate |
4 | Is this household inside city limits? | extension:withinCityLimitsIndicator | Mothers Worksheet for Child’s Birth Certificate |
5 | What is your mailing address? | address | Mothers Worksheet for Child’s Birth Certificate |
6 | What is your date of birth? | birthDate | Mothers Worksheet for Child’s Birth Certificate |
7 | In what State, U.S. territory, or foreign country were you born? | extension:birthPlace | Mothers Worksheet for Child’s Birth Certificate |
17 | What name did you use prior to your first marriage? | name:namePriorToFirstMarriage | Mothers Worksheet for Child’s Birth Certificate |
25a | What is your Social Security Number? | identifier:SSN | Mothers Worksheet for Child’s Birth Certificate |
10a | Mother’s Current Legal Name | name:currentLegalName | Report of Fetal Death |
10b | Mother's Date of Birth | birthDate | Report of Fetal Death |
10c | Mother’s Name Prior to First Marriage | name:namePriorToFirstMarriage | Report of Fetal Death |
10d | Mother's Birthplace | extension:birthPlace | Report of Fetal Death |
11a | Residence of Mother-State | address.state | Report of Fetal Death |
11b | Residence of Mother-County | address.district | Report of Fetal Death |
11c | Residence of Mother-City, Town, Or Location | address.city | Report of Fetal Death |
11d | Residence of Mother-Street And Number | address.line | Report of Fetal Death |
11e | Residence of Mother-Apt. No. | address.line | Report of Fetal Death |
11f | Residence of Mother-Zip Code | address.postalCode | Report of Fetal Death |
11g | Residence of Mother-Inside City Limits? | extension:withinCityLimitsIndicator | Report of Fetal Death |
- | Patient’s medical record # | identifier:MRN | Facility Worksheet for the Report of Fetal Death |
- | Patient’s name | name:currentLegalName | Facility Worksheet for the Report of Fetal Death |
- | Patient’s Medical Record # | identifier:MRN | Patient’s Worksheet for the Report of Fetal Death |
- | Patient’s Name | name:currentLegalName | Patient’s Worksheet for the Report of Fetal Death |
2 | What is your current legal name? | name:currentLegalName | Patient’s Worksheet for the Report of Fetal Death |
3 | Where do you usually live (household/residence location)? | address | Patient’s Worksheet for the Report of Fetal Death |
4 | Is this household inside city limits? | extension:withinCityLimitsIndicator | Patient’s Worksheet for the Report of Fetal Death |
5 | What is your mailing address? | address | Patient’s Worksheet for the Report of Fetal Death |
6 | What is your date of birth? | birthDate | Patient’s Worksheet for the Report of Fetal Death |
7 | In what State, U.S. territory, or foreign country were you born? | extension:birthPlace | 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:birthPlace | 0..1 | PatBirthPlace(5.1.0) | Place of Birth for patient | |
value[x] | ||||
state | 0..1 | string | State, territory, province code | |
country | 0..1 | string | Country code | |
Slices for identifier | Content/Rules for all slices | |||
identifier:MRN | S | 0..* | Identifier | Medical Record Number |
type | ||||
coding | ||||
code | 0..1 | code | Code type | |
value | 1..1 | string | Medical Record no. | |
identifier:SSN | S | 0..1 | Identifier | SSN if available and appropriate to send |
type | ||||
coding | ||||
code | 0..1 | code | Code type | |
value | 1..1 | string | Social Security no. | |
name | 1..* | HumanName | A name associated with the patient | |
use | 0..1 | code | The use of a human name | |
family | 1..1 | string | Surname | |
given | 0..* | string | Given name | |
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 | |
Slices for extension | Content/Rules for all slices | |||
extension:bypassEditFlag | 0..1 | ExtensionBypassEditFlagVitalRecords | To reflect the relevant edit possibilities for Mother's date of birth. | |
value[x] | 1..1 | CodeableConcept | Date edit | |
deceased[x] | 0..1 | boolean, dateTime | Indicates if the individual is deceased or not, dateTime is preferred | |
address | ||||
Slices for extension | Content/Rules for all slices | |||
extension:withinCityLimitsIndicator | 0..1 | ExtensionWithinCityLimitsIndicatorVitalRecords | Within City Limits Indicator Vital Records | |
value[x] | 1..1 | Coding | Residence inside city limits | |
extension:predir | 0..1 | ExtensionPreDirectionalVitalRecords | Residence predirectional | |
extension:stnum | 0..1 | ExtensionStreetNumberVitalRecords | Residence street number | |
extension:stname | 0..1 | ExtensionStreetNameVitalRecords | Residence street name | |
extension:stdesig | 0..1 | ExtensionStreetDesignatorVitalRecords | Residence street designator | |
extension:postdir | 0..1 | ExtensionPostDirectionalVitalRecords | Residence postdirectional | |
extension:unitnumber | 0..1 | ExtensionUnitOrAptNumberVitalRecords | Residence unit no. | |
line | 0..* | string | Street address | |
city | 0..1 | string | City literal | |
Slices for extension | Content/Rules for all slices | |||
extension:cityCode | 0..1 | ExtensionCityCodeVitalRecords | city code | |
district | 0..1 | string | County literal | |
Slices for extension | Content/Rules for all slices | |||
extension:districtCode | 0..1 | ExtensionDistrictCodeVitalRecords | county code | |
state | 0..1 | string | State | |
postalCode | 0..1 | string | Zip code | |
country | 0..1 | string | Country | |
maritalStatus | ||||
text | 0..1 | string | marital status desc | |
Slices for link | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person Slice: Unordered, Open by pattern:type | |
link:mother | 0..1 | BackboneElement | Link to the birth mother's RelatedPerson record | |
other | 1..1 | Reference(RelatedPerson - Mother Vital Records) | The other patient or related person resource that the link refers to | |
type | 1..1 | code | replaced-by | replaces | refer | seealso Required Pattern: seealso | |
Documentation for this format |
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 | code | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex Binding: Birth Sex (required): Code for sex assigned at birth | |
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, territory, province code 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) | |
country | Σ | 0..1 | string | Country code Binding: Value Set - Birthplace Country Vital Records (required) |
parentReportedAgeAtDelivery | 0..2 | (Complex) | Extension - Reported Parent Age at Delivery - Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-reported-parent-age-at-delivery-vr | |
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: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 | Medical Record no. 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 | Social Security no. 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 | Surname |
Slices for extension | Content/Rules for all slices | |||
dataAbsentReason | 0..1 | code | unknown | asked | temp | notasked | masked | unsupported | astext | error URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason Binding: DataAbsentReason (required) | |
given | SΣC | 0..* | string | Given name 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 | unknown | asked | temp | notasked | masked | unsupported | astext | error 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) | To reflect the relevant edit possibilities for Mother's date of birth. 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 | Date edit Binding: Value Set - Date of Birth Edit Flags (NCHS) Vital Records (required): Date of Birth Edit Flags (NCHS) | |
Slices for deceased[x] | ?!Σ | 0..1 | Indicates if the individual is deceased or not, dateTime is preferred Slice: Unordered, Closed by type:$this | |
deceasedBoolean | boolean | |||
deceasedDateTime | dateTime | |||
deceased[x]:deceasedBoolean | ?!ΣC | 0..1 | boolean | Boolean indicator. True if the individual is deceased. fetalDeathOnlyIfDeceased: Fetal death should only be indicated if Patient is deceased. |
Slices for extension | Content/Rules for all slices | |||
fetalDeath | 0..1 | boolean | Boolean indicator. True if the Patient died as a fetus. URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-patient-fetal-death-vr | |
address | SΣ | 0..* | Address | An address for the individual |
Slices for extension | Content/Rules for all slices | |||
withinCityLimitsIndicator | 0..1 | (Complex) | Within City Limits Indicator Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-within-city-limits-indicator-vr | |
extension | 0..0 | |||
url | 1..1 | uri | "http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-within-city-limits-indicator-vr" | |
value[x] | 1..1 | Coding | Residence inside city limits Binding: Value Set - Yes No Unknown Vital Records (required): Yes No Unknown (YNU) | |
predir | 0..1 | string | Residence predirectional URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PreDirectional | |
stnum | 0..1 | string | Residence street number URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetNumber | |
stname | 0..1 | string | Residence street name URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetName | |
stdesig | 0..1 | string | Residence street designator URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetDesignator | |
postdir | 0..1 | string | Residence postdirectional URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PostDirectional | |
unitnumber | 0..1 | string | Residence unit no. 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 address 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 | City literal 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 | |
district | Σ | 0..1 | string | County literal Example General: Madison |
Slices for extension | Content/Rules for all slices | |||
districtCode | 0..1 | positiveInt | county code URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/DistrictCode | |
state | SΣ | 0..1 | string | State Binding: Value Set - States, Territories and Provinces Vital Records (required) |
postalCode | SΣ | 0..1 | string | Zip code Example General: 9132 |
country | Σ | 0..1 | string | Country 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"} |
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) |
Slices for link | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person Slice: Unordered, Open by pattern:type |
link:All Slices | Content/Rules for all slices | |||
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. |
link:mother | ?!Σ | 0..1 | BackboneElement | Link to the birth mother's RelatedPerson record |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
other | Σ | 1..1 | Reference(RelatedPerson - Mother Vital Records) | 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. Required Pattern: seealso |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
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 from this IG | |
Patient.extension:birthPlace.value[x].country | required | ValueSetBirthplaceCountryVitalRecords (a valid code from Code System - Country Codes Vital Records)http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-birthplace-country-vr from this IG | |
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 from this IG | |
Patient.address.extension:withinCityLimitsIndicator.value[x] | required | ValueSetYesNoUnknownVitalRecordshttp://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-yes-no-unknown-vr from this IG | |
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 from this IG | |
Patient.address.country | required | ValueSetResidenceCountryVitalRecordshttp://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-residence-country-vr from this IG | |
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 | |
Patient.link:mother.type | required | Pattern: seealsohttp://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 | code | Extension URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex Binding: Birth Sex (required): Code for sex assigned at birth | |||||
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 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 | State, territory, province code 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 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) | Extension - Reported Parent Age at Delivery - Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-reported-parent-age-at-delivery-vr | |||||
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: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 | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
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 | Σ | 0..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 0..1 | code | Code type | ||||
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 | Medical Record no. 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 | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
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 | Σ | 0..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 0..1 | code | Code type | ||||
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 | Social Security no. 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 | 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 | unknown | asked | temp | notasked | masked | unsupported | astext | error 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 name 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 | unknown | asked | temp | notasked | masked | unsupported | astext | error 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) | To reflect the relevant edit possibilities for Mother's date of birth. 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 | Date edit 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] | ?!Σ | 0..1 | Indicates if the individual is deceased or not, dateTime is preferred Slice: Unordered, Closed by type:$this | |||||
deceasedBoolean | boolean | |||||||
deceasedDateTime | dateTime | |||||||
deceased[x]:deceasedBoolean | ?!ΣC | 0..1 | boolean | Boolean indicator. True if the individual is deceased. fetalDeathOnlyIfDeceased: Fetal death should only be indicated if Patient is deceased. | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
fetalDeath | 0..1 | boolean | Boolean indicator. True if the Patient died as a fetus. URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-patient-fetal-death-vr | |||||
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 | (Complex) | Within City Limits Indicator Vital Records URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-within-city-limits-indicator-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-within-city-limits-indicator-vr" | |||||
value[x] | 1..1 | Coding | Residence inside city limits Binding: Value Set - Yes No Unknown Vital Records (required): Yes No Unknown (YNU) | |||||
predir | 0..1 | string | Residence predirectional URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PreDirectional | |||||
stnum | 0..1 | string | Residence street number URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetNumber | |||||
stname | 0..1 | string | Residence street name URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetName | |||||
stdesig | 0..1 | string | Residence street designator URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetDesignator | |||||
postdir | 0..1 | string | Residence postdirectional URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PostDirectional | |||||
unitnumber | 0..1 | string | Residence unit no. 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 address 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 | City literal 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 | County literal 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 | State Binding: Value Set - States, Territories and Provinces Vital Records (required) | ||||
postalCode | SΣ | 0..1 | string | Zip code Example General: 9132 | ||||
country | Σ | 0..1 | string | Country 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. | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
text | Σ | 0..1 | string | marital status desc | ||||
multipleBirth[x] | 0..1 | If not single birth - born first, second, third, etc. | ||||||
multipleBirth[x]All Types | Content/Rules for all Types | |||||||
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 | Value of extension Binding: Value Set - Plurality Edit Flags (NCHS) Vital Records (required): Plurality Edit Flags (NCHS) | |||||
multipleBirthTotal | 0..1 | positiveInt | Total births in this pregnancy URL: http://hl7.org/fhir/StructureDefinition/patient-multipleBirthTotal | |||||
multipleBirthBoolean | boolean | |||||||
multipleBirthInteger | integer | |||||||
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 | ||||
Slices for link | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person Slice: Unordered, Open by pattern:type | ||||
link: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 | |||||
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. | ||||
link:mother | ?!Σ | 0..1 | BackboneElement | Link to the birth mother's RelatedPerson record | ||||
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(RelatedPerson - Mother Vital Records) | 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. Required Pattern: seealso | ||||
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: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 from this IG | ||||
Patient.extension:birthPlace.value[x].country | required | ValueSetBirthplaceCountryVitalRecords (a valid code from Code System - Country Codes Vital Records)http://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-birthplace-country-vr from this IG | ||||
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 from this IG | ||||
Patient.address.extension:withinCityLimitsIndicator.value[x] | required | ValueSetYesNoUnknownVitalRecordshttp://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-yes-no-unknown-vr from this IG | ||||
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 from this IG | ||||
Patient.address.country | required | ValueSetResidenceCountryVitalRecordshttp://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-residence-country-vr from this IG | ||||
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 from this IG | ||||
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 | ||||
Patient.link:mother.type | required | Pattern: seealsohttp://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard |
This structure is derived from PatientVitalRecords
Summary
Mandatory: 2 elements(2 nested mandatory elements)
Must-Support: 2 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
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:birthPlace | 0..1 | PatBirthPlace(5.1.0) | Place of Birth for patient | |