Vital Records Common Library (VRCL) FHIR Implementation Guide
2.0.0 - STU2-CI Build United States of America flag

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

Resource Profile: Patient - Mother Vital Records

Official URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Patient-mother-vr Version: 2.0.0
Active as of 2026-10-16 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.

IJE Mapping

Natality
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]
address.use = home		 string
Natality 263 Residence Pre Directional PREDIR address.extension[predir]
address.use = home		 string
Natality 264 Residence Street name STNAME address.extension[stname]
address.use = home		 string
Natality 265 Residence Street designator STDESIG address.extension[stdesig]
address.use = home		 string
Natality 266 Residence Post Directional POSTDIR address.extension[postdir]
address.use = home		 string
Natality 267 Residence Unit or Apartment Number UNUM address.extension[unitnum]
address.use = home		 string
Natality 268 Mother's Residence Street Address ADDRESS address.line
address.use = home		 string
Natality 269 Mother's Residence Zip Code and Zip+4 ZIPCODE address.postalCode
address.use = home		 string
Natality 270 Mother's Residence County (Literal) COUNTYTXT address.district
address.use = home		 string
Natality 271 Mother's Residence City/Town (Literal) CITYTEXT address.city
address.use = home		 string
Natality 272 State, U.S. Territory or Canadian Province of Residence (Mother) - literal STATETXT address.state (expanded from 2 letter code)
address.use = home		 string See StateLiterals
Natality 273 Mother's Residence Country (Literal) CNTRYTXT address.country (expanded from 2 letter code)
address.use = home		 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]
address.use = billing		 string
Natality 310 Mother's Mailing Address Pre Directional MAIL_PREDIR address.extension[predir]
address.use = billing		 string
Natality 311 Mother's Mailing Address Street name MAIL_STNAME address.extension[stname]
address.use = billing		 string
Natality 312 Mother's Mailing Address Street designator MAIL_STDESIG address.extension[stdesig]
address.use = billing		 string
Natality 313 Mother's Mailing Address Post Directional MAIL_POSTDIR address.extension[postdir]
address.use = billing		 string
Natality 314 Mother's Mailing Address Unit or Apartment Number MAIL_UNUM address.extension[unitnum]
address.use = billing		 string
Natality 315 Mother's Mailing Address Street Address MAIL_ADDRESS address.line
address.use = billing		 string
Natality 316 Mother's Mailing Address Zip Code and Zip+4 MAIL_ZIPCODE address.postalCode
address.use = billing		 string
Natality 317 Mother's Mailing Address County (Literal) MAIL_COUNTYTXT address.district
address.use = billing		 string
Natality 318 Mother's Mailing Address City/Town (Literal) MAIL_CITYTEXT address.city
address.use = billing		 string
Natality 319 Mother's Mailing Address State (Literal) MAIL_STATETXT address.state (expanded from 2 letter code)
address.use = billing		 string See StateLiterals
Natality 320 Mother's Mailing Address Country (Literal) MAIL_CNTRYTXT address.country (expanded from 2 letter code)
address.use = billing		 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

Fetal Death
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

Form Mapping

Form Mapping
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

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient C 0..* PatientVitalRecords Information about an individual or animal receiving health care services
Constraints: us-core-6
Patient.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Patient.Slices for extension Content/Rules for all slices
Patient.Slices for extension.extension:race 0..1 (Complex) US Core Race Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
Patient.Slices for extension.extension:ethnicity 0..1 (Complex) US Core ethnicity Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
Patient.Slices for extension.extension:birthsex 0..1 code Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex
Binding: Birth Sex (required): Code for sex assigned at birth
Patient.Slices for extension.extension:genderIdentity 0..1 CodeableConcept Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity
Binding: Gender Identity (extensible)
Patient.Slices for extension.extension:birthPlace 0..1 (Complex) Place of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
Patient.Slices for extension.extension:birthPlace.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:birthPlace.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
Patient.Slices for extension.extension:birthPlace.value[x] 1..1 Address Value of extension
Patient.Slices for extension.extension:birthPlace.value[x].use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
Patient.Slices for extension.extension:birthPlace.value[x].state This element is included in summaries. 0..1 string State, territory, province code
Binding: Value Set - States, Territories and Provinces Vital Records (required)
Patient.Slices for extension.extension:birthPlace.value[x].state.Slices for extension Content/Rules for all slices
Patient.Slices for extension.extension:birthPlace.value[x].state.Slices for extension.extension:nationalReportingJurisdictionId 0..1 string Location Jurisdiction Id Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-jurisdiction-id-vr
Binding: Value Set - Jurisdictions Vital Records (required)
Patient.Slices for extension.extension:birthPlace.value[x].country This element is included in summaries. 0..1 string Country code
Binding: Value Set - Birthplace Country Vital Records (required)
Patient.Slices for extension.extension:parentReportedAgeAtDelivery 0..2 (Complex) Extension - Reported Parent Age at Delivery - Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-reported-parent-age-at-delivery-vr
Patient.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Patient.Slices for identifier This element must be supported. This element is included in summaries. 1..* Identifier An identifier for this patient
Slice: Unordered, Open by pattern:type

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for identifier.identifier:MRN This element must be supported. This element is included in summaries. 0..* Identifier Medical Record Number
Patient.Slices for identifier.identifier:MRN.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:MRN.type This element is included in summaries. 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
      "code" : "MR"
    }
  ]
}
Patient.Slices for identifier.identifier:MRN.system This element must be supported. This element is included in summaries. 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Patient.Slices for identifier.identifier:MRN.value This element must be supported. This element is included in summaries. 1..1 string Medical Record no.
Example General: 123456
Patient.Slices for identifier.identifier:SSN This element must be supported. This element is included in summaries. 0..1 Identifier SSN if available and appropriate to send
Patient.Slices for identifier.identifier:SSN.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:SSN.type This element is included in summaries. 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
      "code" : "SS"
    }
  ]
}
Patient.Slices for identifier.identifier:SSN.system This element must be supported. This element is included in summaries. 1..1 uri The namespace for the identifier value
Required Pattern: http://hl7.org/fhir/sid/us-ssn (extensions allowed)
Patient.Slices for identifier.identifier:SSN.value This element must be supported. This element is included in summaries. 1..1 string Social Security no.
Example General: 123456
Patient.active This element is a modifier element. This element is included in summaries. 0..1 boolean Whether this patient's record is in active use
Patient.Slices for name This element must be supported. This element is included in summaries. 1..* HumanName A name associated with the patient
Slice: Unordered, Open by value:use

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for name.name:All Slices Content/Rules for all slices
Patient.Slices for name.name:All Slices.use This element is a modifier element. This element is included in summaries. 0..1 code The use of a human name
Binding: NameUse (required): The use of a human name.
Patient.Slices for name.name:All Slices.family This element must be supported. This element is included in summaries. C 1..1 string Surname
Patient.Slices for name.name:All Slices.family.Slices for extension Content/Rules for all slices
Patient.Slices for name.name:All Slices.family.Slices for extension.extension:dataAbsentReason 0..1 code unknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
Patient.Slices for name.name:All Slices.given This element must be supported. This element is included in summaries. C 0..* string Given name
This repeating element order: Given Names appear in the correct order for presenting the name
Patient.Slices for name.name:All Slices.given.Slices for extension Content/Rules for all slices
Patient.Slices for name.name:All Slices.given.Slices for extension.extension:dataAbsentReason 0..1 code unknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
Patient.Slices for name.name:All Slices.suffix This element is included in summaries. 0..* string Surname suffix
This repeating element order: Suffixes appear in the correct order for presenting the name
Patient.Slices for name.name:currentLegalName This element must be supported. This element is included in summaries. 0..1 HumanName current legal name
Patient.Slices for name.name:currentLegalName.use This element is a modifier element. This element is included in summaries. 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Fixed Value: official (no extensions allowed)
Patient.Slices for name.name:currentLegalName.family This element must be supported. This element is included in summaries. C 1..1 string Family name (often called 'Surname')
Patient.Slices for name.name:currentLegalName.given This element must be supported. This element is included in summaries. C 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
Patient.Slices for name.name:namePriorToFirstMarriage This element must be supported. This element is included in summaries. 0..1 HumanName Name prior to first marriage
Patient.Slices for name.name:namePriorToFirstMarriage.use This element is a modifier element. This element is included in summaries. 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Fixed Value: maiden (no extensions allowed)
Patient.Slices for name.name:namePriorToFirstMarriage.family This element must be supported. This element is included in summaries. C 1..1 string Family name (often called 'Surname')
Patient.Slices for name.name:namePriorToFirstMarriage.given This element must be supported. This element is included in summaries. C 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
Patient.telecom This element is included in summaries. 0..* ContactPoint A contact detail for the individual
Patient.telecom.system This element must be supported. This element is included in summaries. C 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Patient.telecom.value This element must be supported. This element is included in summaries. 1..1 string The actual contact point details
Patient.telecom.use This element is a modifier element. This element must be supported. This element is included in summaries. 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
Patient.gender This element must be supported. This element is included in summaries. 1..1 code male | female | other | unknown
Binding: AdministrativeGender (required)
Patient.birthDate This element must be supported. This element is included in summaries. 1..1 date The date of birth for the individual
Patient.birthDate.Slices for extension Content/Rules for all slices
Patient.birthDate.Slices for extension.extension:partialDateTime 0..1 (Complex) partialDateTIme
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-partial-date-time-vr
Patient.birthDate.Slices for extension.extension:birthTime 0..1 dateTime Time of day of birth
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
Patient.birthDate.Slices for extension.extension:bypassEditFlag 0..1 (Complex) To reflect the relevant edit possibilities for Mother's date of birth.
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag
Patient.birthDate.Slices for extension.extension:bypassEditFlag.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.birthDate.Slices for extension.extension:bypassEditFlag.url 1..1 uri "http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag"
Patient.birthDate.Slices for extension.extension:bypassEditFlag.value[x] 1..1 CodeableConcept Date edit
Binding: Value Set - Date of Birth Edit Flags (NCHS) Vital Records (required): Date of Birth Edit Flags (NCHS)
Patient.Slices for deceased[x] This element is a modifier element. This element is included in summaries. 0..1 Indicates if the individual is deceased or not, dateTime is preferred
Slice: Unordered, Closed by type:$this
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view
Patient.Slices for deceased[x].deceasedBoolean boolean
Patient.Slices for deceased[x].deceasedDateTime dateTime
Patient.Slices for deceased[x].deceased[x]:deceasedBoolean This element is a modifier element. This element is included in summaries. C 0..1 boolean Boolean indicator. True if the individual is deceased.
Constraints: fetalDeathOnlyIfDeceased
Patient.Slices for deceased[x].deceased[x]:deceasedBoolean.Slices for extension Content/Rules for all slices
Patient.Slices for deceased[x].deceased[x]:deceasedBoolean.Slices for extension.extension:fetalDeath 0..1 boolean Boolean indicator. True if the Patient died as a fetus.
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-patient-fetal-death-vr
Patient.address This element must be supported. This element is included in summaries. 0..* Address An address for the individual
Patient.address.Slices for extension Content/Rules for all slices
Patient.address.Slices for extension.extension:withinCityLimitsIndicator 0..1 (Complex) Within City Limits Indicator Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-within-city-limits-indicator-vr
Patient.address.Slices for extension.extension:withinCityLimitsIndicator.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.address.Slices for extension.extension:withinCityLimitsIndicator.url 1..1 uri "http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-within-city-limits-indicator-vr"
Patient.address.Slices for extension.extension:withinCityLimitsIndicator.value[x] 1..1 Coding Residence inside city limits
Binding: Value Set - Yes No Unknown Vital Records (required): Yes No Unknown (YNU)
Patient.address.Slices for extension.extension:predir 0..1 string Residence predirectional
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PreDirectional
Patient.address.Slices for extension.extension:stnum 0..1 string Residence street number
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetNumber
Patient.address.Slices for extension.extension:stname 0..1 string Residence street name
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetName
Patient.address.Slices for extension.extension:stdesig 0..1 string Residence street designator
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetDesignator
Patient.address.Slices for extension.extension:postdir 0..1 string Residence postdirectional
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PostDirectional
Patient.address.Slices for extension.extension:unitnumber 0..1 string Residence unit no.
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/UnitOrAptNumber
Patient.address.use This element is a modifier element. This element is included in summaries. 0..1 code Identifies the use of Mother's address, for residence=home and mailing=billing
Binding: AddressUse (required): The use of an address.
Example General: home
Patient.address.line This element must be supported. This element is included in summaries. 0..* string Street address
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
Patient.address.city This element must be supported. This element is included in summaries. 0..1 string City literal
Example General: Erewhon
Patient.address.city.Slices for extension Content/Rules for all slices
Patient.address.city.Slices for extension.extension:cityCode 0..1 positiveInt city code
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode
Patient.address.district This element is included in summaries. 0..1 string County literal
Example General: Madison
Patient.address.district.Slices for extension Content/Rules for all slices
Patient.address.district.Slices for extension.extension:districtCode 0..1 positiveInt county code
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/DistrictCode
Patient.address.state This element must be supported. This element is included in summaries. 0..1 string State
Binding: Value Set - States, Territories and Provinces Vital Records (required)
Patient.address.postalCode This element must be supported. This element is included in summaries. 0..1 string Zip code
Example General: 9132
Patient.address.country This element is included in summaries. 0..1 string Country
Binding: Value Set - Residence Country Vital Records (required)
Patient.address.period This element must be supported. This element is included in summaries. 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
Patient.communication 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
Patient.communication.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.communication.language This element must be supported. 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: Language codes with language and optionally a region modifier (extensible)
Patient.Slices for link This element is a modifier element. This element is included in summaries. 0..* BackboneElement Link to another patient resource that concerns the same actual person
Slice: Unordered, Open by pattern:type

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for link.link:All Slices Content/Rules for all slices
Patient.Slices for link.link:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.Slices for link.link:All Slices.other This element is included in summaries. 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
Patient.Slices for link.link:All Slices.type This element is included in summaries. 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Patient.Slices for link.link:mother This element is a modifier element. This element is included in summaries. 0..1 BackboneElement Link to the birth mother's RelatedPerson record
Patient.Slices for link.link:mother.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.Slices for link.link:mother.other This element is included in summaries. 1..1 Reference(RelatedPerson - Mother Vital Records) The other patient or related person resource that the link refers to
Patient.Slices for link.link:mother.type This element is included in summaries. 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Required Pattern: seealso (extensions allowed)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.extension:birthPlace.​value[x].use Base required AddressUse 📍4.0.1 FHIR Std.
Patient.extension:birthPlace.​value[x].state Base required Value Set - States, Territories and Provinces Vital Records 📦2.0.0 This IG
Patient.extension:birthPlace.​value[x].country Base required Value Set - Birthplace Country Vital Records 📦2.0.0 This IG
Patient.identifier:MRN.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:MRN.​type Base extensible IdentifierType 📦4.0.1 FHIR Std.
Patient.identifier:SSN.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:SSN.​type Base extensible IdentifierType 📦4.0.1 FHIR Std.
Patient.name.use Base required NameUse 📍4.0.1 FHIR Std.
Patient.name:currentLegalName.​use Base required NameUse 📍4.0.1 FHIR Std.
Patient.name:namePriorToFirstMarriage.​use Base required NameUse 📍4.0.1 FHIR Std.
Patient.telecom.system Base required ContactPointSystem 📦4.0.1 FHIR Std.
Patient.telecom.use Base required ContactPointUse 📦4.0.1 FHIR Std.
Patient.gender Base required AdministrativeGender 📦4.0.1 FHIR Std.
Patient.birthDate.extension:bypassEditFlag.​value[x] Base required Value Set - Date of Birth Edit Flags (NCHS) Vital Records 📦2.0.0 This IG
Patient.address.extension:withinCityLimitsIndicator.​value[x] Base required Value Set - Yes No Unknown Vital Records 📦2.0.0 This IG
Patient.address.use Base required AddressUse 📍4.0.1 FHIR Std.
Patient.address.state Base required Value Set - States, Territories and Provinces Vital Records 📦2.0.0 This IG
Patient.address.country Base required Value Set - Residence Country Vital Records 📦2.0.0 This IG
Patient.communication.​language Base extensible Language codes with language and optionally a region modifier 📦5.0.1 US Core v5.0
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.
Patient.link:mother.​type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

