This page is part of the Vital Records Death Reporting FHIR Implementation Guide (v3.0.0: STU3) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
The following table illustrates the mappings of fields in the Interjurisdictional Exchange (IJE) formats for mortality to profiles and fields within this FHIR Implementation guide. This information is provided to guide implementers who are transitioning from the familiar IJE to the new FHIR format for this information.
Note that string fields in FHIR-formatted data will often be subject to the same string length limitations of the IJE format for the same content. For example, name fields in IJE (e.g., DINSTI, GNAME) are restricted to 50 characters. Including strings longer than the IJE strength length limitations may lead to data truncation and/or business rule violations when data is sent to certain receivers, including NCHS. The IG includes maximum length restrictions on FHIR strings for some fields, and the FHIR validator will flag violations of these conformance restrictions. The IG does not impose maximum length restrictions for general FHIR fields like names and addresses since this seemed an unnatural constraint of widely used FHIR resources.
# | Description | IJE Name* | Profile | Field | Type | Value Set/Comments |
8 | Date of Death--Month | DOD_MO | DeathDate | value | dateTime | See PartialDatesAndTimes |
9 | Date of Death--Day | DOD_DY | DeathDate | value | dateTime | See PartialDatesAndTimes |
10 | Date of Death--Year | DOD_YR | DeathDate | value | dateTime | Required for processing |
6 | State, U.S. Territory or Canadian Province of Death - literal | STATETEXT_D | DeathLocation | address.state (expanded from 2 letter code) | string | - |
7 | State, U.S. Territory or Canadian Province of Death - code | DSTATE | DeathLocation | address.state or address.state.extension[nationalReportingJurisdictionId] | codeable | ValueSetStatesTerritoriesAndProvincesVitalRecords or ValueSetJurisdictionVitalRecords |
30 | Death Country - Code | DCOUNTRYC | DeathLocation | address.country | string | ValueSetResidenceCountryVitalRecords. Note: For US Death certificates should be US. |
1 | State, U.S. Territory or Canadian Province of Birth - literal | STATEBTH | Decedent | extension[patient-birthPlace].value[x].state or extension[patient-birthPlace].value[x].state.extension[nationalReportingJurisdictionId] if present (expanded from 2 letter code) | string | See StateLiterals |
2 | State, U.S. Territory or Canadian Province of Birth - code | BPLACE_ST | Decedent | extension[patient-birthPlace].value[x].state or extension[patient-birthPlace].value[x].state.extension[nationalReportingJurisdictionId] if present | string | ValueSetJurisdictionVitalRecords |
3 | Decedent's Legal Name--Given | GNAME | Decedent | name.given , name.use = official | string | See Note on Decedent Name |
4 | Decedent's Legal Name--Middle | MIDNAME | Decedent | name.given , name.use = official (first letter) | string | See Note on Decedent Name |
5 | Decedent's Legal Name--Last | LNAME | Decedent | name.family , name.use = official | string | See Note on Decedent Name |
11 | Date of Birth--Month | DOB_MO | Decedent | birthDate.value | dateTime | See PartialDatesAndTimes |
12 | Date of Birth--Day | DOB_DY | Decedent | birthDate.value | dateTime | See PartialDatesAndTimes |
13 | Date of Birth--Year | DOB_YR | Decedent | birthDate.value | dateTime | See PartialDatesAndTimes |
14 | Sex | SEX | Decedent | extension[NVSS-SexAtDeath] | codeable | AdministrativeGenderVS |
NA | Gender | *NO IJE MAPPING* | Decedent | gender | codeable | AdministrativeGenderVS - See Note on Gender |
22 | Decedent's Suffix | SUFF | Decedent | name.suffix , name.use = official | string | - |
26 | Decedent's Maiden Name | DMAIDEN | Decedent | name.text , name.use = maiden | string | |
27 | State, U.S. Territory or Canadian Province of Decedent's Residence - literal | STATETEXT_R | Decedent | address.state (expanded from 2 letter code) | string | See StateLiterals |
28 | State, U.S. Territory or Canadian Province of Decedent's Residence - code | STATEC | Decedent | address.state | string | ValueSetStatesTerritoriesAndProvincesVitalRecords |
29 | Birthplace Country - Code | BPLACE_CT | Decedent | extension[patient-birthPlace].value[x].country | string | ValueSetBirthplaceCountryVitalRecords. |
31 | Decedent's Residence Country - Code | COUNTRYC | Decedent | address.country | string | ValueSetResidenceCountryVitalRecords |
32 | Decedent's SSN (may be used by some jurisdictions when allowed by law, to match with the SSN contained with the birth record) | SSN | Decedent | identifier.value where system = 'http://hl7.org/fhir/sid/us-ssn and type.coding.code="SS" | string | type.coding.code="SB" is deprecated but also supported for compatibility |
16 | Father's First Name | DADFNAME | DecedentFather | name.given , name.use = official | string | - |
17 | Father's Middle Name | DADMIDNAME | DecedentFather | name.given , name.use = official | string | - |
18 | Father's Surname | DADLNAME | DecedentFather | name.family | string | - |
23 | Father's Suffix | DADSUFF | DecedentFather | name.suffix , name.use = official | string | - |
19 | Mother's Given Name | MOMGNAME | DecedentMother | name.given , name.use = official | string | - |
20 | Mother's Middle Name | MOMMIDNAME | DecedentMother | name.given , name.use = official | string | - |
21 | Mother's Maiden Surname | MOMMAIDNAME | DecedentMother | name.family , name.use = maiden | string | - |
24 | Mother's Suffix | MOMSUFF | DecedentMother | name.suffix , name.use = official | string | - |
# | Description | IJE Name* | Value Set/Comments |
25 | Filler | BLANK1 | |
35 | Blank for Future Expansion | BLANK2 |