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 - Child Vital Records

Official URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Patient-child-vr Version: 2.0.0
Active as of 2026-10-16 Computable Name: PatientChildVitalRecords

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

This profile adds further constraints to the US Core Patient such as:

  • the patient-birthPlace extension
  • the patient-birthTime extension
  • the patient-multipleBirthTotal extension to record plurality
  • the base FHIR data-absent-reason extension to both name.given and name.family (a name may not yet have been chosen for the baby and US Core Patient requires that Patient.name.given or Patient.name.family or both SHALL be present)
    • use not-applicable if the name hasn't been chosen

Note: The PatientChild 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 1 Date of Birth (Infant)--Year IDOB_YR birthDate.value date See note on birth date and time
Natality 2 State, U.S. Territory or Canadian Province of Birth (Infant) - code BSTATE extension[birthPlace].value[x].state or extension[birthPlace].value[x].state.extension[nationalReportingJurisdictionId] string ValueSetStatesTerritoriesAndProvincesVitalRecords in state field or ValueSetJurisdictionVitalRecords in extension
Natality 6 Time of Birth TB birthDate.extension[patient-birthTime] dateTime See note on birth date and time
Natality 7 Sex ISEX extension[birthsex].value codeable ValueSetSexAssignedAtBirthVitalRecords
Natality Gender *NO IJE MAPPING* gender codeable USCorePatient requires gender - can be 'unknown'. See [Note on Gender]
Natality 8 Date of Birth (Infant)--Month IDOB_MO birthDate.value date See note on birth date and time
Natality 9 Date of Birth (Infant)--Day IDOB_DY birthDate.value date See note on birth date and time
Natality 10 County of Birth CNTYO extension[birthPlace].value[x].district.extension[districtCode] integer See CountyCodes
Natality 207 Plurality PLUR extension[patient-multipleBirthTotal].valuePositiveInt integer
Natality 208 Set Order SORD multipleBirth[x] integer
Natality 211 Plurality--Edit Flag PLUR_BYPASS multipleBirth.extension[bypassEditFlag].value codeable ValueSetPluralityEditFlagsVitalRecords,
See Handling of edit flags
Natality 237 Mother's Reported Age MAGER extension[parentReportedAgeAtDelivery].extension[reportedAge].value,
extension[parentReportedAgeAtDelivery].extension[motherOrFather].value='MTH'		 quantity
Natality 238 Father's Reported Age FAGER extension[parentReportedAgeAtDelivery].extension[reportedAge].value,
extension[parentReportedAgeAtDelivery].extension[motherOrFather].value='FTH'		 quantity
Natality 247 Child's First Name KIDFNAME name.given,
name.use = official		 string See note on Child and Decedent Fetus name
Natality 248 Child's Middle Name KIDMNAME name.given,
name.use = official 		string See note on Child and Decedent Fetus name
Natality 249 Child's Last Name KIDLNAME name.family,
name.use = official		 string See note on Child and Decedent Fetus name
Natality 250 Child's Surname Suffix (moved from end) KIDSUFFX name.suffix,
name.use = official		 string
Natality 251 County of Birth (Literal) BIRTH_CO extension[patient-birthPlace].value[x].district string
Natality 252 City/town/place of birth (Literal) BRTHCITY extension[patient-birthPlace].value[x].city string
Natality 332 Infant's Medical Record Number INF_MED_REC_NUM identifier.value where system = ‘http://terminology.hl7.org/CodeSystem/v2-0203'
and type.coding.code=”MR”		 string

Form Mapping

