Birth And Fetal Death (BFDR) FHIR Implementation Guide
2.0.0 - STU2 - CIBuild United States of America flag

Birth And Fetal Death (BFDR) 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/fhir-bfdr/ and changes regularly. See the Directory of published versions

Resource Profile: Patient - Decedent Fetus

Official URL: http://hl7.org/fhir/us/bfdr/StructureDefinition/Patient-decedent-fetus Version: 2.0.0
Standards status: Draft Computable Name: PatientDecedentFetus
Other Identifiers: OID:2.16.840.1.113883.4.642.40.13.42.83

A stillborn for whom clinical data is included in the report.

Note: The PatientDecedentFetus profile is based on the US Core Patient Profile which requires gender. A value of 'unknown' will satisfy this requirement. Complete fetal death record submissions may fail FHIR validation due to lack of a value for gender.

IJE Mapping

Fetal Death
Use Case # Description IJE Name Field Type Value Set/Comments
Fetal Death 1 Date of Delivery (Fetus)--Year FDOD_YR birthDate.value date See note on birth date and time
Fetal Death 2 State, U.S. Territory or Canadian Province of Place of Delivery - code DSTATE extension[birthPlace].value[x].state or extension[birthPlace].value[x].state.extension[nationalReportingJurisdictionId] string ValueSetStatesTerritoriesAndProvincesVitalRecords in state field or ValueSetJurisdictionVitalRecords in extension
Fetal Death 6 Time of Delivery TD birthDate.extension[patient-birthTime] dateTime See note on birth date and time
Fetal Death 7 Sex FSEX extension[birthsex].value codeable ValueSetSexAssignedAtBirthVitalRecords
Fetal Death Gender *NO IJE MAPPING* gender codeable USCorePatient requires gender - can be 'unknown'. See Note on Gender
Fetal Death 8 Date of Delivery (Fetus)--Month FDOD_MO birthDate.value date See note on birth date and time
Fetal Death 9 Date of Delivery (Fetus)--Day FDOD_DY birthDate.value date See note on birth date and time
Fetal Death 10 County of Delivery CNTYO extension[birthPlace].value[x].district.extension[districtCode] integer See CountyCodes
Fetal Death 151 Plurality PLUR extension[patient-multipleBirthTotal].valuePositiveInt integer
Fetal Death 152 Set Order SORD multipleBirth[x] integer
Fetal Death 155 Plurality--Edit Flag PLUR_BYPASS multipleBirth.extension[bypassEditFlag].value codeable ValueSetPluralityEditFlagsVitalRecords,
See Handling of edit flags
Fetal Death 171 Mother's Reported Age MAGER extension[parentReportedAgeAtDelivery].extension[reportedAge].value,
extension[parentReportedAgeAtDelivery].extension[motherOrFather].value='MTH'
quantity
Fetal Death 172 Father's Reported Age FAGER extension[parentReportedAgeAtDelivery].extension[reportedAge].value,
extension[parentReportedAgeAtDelivery].extension[motherOrFather].value='FTH'
quantity
Fetal Death 219 Fetus First Name FETFNAME name.given,
name.use = official
string See note on Child and Decedent Fetus name
Fetal Death 220 Fetus Middle Name FETMNAME name.given,
name.use = official
string See note on Child and Decedent Fetus name
Fetal Death 221 Fetus Last Name FETLNAME name.family, name.use = official. (absence is equivalent to ‘UNKNOWN’.) string See note on Child and Decedent Fetus name
Fetal Death 222 Fetus Surname Suffix SUFFIX name.suffix,
name.use = official
string

Form Mapping

