Vital Records Common Profiles Library
1.1.0 - STU 1.1 United States of America flag

This page is part of the Vital Records Common Profile Library (v1.1.0: STU 1) based on FHIR 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

Artifacts Summary

This page provides a list of the FHIR artifacts defined as part of this implementation guide.

Profiles: Participant

Patient - Child - Vital Records

This Patient profile represents the subject patient (newborn/infant/child) for whom clinical data is included in the report.

Patient - Decedent Fetus - Vital Records

This Patient profile represents a delivered fetus for which 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.

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.

Related Person - Parent - Vital Records

This RelatedPerson profile contains constraints common to the Mother and Father profiles.

RelatedPerson - Father - Vital Records

This RelatedPerson profile represents the father of the subject (patient). Different individuals may play different roles as the father (e.g., biological father, adoptive father, etc.).

RelatedPerson - Father Natural - Vital Records

This RelatedPerson profile represents the biological (natural) father of the newborn or fetus.

RelatedPerson - Mother - Vital Records

This RelatedPerson profile represents the mother of the report subject. Different individuals may play different roles as the mother (e.g., biological mother, adoptive mother, etc.).

RelatedPerson - Mother Gestational - Vital Records

This RelatedPerson profile represents the woman who gave birth to or delivered the infant. The RelatedPerson structure is required in order to link the mother to the newborn or fetus.

Profiles: Observations

Observation - APGAR Score - Vital Records

This Observation represents the Apgar score post-birth.

Observation - Birth Weight - Vital Records

This Observation profile represents the weight of the infant/fetus at birth/delivery.

Observation - Gestational Age at Delivery - Vital Records

This Observation profile represents the obstetric estimate of the infant’s gestation in completed weeks based on the birth/delivery attendant’s final estimate of gestation which should be determined by all perinatal factors and assessments such as ultrasound, but not the neonatal exam.

Observation - Infant Living - Vital Records

This Observation profile represents whether the infant is living at the time the report is being submitted.

Observation - Last Menstrual Period - Vital Records

This Observation profile represents the date of the last menstrual period of the patient. The first day of last menstrual period should be captured. The effectiveTime captures the observation date.

Observation - Mother Delivery Weight - Vital Records

This Observation profile represents the weight of the mother at the time of birth/delivery.

Observation - Mother Height - Vital Records

This Observation profile represents the height of the mother.

Observation - Mother Prepregnancy Weight - Vital Records

This Observation profile represents the weight of the mother before becoming pregnant.

Observation - Number of Births Now Dead - Vital Records

This Observation profile represents the total number of previous live-born infants for the mother now dead.

Observation - Number of Births Now Living - Vital Records

This Observation profile represents the total number of previous live-born infants for the mother now living.

Observation - Number of Fetal Deaths This Delivery - Vital Records

This Observation profile represents the number of fetal deaths in this delivery.

Observation - Number of Live Births This Delivery - Vital Records

This Observation profile represents the number of live births in this delivery.

Observation - Number of Other Pregnancy Outcomes - Vital Records

This Observation profile represents the total number of other pregnancy outcomes for the mother that did not result in a live birth (included pregnancy losses of any gestational age, e.g., spontaneous or induced losses or ectopic pregnancies).

Observation - Number of Prenatal Visits - Vital Records

This Observation profile represents the total number of prenatal visits for the mother. The dates of the first and last prenatal visit are indicated by the effective date range. If the mother received no prenatal care, the value should indicate 0 visits.

Observation - Number of Previous Cesareans - Vital Records

This Observation profile represents the total number of prior cesarean deliveries for the mother.

Observation - Parent Education Level - Vital Records

This Observation profile represents the highest degree or level of schooling completed by the parent.

Observation - Plurality - Vital Records

This Observation profile represents the number of fetuses delivered live or dead at any time in the pregnancy regardless of gestational age, or if the fetuses were delivered at different dates in the pregnancy.

Observation - Race - Vital Records

This Observation profile represents a single race code assigned to the person. If the value is unknown, set dataAbsentReason to “unknown”.

Observation - Tabulated Ethnicity - Vital Records