Form Mapping
Item # Form Field FHIR Profile Field Reference
1 Child’s Name name Certificate of Live Birth
2 Child's Time of Birth extension:birthTime Certificate of Live Birth
3 Child's Sex extension:birthsex Certificate of Live Birth
4 Child's Date Of Birth birthDate Certificate of Live Birth
6 City, Town, Or Location Of Birth extension:birthPlace Certificate of Live Birth
7 County Of Birth extension:birthPlace Certificate of Live Birth
48 Newborn Medical Record Number identifier:MRN Certificate of Live Birth
52 Plurality multipleBirth[x].extension:multipleBirthTotal Certificate of Live Birth
53 If Not Single Birth - Born First, Second, Third, etc. (Specify) multipleBirthInteger Certificate of Live Birth
3 City, Town or Location of birth extension:birthPlace Facility Worksheet for the Live Birth Certificate
4 County of birth extension:birthPlace Facility Worksheet for the Live Birth Certificate
17 Date of birth birthDate Facility Worksheet for the Live Birth Certificate
18 Time of birth birthDate.extension:birthTime Facility Worksheet for the Live Birth Certificate
22 Infant’s medical record number identifier:MRN Facility Worksheet for the Live Birth Certificate
31 Sex: extension:birthsex Facility Worksheet for the Live Birth Certificate
33 Plurality multipleBirthInteger.extension:multipleBirthTotal Facility Worksheet for the Live Birth Certificate
34 If not single birth, order delivered in the pregnancy multipleBirthInteger Facility Worksheet for the Live Birth Certificate
- Child’s name/medical record # identifier Attachment to the Facility Worksheet for the Live Birth Certificate for Multiple Births
17 Date of birth birthDate Attachment to the Facility Worksheet for the Live Birth Certificate for Multiple Births
18 Time of birth birthDate.extension:birthTime Attachment to the Facility Worksheet for the Live Birth Certificate for Multiple Births
34 Order delivered in the pregnancy multipleBirthInteger Attachment to the Facility Worksheet for the Live Birth Certificate for Multiple Births
31 Sex extension:birthsex Attachment to the Facility Worksheet for the Live Birth Certificate for Multiple Births
2 What will be your baby’s legal name? name Mothers Worksheet for Child’s Birth Certificate

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, childNotDeceased
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 1..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
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 1..1 (Complex) Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex
Patient.Slices for extension.extension:birthsex.extension 0..0 Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for extension.extension:birthsex.url 1..1 uri "http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex"
Patient.Slices for extension.extension:birthsex.value[x] 1..1 code Sex
Binding: Value Set - Sex Assigned At Birth Vital Records (required)
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].city This element is included in summaries. 0..1 string City of Birth
Example General: Erewhon
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].district This element is included in summaries. 0..1 string District of Birth
Example General: Madison
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 of birth
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/DistrictCode
Patient.Slices for extension.extension:birthPlace.value[x].state This element is included in summaries. 0..1 string State of Birth
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 Jurisdiction of Birth
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:parentReportedAgeAtDelivery 0..2 (Complex) The mother or father's reported age at the time of delivery of the child
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-reported-parent-age-at-delivery-vr
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension 2..3 Extension Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension Content/Rules for all slices
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension.extension:reportedAge 1..1 Extension Age of the parent at the time of delivery reported by another person.
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension.extension:reportedAge.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension.extension:reportedAge.url 1..1 uri "reportedAge"
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension.extension:reportedAge.value[x] 1..1 Quantity Reported age
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension.extension:reportedAge.value[x].value This element is included in summaries. 1..1 decimal Numerical value (with implicit precision)
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension.extension:reportedAge.value[x].comparator This element is a modifier element. This element is included in summaries. 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension.extension:reportedAge.value[x].code This element is included in summaries. 0..1 code year
Fixed Value: a (no extensions allowed)
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension.extension:motherOrFather 1..1 Extension Mother or Father
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension.extension:motherOrFather.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension.extension:motherOrFather.url 1..1 uri "motherOrFather"
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension.extension:motherOrFather.value[x] 1..1 CodeableConcept Indicates mother/Father code
Binding: Value Set - Role Vital Records (extensible): Vital Records Role
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension.extension:reporter 0..1 Extension Reference to the person who reported the parent's age.
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension.extension:reporter.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension.extension:reporter.url 1..1 uri "reporter"
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension.extension:reporter.value[x] 1..1 Reference(US Core Patient Profile | US Core RelatedPerson Profile) Value of extension
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.url 1..1 uri "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 number
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 The value that is unique within the system.
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 Family name (often called '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 When "name not chosen" use code "temp-unknown"
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 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: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 When "name not chosen" use code "temp-unknown"
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 Birth Date with support for partial date and time of birth via extension. See [Birth Date and Time].
Patient.birthDate.Slices for extension Content/Rules for all slices
Patient.birthDate.Slices for extension.extension:partialDateTime 0..1 (Complex) Use if only partial date and time of birth is known
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 Birth
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
Patient.birthDate.Slices for extension.extension:bypassEditFlag 0..1 (Complex) BypassEditFlag Vital Records
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 To reflect the relevant edit possibilities for date of birth.
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 must be supported. 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 Coding Used to indicate whether or not an address is within city limits.
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-within-city-limits-indicator-vr
Binding: Value Set - Yes No Unknown Vital Records (required): Yes No Unknown (YNU)
Patient.address.Slices for extension.extension:predir 0..1 string PreDirectional Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PreDirectional
Patient.address.Slices for extension.extension:stnum 0..1 string StreetNumber Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetNumber
Patient.address.Slices for extension.extension:stname 0..1 string StreetName Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetName
Patient.address.Slices for extension.extension:stdesig 0..1 string StreetDesignator Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetDesignator
Patient.address.Slices for extension.extension:postdir 0..1 string PostDirectional Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PostDirectional
Patient.address.Slices for extension.extension:unitnumber 0..1 string UnitOrAptNumber Vital Records
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 home | work | temp | old | billing - purpose of this address
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 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.address.city This element must be supported. This element is included in summaries. 0..1 string Name of city, town etc.
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.state This element must be supported. This element is included in summaries. 0..1 string Sub-unit of country (abbreviations ok)
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 US Zip Codes
Example General: 9132
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.multipleBirth[x] 0..1 integer If not single birth - born first, second, third, etc.
Patient.multipleBirth[x].Slices for extension Content/Rules for all slices
Patient.multipleBirth[x].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].Slices for extension.extension:bypassEditFlag.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.multipleBirth[x].Slices for extension.extension:bypassEditFlag.url 1..1 uri "http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag"
Patient.multipleBirth[x].Slices for extension.extension:bypassEditFlag.value[x] 1..1 CodeableConcept To reflect the relevant edit possibilities for plurality.
Binding: Value Set - Plurality Edit Flags (NCHS) Vital Records (required): Plurality Edit Flags (NCHS)
Patient.multipleBirth[x].Slices for extension.extension:multipleBirthTotal 0..1 (Complex) Where a patient is a part of a multiple delivery, this is the total number of deliveries that occurred in this pregnancy.
URL: http://hl7.org/fhir/StructureDefinition/patient-multipleBirthTotal
Patient.multipleBirth[x].Slices for extension.extension:multipleBirthTotal.extension 0..0 Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.multipleBirth[x].Slices for extension.extension:multipleBirthTotal.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-multipleBirthTotal"
Patient.multipleBirth[x].Slices for extension.extension:multipleBirthTotal.value[x] 1..1 positiveInt Plurality
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.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
Patient.link.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.link.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.link.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.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.extension:birthsex.​value[x] Base required Value Set - Sex Assigned At Birth Vital Records 📦2.0.0 This IG
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:parentReportedAgeAtDelivery.​extension:reportedAge.​value[x].comparator Base required QuantityComparator 📍4.0.1 FHIR Std.
Patient.extension:parentReportedAgeAtDelivery.​extension:motherOrFather.​value[x] Base extensible Value Set - Role 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.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.multipleBirth[x].​extension:bypassEditFlag.​value[x] Base required Value Set - Plurality Edit Flags (NCHS) 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.