Form Mapping
Item # Form Field FHIR Profile Field Reference
1 Name of Fetus name Report of Fetal Death
2 Time of Delivery Patient-decedent-fetus.birthDate.extension:birthTime Report of Fetal Death
3 Sex Patient-decedent-fetus.extension:birthsex Report of Fetal Death
4 Date of Delivery birthDate Report of Fetal Death
5a City, Town, or Location of Delivery Patient-decedent-fetus.extension:birthPlace Report of Fetal Death
5b Zip Code of Delivery Patient-decedent-fetus.extension:birthPlace Report of Fetal Death
6 County of Delivery Patient-decedent-fetus.extension:birthPlace Report of Fetal Death
33 Plurality Patient-decedent-fetus.multipleBirthInteger.extension:multipleBirthTotal Report of Fetal Death
34 If Not Single Birth-Born First, Second, Third, etc. multipleBirthInteger Report of Fetal Death
3 City, Town or Location of delivery Patient-decedent-fetus.extension:birthPlace Facility Worksheet for the Report of Fetal Death
4 County of delivery Patient-decedent-fetus.extension:birthPlace Facility Worksheet for the Report of Fetal Death
12 Date of delivery birthDate Facility Worksheet for the Report of Fetal Death
13 Time of delivery Patient-decedent-fetus.extension:birthTime Facility Worksheet for the Report of Fetal Death
21 Sex Patient-decedent-fetus.extension:birthsex Facility Worksheet for the Report of Fetal Death
22 Plurality Patient-decedent-fetus.multipleBirth[x].extension:multipleBirthTotal Facility Worksheet for the Report of Fetal Death
23 If not single delivery, order delivered in the pregnancy multipleBirthInteger Facility Worksheet for the Report of Fetal Death
1 Would you like to name the child? name Patient’s Worksheet for the Report of Fetal Death

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient C 0..* PatientVitalRecords Information about an individual or animal receiving health care services
Constraints: us-core-6
Patient.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Patient.Slices for extension Content/Rules for all slices
Patient.Slices for extension.extension:race 0..1 (Complex) US Core Race Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
Patient.Slices for extension.extension:ethnicity 0..1 (Complex) US Core ethnicity Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
Patient.Slices for extension.extension:birthsex 0..1 (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
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 Value of extension
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].state This element is included in summaries. 0..1 string State
Binding: Value Set - States, Territories and Provinces Vital Records (required)
Patient.Slices for extension.extension:birthPlace.value[x].state.Slices for extension Content/Rules for all slices
Patient.Slices for extension.extension:birthPlace.value[x].state.Slices for extension.extension:nationalReportingJurisdictionId 0..1 string Location Jurisdiction Id Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-jurisdiction-id-vr
Binding: Value Set - Jurisdictions Vital Records (required)
Patient.Slices for extension.extension: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 Parent's 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:All Slices Content/Rules for all slices
Patient.Slices for identifier.identifier:All Slices.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:All Slices.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:All Slices.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: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 The value that is unique within the system.
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 fetus not named use code "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 fetus not named use code "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 The date of birth for the individual
Patient.birthDate.Slices for extension Content/Rules for all slices
Patient.birthDate.Slices for extension.extension:partialDateTime 0..1 (Complex) partialDateTIme
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-partial-date-time-vr
Patient.birthDate.Slices for extension.extension:birthTime 0..1 dateTime Time of day of birth
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
Patient.birthDate.Slices for extension.extension:bypassEditFlag 0..1 (Complex) 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 is included in summaries. 1..1 boolean Indicates if the individual is deceased or not
Slice: Unordered, Closed by type:$this
Patient.Slices for deceased[x].deceased[x]:deceasedBoolean This element is a modifier element. This element is included in summaries. C 1..1 boolean The fetus is deceased
Constraints: fetalDeathOnlyIfDeceased
Required Pattern: true (extensions allowed)
Patient.Slices for deceased[x].deceased[x]:deceasedBoolean.Slices for extension 1..* 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 1..1 (Complex) fetal death indicator
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-patient-fetal-death-vr
Patient.Slices for deceased[x].deceased[x]:deceasedBoolean.Slices for extension.extension:fetalDeath.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.Slices for deceased[x].deceased[x]:deceasedBoolean.Slices for extension.extension:fetalDeath.url 1..1 uri "http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-patient-fetal-death-vr"
Patient.Slices for deceased[x].deceased[x]:deceasedBoolean.Slices for extension.extension:fetalDeath.value[x] 1..1 boolean Value of extension
Required Pattern: true (extensions allowed)
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
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 Vital Records Common Library v2.0
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 Vital Records Common Library v2.0
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 Vital Records Common Library v2.0
Patient.identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
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 Vital Records Common Library v2.0
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 Vital Records Common Library v2.0
Patient.multipleBirth[x].​extension:bypassEditFlag.​value[x] Base required Value Set - Plurality Edit Flags (NCHS) Vital Records 📦2.0.0 Vital Records Common Library v2.0
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