This Observation profile represents the ethnic affiliation information for the mother or father. The observation will convey, as coded data, information that is provided in text form. If the value is unknown, set dataAbsentReason to “unknown”.

Profiles: Pregnancy Risk Factors

Condition - Eclampsia Hypertension - Vital Records

This Condition profile indicates that the mother had a pregnancy risk factor of eclampsia hypertension.

Condition - Gestational Diabetes - Vital Records

This Condition profile indicates that the mother had a pregnancy risk factor of gestational diabetes.

Condition - Gestational Hypertension - Vital Records

This Condition profile indicates that the mother had a pregnancy risk factor of gestational hypertension.

Condition - Prepregnancy Diabetes - Vital Records

This Condition profile indicates that the mother had a pregnancy risk factor of prepregnancy diabetes.

Condition - Prepregnancy Hypertension - Vital Records

This Condition profile indicates that the mother had a pregnancy risk factor of prepregnancy hypertension.

Observation - None Of Specified Pregnancy Risk Factors - Vital Records

This Observation profile indicates that none of the specified pregnancy risk factors (including concept codes: 73211009, 11687002, 8762007, 48194001, 15938005, 161765003, 271903000, 63487001, 58533008, 63487001, 200144004) were risks factors noted for this pregnancy.

Observation - Previous Cesarean - Vital Records

This Observation profile indicates that the mother had a pregnancy risk factor of previous cesarean.

Observation - Previous Preterm Birth - Vital Records

This Observation profile indicates that the mother had a pregnancy risk factor of previous preterm birth.

Procedure - Artificial Insemination - Vital Records

This Procedure profile records that a pregnancy risk factor of artificial insemination was provided to the mother.

Procedure - Assisted Fertilization - Vital Records

This Procedure profile records that a pregnancy risk factor of assisted fertilization was provided to the mother.

Procedure - Infertility Treatment - Vital Records

This Procedure profile records that a pregnancy risk factor of infertility treatment was provided to the mother.

Profiles: Extensions

Extension - Partial Date - Vital Records

This Extension profile represents values of a partial date.

Extension - Patient Fetal Death - Vital Records

The fetal death status of the patient.

Extension - RelatedPerson Birth Place - Vital Records

This Extension profile represents 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.

Extension - RelatedPerson Deceased - Vital Records

This Extension profile represents the deceased indicator for a RelatedPerson. Deceased date/time is preferred.

Extension - 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 reference to either the Patient - Mother - Vital Records or the RelatedPerson - Father Natural - Vital Records represents the parent. It can optionally contain a reference to the reporter (US Core Patient Profile or US Core RelatedPerson Profile).

Extension - Within City Limits Indicator - Vital Records

This Extension profile is 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.

Profiles: Death Reporting

Location - Death - Vital Records

This Location profile records the location of death. It is based on US Core Location and further constrains the type element to indicate that this is the location of death.

Location - Injury - Vital Records

This Location profile records the location of an injury. It is based on US Core Location and further constrains the type element to indicate that this is the location of an injury.

Observation - Autopsy Performed Indicator - Vital Records

This Observation profile represents if an autopsy was performed, if autopsy findings are available, and the autopsy performer (US Core Practioner).

Observation - Cause of Death Part 1 - Vital Records

This Observation profile represents the ordered causes of death asserted by the death certifier. The cause of death is initially specified with text.

Observation - Contributing Cause of Death Part 2 - Vital Records

This Observation profile represents represents factors contributing to the cause of death as asserted by the death certifier.

Observation - Death Date - Vital Records

This Observation profile represents the death date, death pronouncer, and date pronounced dead. If the actual date of death is known, set value to type dateTime. If the date of death is not known, and a range is known, set value to type Period.

Observation - Decedent Pregnancy - Vital Records

This Observation profile represents the pregnancy status of the decedent.

Observation - Injury Incident - Vital Records

This Observation profile represents the certified explanation of how the injury leading to death occurred.

Observation - Manner of Death - Vital Records

This Observation profile represents the conclusion arrived at upon completion of death investigation regarding the manner of death (e.g., natural, homicide, suicide, accident).

Observation - Tobacco Use Contributed to Death - Vital Records