Constraints

Id Grade Path(s) Description Expression
childNotDeceased error Patient Patients who are marked deceased don't conform to PatientChildVitalRecords. If the deceased field is present, it must be false deceased.exists() implies deceased = false

This structure is derived from PatientVitalRecords

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient C 0..* PatientVitalRecords Information about an individual or animal receiving health care services
Constraints: childNotDeceased
Patient.extension 1..* Extension Extension
Patient.Slices for extension Content/Rules for all slices
Patient.Slices for extension.extension:birthsex 1..1 USCoreBirthSexExtension Extension
Patient.Slices for extension.extension:birthsex.extension 0..0 Extension
Patient.Slices for extension.extension:birthsex.value[x] 1..1 code Sex
Binding: Value Set - Sex Assigned At Birth Vital Records (required)
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].city 0..1 string City of Birth
Patient.Slices for extension.extension:birthPlace.value[x].district 0..1 string District of Birth
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 ExtensionDistrictCodeVitalRecords County of birth
Patient.Slices for extension.extension:birthPlace.value[x].state 0..1 string State of Birth
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 ExtensionLocationJurisdictionIdVitalRecords Jurisdiction of Birth
Patient.Slices for extension.extension:parentReportedAgeAtDelivery 0..2 ExtensionReportedParentAgeAtDeliveryVitalRecords The mother or father's reported age at the time of delivery of the child
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension Content/Rules for all slices
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension.extension:reportedAge 1..1 Extension Age of the parent at the time of delivery reported by another person.
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension.extension:reportedAge.value[x] 1..1 Quantity Reported age
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension.extension:motherOrFather 1..1 Extension Mother or Father
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension.extension:motherOrFather.value[x] 1..1 CodeableConcept Indicates mother/Father code
Patient.Slices for identifier Content/Rules for all slices
Patient.Slices for identifier.identifier:MRN 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 Identifier type code
Patient.Slices for identifier.identifier:MRN.value 1..1 string Medical record number
Patient.name.use 0..1 code The use of a human name
Patient.name.family 1..1 string Family name (often called 'Surname')
Patient.name.family.Slices for extension Content/Rules for all slices
Patient.name.family.Slices for extension.extension:dataAbsentReason 0..1 DataAbsentReason(5.3.0) When "name not chosen" use code "temp-unknown"
Patient.name.given
Patient.name.given.Slices for extension Content/Rules for all slices
Patient.name.given.Slices for extension.extension:dataAbsentReason 0..1 DataAbsentReason(5.3.0) When "name not chosen" use code "temp-unknown"
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 Birth Date with support for partial date and time of birth via extension. See [Birth Date and Time].
Patient.birthDate.Slices for extension Content/Rules for all slices
Patient.birthDate.Slices for extension.extension:partialDateTime 0..1 ExtensionPartialDateTimeVitalRecords Use if only partial date and time of birth is known
Patient.birthDate.Slices for extension.extension:birthTime 0..1 PatBirthTime(5.3.0) Time of Birth
Patient.deceased[x] This element must be supported. 0..1 boolean, dateTime Indicates if the individual is deceased or not, dateTime is preferred
Patient.multipleBirth[x] 0..1 integer If not single birth - born first, second, third, etc.
Patient.multipleBirth[x].Slices for extension Content/Rules for all slices
Patient.multipleBirth[x].Slices for extension.extension:bypassEditFlag 0..1 ExtensionBypassEditFlagVitalRecords BypassEditFlag Vital Records
Patient.multipleBirth[x].Slices for extension.extension:bypassEditFlag.value[x] 1..1 CodeableConcept To reflect the relevant edit possibilities for plurality.
Patient.multipleBirth[x].Slices for extension.extension:multipleBirthTotal 0..1 PatMultipleBirthTotal Where a patient is a part of a multiple delivery, this is the total number of deliveries that occurred in this pregnancy.
Patient.multipleBirth[x].Slices for extension.extension:multipleBirthTotal.extension 0..0 Extension
Patient.multipleBirth[x].Slices for extension.extension:multipleBirthTotal.value[x] 1..1 positiveInt Plurality

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Patient.extension:birthsex.​value[x] Base required Value Set - Sex Assigned At Birth Vital Records 📦2.0.0 This IG

