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.
Other representations of profile: CSV, Excel, Schematron