This Observation profile represents the conclusion arrived at during death investigation regarding the extent to which tobacco use contributed to the death of the decedent.

Procedure - Death Certification - Vital Records

This Procedure profile records the certification of death by the certifier.

Profiles: Administrative

Parameters - Coding Status Values - Vital Records

This Parameters profile contains coding status values that represent various status flags that result from the coding process.

Profiles: Extensions - Death Reporting

Extension - Date Day - Vital Records

This Extension profile represents the day portion (DD) of the partial date.

Extension - Date Month - Vital Records

This Extension profile represents the month portion (MM) of the partial date.

Extension - Date Time - Vital Records

This Extension profile represents the time portion (DD) of the partial date.

Extension - Date Year - Vital Records

This Extension profile represents the year portion (YYYY) of the partial date.

Extension - Partial DateTime - Vital Records

This Extension profile represents Provides values of a partial dateTime

Examples: Participant

Patient - Child - Baby G Quinn

Patient - Child: Baby G Quinn example

Patient - Decedent Fetus - Fetus Not Named

Patient - Decedent Fetus: Fetus Not Named

Patient - Mother - Carmen Teresa Lee

Patient - Mother: Carmen Teresa Lee example

Patient - Mother - Carmen Teresa Lee DOB Part Absent

Patient - Mother: Carmen Teresa Lee DOB Part Absent

Patient - Mother - Jada Ann Quinn

Patient - Mother: Jada Ann Quinn example

Practitioner - Vital Records - Janet Seito

Practitioner - Vital Records: Janet Seito example

RelatedPerson - Adoptive Father - Tony Lewis

RelatedPerson - Adoptive Father: Tony Lewis example

RelatedPerson - Adoptive Mother - Carol Hoffer

RelatedPerson - Adoptive Mother: Carol Hoffer example

RelatedPerson - Father - Tom Yan Lee

RelatedPerson - Father: Tom Yan Lee example

RelatedPerson - Father Natural - Tom Yan Lee

RelatedPerson - Father Natural: Tom Yan Lee example

RelatedPerson - Mother Gestational - Carmen Teresa Lee

RelatedPerson - Mother Gestational: Carmen Teresa Lee example

RelatedPerson - Stepmother

RelatedPerson - Stepmother: example

Examples: Observation

Observation - Apgar Score - - Baby G Quinn-5 min

Observation - Apgar Score: Baby G Quinn-5 min example

Observation - Birth Weight - Baby G Quinn

Observation - Birth Weight: Baby G Quinn example

Observation - Gestational Age at Delivery - Baby G Quinn

Observation - Gestational Age at Delivery: Baby G Quinn example

Observation - Gestational Age at Delivery - Fetus Not Named

Observation - Gestational Age at Delivery: Fetus Not Named example

Observation - Infant Living - Baby G Quinn

Observation - Infant Living: Baby G Quinn example

Observation - Last Menstrual Period - Carmen Teresa Lee

Observation - Last Menstrual Period: Carmen Teresa Lee example

Observation - Mother Delivery Weight - Jada Ann Quinn

Observation - Mother Delivery Weight: Jada Ann Quinn example

Observation - Mother Height - Carmen Teresa Lee

Observation - Mother Height: Carmen Teresa Lee example

Observation - Mother Prepregnancy Weight - Carmen Teresa Lee

Observation - Mother Prepregnancy Weight: Carmen Teresa Lee example

Observation - Number Births Now Dead - Carmen Teresa Lee

Observation - Number Births Now Dead: Carmen Teresa Lee example

Observation - Number Live Births This Delivery - Carmen Teresa Lee

Observation - Number Live Births This Delivery: Carmen Teresa Lee example

Observation - Number of Births Now Living - Carmen Teresa Lee

Observation - Number of Births Now Living: Carmen Teresa Lee example

Observation - Number of Fetal Deaths This Delivery - Carmen Teresa Lee

Observation - Number of Fetal Deaths This Delivery: Carmen Teresa Lee example

Observation - Number Other Pregnancy Outcomes - Jada Ann Quinn

Observation - Number Other Pregnancy Outcomes: Jada Ann Quinn example