Constraints

Id Grade Path(s) Description Expression
childNotDeceased error Patient Patients who are marked deceased don't conform to PatientChildVitalRecords. If the deceased field is present, it must be false deceased.exists() implies deceased = false
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient C 0..* PatientVitalRecords Information about an individual or animal receiving health care services
Constraints: us-core-6, childNotDeceased
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 1..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
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 1..1 (Complex) Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex
Patient.Slices for extension.extension:birthsex.id 0..1 string Unique id for inter-element referencing
Patient.Slices for extension.extension:birthsex.extension 0..0 Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for extension.extension:birthsex.url 1..1 uri "http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex"
Patient.Slices for extension.extension:birthsex.value[x] 1..1 code Sex
Binding: Value Set - Sex Assigned At Birth Vital Records (required)
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 City of Birth
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 of Birth
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 of birth
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 of Birth
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 Jurisdiction of Birth
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 (e.g. can be ISO 3166 2 or 3 letter 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) The mother or father's reported age at the time of delivery of the child
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-reported-parent-age-at-delivery-vr
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.id 0..1 string Unique id for inter-element referencing
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension 2..3 Extension Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension Content/Rules for all slices
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension.extension:reportedAge 1..1 Extension Age of the parent at the time of delivery reported by another person.
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension.extension:reportedAge.id 0..1 string Unique id for inter-element referencing
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension.extension:reportedAge.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension.extension:reportedAge.url 1..1 uri "reportedAge"
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension.extension:reportedAge.value[x] 1..1 Quantity Reported age
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension.extension:reportedAge.value[x].id 0..1 string Unique id for inter-element referencing
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension.extension:reportedAge.value[x].extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension.extension:reportedAge.value[x].value This element is included in summaries. 1..1 decimal Numerical value (with implicit precision)
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension.extension:reportedAge.value[x].comparator This element is a modifier element. This element is included in summaries. 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension.extension:reportedAge.value[x].unit This element is included in summaries. 0..1 string Unit representation
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension.extension:reportedAge.value[x].system This element is included in summaries. C 0..1 uri System that defines coded unit form
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension.extension:reportedAge.value[x].code This element is included in summaries. 0..1 code year
Fixed Value: a (no extensions allowed)
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension.extension:motherOrFather 1..1 Extension Mother or Father
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension.extension:motherOrFather.id 0..1 string Unique id for inter-element referencing
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension.extension:motherOrFather.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension.extension:motherOrFather.url 1..1 uri "motherOrFather"
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension.extension:motherOrFather.value[x] 1..1 CodeableConcept Indicates mother/Father code
Binding: Value Set - Role Vital Records (extensible): Vital Records Role
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension.extension:reporter 0..1 Extension Reference to the person who reported the parent's age.
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension.extension:reporter.id 0..1 string Unique id for inter-element referencing
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension.extension:reporter.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension.extension:reporter.url 1..1 uri "reporter"
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension.extension:reporter.value[x] 1..1 Reference(US Core Patient Profile | US Core RelatedPerson Profile) Value of extension
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.url 1..1 uri "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 Identifier type code
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 number
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.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 The value that is unique within the system.
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 Family name (often called '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 When "name not chosen" use code "temp-unknown"
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 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: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 When "name not chosen" use code "temp-unknown"
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 Birth Date with support for partial date and time of birth via extension. See [Birth Date and Time].
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) Use if only partial date and time of birth is known
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 Birth
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
Patient.birthDate.Slices for extension.extension:bypassEditFlag 0..1 (Complex) BypassEditFlag Vital Records
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 To reflect the relevant edit possibilities for date of birth.
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 must be supported. 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 Coding Used to indicate whether or not an address is within city limits.
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-within-city-limits-indicator-vr
Binding: Value Set - Yes No Unknown Vital Records (required): Yes No Unknown (YNU)
Patient.address.Slices for extension.extension:predir 0..1 string PreDirectional Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PreDirectional
Patient.address.Slices for extension.extension:stnum 0..1 string StreetNumber Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetNumber
Patient.address.Slices for extension.extension:stname 0..1 string StreetName Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetName
Patient.address.Slices for extension.extension:stdesig 0..1 string StreetDesignator Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetDesignator
Patient.address.Slices for extension.extension:postdir 0..1 string PostDirectional Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PostDirectional
Patient.address.Slices for extension.extension:unitnumber 0..1 string UnitOrAptNumber Vital Records
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 home | work | temp | old | billing - purpose of this address
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 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.address.city This element must be supported. This element is included in summaries. 0..1 string Name of city, town etc.
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 District name (aka county)
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 Sub-unit of country (abbreviations ok)
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 US Zip Codes
Example General: 9132
Patient.address.country This element is included in summaries. 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
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.multipleBirth[x] 0..1 integer If not single birth - born first, second, third, etc.
Patient.multipleBirth[x].id 0..1 string Unique id for inter-element referencing
Patient.multipleBirth[x].Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.multipleBirth[x].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].Slices for extension.extension:bypassEditFlag.id 0..1 string Unique id for inter-element referencing
Patient.multipleBirth[x].Slices for extension.extension:bypassEditFlag.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.multipleBirth[x].Slices for extension.extension:bypassEditFlag.url 1..1 uri "http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag"
Patient.multipleBirth[x].Slices for extension.extension:bypassEditFlag.value[x] 1..1 CodeableConcept To reflect the relevant edit possibilities for plurality.
Binding: Value Set - Plurality Edit Flags (NCHS) Vital Records (required): Plurality Edit Flags (NCHS)
Patient.multipleBirth[x].Slices for extension.extension:multipleBirthTotal 0..1 (Complex) Where a patient is a part of a multiple delivery, this is the total number of deliveries that occurred in this pregnancy.
URL: http://hl7.org/fhir/StructureDefinition/patient-multipleBirthTotal
Patient.multipleBirth[x].Slices for extension.extension:multipleBirthTotal.id 0..1 string Unique id for inter-element referencing
Patient.multipleBirth[x].Slices for extension.extension:multipleBirthTotal.extension 0..0 Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.multipleBirth[x].Slices for extension.extension:multipleBirthTotal.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-multipleBirthTotal"
Patient.multipleBirth[x].Slices for extension.extension:multipleBirthTotal.value[x] 1..1 positiveInt Plurality
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.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
Patient.link.id 0..1 string Unique id for inter-element referencing
Patient.link.extension 0..* Extension Additional content defined by implementations
Patient.link.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.link.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.link.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.

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:birthsex.​value[x] Base required Value Set - Sex Assigned At Birth Vital Records 📦2.0.0 This IG
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.extension:parentReportedAgeAtDelivery.​extension:reportedAge.​value[x].comparator Base required QuantityComparator 📍4.0.1 FHIR Std.
Patient.extension:parentReportedAgeAtDelivery.​extension:motherOrFather.​value[x] Base extensible Value Set - Role 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.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.

