Vital Records Common Profiles Library
1.1.0-for-comment - CI Build United States of America flag

Vital Records Common Profiles Library, published by HL7 International - Public Health Work Group. This is not an authorized publication; it is the continuous build for version 1.1.0-for-comment). 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

Artifacts Summary

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

Participants

Patient - Child Vital Records

The subject patient (newborn/infant/child) for whom clinical data is included in the report.

Patient - Decedent Fetus Vital Records

A stillborn 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.

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

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

RelatedPerson - Father Natural Vital Records

The biological (natural) father of the newborn or fetus.

RelatedPerson - Father Vital Records

The father of the subject. Different individuals may play different roles as the father (e.g., biological father, adoptive father, etc.).

RelatedPerson - Mother Gestational Vital Records

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.

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.).

Observations

Observation - APGAR Score Vital Records

APGAR score post-birth.

Observation - Birth Weight Vital Records

The weight of the infant/fetus at birth/delivery.

Observation - Gestational Age at Delivery Vital Records

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

An indication of whether the infant is living at the time the report is being submitted.

Observation - Last Menstrual Period Vital Records

This 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

The weight of the mother at the time of birth/delivery.

Observation - Mother Height Vital Records

The height of the mother.

Observation - Mother Prepregnancy Weight Vital Records

The weight of the mother before becoming pregnant.

Observation - Number of Births Now Dead Vital Records

The total number of previous live-born infants for the mother now dead.

Observation - Number of Births Now Living Vital Records

The total number of previous live-born infants for the mother now living.

Observation - Number of Fetal Deaths This Delivery Vital Records

The number of fetal deaths in this delivery.

Observation - Number of Live Births This Delivery Vital Records

The number of live births in this delivery.

Observation - Number of Other Pregnancy Outcomes Vital Records

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

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

The total number of prior cesarean deliveries for the mother.

Observation - Parent Education Level Vital Records

The highest degree or level of schooling completed by the parent.

Observation - Plurality Vital Records

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. (‘Reabsorbed’ fetuses, those which are not ‘delivered’ (expulsed or extracted from the mother) should not be counted.) Include all live births and fetal losses resulting from this pregnancy.

Observation - Pregnancy Risk Factor Vital Records

Selected medical risk factors of the mother during the pregnancy.

Observation - Race Vital Records

This 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 profile records a code representing 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”.

Extensions

Extension - Date Part Absent Reason Vital Records

Provides a reason why an expected date part is missing.

Extension - 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.

Extension - RelatedPerson Deceased Vital Records

The deceased indicator for a RelatedPerson. Deceased date/time is preferred.

Extension - 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.

Participant Examples

Patient - Child example [Baby G Quinn]

Example of Patient-child-vr profile (Baby G Quinn)

Patient - Decedent Fetus example [Fetus Not Named]

Example of Patient-decedent-fetus-vr (Fetus Not Named)

Patient - Mother Date Part Absent

Example of Patient-mother-vr profile (Date Part Absent)

Patient - Mother example [Carmen Teresa Lee]

Example of Patient-mother-vr profile (Carmen Teresa Lee)

Patient - Mother Jada Ann Quinn

Example of Patient-mother-vr profile (Jada Ann Quinn)

Practitioner - Vital Records example [Janet Seito]

Example of Practitioner-vital-records-vr profile (Janet Seito)

RelatedPerson - Adoptive Father

Example of RelatedPerson-father-vr profile (adoptive father)

RelatedPerson - Adoptive Mother

Example of RelatedPerson-mother-vr profile (adoptive mother)

RelatedPerson - Father example [Tom Yan Lee]

Example of Relatedperson-father-vr (Tom Yan Lee)

RelatedPerson - Father Natural example [Tom Yan Lee]

Example of Relatedperson-father-natural-vr (Tom Yan Lee)

RelatedPerson - Mother Gestaional example [Carmen Teresa Lee]

Example of Relatedperson-gestational-vr profile (Carmen Teresa Lee)

RelatedPerson - Stepmother

Example of RelatedPerson-parent-vr profile (stepmother)

Observation Examples

Observation - APGAR Score example [BabyG Quinn: 5 min]

Example of Observation-apgar-score-vr profile (Babyg Quinn: 5 min)