This structure is derived from PatientVitalRecords

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient 0..* PatientVitalRecords Information about an individual or animal receiving health care services
Patient.Slices for extension Content/Rules for all slices
Patient.Slices for extension.extension:birthPlace 0..1 PatBirthPlace(5.3.0) Place of Birth for patient
Patient.Slices for extension.extension:birthPlace.value[x]
Patient.Slices for extension.extension:birthPlace.value[x].state 0..1 string State, territory, province code
Patient.Slices for extension.extension:birthPlace.value[x].country 0..1 string Country code
Patient.Slices for identifier Content/Rules for all slices
Patient.Slices for identifier.identifier:MRN This element must be supported. 0..* Identifier Medical Record Number
Patient.Slices for identifier.identifier:MRN.type
Patient.Slices for identifier.identifier:MRN.type.coding
Patient.Slices for identifier.identifier:MRN.type.coding.code 0..1 code Code type
Patient.Slices for identifier.identifier:MRN.value 1..1 string Medical Record no.
Patient.Slices for identifier.identifier:SSN This element must be supported. 0..1 Identifier SSN if available and appropriate to send
Patient.Slices for identifier.identifier:SSN.type
Patient.Slices for identifier.identifier:SSN.type.coding
Patient.Slices for identifier.identifier:SSN.type.coding.code 0..1 code Code type
Patient.Slices for identifier.identifier:SSN.value 1..1 string Social Security no.
Patient.name 1..* HumanName A name associated with the patient
Patient.name.use 0..1 code The use of a human name
Patient.name.family 1..1 string Surname
Patient.name.given 0..* string Given name
Patient.name.suffix 0..* string Surname suffix
Patient.Slices for name.name:currentLegalName 0..1 HumanName current legal name
Patient.Slices for name.name:currentLegalName.family 1..1 string Family name (often called 'Surname')
Patient.Slices for name.name:namePriorToFirstMarriage 0..1 HumanName Name prior to first marriage
Patient.Slices for name.name:namePriorToFirstMarriage.family 1..1 string Family name (often called 'Surname')
Patient.birthDate 1..1 date The date of birth for the individual
Patient.birthDate.Slices for extension Content/Rules for all slices
Patient.birthDate.Slices for extension.extension:bypassEditFlag 0..1 ExtensionBypassEditFlagVitalRecords To reflect the relevant edit possibilities for Mother's date of birth.
Patient.birthDate.Slices for extension.extension:bypassEditFlag.value[x] 1..1 CodeableConcept Date edit
Patient.deceased[x] 0..1 boolean, dateTime Indicates if the individual is deceased or not, dateTime is preferred
Patient.address
Patient.address.Slices for extension Content/Rules for all slices
Patient.address.Slices for extension.extension:withinCityLimitsIndicator 0..1 ExtensionWithinCityLimitsIndicatorVitalRecords Within City Limits Indicator Vital Records
Patient.address.Slices for extension.extension:withinCityLimitsIndicator.value[x] 1..1 Coding Residence inside city limits
Patient.address.Slices for extension.extension:predir 0..1 ExtensionPreDirectionalVitalRecords Residence predirectional
Patient.address.Slices for extension.extension:stnum 0..1 ExtensionStreetNumberVitalRecords Residence street number
Patient.address.Slices for extension.extension:stname 0..1 ExtensionStreetNameVitalRecords Residence street name
Patient.address.Slices for extension.extension:stdesig 0..1 ExtensionStreetDesignatorVitalRecords Residence street designator
Patient.address.Slices for extension.extension:postdir 0..1 ExtensionPostDirectionalVitalRecords Residence postdirectional
Patient.address.Slices for extension.extension:unitnumber 0..1 ExtensionUnitOrAptNumberVitalRecords Residence unit no.
Patient.address.use 0..1 code Identifies the use of Mother's address, for residence=home and mailing=billing
Patient.address.line 0..* string Street address
Patient.address.city 0..1 string City literal
Patient.address.city.Slices for extension Content/Rules for all slices
Patient.address.city.Slices for extension.extension:cityCode 0..1 ExtensionCityCodeVitalRecords city code
Patient.address.district 0..1 string County literal
Patient.address.district.Slices for extension Content/Rules for all slices
Patient.address.district.Slices for extension.extension:districtCode 0..1 ExtensionDistrictCodeVitalRecords county code
Patient.address.state 0..1 string State
Patient.address.postalCode 0..1 string Zip code
Patient.address.country 0..1 string Country
Patient.maritalStatus
Patient.maritalStatus.text 0..1 string marital status desc
Patient.Slices for link 0..* BackboneElement Link to another patient resource that concerns the same actual person
Slice: Unordered, Open by pattern:type
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for link.link:mother 0..1 BackboneElement Link to the birth mother's RelatedPerson record
Patient.Slices for link.link:mother.other 1..1 Reference(RelatedPerson - Mother Vital Records) The other patient or related person resource that the link refers to
Patient.Slices for link.link:mother.type 1..1 code replaced-by | replaces | refer | seealso
Required Pattern: seealso (extensions allowed)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient C 0..* PatientVitalRecords Information about an individual or animal receiving health care services
Constraints: us-core-6
Patient.id This element is included in summaries. 0..1 id Logical id of this artifact
Patient.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Patient.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Patient.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Patient.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Patient.contained 0..* Resource Contained, inline Resources
Patient.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:race 0..1 (Complex) US Core Race Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
Patient.Slices for extension.extension:ethnicity 0..1 (Complex) US Core ethnicity Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
Patient.Slices for extension.extension:birthsex 0..1 code Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex
Binding: Birth Sex (required): Code for sex assigned at birth
Patient.Slices for extension.extension:genderIdentity 0..1 CodeableConcept Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity
Binding: Gender Identity (extensible)
Patient.Slices for extension.extension:birthPlace 0..1 (Complex) Place of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
Patient.Slices for extension.extension:birthPlace.id 0..1 string Unique id for inter-element referencing
Patient.Slices for extension.extension:birthPlace.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:birthPlace.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
Patient.Slices for extension.extension:birthPlace.value[x] 1..1 Address Value of extension
Patient.Slices for extension.extension:birthPlace.value[x].id 0..1 string Unique id for inter-element referencing
Patient.Slices for extension.extension:birthPlace.value[x].extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:birthPlace.value[x].use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
Patient.Slices for extension.extension:birthPlace.value[x].type This element is included in summaries. 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
Patient.Slices for extension.extension:birthPlace.value[x].text This element is included in summaries. 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
Patient.Slices for extension.extension:birthPlace.value[x].line This element is included in summaries. 0..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
Patient.Slices for extension.extension:birthPlace.value[x].city This element is included in summaries. 0..1 string Name of city, town etc.
Example General: Erewhon
Patient.Slices for extension.extension:birthPlace.value[x].city.id 0..1 string xml:id (or equivalent in JSON)
Patient.Slices for extension.extension:birthPlace.value[x].city.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:birthPlace.value[x].city.Slices for extension Content/Rules for all slices
Patient.Slices for extension.extension:birthPlace.value[x].city.Slices for extension.extension:cityCode 0..1 positiveInt City Code Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode
Patient.Slices for extension.extension:birthPlace.value[x].city.value 0..1 string Primitive value for string
Max Length:1048576
Patient.Slices for extension.extension:birthPlace.value[x].district This element is included in summaries. 0..1 string District name (aka county)
Example General: Madison
Patient.Slices for extension.extension:birthPlace.value[x].district.id 0..1 string xml:id (or equivalent in JSON)
Patient.Slices for extension.extension:birthPlace.value[x].district.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:birthPlace.value[x].district.Slices for extension Content/Rules for all slices
Patient.Slices for extension.extension:birthPlace.value[x].district.Slices for extension.extension:districtCode 0..1 positiveInt County code
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/DistrictCode
Patient.Slices for extension.extension:birthPlace.value[x].district.value 0..1 string Primitive value for string
Max Length:1048576
Patient.Slices for extension.extension:birthPlace.value[x].state This element is included in summaries. 0..1 string State, territory, province code
Binding: Value Set - States, Territories and Provinces Vital Records (required)
Patient.Slices for extension.extension:birthPlace.value[x].state.id 0..1 string xml:id (or equivalent in JSON)
Patient.Slices for extension.extension:birthPlace.value[x].state.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:birthPlace.value[x].state.Slices for extension Content/Rules for all slices
Patient.Slices for extension.extension:birthPlace.value[x].state.Slices for extension.extension:nationalReportingJurisdictionId 0..1 string Location Jurisdiction Id Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-jurisdiction-id-vr
Binding: Value Set - Jurisdictions Vital Records (required)
Patient.Slices for extension.extension:birthPlace.value[x].state.value 0..1 string Primitive value for string
Max Length:1048576
Patient.Slices for extension.extension:birthPlace.value[x].postalCode This element is included in summaries. 0..1 string Postal code for area
Example General: 9132
Patient.Slices for extension.extension:birthPlace.value[x].country This element is included in summaries. 0..1 string Country code
Binding: Value Set - Birthplace Country Vital Records (required)
Patient.Slices for extension.extension:birthPlace.value[x].period This element is included in summaries. 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
Patient.Slices for extension.extension:parentReportedAgeAtDelivery 0..2 (Complex) Extension - Reported Parent Age at Delivery - Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-reported-parent-age-at-delivery-vr
Patient.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Patient.Slices for identifier This element must be supported. This element is included in summaries. 1..* Identifier An identifier for this patient
Slice: Unordered, Open by pattern:type

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for identifier.identifier:MRN This element must be supported. This element is included in summaries. 0..* Identifier Medical Record Number
Patient.Slices for identifier.identifier:MRN.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:MRN.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:MRN.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:MRN.type This element is included in summaries. 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
      "code" : "MR"
    }
  ]
}
Patient.Slices for identifier.identifier:MRN.type.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:MRN.type.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:MRN.type.coding This element is included in summaries. 0..* Coding Code defined by a terminology system
Patient.Slices for identifier.identifier:MRN.type.coding.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:MRN.type.coding.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:MRN.type.coding.system This element is included in summaries. 0..1 uri Identity of the terminology system
Patient.Slices for identifier.identifier:MRN.type.coding.version This element is included in summaries. 0..1 string Version of the system - if relevant
Patient.Slices for identifier.identifier:MRN.type.coding.code This element is included in summaries. 0..1 code Code type
Patient.Slices for identifier.identifier:MRN.type.coding.display This element is included in summaries. 0..1 string Representation defined by the system
Patient.Slices for identifier.identifier:MRN.type.coding.userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user
Patient.Slices for identifier.identifier:MRN.type.text This element is included in summaries. 0..1 string Plain text representation of the concept
Patient.Slices for identifier.identifier:MRN.system This element must be supported. This element is included in summaries. 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Patient.Slices for identifier.identifier:MRN.value This element must be supported. This element is included in summaries. 1..1 string Medical Record no.
Example General: 123456
Patient.Slices for identifier.identifier:MRN.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Patient.Slices for identifier.identifier:MRN.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Patient.Slices for identifier.identifier:SSN This element must be supported. This element is included in summaries. 0..1 Identifier SSN if available and appropriate to send
Patient.Slices for identifier.identifier:SSN.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:SSN.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:SSN.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:SSN.type This element is included in summaries. 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
      "code" : "SS"
    }
  ]
}
Patient.Slices for identifier.identifier:SSN.type.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:SSN.type.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:SSN.type.coding This element is included in summaries. 0..* Coding Code defined by a terminology system
Patient.Slices for identifier.identifier:SSN.type.coding.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:SSN.type.coding.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:SSN.type.coding.system This element is included in summaries. 0..1 uri Identity of the terminology system
Patient.Slices for identifier.identifier:SSN.type.coding.version This element is included in summaries. 0..1 string Version of the system - if relevant
Patient.Slices for identifier.identifier:SSN.type.coding.code This element is included in summaries. 0..1 code Code type
Patient.Slices for identifier.identifier:SSN.type.coding.display This element is included in summaries. 0..1 string Representation defined by the system
Patient.Slices for identifier.identifier:SSN.type.coding.userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user
Patient.Slices for identifier.identifier:SSN.type.text This element is included in summaries. 0..1 string Plain text representation of the concept
Patient.Slices for identifier.identifier:SSN.system This element must be supported. This element is included in summaries. 1..1 uri The namespace for the identifier value
Required Pattern: http://hl7.org/fhir/sid/us-ssn (extensions allowed)
Patient.Slices for identifier.identifier:SSN.value This element must be supported. This element is included in summaries. 1..1 string Social Security no.
Example General: 123456
Patient.Slices for identifier.identifier:SSN.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Patient.Slices for identifier.identifier:SSN.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Patient.active This element is a modifier element. This element is included in summaries. 0..1 boolean Whether this patient's record is in active use
Patient.Slices for name This element must be supported. This element is included in summaries. 1..* HumanName A name associated with the patient
Slice: Unordered, Open by value:use

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for name.name:All Slices Content/Rules for all slices
Patient.Slices for name.name:All Slices.id 0..1 string Unique id for inter-element referencing
Patient.Slices for name.name:All Slices.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for name.name:All Slices.use This element is a modifier element. This element is included in summaries. 0..1 code The use of a human name
Binding: NameUse (required): The use of a human name.
Patient.Slices for name.name:All Slices.text This element is included in summaries. 0..1 string Text representation of the full name
Patient.Slices for name.name:All Slices.family This element must be supported. This element is included in summaries. C 1..1 string Surname
Patient.Slices for name.name:All Slices.family.id 0..1 string xml:id (or equivalent in JSON)
Patient.Slices for name.name:All Slices.family.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Patient.Slices for name.name:All Slices.family.Slices for extension.extension:dataAbsentReason 0..1 code unknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
Patient.Slices for name.name:All Slices.family.value 0..1 string Primitive value for string
Max Length:1048576
Patient.Slices for name.name:All Slices.given This element must be supported. This element is included in summaries. C 0..* string Given name
This repeating element order: Given Names appear in the correct order for presenting the name
Patient.Slices for name.name:All Slices.given.id 0..1 string xml:id (or equivalent in JSON)
Patient.Slices for name.name:All Slices.given.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Patient.Slices for name.name:All Slices.given.Slices for extension.extension:dataAbsentReason 0..1 code unknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
Patient.Slices for name.name:All Slices.given.value 0..1 string Primitive value for string
Max Length:1048576
Patient.Slices for name.name:All Slices.prefix This element is included in summaries. 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
Patient.Slices for name.name:All Slices.suffix This element is included in summaries. 0..* string Surname suffix
This repeating element order: Suffixes appear in the correct order for presenting the name
Patient.Slices for name.name:All Slices.period This element is included in summaries. 0..1 Period Time period when name was/is in use
Patient.Slices for name.name:currentLegalName This element must be supported. This element is included in summaries. 0..1 HumanName current legal name
Patient.Slices for name.name:currentLegalName.id 0..1 string Unique id for inter-element referencing
Patient.Slices for name.name:currentLegalName.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for name.name:currentLegalName.use This element is a modifier element. This element is included in summaries. 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Fixed Value: official (no extensions allowed)
Patient.Slices for name.name:currentLegalName.text This element is included in summaries. 0..1 string Text representation of the full name
Patient.Slices for name.name:currentLegalName.family This element must be supported. This element is included in summaries. C 1..1 string Family name (often called 'Surname')
Patient.Slices for name.name:currentLegalName.given This element must be supported. This element is included in summaries. C 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
Patient.Slices for name.name:currentLegalName.prefix This element is included in summaries. 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
Patient.Slices for name.name:currentLegalName.suffix This element is included in summaries. 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
Patient.Slices for name.name:currentLegalName.period This element is included in summaries. 0..1 Period Time period when name was/is in use
Patient.Slices for name.name:namePriorToFirstMarriage This element must be supported. This element is included in summaries. 0..1 HumanName Name prior to first marriage
Patient.Slices for name.name:namePriorToFirstMarriage.id 0..1 string Unique id for inter-element referencing
Patient.Slices for name.name:namePriorToFirstMarriage.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for name.name:namePriorToFirstMarriage.use This element is a modifier element. This element is included in summaries. 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Fixed Value: maiden (no extensions allowed)
Patient.Slices for name.name:namePriorToFirstMarriage.text This element is included in summaries. 0..1 string Text representation of the full name
Patient.Slices for name.name:namePriorToFirstMarriage.family This element must be supported. This element is included in summaries. C 1..1 string Family name (often called 'Surname')
Patient.Slices for name.name:namePriorToFirstMarriage.given This element must be supported. This element is included in summaries. C 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
Patient.Slices for name.name:namePriorToFirstMarriage.prefix This element is included in summaries. 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
Patient.Slices for name.name:namePriorToFirstMarriage.suffix This element is included in summaries. 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
Patient.Slices for name.name:namePriorToFirstMarriage.period This element is included in summaries. 0..1 Period Time period when name was/is in use
Patient.telecom This element is included in summaries. 0..* ContactPoint A contact detail for the individual
Patient.telecom.id 0..1 string Unique id for inter-element referencing
Patient.telecom.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.telecom.system This element must be supported. This element is included in summaries. C 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Patient.telecom.value This element must be supported. This element is included in summaries. 1..1 string The actual contact point details
Patient.telecom.use This element is a modifier element. This element must be supported. This element is included in summaries. 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
Patient.telecom.rank This element is included in summaries. 0..1 positiveInt Specify preferred order of use (1 = highest)
Patient.telecom.period This element is included in summaries. 0..1 Period Time period when the contact point was/is in use
Patient.gender This element must be supported. This element is included in summaries. 1..1 code male | female | other | unknown
Binding: AdministrativeGender (required)
Patient.birthDate This element must be supported. This element is included in summaries. 1..1 date The date of birth for the individual
Patient.birthDate.id 0..1 string xml:id (or equivalent in JSON)
Patient.birthDate.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Patient.birthDate.Slices for extension.extension:partialDateTime 0..1 (Complex) partialDateTIme
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-partial-date-time-vr
Patient.birthDate.Slices for extension.extension:birthTime 0..1 dateTime Time of day of birth
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
Patient.birthDate.Slices for extension.extension:bypassEditFlag 0..1 (Complex) To reflect the relevant edit possibilities for Mother's date of birth.
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag
Patient.birthDate.Slices for extension.extension:bypassEditFlag.id 0..1 string Unique id for inter-element referencing
Patient.birthDate.Slices for extension.extension:bypassEditFlag.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.birthDate.Slices for extension.extension:bypassEditFlag.url 1..1 uri "http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag"
Patient.birthDate.Slices for extension.extension:bypassEditFlag.value[x] 1..1 CodeableConcept Date edit
Binding: Value Set - Date of Birth Edit Flags (NCHS) Vital Records (required): Date of Birth Edit Flags (NCHS)
Patient.birthDate.value 0..1 date Primitive value for date
Patient.Slices for deceased[x] This element is a modifier element. This element is included in summaries. 0..1 Indicates if the individual is deceased or not, dateTime is preferred
Slice: Unordered, Closed by type:$this
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view
Patient.Slices for deceased[x].deceasedBoolean boolean
Patient.Slices for deceased[x].deceasedDateTime dateTime
Patient.Slices for deceased[x].deceased[x]:deceasedBoolean This element is a modifier element. This element is included in summaries. C 0..1 boolean Boolean indicator. True if the individual is deceased.
Constraints: fetalDeathOnlyIfDeceased
Patient.Slices for deceased[x].deceased[x]:deceasedBoolean.id 0..1 string xml:id (or equivalent in JSON)
Patient.Slices for deceased[x].deceased[x]:deceasedBoolean.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Patient.Slices for deceased[x].deceased[x]:deceasedBoolean.Slices for extension Content/Rules for all slices
Patient.Slices for deceased[x].deceased[x]:deceasedBoolean.Slices for extension.extension:fetalDeath 0..1 boolean Boolean indicator. True if the Patient died as a fetus.
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-patient-fetal-death-vr
Patient.Slices for deceased[x].deceased[x]:deceasedBoolean.value 0..1 boolean Primitive value for boolean
Patient.address This element must be supported. This element is included in summaries. 0..* Address An address for the individual
Patient.address.id 0..1 string Unique id for inter-element referencing
Patient.address.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.address.Slices for extension.extension:withinCityLimitsIndicator 0..1 (Complex) Within City Limits Indicator Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-within-city-limits-indicator-vr
Patient.address.Slices for extension.extension:withinCityLimitsIndicator.id 0..1 string Unique id for inter-element referencing
Patient.address.Slices for extension.extension:withinCityLimitsIndicator.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.address.Slices for extension.extension:withinCityLimitsIndicator.url 1..1 uri "http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-within-city-limits-indicator-vr"
Patient.address.Slices for extension.extension:withinCityLimitsIndicator.value[x] 1..1 Coding Residence inside city limits
Binding: Value Set - Yes No Unknown Vital Records (required): Yes No Unknown (YNU)
Patient.address.Slices for extension.extension:predir 0..1 string Residence predirectional
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PreDirectional
Patient.address.Slices for extension.extension:stnum 0..1 string Residence street number
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetNumber
Patient.address.Slices for extension.extension:stname 0..1 string Residence street name
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetName
Patient.address.Slices for extension.extension:stdesig 0..1 string Residence street designator
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetDesignator
Patient.address.Slices for extension.extension:postdir 0..1 string Residence postdirectional
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PostDirectional
Patient.address.Slices for extension.extension:unitnumber 0..1 string Residence unit no.
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/UnitOrAptNumber
Patient.address.use This element is a modifier element. This element is included in summaries. 0..1 code Identifies the use of Mother's address, for residence=home and mailing=billing
Binding: AddressUse (required): The use of an address.
Example General: home
Patient.address.type This element is included in summaries. 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
Patient.address.text This element is included in summaries. 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
Patient.address.line This element must be supported. This element is included in summaries. 0..* string Street address
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
Patient.address.city This element must be supported. This element is included in summaries. 0..1 string City literal
Example General: Erewhon
Patient.address.city.id 0..1 string xml:id (or equivalent in JSON)
Patient.address.city.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Patient.address.city.Slices for extension.extension:cityCode 0..1 positiveInt city code
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode
Patient.address.city.value 0..1 string Primitive value for string
Max Length:1048576
Patient.address.district This element is included in summaries. 0..1 string County literal
Example General: Madison
Patient.address.district.id 0..1 string xml:id (or equivalent in JSON)
Patient.address.district.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Patient.address.district.Slices for extension.extension:districtCode 0..1 positiveInt county code
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/DistrictCode
Patient.address.district.value 0..1 string Primitive value for string
Max Length:1048576
Patient.address.state This element must be supported. This element is included in summaries. 0..1 string State
Binding: Value Set - States, Territories and Provinces Vital Records (required)
Patient.address.postalCode This element must be supported. This element is included in summaries. 0..1 string Zip code
Example General: 9132
Patient.address.country This element is included in summaries. 0..1 string Country
Binding: Value Set - Residence Country Vital Records (required)
Patient.address.period This element must be supported. This element is included in summaries. 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
Patient.maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
Patient.maritalStatus.id 0..1 string Unique id for inter-element referencing
Patient.maritalStatus.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.maritalStatus.coding This element is included in summaries. 0..* Coding Code defined by a terminology system
Patient.maritalStatus.text This element is included in summaries. 0..1 string marital status desc
Patient.multipleBirth[x] 0..1 If not single birth - born first, second, third, etc.
Patient.multipleBirth[x].multipleBirth[x]All Types Content/Rules for all Types
Patient.multipleBirth[x].multipleBirth[x]All Types.id 0..1 string Unique id for inter-element referencing
Patient.multipleBirth[x].multipleBirth[x]All Types.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.multipleBirth[x].multipleBirth[x]All Types.Slices for extension.extension:bypassEditFlag 0..1 (Complex) BypassEditFlag Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag
Patient.multipleBirth[x].multipleBirth[x]All Types.Slices for extension.extension:bypassEditFlag.id 0..1 string Unique id for inter-element referencing
Patient.multipleBirth[x].multipleBirth[x]All Types.Slices for extension.extension:bypassEditFlag.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.multipleBirth[x].multipleBirth[x]All Types.Slices for extension.extension:bypassEditFlag.url 1..1 uri "http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag"
Patient.multipleBirth[x].multipleBirth[x]All Types.Slices for extension.extension:bypassEditFlag.value[x] 1..1 CodeableConcept Value of extension
Binding: Value Set - Plurality Edit Flags (NCHS) Vital Records (required): Plurality Edit Flags (NCHS)
Patient.multipleBirth[x].multipleBirth[x]All Types.Slices for extension.extension:multipleBirthTotal 0..1 positiveInt Total births in this pregnancy
URL: http://hl7.org/fhir/StructureDefinition/patient-multipleBirthTotal
Patient.multipleBirth[x].multipleBirthBoolean boolean
Patient.multipleBirth[x].multipleBirthInteger integer
Patient.photo 0..* Attachment Image of the patient
Patient.contact C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
Constraints: pat-1
Patient.contact.id 0..1 string Unique id for inter-element referencing
Patient.contact.extension 0..* Extension Additional content defined by implementations
Patient.contact.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.contact.relationship 0..* CodeableConcept The kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
Patient.contact.name 0..1 HumanName A name associated with the contact person
Patient.contact.telecom 0..* ContactPoint A contact detail for the person
Patient.contact.address 0..1 Address Address for the contact person
Patient.contact.gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.contact.organization C 0..1 Reference(Organization) Organization that is associated with the contact
Patient.contact.period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
Patient.communication 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
Patient.communication.id 0..1 string Unique id for inter-element referencing
Patient.communication.extension 0..* Extension Additional content defined by implementations
Patient.communication.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.communication.language This element must be supported. 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: Language codes with language and optionally a region modifier (extensible)
Patient.communication.preferred 0..1 boolean Language preference indicator
Patient.generalPractitioner 0..* Reference(Organization | Practitioner | PractitionerRole) Patient's nominated primary care provider
Patient.managingOrganization This element is included in summaries. 0..1 Reference(Organization) Organization that is the custodian of the patient record
Patient.Slices for link This element is a modifier element. This element is included in summaries. 0..* BackboneElement Link to another patient resource that concerns the same actual person
Slice: Unordered, Open by pattern:type

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for link.link:All Slices Content/Rules for all slices
Patient.Slices for link.link:All Slices.id 0..1 string Unique id for inter-element referencing
Patient.Slices for link.link:All Slices.extension 0..* Extension Additional content defined by implementations
Patient.Slices for link.link:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.Slices for link.link:All Slices.other This element is included in summaries. 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
Patient.Slices for link.link:All Slices.type This element is included in summaries. 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Patient.Slices for link.link:mother This element is a modifier element. This element is included in summaries. 0..1 BackboneElement Link to the birth mother's RelatedPerson record
Patient.Slices for link.link:mother.id 0..1 string Unique id for inter-element referencing
Patient.Slices for link.link:mother.extension 0..* Extension Additional content defined by implementations
Patient.Slices for link.link:mother.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.Slices for link.link:mother.other This element is included in summaries. 1..1 Reference(RelatedPerson - Mother Vital Records) The other patient or related person resource that the link refers to
Patient.Slices for link.link:mother.type This element is included in summaries. 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Required Pattern: seealso (extensions allowed)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.language Base preferred Common Languages 📦4.0.1 FHIR Std.
Patient.extension:birthPlace.​value[x].use Base required AddressUse 📍4.0.1 FHIR Std.
Patient.extension:birthPlace.​value[x].type Base required AddressType 📍4.0.1 FHIR Std.
Patient.extension:birthPlace.​value[x].state Base required Value Set - States, Territories and Provinces Vital Records 📦2.0.0 This IG
Patient.extension:birthPlace.​value[x].country Base required Value Set - Birthplace Country Vital Records 📦2.0.0 This IG
Patient.identifier:MRN.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:MRN.​type Base extensible IdentifierType 📦4.0.1 FHIR Std.
Patient.identifier:SSN.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:SSN.​type Base extensible IdentifierType 📦4.0.1 FHIR Std.
Patient.name.use Base required NameUse 📍4.0.1 FHIR Std.
Patient.name:currentLegalName.​use Base required NameUse 📍4.0.1 FHIR Std.
Patient.name:namePriorToFirstMarriage.​use Base required NameUse 📍4.0.1 FHIR Std.
Patient.telecom.system Base required ContactPointSystem 📦4.0.1 FHIR Std.
Patient.telecom.use Base required ContactPointUse 📦4.0.1 FHIR Std.
Patient.gender Base required AdministrativeGender 📦4.0.1 FHIR Std.
Patient.birthDate.extension:bypassEditFlag.​value[x] Base required Value Set - Date of Birth Edit Flags (NCHS) Vital Records 📦2.0.0 This IG
Patient.address.extension:withinCityLimitsIndicator.​value[x] Base required Value Set - Yes No Unknown Vital Records 📦2.0.0 This IG
Patient.address.use Base required AddressUse 📍4.0.1 FHIR Std.
Patient.address.type Base required AddressType 📍4.0.1 FHIR Std.
Patient.address.state Base required Value Set - States, Territories and Provinces Vital Records 📦2.0.0 This IG
Patient.address.country Base required Value Set - Residence Country Vital Records 📦2.0.0 This IG
Patient.maritalStatus Base extensible MaritalStatus 📦4.0.1 FHIR Std.
Patient.multipleBirth[x].​extension:bypassEditFlag.​value[x] Base required Value Set - Plurality Edit Flags (NCHS) Vital Records 📦2.0.0 This IG
Patient.contact.relationship Base extensible Patient Contact Relationship 📦4.0.1 FHIR Std.
Patient.contact.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.communication.​language Base extensible Language codes with language and optionally a region modifier 📦5.0.1 US Core v5.0
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.
Patient.link:mother.​type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