Constraints

Id Grade Path(s) Description Expression
childNotDeceased error Patient Patients who are marked deceased don't conform to PatientChildVitalRecords. If the deceased field is present, it must be false deceased.exists() implies deceased = false

This structure is derived from PatientVitalRecords

Summary

Mandatory: 4 elements(2 nested mandatory elements)
Must-Support: 1 element
Prohibited: 2 elements

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, childNotDeceased
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 1..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
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 1..1 (Complex) Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex
Patient.Slices for extension.extension:birthsex.extension 0..0 Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for extension.extension:birthsex.url 1..1 uri "http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex"
Patient.Slices for extension.extension:birthsex.value[x] 1..1 code Sex
Binding: Value Set - Sex Assigned At Birth Vital Records (required)
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].city This element is included in summaries. 0..1 string City of Birth
Example General: Erewhon
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].district This element is included in summaries. 0..1 string District of Birth
Example General: Madison
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 of birth
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/DistrictCode
Patient.Slices for extension.extension:birthPlace.value[x].state This element is included in summaries. 0..1 string State of Birth
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 Jurisdiction of Birth
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:parentReportedAgeAtDelivery 0..2 (Complex) The mother or father's reported age at the time of delivery of the child
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-reported-parent-age-at-delivery-vr
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension 2..3 Extension Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension Content/Rules for all slices
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension.extension:reportedAge 1..1 Extension Age of the parent at the time of delivery reported by another person.
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension.extension:reportedAge.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension.extension:reportedAge.url 1..1 uri "reportedAge"
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension.extension:reportedAge.value[x] 1..1 Quantity Reported age
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension.extension:reportedAge.value[x].value This element is included in summaries. 1..1 decimal Numerical value (with implicit precision)
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension.extension:reportedAge.value[x].comparator This element is a modifier element. This element is included in summaries. 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension.extension:reportedAge.value[x].code This element is included in summaries. 0..1 code year
Fixed Value: a (no extensions allowed)
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension.extension:motherOrFather 1..1 Extension Mother or Father
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension.extension:motherOrFather.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension.extension:motherOrFather.url 1..1 uri "motherOrFather"
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension.extension:motherOrFather.value[x] 1..1 CodeableConcept Indicates mother/Father code
Binding: Value Set - Role Vital Records (extensible): Vital Records Role
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension.extension:reporter 0..1 Extension Reference to the person who reported the parent's age.
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension.extension:reporter.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension.extension:reporter.url 1..1 uri "reporter"
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension.extension:reporter.value[x] 1..1 Reference(US Core Patient Profile | US Core RelatedPerson Profile) Value of extension
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.url 1..1 uri "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 number
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 The value that is unique within the system.
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 Family name (often called '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 When "name not chosen" use code "temp-unknown"
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 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: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 When "name not chosen" use code "temp-unknown"
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 Birth Date with support for partial date and time of birth via extension. See [Birth Date and Time].
Patient.birthDate.Slices for extension Content/Rules for all slices
Patient.birthDate.Slices for extension.extension:partialDateTime 0..1 (Complex) Use if only partial date and time of birth is known
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 Birth
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
Patient.birthDate.Slices for extension.extension:bypassEditFlag 0..1 (Complex) BypassEditFlag Vital Records
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 To reflect the relevant edit possibilities for date of birth.
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 must be supported. 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 Coding Used to indicate whether or not an address is within city limits.
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-within-city-limits-indicator-vr
Binding: Value Set - Yes No Unknown Vital Records (required): Yes No Unknown (YNU)
Patient.address.Slices for extension.extension:predir 0..1 string PreDirectional Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PreDirectional
Patient.address.Slices for extension.extension:stnum 0..1 string StreetNumber Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetNumber
Patient.address.Slices for extension.extension:stname 0..1 string StreetName Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetName
Patient.address.Slices for extension.extension:stdesig 0..1 string StreetDesignator Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetDesignator
Patient.address.Slices for extension.extension:postdir 0..1 string PostDirectional Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PostDirectional
Patient.address.Slices for extension.extension:unitnumber 0..1 string UnitOrAptNumber Vital Records
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 home | work | temp | old | billing - purpose of this address
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 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.address.city This element must be supported. This element is included in summaries. 0..1 string Name of city, town etc.
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.state This element must be supported. This element is included in summaries. 0..1 string Sub-unit of country (abbreviations ok)
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 US Zip Codes
Example General: 9132
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.multipleBirth[x] 0..1 integer If not single birth - born first, second, third, etc.
Patient.multipleBirth[x].Slices for extension Content/Rules for all slices
Patient.multipleBirth[x].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].Slices for extension.extension:bypassEditFlag.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.multipleBirth[x].Slices for extension.extension:bypassEditFlag.url 1..1 uri "http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag"
Patient.multipleBirth[x].Slices for extension.extension:bypassEditFlag.value[x] 1..1 CodeableConcept To reflect the relevant edit possibilities for plurality.
Binding: Value Set - Plurality Edit Flags (NCHS) Vital Records (required): Plurality Edit Flags (NCHS)
Patient.multipleBirth[x].Slices for extension.extension:multipleBirthTotal 0..1 (Complex) Where a patient is a part of a multiple delivery, this is the total number of deliveries that occurred in this pregnancy.
URL: http://hl7.org/fhir/StructureDefinition/patient-multipleBirthTotal
Patient.multipleBirth[x].Slices for extension.extension:multipleBirthTotal.extension 0..0 Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.multipleBirth[x].Slices for extension.extension:multipleBirthTotal.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-multipleBirthTotal"
Patient.multipleBirth[x].Slices for extension.extension:multipleBirthTotal.value[x] 1..1 positiveInt Plurality
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.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
Patient.link.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.link.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.link.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.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.extension:birthsex.​value[x] Base required Value Set - Sex Assigned At Birth Vital Records 📦2.0.0 This IG
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:parentReportedAgeAtDelivery.​extension:reportedAge.​value[x].comparator Base required QuantityComparator 📍4.0.1 FHIR Std.
Patient.extension:parentReportedAgeAtDelivery.​extension:motherOrFather.​value[x] Base extensible Value Set - Role 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.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.multipleBirth[x].​extension:bypassEditFlag.​value[x] Base required Value Set - Plurality Edit Flags (NCHS) 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.