Observation - Number Prenatal Visits - Jada Ann Quinn

Observation - Number Prenatal Visits: Jada Ann Quinn example

Observation - Number Previous Cesareans - Carmen Teresa Lee

Observation - Number Previous Cesareans: Carmen Teresa Lee example

Observation - Parent Education Level - Carmen Teresa Lee

Observation - Parent Education Level: Carmen Teresa Lee example

Observation - Parent Education Level - Tom Yan Lee

Observation - Parent Education Level: Carmen Teresa Lee example

Observation - Plurality - Carmen Teresa Lee

Observation - Plurality: Carmen Teresa Lee example

Observation - Race - Jada Ann Quinn

Observation - Race: Jada Ann Quinn example

Observation - Tabulated Ethnicity - Jada Ann Quinn

Observation - Tabulated Ethnicity: Jada Ann Quinn example

Examples: Pregnancy Risk Factors

Condition - Eclampsia Hypertension - Jada Ann Quinn

Condition - Eclampsia Hypertension: Jada Ann Quinn example

Condition - Gestational Diabetes - Jada Ann Quinn

Condition - Gestational Diabetes: Jada Ann Quinn example

Condition - Gestational Hypertension - Jada Ann Quinn

Condition - Gestational Hypertension: Jada Ann Quinn example

Condition - Prepregnancy Diabetes - Jada Ann Quinn

Condition - Prepregnancy Diabetes: Jada Ann Quinn example

Condition - Prepregnancy Hypertension - Jada Ann Quinn

Condition - Prepregnancy Hypertension: Jada Ann Quinn example

Observation - Birth Weight - Fetus Not Named

Observation - Birth Weight: Fetus Not Named example

Observation - None of Specified Risk Factors - Jada Ann Quinn

Observation - Previous Cesarean: Jada Ann Quinn example

Observation - Previous Cesarean - Jada Ann Quinn

Observation - Previous Cesarean: Jada Ann Quinn example

Observation - Previous Preterm Births - Jada Ann Quinn

Observation - Previous Preterm Births: Jada Ann Quinn example

Procedure - Assisted Fertilization - Jada Ann Quinn

Procedure - Assisted Fertilization: Jada Ann Quinn example

Procedure - Infertility Treatment - Jada Ann Quinn

Procedure - Infertility Treatment: Jada Ann Quinn example

Prodecure - Artificial Insemniation - Jada Ann Quinn

Prodecure - Artificial Insemniation: Jada Ann Quinn example

Examples: Death Reporting

Observation - Autopsy Performed - Fetus Not Named

Observation - Autopsy Performed: Fetus Not Named example

Observation - Autopsy Performed Indicator - A Freeman

Observation - Autopsy Performed Indicator: A Freeman example

Observation - Cause of Death Part 1 - Freeman

Observation - Cause of Death Part 1: Freeman example

Observation - Contributing Cause of Death Part 2 - Freeman

Observation - Contributing Cause of Death Part 2: Freeman example

Observation - Death Date - Freeman

Observation - Death Date: Freeman example

Observation - Decedent Pregnancy - Freeman

Observation - Decedent Pregnancy: Freeman example

Observation - Injury Incident - Freeman

Observation - Injury Incident: Freeman example

Observation - Manner of Death - A Freeman, accidental

Observation - Manner of Death: A Freeman, accidental example

Observation - Tobacco Use - A Freeman

Observation - Tobacco Use: A Freeman example

Procedure - Death Certification - A Freeman

Procedure - Death Certification: A Freeman example

Examples: Death Reporting Participant

US Core Patient - Alice J. Freeman

US Core Patient: Freeman example

US Core Patient - Unknown Name

US Core Patient: Unknown Name example

US Core Practitioner - J Jones

US Core Practitioner: J Jones example

US Core Practitioner - S Jones

US Core Practitioner: S Jones example

Examples: Death Reporting Location

Location - Death - Atlanta GA - Freeman

Location - Death - Atlanta GA: Freeman example

Location - Injury - Atlanta GA - Freeman

Location - Injury - Atlanta GA: Freeman example

Terminology: Code Systems - Administrative