This structure is derived from PatientVitalRecords

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient 0..* PatientVitalRecords Information about an individual or animal receiving health care services
Patient.Slices for extension Content/Rules for all slices
Patient.Slices for extension.extension:birthsex 0..1 USCoreBirthSexExtension Extension
Patient.Slices for extension.extension:birthsex.extension 0..0 Extension
Patient.Slices for extension.extension:birthsex.value[x] 1..1 code Value of extension
Binding: Value Set - Sex Assigned At Birth Vital Records (required)
Patient.Slices for extension.extension:birthPlace 0..1 PatBirthPlace(5.4.0) Place of Birth for patient
Patient.Slices for extension.extension:birthPlace.value[x]
Patient.Slices for extension.extension:birthPlace.value[x].district
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
Patient.Slices for extension.extension:birthPlace.value[x].state 0..1 string State
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 Parent's 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.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.4.0) When fetus not named use code "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.4.0) When fetus not named use code "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.deceased[x] 1..1 boolean Indicates if the individual is deceased or not
Patient.Slices for deceased[x] Content/Rules for all slices
Patient.Slices for deceased[x].deceased[x]:deceasedBoolean 1..1 boolean The fetus is deceased
Required Pattern: true (extensions allowed)
Patient.Slices for deceased[x].deceased[x]:deceasedBoolean.extension 1..* Extension Extension
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 1..1 ExtensionPatientFetalDeathVitalRecords fetal death indicator
Patient.Slices for deceased[x].deceased[x]:deceasedBoolean.Slices for extension.extension:fetalDeath.value[x] 1..1 boolean Value of extension
Required Pattern: true (extensions allowed)
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(5.4.0) 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 Vital Records Common Library v2.0
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient C 0..* PatientVitalRecords Information about an individual or animal receiving health care services
Constraints: us-core-6
Patient.id This element is included in summaries. 0..1 id Logical id of this artifact
Patient.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Patient.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Patient.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Patient.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Patient.contained 0..* Resource Contained, inline Resources
Patient.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:race 0..1 (Complex) US Core Race Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
Patient.Slices for extension.extension:ethnicity 0..1 (Complex) US Core ethnicity Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
Patient.Slices for extension.extension:birthsex 0..1 (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
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 Value of extension
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 id Unique id for inter-element referencing
Patient.Slices for extension.extension:birthPlace.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:birthPlace.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
Patient.Slices for extension.extension:birthPlace.value[x] 1..1 Address Value of extension
Patient.Slices for extension.extension:birthPlace.value[x].id 0..1 string Unique id for inter-element referencing
Patient.Slices for extension.extension:birthPlace.value[x].extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:birthPlace.value[x].use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
Patient.Slices for extension.extension:birthPlace.value[x].type This element is included in summaries. 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
Patient.Slices for extension.extension:birthPlace.value[x].text This element is included in summaries. 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
Patient.Slices for extension.extension:birthPlace.value[x].line This element is included in summaries. 0..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
Patient.Slices for extension.extension:birthPlace.value[x].city This element is included in summaries. 0..1 string Name of city, town etc.
Example General: Erewhon
Patient.Slices for extension.extension:birthPlace.value[x].city.id 0..1 string xml:id (or equivalent in JSON)
Patient.Slices for extension.extension:birthPlace.value[x].city.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:birthPlace.value[x].city.Slices for extension Content/Rules for all slices
Patient.Slices for extension.extension:birthPlace.value[x].city.Slices for extension.extension:cityCode 0..1 positiveInt City Code Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode
Patient.Slices for extension.extension:birthPlace.value[x].city.value 0..1 string Primitive value for string
Max Length:1048576
Patient.Slices for extension.extension:birthPlace.value[x].district This element is included in summaries. 0..1 string District name (aka county)
Example General: Madison
Patient.Slices for extension.extension:birthPlace.value[x].district.id 0..1 string xml:id (or equivalent in JSON)
Patient.Slices for extension.extension:birthPlace.value[x].district.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:birthPlace.value[x].district.Slices for extension Content/Rules for all slices
Patient.Slices for extension.extension:birthPlace.value[x].district.Slices for extension.extension:districtCode 0..1 positiveInt County
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
Binding: Value Set - States, Territories and Provinces Vital Records (required)
Patient.Slices for extension.extension:birthPlace.value[x].state.id 0..1 string xml:id (or equivalent in JSON)
Patient.Slices for extension.extension:birthPlace.value[x].state.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:birthPlace.value[x].state.Slices for extension Content/Rules for all slices
Patient.Slices for extension.extension:birthPlace.value[x].state.Slices for extension.extension:nationalReportingJurisdictionId 0..1 string Location Jurisdiction Id Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-jurisdiction-id-vr
Binding: Value Set - Jurisdictions Vital Records (required)
Patient.Slices for extension.extension:birthPlace.value[x].state.value 0..1 string Primitive value for string
Max Length:1048576
Patient.Slices for extension.extension:birthPlace.value[x].postalCode This element is included in summaries. 0..1 string Postal code for area
Example General: 9132
Patient.Slices for extension.extension:birthPlace.value[x].country This element is included in summaries. 0..1 string Country (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 Parent's 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:All Slices Content/Rules for all slices
Patient.Slices for identifier.identifier:All Slices.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:All Slices.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:All Slices.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:All Slices.type This element is included in summaries. 0..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.
Patient.Slices for identifier.identifier:All Slices.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:All Slices.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:All Slices.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Patient.Slices for identifier.identifier:All Slices.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
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.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 The value that is unique within the system.
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 fetus not named use code "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 fetus not named use code "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 The date of birth for the individual
Patient.birthDate.id 0..1 string xml:id (or equivalent in JSON)
Patient.birthDate.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Patient.birthDate.Slices for extension.extension:partialDateTime 0..1 (Complex) partialDateTIme
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-partial-date-time-vr
Patient.birthDate.Slices for extension.extension:birthTime 0..1 dateTime Time of day of birth
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
Patient.birthDate.Slices for extension.extension:bypassEditFlag 0..1 (Complex) 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 is included in summaries. 1..1 boolean Indicates if the individual is deceased or not
Slice: Unordered, Closed by type:$this
Patient.Slices for deceased[x].deceased[x]:deceasedBoolean This element is a modifier element. This element is included in summaries. C 1..1 boolean The fetus is deceased
Constraints: fetalDeathOnlyIfDeceased
Required Pattern: true (extensions allowed)
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 1..* 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 1..1 (Complex) fetal death indicator
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-patient-fetal-death-vr
Patient.Slices for deceased[x].deceased[x]:deceasedBoolean.Slices for extension.extension:fetalDeath.id 0..1 string Unique id for inter-element referencing
Patient.Slices for deceased[x].deceased[x]:deceasedBoolean.Slices for extension.extension:fetalDeath.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.Slices for deceased[x].deceased[x]:deceasedBoolean.Slices for extension.extension:fetalDeath.url 1..1 uri "http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-patient-fetal-death-vr"
Patient.Slices for deceased[x].deceased[x]:deceasedBoolean.Slices for extension.extension:fetalDeath.value[x] 1..1 boolean Value of extension
Required Pattern: true (extensions allowed)
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
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 Vital Records Common Library v2.0
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 Vital Records Common Library v2.0
Patient.extension:birthPlace.​value[x].country Base required Value Set - Birthplace Country Vital Records 📦2.0.0 Vital Records Common Library v2.0
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 Vital Records Common Library v2.0
Patient.identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier.type Base extensible IdentifierType 📦4.0.1 FHIR Std.
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 Vital Records Common Library v2.0
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 Vital Records Common Library v2.0
Patient.address.country Base required Value Set - Residence Country Vital Records 📦2.0.0 Vital Records Common Library v2.0
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 Vital Records Common Library v2.0
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

This structure is derived from PatientVitalRecords

Summary

Mandatory: 6 elements(2 nested mandatory elements)
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
Patient.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Patient.Slices for extension Content/Rules for all slices
Patient.Slices for extension.extension:race 0..1 (Complex) US Core Race Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
Patient.Slices for extension.extension:ethnicity 0..1 (Complex) US Core ethnicity Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
Patient.Slices for extension.extension:birthsex 0..1 (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
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 Value of extension
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].state This element is included in summaries. 0..1 string State
Binding: Value Set - States, Territories and Provinces Vital Records (required)
Patient.Slices for extension.extension:birthPlace.value[x].state.Slices for extension Content/Rules for all slices
Patient.Slices for extension.extension:birthPlace.value[x].state.Slices for extension.extension:nationalReportingJurisdictionId 0..1 string Location Jurisdiction Id Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-jurisdiction-id-vr
Binding: Value Set - Jurisdictions Vital Records (required)
Patient.Slices for extension.extension: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 Parent's 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:All Slices Content/Rules for all slices
Patient.Slices for identifier.identifier:All Slices.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:All Slices.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:All Slices.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: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 The value that is unique within the system.
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 fetus not named use code "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 fetus not named use code "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 The date of birth for the individual
Patient.birthDate.Slices for extension Content/Rules for all slices
Patient.birthDate.Slices for extension.extension:partialDateTime 0..1 (Complex) partialDateTIme
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-partial-date-time-vr
Patient.birthDate.Slices for extension.extension:birthTime 0..1 dateTime Time of day of birth
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
Patient.birthDate.Slices for extension.extension:bypassEditFlag 0..1 (Complex) 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 is included in summaries. 1..1 boolean Indicates if the individual is deceased or not
Slice: Unordered, Closed by type:$this
Patient.Slices for deceased[x].deceased[x]:deceasedBoolean This element is a modifier element. This element is included in summaries. C 1..1 boolean The fetus is deceased
Constraints: fetalDeathOnlyIfDeceased
Required Pattern: true (extensions allowed)
Patient.Slices for deceased[x].deceased[x]:deceasedBoolean.Slices for extension 1..* 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 1..1 (Complex) fetal death indicator
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-patient-fetal-death-vr
Patient.Slices for deceased[x].deceased[x]:deceasedBoolean.Slices for extension.extension:fetalDeath.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.Slices for deceased[x].deceased[x]:deceasedBoolean.Slices for extension.extension:fetalDeath.url 1..1 uri "http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-patient-fetal-death-vr"
Patient.Slices for deceased[x].deceased[x]:deceasedBoolean.Slices for extension.extension:fetalDeath.value[x] 1..1 boolean Value of extension
Required Pattern: true (extensions allowed)
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
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 Vital Records Common Library v2.0
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 Vital Records Common Library v2.0
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 Vital Records Common Library v2.0
Patient.identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
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 Vital Records Common Library v2.0
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 Vital Records Common Library v2.0
Patient.multipleBirth[x].​extension:bypassEditFlag.​value[x] Base required Value Set - Plurality Edit Flags (NCHS) Vital Records 📦2.0.0 Vital Records Common Library v2.0
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

Differential View

This structure is derived from PatientVitalRecords

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient 0..* PatientVitalRecords Information about an individual or animal receiving health care services
Patient.Slices for extension Content/Rules for all slices
Patient.Slices for extension.extension:birthsex 0..1 USCoreBirthSexExtension Extension
Patient.Slices for extension.extension:birthsex.extension 0..0 Extension
Patient.Slices for extension.extension:birthsex.value[x] 1..1 code Value of extension
Binding: Value Set - Sex Assigned At Birth Vital Records (required)
Patient.Slices for extension.extension:birthPlace 0..1 PatBirthPlace(5.4.0) Place of Birth for patient
Patient.Slices for extension.extension:birthPlace.value[x]
Patient.Slices for extension.extension:birthPlace.value[x].district
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
Patient.Slices for extension.extension:birthPlace.value[x].state 0..1 string State
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 Parent's 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.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.4.0) When fetus not named use code "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.4.0) When fetus not named use code "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 The date of birth for the individual
Patient.deceased[x] 1..1 boolean Indicates if the individual is deceased or not
Patient.Slices for deceased[x] Content/Rules for all slices
Patient.Slices for deceased[x].deceased[x]:deceasedBoolean 1..1 boolean The fetus is deceased
Required Pattern: true (extensions allowed)
Patient.Slices for deceased[x].deceased[x]:deceasedBoolean.extension 1..* Extension Extension
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 1..1 ExtensionPatientFetalDeathVitalRecords fetal death indicator
Patient.Slices for deceased[x].deceased[x]:deceasedBoolean.Slices for extension.extension:fetalDeath.value[x] 1..1 boolean Value of extension
Required Pattern: true (extensions allowed)
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(5.4.0) 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 Vital Records Common Library v2.0

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Patient C 0..* PatientVitalRecords Information about an individual or animal receiving health care services
Constraints: us-core-6
Patient.id This element is included in summaries. 0..1 id Logical id of this artifact
Patient.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Patient.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Patient.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Patient.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Patient.contained 0..* Resource Contained, inline Resources
Patient.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:race 0..1 (Complex) US Core Race Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
Patient.Slices for extension.extension:ethnicity 0..1 (Complex) US Core ethnicity Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
Patient.Slices for extension.extension:birthsex 0..1 (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
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 Value of extension
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 id Unique id for inter-element referencing
Patient.Slices for extension.extension:birthPlace.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:birthPlace.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
Patient.Slices for extension.extension:birthPlace.value[x] 1..1 Address Value of extension
Patient.Slices for extension.extension:birthPlace.value[x].id 0..1 string Unique id for inter-element referencing
Patient.Slices for extension.extension:birthPlace.value[x].extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:birthPlace.value[x].use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
Patient.Slices for extension.extension:birthPlace.value[x].type This element is included in summaries. 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
Patient.Slices for extension.extension:birthPlace.value[x].text This element is included in summaries. 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
Patient.Slices for extension.extension:birthPlace.value[x].line This element is included in summaries. 0..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
Patient.Slices for extension.extension:birthPlace.value[x].city This element is included in summaries. 0..1 string Name of city, town etc.
Example General: Erewhon
Patient.Slices for extension.extension:birthPlace.value[x].city.id 0..1 string xml:id (or equivalent in JSON)
Patient.Slices for extension.extension:birthPlace.value[x].city.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:birthPlace.value[x].city.Slices for extension Content/Rules for all slices
Patient.Slices for extension.extension:birthPlace.value[x].city.Slices for extension.extension:cityCode 0..1 positiveInt City Code Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode
Patient.Slices for extension.extension:birthPlace.value[x].city.value 0..1 string Primitive value for string
Max Length:1048576
Patient.Slices for extension.extension:birthPlace.value[x].district This element is included in summaries. 0..1 string District name (aka county)
Example General: Madison
Patient.Slices for extension.extension:birthPlace.value[x].district.id 0..1 string xml:id (or equivalent in JSON)
Patient.Slices for extension.extension:birthPlace.value[x].district.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:birthPlace.value[x].district.Slices for extension Content/Rules for all slices
Patient.Slices for extension.extension:birthPlace.value[x].district.Slices for extension.extension:districtCode 0..1 positiveInt County
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
Binding: Value Set - States, Territories and Provinces Vital Records (required)
Patient.Slices for extension.extension:birthPlace.value[x].state.id 0..1 string xml:id (or equivalent in JSON)
Patient.Slices for extension.extension:birthPlace.value[x].state.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Patient.Slices for extension.extension:birthPlace.value[x].state.Slices for extension Content/Rules for all slices
Patient.Slices for extension.extension:birthPlace.value[x].state.Slices for extension.extension:nationalReportingJurisdictionId 0..1 string Location Jurisdiction Id Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-jurisdiction-id-vr
Binding: Value Set - Jurisdictions Vital Records (required)
Patient.Slices for extension.extension:birthPlace.value[x].state.value 0..1 string Primitive value for string
Max Length:1048576
Patient.Slices for extension.extension:birthPlace.value[x].postalCode This element is included in summaries. 0..1 string Postal code for area
Example General: 9132
Patient.Slices for extension.extension:birthPlace.value[x].country This element is included in summaries. 0..1 string Country (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 Parent's 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:All Slices Content/Rules for all slices
Patient.Slices for identifier.identifier:All Slices.id 0..1 string Unique id for inter-element referencing
Patient.Slices for identifier.identifier:All Slices.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Patient.Slices for identifier.identifier:All Slices.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:All Slices.type This element is included in summaries. 0..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.
Patient.Slices for identifier.identifier:All Slices.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:All Slices.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:All Slices.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Patient.Slices for identifier.identifier:All Slices.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
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.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 The value that is unique within the system.
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 fetus not named use code "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 fetus not named use code "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 The date of birth for the individual
Patient.birthDate.id 0..1 string xml:id (or equivalent in JSON)
Patient.birthDate.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Patient.birthDate.Slices for extension.extension:partialDateTime 0..1 (Complex) partialDateTIme
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-partial-date-time-vr
Patient.birthDate.Slices for extension.extension:birthTime 0..1 dateTime Time of day of birth
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
Patient.birthDate.Slices for extension.extension:bypassEditFlag 0..1 (Complex) 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 is included in summaries. 1..1 boolean Indicates if the individual is deceased or not
Slice: Unordered, Closed by type:$this
Patient.Slices for deceased[x].deceased[x]:deceasedBoolean This element is a modifier element. This element is included in summaries. C 1..1 boolean The fetus is deceased
Constraints: fetalDeathOnlyIfDeceased
Required Pattern: true (extensions allowed)
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 1..* 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 1..1 (Complex) fetal death indicator
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-patient-fetal-death-vr
Patient.Slices for deceased[x].deceased[x]:deceasedBoolean.Slices for extension.extension:fetalDeath.id 0..1 string Unique id for inter-element referencing
Patient.Slices for deceased[x].deceased[x]:deceasedBoolean.Slices for extension.extension:fetalDeath.extension 0..0 Extension
Slice: Unordered, Open by value:url
Patient.Slices for deceased[x].deceased[x]:deceasedBoolean.Slices for extension.extension:fetalDeath.url 1..1 uri "http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-patient-fetal-death-vr"
Patient.Slices for deceased[x].deceased[x]:deceasedBoolean.Slices for extension.extension:fetalDeath.value[x] 1..1 boolean Value of extension
Required Pattern: true (extensions allowed)
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
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 Vital Records Common Library v2.0
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 Vital Records Common Library v2.0
Patient.extension:birthPlace.​value[x].country Base required Value Set - Birthplace Country Vital Records 📦2.0.0 Vital Records Common Library v2.0
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 Vital Records Common Library v2.0
Patient.identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
Patient.identifier.type Base extensible IdentifierType 📦4.0.1 FHIR Std.
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 Vital Records Common Library v2.0
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 Vital Records Common Library v2.0
Patient.address.country Base required Value Set - Residence Country Vital Records 📦2.0.0 Vital Records Common Library v2.0
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 Vital Records Common Library v2.0
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

This structure is derived from PatientVitalRecords

Summary

Mandatory: 6 elements(2 nested mandatory elements)
Prohibited: 2 elements

 

Other representations of profile: CSV, Excel, Schematron