This structure is derived from PatientVitalRecords

Summary

Mandatory: 2 elements(2 nested mandatory elements)
Must-Support: 2 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Patient.link

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient C 0..* PatientVitalRecords Information about an individual or animal receiving health care services
Constraints: us-core-6
Patient.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Patient.Slices for extension Content/Rules for all slices
Patient.Slices for extension.extension:race 0..1 (Complex) US Core Race Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
Patient.Slices for extension.extension:ethnicity 0..1 (Complex) US Core ethnicity Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
Patient.Slices for extension.extension:birthsex 0..1 code Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex
Binding: Birth Sex (required): Code for sex assigned at birth
Patient.Slices for extension.extension:genderIdentity 0..1 CodeableConcept Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity
Binding: Gender Identity (extensible)
Patient.Slices for extension.extension:birthPlace 0..1 (Complex) Place of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
Patient.Slices for extension.extension:birthPlace.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:birthPlace.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
Patient.Slices for extension.extension:birthPlace.value[x] 1..1 Address Value of extension
Patient.Slices for extension.extension:birthPlace.value[x].use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
Patient.Slices for extension.extension:birthPlace.value[x].state This element is included in summaries. 0..1 string State, territory, province code
Binding: Value Set - States, Territories and Provinces Vital Records (required)
Patient.Slices for extension.extension:birthPlace.value[x].state.Slices for extension Content/Rules for all slices
Patient.Slices for extension.extension:birthPlace.value[x].state.Slices for extension.extension:nationalReportingJurisdictionId 0..1 string Location Jurisdiction Id Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-jurisdiction-id-vr
Binding: Value Set - Jurisdictions Vital Records (required)
Patient.Slices for extension.extension:birthPlace.value[x].country This element is included in summaries. 0..1 string Country code
Binding: Value Set - Birthplace Country Vital Records (required)
Patient.Slices for extension.extension:parentReportedAgeAtDelivery 0..2 (Complex) Extension - Reported Parent Age at Delivery - Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-reported-parent-age-at-delivery-vr
Patient.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Patient.Slices for identifier This element must be supported. This element is included in summaries. 1..* Identifier An identifier for this patient
Slice: Unordered, Open by pattern:type

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for identifier.identifier:MRN This element must be supported. This element is included in summaries. 0..* Identifier Medical Record Number
Patient.Slices for identifier.identifier:MRN.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:MRN.type This element is included in summaries. 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
      "code" : "MR"
    }
  ]
}
Patient.Slices for identifier.identifier:MRN.system This element must be supported. This element is included in summaries. 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Patient.Slices for identifier.identifier:MRN.value This element must be supported. This element is included in summaries. 1..1 string Medical Record no.
Example General: 123456
Patient.Slices for identifier.identifier:SSN This element must be supported. This element is included in summaries. 0..1 Identifier SSN if available and appropriate to send
Patient.Slices for identifier.identifier:SSN.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:SSN.type This element is included in summaries. 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
      "code" : "SS"
    }
  ]
}
Patient.Slices for identifier.identifier:SSN.system This element must be supported. This element is included in summaries. 1..1 uri The namespace for the identifier value
Required Pattern: http://hl7.org/fhir/sid/us-ssn (extensions allowed)
Patient.Slices for identifier.identifier:SSN.value This element must be supported. This element is included in summaries. 1..1 string Social Security no.
Example General: 123456
Patient.active This element is a modifier element. This element is included in summaries. 0..1 boolean Whether this patient's record is in active use
Patient.Slices for name This element must be supported. This element is included in summaries. 1..* HumanName A name associated with the patient
Slice: Unordered, Open by value:use

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for name.name:All Slices Content/Rules for all slices
Patient.Slices for name.name:All Slices.use This element is a modifier element. This element is included in summaries. 0..1 code The use of a human name
Binding: NameUse (required): The use of a human name.
Patient.Slices for name.name:All Slices.family This element must be supported. This element is included in summaries. C 1..1 string Surname
Patient.Slices for name.name:All Slices.family.Slices for extension Content/Rules for all slices
Patient.Slices for name.name:All Slices.family.Slices for extension.extension:dataAbsentReason 0..1 code unknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
Patient.Slices for name.name:All Slices.given This element must be supported. This element is included in summaries. C 0..* string Given name
This repeating element order: Given Names appear in the correct order for presenting the name
Patient.Slices for name.name:All Slices.given.Slices for extension Content/Rules for all slices
Patient.Slices for name.name:All Slices.given.Slices for extension.extension:dataAbsentReason 0..1 code unknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
Patient.Slices for name.name:All Slices.suffix This element is included in summaries. 0..* string Surname suffix
This repeating element order: Suffixes appear in the correct order for presenting the name
Patient.Slices for name.name:currentLegalName This element must be supported. This element is included in summaries. 0..1 HumanName current legal name
Patient.Slices for name.name:currentLegalName.use This element is a modifier element. This element is included in summaries. 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Fixed Value: official (no extensions allowed)
Patient.Slices for name.name:currentLegalName.family This element must be supported. This element is included in summaries. C 1..1 string Family name (often called 'Surname')
Patient.Slices for name.name:currentLegalName.given This element must be supported. This element is included in summaries. C 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
Patient.Slices for name.name:namePriorToFirstMarriage This element must be supported. This element is included in summaries. 0..1 HumanName Name prior to first marriage
Patient.Slices for name.name:namePriorToFirstMarriage.use This element is a modifier element. This element is included in summaries. 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Fixed Value: maiden (no extensions allowed)
Patient.Slices for name.name:namePriorToFirstMarriage.family This element must be supported. This element is included in summaries. C 1..1 string Family name (often called 'Surname')
Patient.Slices for name.name:namePriorToFirstMarriage.given This element must be supported. This element is included in summaries. C 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
Patient.telecom This element is included in summaries. 0..* ContactPoint A contact detail for the individual
Patient.telecom.system This element must be supported. This element is included in summaries. C 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Patient.telecom.value This element must be supported. This element is included in summaries. 1..1 string The actual contact point details
Patient.telecom.use This element is a modifier element. This element must be supported. This element is included in summaries. 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
Patient.gender This element must be supported. This element is included in summaries. 1..1 code male | female | other | unknown
Binding: AdministrativeGender (required)
Patient.birthDate This element must be supported. This element is included in summaries. 1..1 date The date of birth for the individual
Patient.birthDate.Slices for extension Content/Rules for all slices
Patient.birthDate.Slices for extension.extension:partialDateTime 0..1 (Complex) partialDateTIme
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-partial-date-time-vr
Patient.birthDate.Slices for extension.extension:birthTime 0..1 dateTime Time of day of birth
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
Patient.birthDate.Slices for extension.extension:bypassEditFlag 0..1 (Complex) To reflect the relevant edit possibilities for Mother's date of birth.
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag
Patient.birthDate.Slices for extension.extension:bypassEditFlag.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.birthDate.Slices for extension.extension:bypassEditFlag.url 1..1 uri "http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag"
Patient.birthDate.Slices for extension.extension:bypassEditFlag.value[x] 1..1 CodeableConcept Date edit
Binding: Value Set - Date of Birth Edit Flags (NCHS) Vital Records (required): Date of Birth Edit Flags (NCHS)
Patient.Slices for deceased[x] This element is a modifier element. This element is included in summaries. 0..1 Indicates if the individual is deceased or not, dateTime is preferred
Slice: Unordered, Closed by type:$this
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view
Patient.Slices for deceased[x].deceasedBoolean boolean
Patient.Slices for deceased[x].deceasedDateTime dateTime
Patient.Slices for deceased[x].deceased[x]:deceasedBoolean This element is a modifier element. This element is included in summaries. C 0..1 boolean Boolean indicator. True if the individual is deceased.
Constraints: fetalDeathOnlyIfDeceased
Patient.Slices for deceased[x].deceased[x]:deceasedBoolean.Slices for extension Content/Rules for all slices
Patient.Slices for deceased[x].deceased[x]:deceasedBoolean.Slices for extension.extension:fetalDeath 0..1 boolean Boolean indicator. True if the Patient died as a fetus.
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-patient-fetal-death-vr
Patient.address This element must be supported. This element is included in summaries. 0..* Address An address for the individual
Patient.address.Slices for extension Content/Rules for all slices
Patient.address.Slices for extension.extension:withinCityLimitsIndicator 0..1 (Complex) Within City Limits Indicator Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-within-city-limits-indicator-vr
Patient.address.Slices for extension.extension:withinCityLimitsIndicator.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.address.Slices for extension.extension:withinCityLimitsIndicator.url 1..1 uri "http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-within-city-limits-indicator-vr"
Patient.address.Slices for extension.extension:withinCityLimitsIndicator.value[x] 1..1 Coding Residence inside city limits
Binding: Value Set - Yes No Unknown Vital Records (required): Yes No Unknown (YNU)
Patient.address.Slices for extension.extension:predir 0..1 string Residence predirectional
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PreDirectional
Patient.address.Slices for extension.extension:stnum 0..1 string Residence street number
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetNumber
Patient.address.Slices for extension.extension:stname 0..1 string Residence street name
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetName
Patient.address.Slices for extension.extension:stdesig 0..1 string Residence street designator
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetDesignator
Patient.address.Slices for extension.extension:postdir 0..1 string Residence postdirectional
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PostDirectional
Patient.address.Slices for extension.extension:unitnumber 0..1 string Residence unit no.
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/UnitOrAptNumber
Patient.address.use This element is a modifier element. This element is included in summaries. 0..1 code Identifies the use of Mother's address, for residence=home and mailing=billing
Binding: AddressUse (required): The use of an address.
Example General: home
Patient.address.line This element must be supported. This element is included in summaries. 0..* string Street address
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
Patient.address.city This element must be supported. This element is included in summaries. 0..1 string City literal
Example General: Erewhon
Patient.address.city.Slices for extension Content/Rules for all slices
Patient.address.city.Slices for extension.extension:cityCode 0..1 positiveInt city code
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode
Patient.address.district This element is included in summaries. 0..1 string County literal
Example General: Madison
Patient.address.district.Slices for extension Content/Rules for all slices
Patient.address.district.Slices for extension.extension:districtCode 0..1 positiveInt county code
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/DistrictCode
Patient.address.state This element must be supported. This element is included in summaries. 0..1 string State
Binding: Value Set - States, Territories and Provinces Vital Records (required)
Patient.address.postalCode This element must be supported. This element is included in summaries. 0..1 string Zip code
Example General: 9132
Patient.address.country This element is included in summaries. 0..1 string Country
Binding: Value Set - Residence Country Vital Records (required)
Patient.address.period This element must be supported. This element is included in summaries. 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
Patient.communication 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
Patient.communication.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.communication.language This element must be supported. 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: Language codes with language and optionally a region modifier (extensible)
Patient.Slices for link This element is a modifier element. This element is included in summaries. 0..* BackboneElement Link to another patient resource that concerns the same actual person
Slice: Unordered, Open by pattern:type

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for link.link:All Slices Content/Rules for all slices
Patient.Slices for link.link:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.Slices for link.link:All Slices.other This element is included in summaries. 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
Patient.Slices for link.link:All Slices.type This element is included in summaries. 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Patient.Slices for link.link:mother This element is a modifier element. This element is included in summaries. 0..1 BackboneElement Link to the birth mother's RelatedPerson record
Patient.Slices for link.link:mother.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.Slices for link.link:mother.other This element is included in summaries. 1..1 Reference(RelatedPerson - Mother Vital Records) The other patient or related person resource that the link refers to
Patient.Slices for link.link:mother.type This element is included in summaries. 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Required Pattern: seealso (extensions allowed)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.extension:birthPlace.​value[x].use Base required AddressUse 📍4.0.1 FHIR Std.
Patient.extension:birthPlace.​value[x].state Base required Value Set - States, Territories and Provinces Vital Records 📦2.0.0 This IG
Patient.extension:birthPlace.​value[x].country Base required Value Set - Birthplace Country Vital Records 📦2.0.0 This IG
Patient.identifier:MRN.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:MRN.​type Base extensible IdentifierType 📦4.0.1 FHIR Std.
Patient.identifier:SSN.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:SSN.​type Base extensible IdentifierType 📦4.0.1 FHIR Std.
Patient.name.use Base required NameUse 📍4.0.1 FHIR Std.
Patient.name:currentLegalName.​use Base required NameUse 📍4.0.1 FHIR Std.
Patient.name:namePriorToFirstMarriage.​use Base required NameUse 📍4.0.1 FHIR Std.
Patient.telecom.system Base required ContactPointSystem 📦4.0.1 FHIR Std.
Patient.telecom.use Base required ContactPointUse 📦4.0.1 FHIR Std.
Patient.gender Base required AdministrativeGender 📦4.0.1 FHIR Std.
Patient.birthDate.extension:bypassEditFlag.​value[x] Base required Value Set - Date of Birth Edit Flags (NCHS) Vital Records 📦2.0.0 This IG
Patient.address.extension:withinCityLimitsIndicator.​value[x] Base required Value Set - Yes No Unknown Vital Records 📦2.0.0 This IG
Patient.address.use Base required AddressUse 📍4.0.1 FHIR Std.
Patient.address.state Base required Value Set - States, Territories and Provinces Vital Records 📦2.0.0 This IG
Patient.address.country Base required Value Set - Residence Country Vital Records 📦2.0.0 This IG
Patient.communication.​language Base extensible Language codes with language and optionally a region modifier 📦5.0.1 US Core v5.0
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.
Patient.link:mother.​type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