Constraints

Id Grade Path(s) Description Expression
childNotDeceased error Patient Patients who are marked deceased don't conform to PatientChildVitalRecords. If the deceased field is present, it must be false deceased.exists() implies deceased = false

Differential View

This structure is derived from PatientVitalRecords

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient C 0..* PatientVitalRecords Information about an individual or animal receiving health care services
Constraints: childNotDeceased
Patient.extension 1..* Extension Extension
Patient.Slices for extension Content/Rules for all slices
Patient.Slices for extension.extension:birthsex 1..1 USCoreBirthSexExtension Extension
Patient.Slices for extension.extension:birthsex.extension 0..0 Extension
Patient.Slices for extension.extension:birthsex.value[x] 1..1 code Sex
Binding: Value Set - Sex Assigned At Birth Vital Records (required)
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].city 0..1 string City of Birth
Patient.Slices for extension.extension:birthPlace.value[x].district 0..1 string District of Birth
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 ExtensionDistrictCodeVitalRecords County of birth
Patient.Slices for extension.extension:birthPlace.value[x].state 0..1 string State of Birth
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 ExtensionLocationJurisdictionIdVitalRecords Jurisdiction of Birth
Patient.Slices for extension.extension:parentReportedAgeAtDelivery 0..2 ExtensionReportedParentAgeAtDeliveryVitalRecords The mother or father's reported age at the time of delivery of the child
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension Content/Rules for all slices
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension.extension:reportedAge 1..1 Extension Age of the parent at the time of delivery reported by another person.
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension.extension:reportedAge.value[x] 1..1 Quantity Reported age
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension.extension:motherOrFather 1..1 Extension Mother or Father
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension.extension:motherOrFather.value[x] 1..1 CodeableConcept Indicates mother/Father code
Patient.Slices for identifier Content/Rules for all slices
Patient.Slices for identifier.identifier:MRN 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 Identifier type code
Patient.Slices for identifier.identifier:MRN.value 1..1 string Medical record number
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 Family name (often called 'Surname')
Patient.name.family.Slices for extension Content/Rules for all slices
Patient.name.family.Slices for extension.extension:dataAbsentReason 0..1 DataAbsentReason(5.3.0) When "name not chosen" use code "temp-unknown"
Patient.name.given
Patient.name.given.Slices for extension Content/Rules for all slices
Patient.name.given.Slices for extension.extension:dataAbsentReason 0..1 DataAbsentReason(5.3.0) When "name not chosen" use code "temp-unknown"
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 Birth Date with support for partial date and time of birth via extension. See [Birth Date and Time].
Patient.birthDate.Slices for extension Content/Rules for all slices
Patient.birthDate.Slices for extension.extension:partialDateTime 0..1 ExtensionPartialDateTimeVitalRecords Use if only partial date and time of birth is known
Patient.birthDate.Slices for extension.extension:birthTime 0..1 PatBirthTime(5.3.0) Time of Birth
Patient.deceased[x] This element must be supported. 0..1 boolean, dateTime Indicates if the individual is deceased or not, dateTime is preferred
Patient.multipleBirth[x] 0..1 integer If not single birth - born first, second, third, etc.
Patient.multipleBirth[x].Slices for extension Content/Rules for all slices
Patient.multipleBirth[x].Slices for extension.extension:bypassEditFlag 0..1 ExtensionBypassEditFlagVitalRecords BypassEditFlag Vital Records
Patient.multipleBirth[x].Slices for extension.extension:bypassEditFlag.value[x] 1..1 CodeableConcept To reflect the relevant edit possibilities for plurality.
Patient.multipleBirth[x].Slices for extension.extension:multipleBirthTotal 0..1 PatMultipleBirthTotal Where a patient is a part of a multiple delivery, this is the total number of deliveries that occurred in this pregnancy.
Patient.multipleBirth[x].Slices for extension.extension:multipleBirthTotal.extension 0..0 Extension
Patient.multipleBirth[x].Slices for extension.extension:multipleBirthTotal.value[x] 1..1 positiveInt Plurality

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Patient.extension:birthsex.​value[x] Base required Value Set - Sex Assigned At Birth Vital Records 📦2.0.0 This IG