Observation - Autopsy Performed example [Fetus Not Named]

Example of Observation-autopsy-performed-vr profile (Fetus Not Named)

Observation - Birth Weight example [Baby G Quinn]

Example of Observation-birth-weight-vr profile (Baby G Quinn)

Observation - Birth Weight example [Fetus Not Named]

Example of Observation-birth-weight-vr (Fetus Not Named)

Observation - Gestational Age at Delivery example [Baby G Quinn]

Example of Observation-gestational-age-at-delivery-vr profile (Baby G Quinn)

Observation - Gestational Age at Delivery example [Fetus Not Named]

Example of Observation-gestational-age-at-delivery profile-vr (Fetus Not Named)

Observation - Infant Living example [Baby G Quinn]

Example of Observation-infant-living profile-vr (Baby G Quinn)

Observation - Last Menstrual Period example [Carmen Teresa Lee]

Example of Observation-last-menstrual-period-vr profile (Carmen Teresa Lee)

Observation - Mother Delivery Weight example [Jada Ann Quinn]

Example of Observation-mother-delivery-weight-vr profile (Jada Ann Quinn)

Observation - Mother Height example [Carmen Teresa Lee]

Example of Observation-mother-height-vr profile (Carmen Teresa Lee)

Observation - Mother Prepregnancy Weight example [Carmen Teresa Lee]

Example of Observation-mother-prepregnancy-weight-vr profile (Carmen Teresa Lee)

Observation - Number Births Now Dead example [Carmen Teresa Lee]

Example of Observation-number-births-now-dead-vr (Carmen Teresa Lee)

Observation - Number Live Births This Delivery example [Carmen Teresa Lee]

Example of Observation-number-live-births-this-delivery-vr (Carmen Teresa Lee)

Observation - Number of Births Now Living example [Carmen Teresa Lee]

Example of Observation-number-births-now-living-vr profile (Carmen Teresa Lee)

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

Example of Observation-number-fetal-deaths-this-delivery profile (Carmen Teresa Lee)

Observation - Number Other Pregnancy Outcomes example [Jada Ann Quinn]

Example of Observation-number-other-pregnancy-outcomes-vr (Jada Ann Quinn)

Observation - Number Prenatal Visits example [Jada Ann Quinn]

Example of Observation-number-prenatal-visits-vr profile (BabyG Quinn/Jada Ann Quinn)

Observation - Number Previous Cesareans example [Carmen Teresa Lee]

Example of Observation-number-previous-cesareans-vr profile (Carmen Teresa Lee)

Observation - Parent Education Level example [Carmen Teresa Lee]

Example of Observation-parent-education-level-vr profile (Carmen Teresa Lee)

Observation - Plurality example [Carmen Teresa Lee]

Example of Observation-plurality-vr profile (Carmen Teresa Lee)

Observation - Pregnancy Risk Factor example [Carmen Teresa Lee: Hypertensive disorder, systemic arterial]

Example of Observation-pregnancy-risk-factor-vr profile (Carmen Teresa Lee: Hypertensive disorder, systemic arterial)

Observation - Race example [Jada Ann Quinn]

Example of Observation-race-vr profile (Jada Ann Quinn)

Observation - Tabulated Ethnicity example [Jada Ann Quinn]

Example of Observation-tabulated-ethnicity-vr example (Jada Ann Quinn)

Structures: Resource Profiles

These define constraints on FHIR resources for systems conforming to this implementation guide

Observation - Autopsy Performed Indicator Vital Records

This Observation records 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

The Observation - Cause of Death Part 1 profile reflects the ordered causes of death asserted by the death certifier. The cause of death is initially specified with text. The MDI Observation - Cause of Death Part 1 artifact overlaps with the VRDR Cause Of Death Part 1 artifact.

Terminology: Value Sets

These define sets of codes used by systems conforming to this implementation guide

ValueSet - APGAR Score Timing Vital Records

This value set contains codes to represent standard timings for APGAR assessments.

ValueSet - Date Part Vital Records

This value set contains codes that represent the parts of a date

ValueSet - Education Level Person Vital Records

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

ValueSet - Father Relationship Vital Records

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

ValueSet - Mother Relationship Vital Records

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

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.