Differential View

This structure is derived from PatientVitalRecords

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient 0..* PatientVitalRecords Information about an individual or animal receiving health care services
Patient.Slices for extension Content/Rules for all slices
Patient.Slices for extension.extension:birthPlace 0..1 PatBirthPlace(5.3.0) Place of Birth for patient
Patient.Slices for extension.extension:birthPlace.value[x]
Patient.Slices for extension.extension:birthPlace.value[x].state 0..1 string State, territory, province code
Patient.Slices for extension.extension:birthPlace.value[x].country 0..1 string Country code
Patient.Slices for identifier Content/Rules for all slices
Patient.Slices for identifier.identifier:MRN This element must be supported. 0..* Identifier Medical Record Number
Patient.Slices for identifier.identifier:MRN.type
Patient.Slices for identifier.identifier:MRN.type.coding
Patient.Slices for identifier.identifier:MRN.type.coding.code 0..1 code Code type
Patient.Slices for identifier.identifier:MRN.value 1..1 string Medical Record no.
Patient.Slices for identifier.identifier:SSN This element must be supported. 0..1 Identifier SSN if available and appropriate to send
Patient.Slices for identifier.identifier:SSN.type
Patient.Slices for identifier.identifier:SSN.type.coding
Patient.Slices for identifier.identifier:SSN.type.coding.code 0..1 code Code type
Patient.Slices for identifier.identifier:SSN.value 1..1 string Social Security no.
Patient.name 1..* HumanName A name associated with the patient
Patient.name.use 0..1 code The use of a human name
Patient.name.family 1..1 string Surname
Patient.name.given 0..* string Given name
Patient.name.suffix 0..* string Surname suffix
Patient.Slices for name Content/Rules for all slices
Patient.Slices for name.name:currentLegalName 0..1 HumanName current legal name
Patient.Slices for name.name:currentLegalName.family 1..1 string Family name (often called 'Surname')
Patient.Slices for name.name:namePriorToFirstMarriage 0..1 HumanName Name prior to first marriage
Patient.Slices for name.name:namePriorToFirstMarriage.family 1..1 string Family name (often called 'Surname')
Patient.birthDate 1..1 date The date of birth for the individual
Patient.birthDate.Slices for extension Content/Rules for all slices
Patient.birthDate.Slices for extension.extension:bypassEditFlag 0..1 ExtensionBypassEditFlagVitalRecords To reflect the relevant edit possibilities for Mother's date of birth.
Patient.birthDate.Slices for extension.extension:bypassEditFlag.value[x] 1..1 CodeableConcept Date edit
Patient.deceased[x] 0..1 boolean, dateTime Indicates if the individual is deceased or not, dateTime is preferred
Patient.address
Patient.address.Slices for extension Content/Rules for all slices
Patient.address.Slices for extension.extension:withinCityLimitsIndicator 0..1 ExtensionWithinCityLimitsIndicatorVitalRecords Within City Limits Indicator Vital Records
Patient.address.Slices for extension.extension:withinCityLimitsIndicator.value[x] 1..1 Coding Residence inside city limits
Patient.address.Slices for extension.extension:predir 0..1 ExtensionPreDirectionalVitalRecords Residence predirectional
Patient.address.Slices for extension.extension:stnum 0..1 ExtensionStreetNumberVitalRecords Residence street number
Patient.address.Slices for extension.extension:stname 0..1 ExtensionStreetNameVitalRecords Residence street name
Patient.address.Slices for extension.extension:stdesig 0..1 ExtensionStreetDesignatorVitalRecords Residence street designator
Patient.address.Slices for extension.extension:postdir 0..1 ExtensionPostDirectionalVitalRecords Residence postdirectional
Patient.address.Slices for extension.extension:unitnumber 0..1 ExtensionUnitOrAptNumberVitalRecords Residence unit no.
Patient.address.use 0..1 code Identifies the use of Mother's address, for residence=home and mailing=billing
Patient.address.line 0..* string Street address
Patient.address.city 0..1 string City literal
Patient.address.city.Slices for extension Content/Rules for all slices
Patient.address.city.Slices for extension.extension:cityCode 0..1 ExtensionCityCodeVitalRecords city code
Patient.address.district 0..1 string County literal
Patient.address.district.Slices for extension Content/Rules for all slices
Patient.address.district.Slices for extension.extension:districtCode 0..1 ExtensionDistrictCodeVitalRecords county code
Patient.address.state 0..1 string State
Patient.address.postalCode 0..1 string Zip code
Patient.address.country 0..1 string Country
Patient.maritalStatus
Patient.maritalStatus.text 0..1 string marital status desc
Patient.Slices for link 0..* BackboneElement Link to another patient resource that concerns the same actual person
Slice: Unordered, Open by pattern:type
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for link.link:mother 0..1 BackboneElement Link to the birth mother's RelatedPerson record
Patient.Slices for link.link:mother.other 1..1 Reference(RelatedPerson - Mother Vital Records) The other patient or related person resource that the link refers to
Patient.Slices for link.link:mother.type 1..1 code replaced-by | replaces | refer | seealso
Required Pattern: seealso (extensions allowed)