Constraints

Id Grade Path(s) Description Expression
childNotDeceased error Patient Patients who are marked deceased don't conform to PatientChildVitalRecords. If the deceased field is present, it must be false deceased.exists() implies deceased = false

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, childNotDeceased
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 1..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
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 1..1 (Complex) Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex
Patient.Slices for extension.extension:birthsex.id 0..1 string Unique id for inter-element referencing
Patient.Slices for extension.extension:birthsex.extension 0..0 Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.Slices for extension.extension:birthsex.url 1..1 uri "http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex"
Patient.Slices for extension.extension:birthsex.value[x] 1..1 code Sex
Binding: Value Set - Sex Assigned At Birth Vital Records (required)
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 City of Birth
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 of Birth
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 of birth
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 of Birth
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 Jurisdiction of Birth
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 (e.g. can be ISO 3166 2 or 3 letter 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) The mother or father's reported age at the time of delivery of the child
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-reported-parent-age-at-delivery-vr
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.id 0..1 string Unique id for inter-element referencing
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension 2..3 Extension Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension Content/Rules for all slices
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension.extension:reportedAge 1..1 Extension Age of the parent at the time of delivery reported by another person.
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension.extension:reportedAge.id 0..1 string Unique id for inter-element referencing
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension.extension:reportedAge.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension.extension:reportedAge.url 1..1 uri "reportedAge"
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension.extension:reportedAge.value[x] 1..1 Quantity Reported age
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension.extension:reportedAge.value[x].id 0..1 string Unique id for inter-element referencing
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension.extension:reportedAge.value[x].extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension.extension:reportedAge.value[x].value This element is included in summaries. 1..1 decimal Numerical value (with implicit precision)
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension.extension:reportedAge.value[x].comparator This element is a modifier element. This element is included in summaries. 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension.extension:reportedAge.value[x].unit This element is included in summaries. 0..1 string Unit representation
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension.extension:reportedAge.value[x].system This element is included in summaries. C 0..1 uri System that defines coded unit form
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension.extension:reportedAge.value[x].code This element is included in summaries. 0..1 code year
Fixed Value: a (no extensions allowed)
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension.extension:motherOrFather 1..1 Extension Mother or Father
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension.extension:motherOrFather.id 0..1 string Unique id for inter-element referencing
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension.extension:motherOrFather.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension.extension:motherOrFather.url 1..1 uri "motherOrFather"
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension.extension:motherOrFather.value[x] 1..1 CodeableConcept Indicates mother/Father code
Binding: Value Set - Role Vital Records (extensible): Vital Records Role
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension.extension:reporter 0..1 Extension Reference to the person who reported the parent's age.
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension.extension:reporter.id 0..1 string Unique id for inter-element referencing
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension.extension:reporter.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension.extension:reporter.url 1..1 uri "reporter"
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.Slices for extension.extension:reporter.value[x] 1..1 Reference(US Core Patient Profile | US Core RelatedPerson Profile) Value of extension
Patient.Slices for extension.extension:parentReportedAgeAtDelivery.url 1..1 uri "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 Identifier type code
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 number
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.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 The value that is unique within the system.
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 Family name (often called '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 When "name not chosen" use code "temp-unknown"
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 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: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 When "name not chosen" use code "temp-unknown"
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 Birth Date with support for partial date and time of birth via extension. See [Birth Date and Time].
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) Use if only partial date and time of birth is known
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 Birth
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
Patient.birthDate.Slices for extension.extension:bypassEditFlag 0..1 (Complex) BypassEditFlag Vital Records
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 To reflect the relevant edit possibilities for date of birth.
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 must be supported. 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 Coding Used to indicate whether or not an address is within city limits.
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-within-city-limits-indicator-vr
Binding: Value Set - Yes No Unknown Vital Records (required): Yes No Unknown (YNU)
Patient.address.Slices for extension.extension:predir 0..1 string PreDirectional Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PreDirectional
Patient.address.Slices for extension.extension:stnum 0..1 string StreetNumber Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetNumber
Patient.address.Slices for extension.extension:stname 0..1 string StreetName Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetName
Patient.address.Slices for extension.extension:stdesig 0..1 string StreetDesignator Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetDesignator
Patient.address.Slices for extension.extension:postdir 0..1 string PostDirectional Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PostDirectional
Patient.address.Slices for extension.extension:unitnumber 0..1 string UnitOrAptNumber Vital Records
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 home | work | temp | old | billing - purpose of this address
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 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.address.city This element must be supported. This element is included in summaries. 0..1 string Name of city, town etc.
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 District name (aka county)
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 Sub-unit of country (abbreviations ok)
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 US Zip Codes
Example General: 9132
Patient.address.country This element is included in summaries. 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
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.multipleBirth[x] 0..1 integer If not single birth - born first, second, third, etc.
Patient.multipleBirth[x].id 0..1 string Unique id for inter-element referencing
Patient.multipleBirth[x].Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.multipleBirth[x].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].Slices for extension.extension:bypassEditFlag.id 0..1 string Unique id for inter-element referencing
Patient.multipleBirth[x].Slices for extension.extension:bypassEditFlag.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.multipleBirth[x].Slices for extension.extension:bypassEditFlag.url 1..1 uri "http://hl7.org/fhir/us/vr-common-library/StructureDefinition/BypassEditFlag"
Patient.multipleBirth[x].Slices for extension.extension:bypassEditFlag.value[x] 1..1 CodeableConcept To reflect the relevant edit possibilities for plurality.
Binding: Value Set - Plurality Edit Flags (NCHS) Vital Records (required): Plurality Edit Flags (NCHS)
Patient.multipleBirth[x].Slices for extension.extension:multipleBirthTotal 0..1 (Complex) Where a patient is a part of a multiple delivery, this is the total number of deliveries that occurred in this pregnancy.
URL: http://hl7.org/fhir/StructureDefinition/patient-multipleBirthTotal
Patient.multipleBirth[x].Slices for extension.extension:multipleBirthTotal.id 0..1 string Unique id for inter-element referencing
Patient.multipleBirth[x].Slices for extension.extension:multipleBirthTotal.extension 0..0 Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Patient.multipleBirth[x].Slices for extension.extension:multipleBirthTotal.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-multipleBirthTotal"
Patient.multipleBirth[x].Slices for extension.extension:multipleBirthTotal.value[x] 1..1 positiveInt Plurality
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.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
Patient.link.id 0..1 string Unique id for inter-element referencing
Patient.link.extension 0..* Extension Additional content defined by implementations
Patient.link.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Patient.link.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.link.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.

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:birthsex.​value[x] Base required Value Set - Sex Assigned At Birth Vital Records 📦2.0.0 This IG
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.extension:parentReportedAgeAtDelivery.​extension:reportedAge.​value[x].comparator Base required QuantityComparator 📍4.0.1 FHIR Std.
Patient.extension:parentReportedAgeAtDelivery.​extension:motherOrFather.​value[x] Base extensible Value Set - Role 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.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.

Constraints

Id Grade Path(s) Description Expression
childNotDeceased error Patient Patients who are marked deceased don't conform to PatientChildVitalRecords. If the deceased field is present, it must be false deceased.exists() implies deceased = false

This structure is derived from PatientVitalRecords

Summary

Mandatory: 4 elements(2 nested mandatory elements)
Must-Support: 1 element
Prohibited: 2 elements

 

Other representations of profile: CSV, Excel, Schematron