This page is part of the Vital Records Common Profile Library (v2.0.0: STU2) 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
Contents:
This page provides a list of the FHIR artifacts defined as part of this implementation guide.
Patient - Child Vital Records |
The subject patient (newborn/infant/child) for whom clinical data is included in the report. |
Patient - Mother Vital Records |
This Patient profile represents the woman who gave birth to, or delivered the infant. |
Patient - Vital Records |
This abstract Patient profile includes common extensions and slicing used across vital records. |
Practitioner - Vital Records |
This Practitioner profile represents a practitioner who is involved in vital records (births, fetal death, death, etc.) as a certifier or an attendant. This profile is based on the US Core Practitioner and adds a further constraint to capture the title of the practitioner. |
RelatedPerson - Father Natural Vital Records |
The biological (natural) father of the newborn or fetus. |
RelatedPerson - Father Vital Records |
The father of the report subject. Different individuals may play different roles as the father (e.g., biological father, adoptive father, etc.). This profile is designed to supplant the similar profile in VRDR |
RelatedPerson - Mother Vital Records |
The mother of the report subject. Different individuals may play different roles as the mother (e.g., biological mother, adoptive mother, etc.). This profile is designed to supplant the similar profile in VRDR |
Related Person - Parent Vital Records |
The RelatedPerson profile contains constraints common to the Mother and Father profiles. Serves as resource profile for RelatedPersonMother and RelatedPersonFather. This profile is designed to supplant the similar profile in VRDR |
Observation - Coded Race and Ethnicity Vital Records |
Coded (from NCHS) Race and Ethnicity (Observation). This is information that is coded by NCHS based on submitted information and sent back to jurisdictions, and will not be processed if submitted to NCHS by jurisdictions. |
Observation - Input Race and Ethnicity Vital Records |
Input (from EDRS or EBRS) Race and Ethnicity (Observation). This is information collected by jurisdictions and submitted to NCHS. |
Location for Vital Records |
Vital Records Location – defines (but does not require) the standard address extensions for vital records. |
Observation - Education Level Vital Records |
The highest degree or level of schooling completed by the decedent or parent. This profile is designed to supplant similar profile in VRDR |
Observation - Emerging Issues Vital Records |
Used to send data needed to respond to emerging public health issues from jurisdictions to NCHS. |
City Code Vital Records |
City expressed as a numeric value. As of the date of publication, in accordance with the NCHS Instruction Manual Part 8, Vital Records Geographic Classification, 2014 (https://www.cdc.gov/nchs/data/dvs/IMP8_2014.pdf). (Extension) |
District Code Vital Records |
District expressed as a numeric value. As of the date of publication, in accordance with the NCHS Instruction Manual Part 8, Vital Records Geographic Classification, 2014 (https://www.cdc.gov/nchs/data/dvs/IMP8_2014.pdf). (Extension) |
PostDirectional Vital Records |
PostDirectional component of address as defined by USPS |
PreDirectional Vital Records |
PreDirectional component of address as defined by USPS |
StreetDesignator Vital Records |
StreetDesignator component of address as defined by USPS |
StreetName Vital Records |
StreetName component of address as defined by USPS |
StreetNumber Vital Records |
StreetNumber component of address as defined by USPS |
UnitOrAptNumber Vital Records |
UnitOrAptNumber component of address as defined by USPS |
Within City Limits Indicator Vital Records |
Used to indicate whether or not an address is within city limits. The content of the component shall be a value from the value set Yes No Unknown. |
Partial Date Time Vital Records |
Provides values of a partial dateTime for cases beyond what FHIR dateTime can support directly. |
Partial Date Vital Records |
Provides values of a partial date for cases beyond what FHIR date can support directly. |
Auxiliary State Identifier1 Vital Records |
The first of two twelve character strings associated by the submitted jurisdiction with a specific certificate number. Identifier1 can be provided separately, or with Identifier2 |
Auxiliary State Identifier2 Vital Records |
The second of two twelve character strings associated by the submitted jurisdiction with a specific certificate number. Identifier2 can be provided separately, or with Identifier1. |
Certificate Number |
Certificate number. Six digit number. Leading zeroes are optional. |
BypassEditFlag Vital Records |
Extension to hold a codeable concept from one of several valuesets. |
Location Jurisdiction Id Vital Records |
Location Jurisdiction Id (Extension) supports jurisdictions with a designator that isn't a USPS two-letter code |
Patient Fetal Death Vital Records |
The fetal death status of the patient. |
RelatedPerson Birth Place Vital Records |
The registered place of birth for the related person. A system may use the address.text if it doesn't store the birthPlace address in discrete elements. This extension is the same as the patient birthPlace extension, but with relatedPerson context. |
Reported Parent Age At Delivery Vital Records |
This Extension profile represents the reported age of the parent (either the gestational mother or the natural father - as defined by NCHS) at the delivery time of the newborn or fetus. A required code indicates whether the mother or father's age is provided. It can optionally contain a reference to the reporter (US Core Patient Profile or US Core RelatedPerson Profile). |
Code System - Country Codes Vital Records |
2 Letter Country Codes from GEC and ISO 3166-1. This codesystem is only for use in the vital records use cases supported by this Implementation guide, and should not be used elsewhere. |
Code System - Jurisdictions Vital Records |
NVSS Jurisdictions that are not US States or Territories. This codesystem is only for use in the vital records use cases supported by this Implementation guide, and should not be used elsewhere. |
Code System - US States and Territories |
Surrogate for usps.com codesystem - IG Publisher found issues with that codesystem. This codesystem is only for use in the vital records use cases supported by this Implementation guide, and should not be used elsewhere. |
Code System - Birth and Death Edit Flags Vital Records |
This code system contains codes to represent all edit flags. This codesystem is only for use in the vital records use cases supported by this Implementation guide, and should not be used elsewhere. |
Code System - Local Component Codes |
Local Component Codes for observation components that lack an appropriate LOINC code. This codesystem is only for use in the vital records use cases supported by this Implementation guide, and should not be used elsewhere. |
Code System - HispanicOrigin Vital Records |
HispanicOrigin from Appendix_D_Excel_Hispanic_Origin_Code_List_Update_2011. This codesystem is only for use in the vital records use cases supported by this Implementation guide, and should not be used elsewhere. |
Code System - Placeholder Code System for IJE in Vital Records |
IJE Code System Placeholder is needed to provide a URL upon which to anchor concept maps. This codesystem is only for use in the vital records use cases supported by this Implementation guide, and should not be used elsewhere. |
Code System - Race Code Vital Records |
RaceCode from Appendix E Excel Race Code List Update 2001. This codesystem is only for use in the vital records use cases supported by this Implementation guide, and should not be used elsewhere. |
Code System - Race Recode 40 Vital Records |
Race Recode 40 This codesystem is only for use in the vital records use cases supported by this Implementation guide, and should not be used elsewhere. |
Code System - Local Observation Codes Vital Records |
Local Observation Codes for observations that lack an appropriate LOINC code. This codesystem is only for use in the vital records use cases supported by this Implementation guide, and should not be used elsewhere. |
Coded Race and Ethnicity Person Vital Records |
This value set contains codes that represent persons for whom coded race and ethnicity can be reported. |
Value Set - HispanicOrigin Vital Records |
This valueset contains the set of codes used to represent NCHS HispanicOrigin. Mapping to IJE codes here. |
Value Set - Input Race and Ethnicity Person Vital Records |
This valueset contains codes that represent persons for whom input race and ethnicity can be reported. |
Value Set - Race Code Vital Records |
This valueset contains the set of codes used to represent NCHS Race Codes. Mapping to IJE codes here. |
Value Set - Race Missing Value Reason Vital Records |
This valueset contains the set of codes used to indicate the reason decedent race data is absent. Mapping to IJE codes here. |
Value Set - Race Recode 40 Vital Records |
This valueset contains the set of codes used to represent NCHS Race Recode 40. NCHS no longer provides this data. Mapping to IJE codes here. |
Value Set - Birthplace Country Vital Records |
This valueset contains the set of codes used to represent 2 Letter Birthplace Country Codes from GEC and ISO 3166-1. Includes historic countries that no longer exist. |
Value Set - Jurisdictions Vital Records |
This valueset contains the set of codes used to represent 2 Letter Codes for all 57 Jurisdictions Reporting Deaths to NCHS |
Value Set - Residence Country Vital Records |
This valueset contains the set of codes used to represent 2 Letter Residence Country Codes from GEC and ISO 3166-1. Excludes historic countries that no longer exist |
Value Set - States, Territories and Provinces Vital Records |
This valueset contains the set of codes used to represent 2 Letter States and Provinces |
Value Set - US States, Territories Vital Records |
This valueset contains the set of 2 Letter codes used to represent US States and Territories |
Value Set - US States Vital Records |
This valueset contains the set of 2 Letter codes used to represent the 50 US States and DC |
Value Set - US Territories Vital Records |
This valueset contains the set of 2 Letter codes used to represent US Territories |
Value Set - Edit Bypass 01234 Vital Records |
A subset of code values (0, 1, 2, 3, and 4) use to indicate the outcome of data validation assessment for unusual data values. Mapping to IJE codes here. |
Value Set - Date of Birth Edit Flags (NCHS) Vital Records |
This valueset contains codes to represent Date of Birth Edit Flags. It is based on the original PHVS_BirthdateEditFlags_NCHS PHINVADS valueset. This IG is the primary source for valuesets for use in vital records. Mapping to IJE codes here. |
Value Set - Plurality Edit Flags (NCHS) Vital Records |
This valueset contains codes to represent Plurality Edit Flags. It is based on the original PHVS_PluralityEditFlags_NCHS PHINVADS valueset. This IG is the primary source for valuesets for use in vital records. Mapping to IJE codes here. |
Value Set - Birth Attendants Titles Vital Records |
This valueset contains codes to represent the type of birth attendant titles. It is based on the original PHVS_BirthAttendantTitles_NCHS PHINVADS valueset. This IG is the primary source for valuesets for use in vital records. Mapping to IJE codes here. |
Value Set - Sex Assigned At Birth Vital Records |
This valueset contains the subset of the US Core Birth Sex Valueset that can be used for a child or decedent fetus' Vital Records. Mapping to IJE codes here for child and here for decedent fetus. |
Value Set - Education Level Vital Records |
This valueset contains the set of codes used to represent the Highest educational level achieved. Mapping to IJE codes here. |
Value Set - Education Level Person Vital Records |
This valueset contains codes that represent persons for whom education level can be reported. |
Value Set - Father Relationship Vital Records |
This valueset contains codes that represent relationships describing the father's role relative to the subject. |
Value Set - Marital Status Vital Records |
The set of codes used to indicate the marital status of the decedent Note: 'Domestic Partnership' is not supported by NCHS and will be mapped to 'U' unknown Mapping to IJE codes here. |
Value Set - Mother Relationship Vital Records |
This valueset contains codes that represent relationships describing the mother's role relative to the subject. |
Value Set - Partial Date/DateTime Data Absent Reason Vital Records |
A set of codes used to represent partial date/dateTime data absent reasons. |
Value Set - Role Vital Records |
This value set contains codes that represent persons for whom some observations can be reported. |
Value Set - Units of Age Vital Records |
This valueset contains the set of codes for specifying the units used when recording age (days, years, etc.). Mapping to IJE codes here. |
Value Set - Yes No Not Applicable Vital Records |
A set of codes used to respond to any question that can be answered Yes, No, or Not Applicable. It is based on the original Yes No Not Applicable (NCHS)[2.16.840.1.114222.4.11.7486] PHINVADS valueset. This IG is the primary source for valuesets for use in vital records. Mapping to IJE codes here. |
Value Set - Yes No Unknown Vital Records |
This valueset contains the set of codes used to respond to any question that can be answered Yes, No, or Unknown. Mapping to IJE codes here. |
Value Set - Yes No Unknown NotApplicable Vital Records |
This valueset contains the set of codes used to respond to any question that can be answered Yes, No, Unknown, or Not Applicable. Mapping to IJE codes here. |
ValueSet - Placeholder ValueSet for Interjurisdictional Exchange (IJE) in Vital Records |
IJE ValueSet Placeholder is needed to provide a URL upon which to anchor concept maps. This valueset is only for use in the vital records use cases supported by this Implementation guide, and should not be used elsewhere. |
Birth Attendant Titles Vital Records |
A mapping between NCHS IJE and FHIR BirthAttendantTitles Value Sets |
Birth Sex Child Vital Records |
A mapping between NCHS IJE and FHIR BirthSex Value Sets |
Birth Sex Fetus Vital Records |
A mapping between NCHS IJE and FHIR BirthSex Value Sets |
EditBypass01234 Concept Map |
A mapping between NCHS IJE and FHIR EditBypass01234 Value Sets |
Education Level Vital Records |
A mapping between NCHS IJE and FHIR EducationLevel Value Sets |
Hispanic No Unknown Vital Records |
A mapping between NCHS IJE and FHIR HispanicNoUnknown Value Sets |
Hispanic Origin Vital Records |
A mapping between NCHS IJE and FHIR HispanicOrigin Value Sets |
Marital Status Vital Records |
Note: 'Domestic Partnership' may be used by jurisdictions, but is not supported by NCHS and will be mapped to 'U' (Not Classifiable). IJE 'U' maps to 'UNK' (unknown) when converted to FHIR. |
Date of Birth Edit Flags Vital Records |
A mapping between NCHS IJE and FHIR DateOfBirthEditFlags Value Sets |
Plurality Edit Flags Vital Records |
A mapping between NCHS IJE and FHIR PluralityEditFlags Value Sets |
Race Code Vital Records |
A mapping between NCHS IJE and FHIR RaceCodes Value Sets |
Race Missing Value Reason Vital Records |
A mapping between NCHS IJE and FHIR RaceMissingValueReason Value Sets |
Race Recode40 Vital Records |
A mapping between NCHS IJE and FHIR RaceRecode40 Value Sets |
Units Of Age Vital Records |
A mapping between NCHS IJE and FHIR UnitsOfAge Value Sets |
Yes No Not Applicable Vital Records |
A mapping between NCHS IJE and FHIR NotApplicable Value Sets |
Yes No Unknown Not Applicable Vital Records |
A mapping between NCHS IJE and FHIR YesNoUnknownNotApplicable Value Sets |
Yes No Unknown Vital Records |
A mapping between NCHS IJE and FHIR YesNoUnknown Value Sets |
expansion-parameters-vr-common |
References US SNOMED CT version. |
Bundle - Example of Identifier Extensions |
Bundle - Example of Identifier Extensions |
Observation - InputRaceAndEthnicity example [Mother] |
Example of input-race-and-ethnicity-vr profile (Mother) |
Observation - InputRaceAndEthnicity example [Father] |
Example of input-race-and-ethnicity-vr profile (Father) |
Observation - CodedRaceAndEthnicity example [Mother] |
Example of coded-race-and-ethnicity-vr profile (Mother) |
Observation - CodedRaceAndEthnicity example [Father] |
Example of coded-race-and-ethnicity-vr profile (Father) |
Observation - Education Level example [A Freeman] |
Example of Observation-education-level-vr profile (A Freeman) |
Observation - EmergingIssues example [A Freeman] |
Example of Observation-emerging-issues-vr profile (A Freeman) |
Observation - Partial Date Time Extension example |
Example of an Observation with Partial Date Time |
Patient - Child example [Baby G Quinn] |
Example of Patient-child-vr profile (Baby G Quinn) with Reported Parent Age at Delivery and full date and time of birth |
Patient - Child example [Baby G Quinn] - no birth time |
Example of Patient-child-vr profile (Baby G Quinn) with Reported Parent Age at Delivery with date of birth but no time of birth. |
Patient - Child example [Baby G Quinn] - partial birth date |
Example of Patient-child-vr profile (Baby G Quinn) with Reported Parent Age at Delivery with partial date of birth - 2nd of some month in 2019. Both the birthTime extension and the value for the birthDate field are omitted. |
Patient - Child example [Baby G Quinn], with Edit Flag |
Example of Patient-child-vr profile (Baby G Quinn) with Edit Flag |
Patient - Fetal Death Extension example |
Example of a Patient with a Fetal Death status |
Patient - Mother Date Part Absent Reason example |
Example of Patient-mother-vr profile with Date Part Absent Reason |
Patient - Mother example [Jada Ann Quinn] |
Example of Patient-mother-vr profile (Jada Ann Quinn) |
Practitioner - example [Janet Seito] |
Example of Practitioner-vr profile (Janet Seito) with address extensions |
RelatedPerson - Father Natural example [James Brandon Quinn] |
Example of Relatedperson-father-natural-vr profile (James Brandon Quinn) |
RelatedPerson - Father example [Tom Yan Lee] |
Example of Relatedperson-father-vr profile (Tom Yan Lee) with partial birthdate |
RelatedPerson - Adoptive Father Deceased example [Tony Lewis] |
Example of RelatedPerson-father-vr profile (adoptive father) with Deceased indicator |
RelatedPerson - Adoptive Mother example [Carol Hoffer] |
Example of RelatedPerson-mother-vr profile (adoptive mother) |
RelatedPerson - Stepmother example [Susan Grant] |
Example of RelatedPerson-parent-vr profile (stepmother) |
USCorePatient - Patient example [A Freeman] |
Example of US Core Patient profile (A Freeman) |
USCorePatient - Patient example [Unknown Name] |
Example of US Core Patient profile (Unknown) |