doco Documentation for this format

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient C 0..* PatientVitalRecords Information about an individual or animal receiving health care services
Constraints: us-core-6
Patient.id This element is included in summaries. 0..1 id Logical id of this artifact
Patient.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Patient.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Patient.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Patient.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Patient.contained 0..* Resource Contained, inline Resources
Patient.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:race 0..1 (Complex) US Core Race Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
Patient.Slices for extension.extension:ethnicity 0..1 (Complex) US Core ethnicity Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
Patient.Slices for extension.extension:birthsex 0..1 code Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex
Binding: Birth Sex (required): Code for sex assigned at birth
Patient.Slices for extension.extension:genderIdentity 0..1 CodeableConcept Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity
Binding: Gender Identity (extensible)
Patient.Slices for extension.extension:birthPlace 0..1 (Complex) Place of Birth for patient
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
Patient.Slices for extension.extension:birthPlace.id 0..1 string Unique id for inter-element referencing
Patient.Slices for extension.extension:birthPlace.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:birthPlace.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
Patient.Slices for extension.extension:birthPlace.value[x] 1..1 Address Value of extension
Patient.Slices for extension.extension:birthPlace.value[x].id 0..1 string Unique id for inter-element referencing
Patient.Slices for extension.extension:birthPlace.value[x].extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:birthPlace.value[x].use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
Patient.Slices for extension.extension:birthPlace.value[x].type This element is included in summaries. 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
Patient.Slices for extension.extension:birthPlace.value[x].text This element is included in summaries. 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
Patient.Slices for extension.extension:birthPlace.value[x].line This element is included in summaries. 0..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
Patient.Slices for extension.extension:birthPlace.value[x].city This element is included in summaries. 0..1 string Name of city, town etc.
Example General: Erewhon
Patient.Slices for extension.extension:birthPlace.value[x].city.id 0..1 string xml:id (or equivalent in JSON)
Patient.Slices for extension.extension:birthPlace.value[x].city.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:birthPlace.value[x].city.Slices for extension Content/Rules for all slices
Patient.Slices for extension.extension:birthPlace.value[x].city.Slices for extension.extension:cityCode 0..1 positiveInt City Code Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode
Patient.Slices for extension.extension:birthPlace.value[x].city.value 0..1 string Primitive value for string
Max Length:1048576
Patient.Slices for extension.extension:birthPlace.value[x].district This element is included in summaries. 0..1 string District name (aka county)
Example General: Madison
Patient.Slices for extension.extension:birthPlace.value[x].district.id 0..1 string xml:id (or equivalent in JSON)
Patient.Slices for extension.extension:birthPlace.value[x].district.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:birthPlace.value[x].district.Slices for extension Content/Rules for all slices
Patient.Slices for extension.extension:birthPlace.value[x].district.Slices for extension.extension:districtCode 0..1 positiveInt County code
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/DistrictCode
Patient.Slices for extension.extension:birthPlace.value[x].district.value 0..1 string Primitive value for string
Max Length:1048576
Patient.Slices for extension.extension:birthPlace.value[x].state This element is included in summaries. 0..1 string State, territory, province code
Binding: Value Set - States, Territories and Provinces Vital Records (required)
Patient.Slices for extension.extension:birthPlace.value[x].state.id 0..1 string xml:id (or equivalent in JSON)
Patient.Slices for extension.extension:birthPlace.value[x].state.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:birthPlace.value[x].state.Slices for extension Content/Rules for all slices
Patient.Slices for extension.extension:birthPlace.value[x].state.Slices for extension.extension:nationalReportingJurisdictionId 0..1 string Location Jurisdiction Id Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-jurisdiction-id-vr
Binding: Value Set - Jurisdictions Vital Records (required)
Patient.Slices for extension.extension:birthPlace.value[x].state.value 0..1 string Primitive value for string
Max Length:1048576
Patient.Slices for extension.extension:birthPlace.value[x].postalCode This element is included in summaries. 0..1 string Postal code for area
Example General: 9132
Patient.Slices for extension.extension:birthPlace.value[x].country This element is included in summaries. 0..1 string Country code
Binding: Value Set - Birthplace Country Vital Records (required)
Patient.Slices for extension.extension:birthPlace.value[x].period This element is included in summaries. 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
Patient.Slices for extension.extension:parentReportedAgeAtDelivery 0..2 (Complex) Extension - Reported Parent Age at Delivery - Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-reported-parent-age-at-delivery-vr
Patient.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Patient.Slices for identifier This element must be supported. This element is included in summaries. 1..* Identifier An identifier for this patient
Slice: Unordered, Open by pattern:type

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for identifier.identifier:MRN This element must be supported. This element is included in summaries. 0..* Identifier Medical Record Number
Patient.Slices for identifier.identifier:MRN.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:MRN.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:MRN.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:MRN.type This element is included in summaries. 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
      "code" : "MR"
    }
  ]
}
Patient.Slices for identifier.identifier:MRN.type.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:MRN.type.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:MRN.type.coding This element is included in summaries. 0..* Coding Code defined by a terminology system
Patient.Slices for identifier.identifier:MRN.type.coding.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:MRN.type.coding.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:MRN.type.coding.system This element is included in summaries. 0..1 uri Identity of the terminology system
Patient.Slices for identifier.identifier:MRN.type.coding.version This element is included in summaries. 0..1 string Version of the system - if relevant
Patient.Slices for identifier.identifier:MRN.type.coding.code This element is included in summaries. 0..1 code Code type
Patient.Slices for identifier.identifier:MRN.type.coding.display This element is included in summaries. 0..1 string Representation defined by the system
Patient.Slices for identifier.identifier:MRN.type.coding.userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user
Patient.Slices for identifier.identifier:MRN.type.text This element is included in summaries. 0..1 string Plain text representation of the concept
Patient.Slices for identifier.identifier:MRN.system This element must be supported. This element is included in summaries. 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Patient.Slices for identifier.identifier:MRN.value This element must be supported. This element is included in summaries. 1..1 string Medical Record no.
Example General: 123456
Patient.Slices for identifier.identifier:MRN.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Patient.Slices for identifier.identifier:MRN.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Patient.Slices for identifier.identifier:SSN This element must be supported. This element is included in summaries. 0..1 Identifier SSN if available and appropriate to send
Patient.Slices for identifier.identifier:SSN.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:SSN.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:SSN.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Patient.Slices for identifier.identifier:SSN.type This element is included in summaries. 1..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
      "code" : "SS"
    }
  ]
}
Patient.Slices for identifier.identifier:SSN.type.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:SSN.type.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:SSN.type.coding This element is included in summaries. 0..* Coding Code defined by a terminology system
Patient.Slices for identifier.identifier:SSN.type.coding.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:SSN.type.coding.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:SSN.type.coding.system This element is included in summaries. 0..1 uri Identity of the terminology system
Patient.Slices for identifier.identifier:SSN.type.coding.version This element is included in summaries. 0..1 string Version of the system - if relevant
Patient.Slices for identifier.identifier:SSN.type.coding.code This element is included in summaries. 0..1 code Code type
Patient.Slices for identifier.identifier:SSN.type.coding.display This element is included in summaries. 0..1 string Representation defined by the system
Patient.Slices for identifier.identifier:SSN.type.coding.userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user
Patient.Slices for identifier.identifier:SSN.type.text This element is included in summaries. 0..1 string Plain text representation of the concept
Patient.Slices for identifier.identifier:SSN.system This element must be supported. This element is included in summaries. 1..1 uri The namespace for the identifier value
Required Pattern: http://hl7.org/fhir/sid/us-ssn (extensions allowed)
Patient.Slices for identifier.identifier:SSN.value This element must be supported. This element is included in summaries. 1..1 string Social Security no.
Example General: 123456
Patient.Slices for identifier.identifier:SSN.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Patient.Slices for identifier.identifier:SSN.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Patient.active This element is a modifier element. This element is included in summaries. 0..1 boolean Whether this patient's record is in active use
Patient.Slices for name This element must be supported. This element is included in summaries. 1..* HumanName A name associated with the patient
Slice: Unordered, Open by value:use

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for name.name:All Slices Content/Rules for all slices
Patient.Slices for name.name:All Slices.id 0..1 string Unique id for inter-element referencing
Patient.Slices for name.name:All Slices.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for name.name:All Slices.use This element is a modifier element. This element is included in summaries. 0..1 code The use of a human name
Binding: NameUse (required): The use of a human name.
Patient.Slices for name.name:All Slices.text This element is included in summaries. 0..1 string Text representation of the full name
Patient.Slices for name.name:All Slices.family This element must be supported. This element is included in summaries. C 1..1 string Surname
Patient.Slices for name.name:All Slices.family.id 0..1 string xml:id (or equivalent in JSON)
Patient.Slices for name.name:All Slices.family.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Patient.Slices for name.name:All Slices.family.Slices for extension.extension:dataAbsentReason 0..1 code unknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
Patient.Slices for name.name:All Slices.family.value 0..1 string Primitive value for string
Max Length:1048576
Patient.Slices for name.name:All Slices.given This element must be supported. This element is included in summaries. C 0..* string Given name
This repeating element order: Given Names appear in the correct order for presenting the name
Patient.Slices for name.name:All Slices.given.id 0..1 string xml:id (or equivalent in JSON)
Patient.Slices for name.name:All Slices.given.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Patient.Slices for name.name:All Slices.given.Slices for extension.extension:dataAbsentReason 0..1 code unknown | asked | temp | notasked | masked | unsupported | astext | error
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
Patient.Slices for name.name:All Slices.given.value 0..1 string Primitive value for string
Max Length:1048576
Patient.Slices for name.name:All Slices.prefix This element is included in summaries. 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
Patient.Slices for name.name:All Slices.suffix This element is included in summaries. 0..* string Surname suffix
This repeating element order: Suffixes appear in the correct order for presenting the name
Patient.Slices for name.name:All Slices.period This element is included in summaries. 0..1 Period Time period when name was/is in use
Patient.Slices for name.name:currentLegalName This element must be supported. This element is included in summaries. 0..1 HumanName current legal name
Patient.Slices for name.name:currentLegalName.id 0..1 string Unique id for inter-element referencing
Patient.Slices for name.name:currentLegalName.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for name.name:currentLegalName.use This element is a modifier element. This element is included in summaries. 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Fixed Value: official (no extensions allowed)
Patient.Slices for name.name:currentLegalName.text This element is included in summaries. 0..1 string Text representation of the full name
Patient.Slices for name.name:currentLegalName.family This element must be supported. This element is included in summaries. C 1..1 string Family name (often called 'Surname')
Patient.Slices for name.name:currentLegalName.given This element must be supported. This element is included in summaries. C 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
Patient.Slices for name.name:currentLegalName.prefix This element is included in summaries. 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
Patient.Slices for name.name:currentLegalName.suffix This element is included in summaries. 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
Patient.Slices for name.name:currentLegalName.period This element is included in summaries. 0..1 Period Time period when name was/is in use
Patient.Slices for name.name:namePriorToFirstMarriage This element must be supported. This element is included in summaries. 0..1 HumanName Name prior to first marriage
Patient.Slices for name.name:namePriorToFirstMarriage.id 0..1 string Unique id for inter-element referencing
Patient.Slices for name.name:namePriorToFirstMarriage.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for name.name:namePriorToFirstMarriage.use This element is a modifier element. This element is included in summaries. 1..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Fixed Value: maiden (no extensions allowed)
Patient.Slices for name.name:namePriorToFirstMarriage.text This element is included in summaries. 0..1 string Text representation of the full name
Patient.Slices for name.name:namePriorToFirstMarriage.family This element must be supported. This element is included in summaries. C 1..1 string Family name (often called 'Surname')
Patient.Slices for name.name:namePriorToFirstMarriage.given This element must be supported. This element is included in summaries. C 0..* string Given names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
Patient.Slices for name.name:namePriorToFirstMarriage.prefix This element is included in summaries. 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
Patient.Slices for name.name:namePriorToFirstMarriage.suffix This element is included in summaries. 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
Patient.Slices for name.name:namePriorToFirstMarriage.period This element is included in summaries. 0..1 Period Time period when name was/is in use
Patient.telecom This element is included in summaries. 0..* ContactPoint A contact detail for the individual
Patient.telecom.id 0..1 string Unique id for inter-element referencing
Patient.telecom.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.telecom.system This element must be supported. This element is included in summaries. C 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Patient.telecom.value This element must be supported. This element is included in summaries. 1..1 string The actual contact point details
Patient.telecom.use This element is a modifier element. This element must be supported. This element is included in summaries. 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
Patient.telecom.rank This element is included in summaries. 0..1 positiveInt Specify preferred order of use (1 = highest)
Patient.telecom.period This element is included in summaries. 0..1 Period Time period when the contact point was/is in use
Patient.gender This element must be supported. This element is included in summaries. 1..1 code male | female | other | unknown
Binding: AdministrativeGender (required)
Patient.birthDate This element must be supported. This element is included in summaries. 1..1 date The date of birth for the individual
Patient.birthDate.id 0..1 string xml:id (or equivalent in JSON)
Patient.birthDate.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Patient.birthDate.Slices for extension.extension:partialDateTime 0..1 (Complex) partialDateTIme
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-partial-date-time-vr
Patient.birthDate.Slices for extension.extension:birthTime 0..1 dateTime Time of day of birth
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
Patient.birthDate.Slices for extension.extension:bypassEditFlag 0..1 (Complex) To reflect the relevant edit possibilities for Mother's date of birth.
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag
Patient.birthDate.Slices for extension.extension:bypassEditFlag.id 0..1 string Unique id for inter-element referencing
Patient.birthDate.Slices for extension.extension:bypassEditFlag.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.birthDate.Slices for extension.extension:bypassEditFlag.url 1..1 uri "http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag"
Patient.birthDate.Slices for extension.extension:bypassEditFlag.value[x] 1..1 CodeableConcept Date edit
Binding: Value Set - Date of Birth Edit Flags (NCHS) Vital Records (required): Date of Birth Edit Flags (NCHS)
Patient.birthDate.value 0..1 date Primitive value for date
Patient.Slices for deceased[x] This element is a modifier element. This element is included in summaries. 0..1 Indicates if the individual is deceased or not, dateTime is preferred
Slice: Unordered, Closed by type:$this
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view
Patient.Slices for deceased[x].deceasedBoolean boolean
Patient.Slices for deceased[x].deceasedDateTime dateTime
Patient.Slices for deceased[x].deceased[x]:deceasedBoolean This element is a modifier element. This element is included in summaries. C 0..1 boolean Boolean indicator. True if the individual is deceased.
Constraints: fetalDeathOnlyIfDeceased
Patient.Slices for deceased[x].deceased[x]:deceasedBoolean.id 0..1 string xml:id (or equivalent in JSON)
Patient.Slices for deceased[x].deceased[x]:deceasedBoolean.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Patient.Slices for deceased[x].deceased[x]:deceasedBoolean.Slices for extension Content/Rules for all slices
Patient.Slices for deceased[x].deceased[x]:deceasedBoolean.Slices for extension.extension:fetalDeath 0..1 boolean Boolean indicator. True if the Patient died as a fetus.
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-patient-fetal-death-vr
Patient.Slices for deceased[x].deceased[x]:deceasedBoolean.value 0..1 boolean Primitive value for boolean
Patient.address This element must be supported. This element is included in summaries. 0..* Address An address for the individual
Patient.address.id 0..1 string Unique id for inter-element referencing
Patient.address.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.address.Slices for extension.extension:withinCityLimitsIndicator 0..1 (Complex) Within City Limits Indicator Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-within-city-limits-indicator-vr
Patient.address.Slices for extension.extension:withinCityLimitsIndicator.id 0..1 string Unique id for inter-element referencing
Patient.address.Slices for extension.extension:withinCityLimitsIndicator.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.address.Slices for extension.extension:withinCityLimitsIndicator.url 1..1 uri "http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-within-city-limits-indicator-vr"
Patient.address.Slices for extension.extension:withinCityLimitsIndicator.value[x] 1..1 Coding Residence inside city limits
Binding: Value Set - Yes No Unknown Vital Records (required): Yes No Unknown (YNU)
Patient.address.Slices for extension.extension:predir 0..1 string Residence predirectional
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PreDirectional
Patient.address.Slices for extension.extension:stnum 0..1 string Residence street number
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetNumber
Patient.address.Slices for extension.extension:stname 0..1 string Residence street name
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetName
Patient.address.Slices for extension.extension:stdesig 0..1 string Residence street designator
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetDesignator
Patient.address.Slices for extension.extension:postdir 0..1 string Residence postdirectional
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PostDirectional
Patient.address.Slices for extension.extension:unitnumber 0..1 string Residence unit no.
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/UnitOrAptNumber
Patient.address.use This element is a modifier element. This element is included in summaries. 0..1 code Identifies the use of Mother's address, for residence=home and mailing=billing
Binding: AddressUse (required): The use of an address.
Example General: home
Patient.address.type This element is included in summaries. 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
Patient.address.text This element is included in summaries. 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
Patient.address.line This element must be supported. This element is included in summaries. 0..* string Street address
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
Patient.address.city This element must be supported. This element is included in summaries. 0..1 string City literal
Example General: Erewhon
Patient.address.city.id 0..1 string xml:id (or equivalent in JSON)
Patient.address.city.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Patient.address.city.Slices for extension.extension:cityCode 0..1 positiveInt city code
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode
Patient.address.city.value 0..1 string Primitive value for string
Max Length:1048576
Patient.address.district This element is included in summaries. 0..1 string County literal
Example General: Madison
Patient.address.district.id 0..1 string xml:id (or equivalent in JSON)
Patient.address.district.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Patient.address.district.Slices for extension.extension:districtCode 0..1 positiveInt county code
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/DistrictCode
Patient.address.district.value 0..1 string Primitive value for string
Max Length:1048576
Patient.address.state This element must be supported. This element is included in summaries. 0..1 string State
Binding: Value Set - States, Territories and Provinces Vital Records (required)
Patient.address.postalCode This element must be supported. This element is included in summaries. 0..1 string Zip code
Example General: 9132
Patient.address.country This element is included in summaries. 0..1 string Country
Binding: Value Set - Residence Country Vital Records (required)
Patient.address.period This element must be supported. This element is included in summaries. 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
Patient.maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
Patient.maritalStatus.id 0..1 string Unique id for inter-element referencing
Patient.maritalStatus.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.maritalStatus.coding This element is included in summaries. 0..* Coding Code defined by a terminology system
Patient.maritalStatus.text This element is included in summaries. 0..1 string marital status desc
Patient.multipleBirth[x] 0..1 If not single birth - born first, second, third, etc.
Patient.multipleBirth[x].multipleBirth[x]All Types Content/Rules for all Types
Patient.multipleBirth[x].multipleBirth[x]All Types.id 0..1 string Unique id for inter-element referencing
Patient.multipleBirth[x].multipleBirth[x]All Types.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.multipleBirth[x].multipleBirth[x]All Types.Slices for extension.extension:bypassEditFlag 0..1 (Complex) BypassEditFlag Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag
Patient.multipleBirth[x].multipleBirth[x]All Types.Slices for extension.extension:bypassEditFlag.id 0..1 string Unique id for inter-element referencing
Patient.multipleBirth[x].multipleBirth[x]All Types.Slices for extension.extension:bypassEditFlag.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.multipleBirth[x].multipleBirth[x]All Types.Slices for extension.extension:bypassEditFlag.url 1..1 uri "http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag"
Patient.multipleBirth[x].multipleBirth[x]All Types.Slices for extension.extension:bypassEditFlag.value[x] 1..1 CodeableConcept Value of extension
Binding: Value Set - Plurality Edit Flags (NCHS) Vital Records (required): Plurality Edit Flags (NCHS)
Patient.multipleBirth[x].multipleBirth[x]All Types.Slices for extension.extension:multipleBirthTotal 0..1 positiveInt Total births in this pregnancy
URL: http://hl7.org/fhir/StructureDefinition/patient-multipleBirthTotal
Patient.multipleBirth[x].multipleBirthBoolean boolean
Patient.multipleBirth[x].multipleBirthInteger integer
Patient.photo 0..* Attachment Image of the patient
Patient.contact C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
Constraints: pat-1
Patient.contact.id 0..1 string Unique id for inter-element referencing
Patient.contact.extension 0..* Extension Additional content defined by implementations
Patient.contact.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.contact.relationship 0..* CodeableConcept The kind of relationship
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
Patient.contact.name 0..1 HumanName A name associated with the contact person
Patient.contact.telecom 0..* ContactPoint A contact detail for the person
Patient.contact.address 0..1 Address Address for the contact person
Patient.contact.gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Patient.contact.organization C 0..1 Reference(Organization) Organization that is associated with the contact
Patient.contact.period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
Patient.communication 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
Patient.communication.id 0..1 string Unique id for inter-element referencing
Patient.communication.extension 0..* Extension Additional content defined by implementations
Patient.communication.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.communication.language This element must be supported. 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Binding: Language codes with language and optionally a region modifier (extensible)
Patient.communication.preferred 0..1 boolean Language preference indicator
Patient.generalPractitioner 0..* Reference(Organization | Practitioner | PractitionerRole) Patient's nominated primary care provider
Patient.managingOrganization This element is included in summaries. 0..1 Reference(Organization) Organization that is the custodian of the patient record
Patient.Slices for link This element is a modifier element. This element is included in summaries. 0..* BackboneElement Link to another patient resource that concerns the same actual person
Slice: Unordered, Open by pattern:type

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for link.link:All Slices Content/Rules for all slices
Patient.Slices for link.link:All Slices.id 0..1 string Unique id for inter-element referencing
Patient.Slices for link.link:All Slices.extension 0..* Extension Additional content defined by implementations
Patient.Slices for link.link:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.Slices for link.link:All Slices.other This element is included in summaries. 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
Patient.Slices for link.link:All Slices.type This element is included in summaries. 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Patient.Slices for link.link:mother This element is a modifier element. This element is included in summaries. 0..1 BackboneElement Link to the birth mother's RelatedPerson record
Patient.Slices for link.link:mother.id 0..1 string Unique id for inter-element referencing
Patient.Slices for link.link:mother.extension 0..* Extension Additional content defined by implementations
Patient.Slices for link.link:mother.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.Slices for link.link:mother.other This element is included in summaries. 1..1 Reference(RelatedPerson - Mother Vital Records) The other patient or related person resource that the link refers to
Patient.Slices for link.link:mother.type This element is included in summaries. 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Required Pattern: seealso (extensions allowed)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.language Base preferred Common Languages 📦4.0.1 FHIR Std.
Patient.extension:birthPlace.​value[x].use Base required AddressUse 📍4.0.1 FHIR Std.
Patient.extension:birthPlace.​value[x].type Base required AddressType 📍4.0.1 FHIR Std.
Patient.extension:birthPlace.​value[x].state Base required Value Set - States, Territories and Provinces Vital Records 📦2.0.0 This IG
Patient.extension:birthPlace.​value[x].country Base required Value Set - Birthplace Country Vital Records 📦2.0.0 This IG
Patient.identifier:MRN.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:MRN.​type Base extensible IdentifierType 📦4.0.1 FHIR Std.
Patient.identifier:SSN.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier:SSN.​type Base extensible IdentifierType 📦4.0.1 FHIR Std.
Patient.name.use Base required NameUse 📍4.0.1 FHIR Std.
Patient.name:currentLegalName.​use Base required NameUse 📍4.0.1 FHIR Std.
Patient.name:namePriorToFirstMarriage.​use Base required NameUse 📍4.0.1 FHIR Std.
Patient.telecom.system Base required ContactPointSystem 📦4.0.1 FHIR Std.
Patient.telecom.use Base required ContactPointUse 📦4.0.1 FHIR Std.
Patient.gender Base required AdministrativeGender 📦4.0.1 FHIR Std.
Patient.birthDate.extension:bypassEditFlag.​value[x] Base required Value Set - Date of Birth Edit Flags (NCHS) Vital Records 📦2.0.0 This IG
Patient.address.extension:withinCityLimitsIndicator.​value[x] Base required Value Set - Yes No Unknown Vital Records 📦2.0.0 This IG
Patient.address.use Base required AddressUse 📍4.0.1 FHIR Std.
Patient.address.type Base required AddressType 📍4.0.1 FHIR Std.
Patient.address.state Base required Value Set - States, Territories and Provinces Vital Records 📦2.0.0 This IG
Patient.address.country Base required Value Set - Residence Country Vital Records 📦2.0.0 This IG
Patient.maritalStatus Base extensible MaritalStatus 📦4.0.1 FHIR Std.
Patient.multipleBirth[x].​extension:bypassEditFlag.​value[x] Base required Value Set - Plurality Edit Flags (NCHS) Vital Records 📦2.0.0 This IG
Patient.contact.relationship Base extensible Patient Contact Relationship 📦4.0.1 FHIR Std.
Patient.contact.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Patient.communication.​language Base extensible Language codes with language and optionally a region modifier 📦5.0.1 US Core v5.0
Patient.link.type Base required LinkType 📍4.0.1 FHIR Std.
Patient.link:mother.​type Base required LinkType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

This structure is derived from PatientVitalRecords

Summary

Mandatory: 2 elements(2 nested mandatory elements)
Must-Support: 2 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Patient.link

 

Other representations of profile: CSV, Excel, Schematron