CodeSystem - Intentional Reject

This CodeSystem contains values representing intentional rejects.

CodeSystem - Local Components Codes Vital Records

This CodeSystem contains codes that represent local component codes for observation components that lack an appropriate LOINC code.

CodeSystem - System Reject Vital Records

This CodeSystem contains code representing system rejects.

CodeSystem - Transax Conversion Vital Records

This CodeSystem contains codes representing transax conversions.

Terminology: Code Systems - Death Reporting

CodeSystem - Death Pregnancy Status Vital Records

This CodeSystem contains codes that represent whether the decedent was pregnant at or around the time of death. Includes the concepts defined in Pregnancy Status (NCHS)[2.16.840.1.114222.4.11.6003] which are from the PHIN VS (CDC Local Coding System)[2.16.840.1.114222.4.5.274]

CodeSystem - Death Reporting Codes Vital Records

This CodeSystem contains codes for use in death investigations and reporting.

Terminology: Value Sets

ValueSet - APGAR Score Timing - Vital Records

This ValueSet contains codes to represent standard timings for APGAR assessments.

ValueSet - Certifier Types - Vital Records

This ValueSet contains codes to represent the type of certifier (Medical Examiner/Coroner, Certifying physician, etc.) The MDI ValueSet - Certifier Types artifact overlaps with the VRDR Certifier Types VS artifact.

ValueSet - Education Level Person - Vital Records

This ValueSet contains codes that represent persons for whom education level can be reported.

ValueSet - Father Relationship - Vital Records

This ValueSet contains codes that represent relationships describing the father’s role relative to the subject.

ValueSet - Mother Relationship - Vital Records

This ValueSet contains codes that represent relationships describing the mother’s role relative to the subject.

Terminology: Value Sets - Administrative

ValueSet - Intentional Reject - Vital Records

This ValueSet contains codes representing intentional rejects.

ValueSet - System Reject - Vital Records

This ValueSet contains codes representing system rejects.

ValueSet - Transax Conversion - Vital Records

This ValueSet contains codes representing transax conversions.

Terminology: Value Sets - Death Reporting

ValueSet - Contributory Tobacco Use - Vital Records

This ValueSet contains codes that represent the extent to which tobacco use contributed to the person’s death. Based on Contributory Tobacco Use (NCHS)[2.16.840.1.114222.4.11.6004]. The MDI ValueSet - Contributory Tobacco Use artifact overlaps with the VRDR Tobacco Use Contributed To Death artifact.

ValueSet - Date Establishment Approach - Vital Records

This ValueSet contains codes that describe the approach to establishing a date.

ValueSet - Death Pregnancy Status - Vital Records

This ValueSet contains codes that represent whether the decedent was pregnant at or around the time of death. Based on Pregnancy Status (NCHS)[2.16.840.1.114222.4.11.6003].

ValueSet - Manner of Death - Vital Records

This ValueSet contains codes to represent the manner in which a person died.

ValueSet - Place of Death - Vital Records

This ValueSet contains codes that represent the death location of the decedent (e.g., hospital, home, hospice).

ValueSet - Transportation Incident Role - Vital Records

This ValueSet contains codes representing the role of the decedent in a transportation incident resulting in a death-related injury.

ValueSet - Units of Age - Vital Records

This ValueSet contains codes representing the units used when recording age (days, years, etc.).

ValueSet - Yes, No, Not Applicable - Vital Records

This ValueSet contains codes used to respond to any question that can be answered Yes, No, or Not Applicable. Based on Yes No Not Applicable (NCHS)[2.16.840.1.114222.4.11.7486]

ValueSet - Yes, No, Unknown - Vital Records

This ValueSet contains codes used to respond to any question that can be answered Yes, No, or Unknown.

ValueSet - Yes, No, Unknown, Not Applicable - Vital Records

This ValueSet contains codes used to respond to any question that can be answered Yes, No, Unknown, or Not Applicable.

Example: Example Instances

These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.

Parameters - Coding Status Values

Parameters - Coding Status Values example

Other

These are resources that are used within this implementation guide that do not fit into one of the other categories.

expansion-parameters-vr-common

References US SNOMED CT version