Vital Records Death Reporting (VRDR) FHIR Implementation Guide
2.2.0 - STU 2.2 United States of America flag

This page is part of the Vital Records Death Reporting FHIR Implementation Guide (v2.2.0: STU 2) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Resource Profile: Decedent

Official URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/vrdr-decedent Version: 2.2.0
Active as of 2023-10-17 Computable Name: Decedent

Decedent (USCorePatient)

Usage

The Decedent profile contains basic information about the decedent, including data that are essential to the death record.

Note: The Decedent profile is based on the US Core Patient Profile which requires gender. The death record submission use case uses NCHS’s definition of sex at time of death which is different than gender. Complete death record submissions may fail FHIR validation due to lack of a value for gender.

# Description IJE Name IJE only Field Type Value Set
7 Decedent’s Legal Name–Given GNAME   name.given , name.use = official string See Note on Decedent Name
8 Decedent’s Legal Name–Middle MNAME   name.given , name.use = official (first letter) string See Note on Decedent Name
9 Decedent’s Legal Name–Last LNAME   name.family , name.use = official. (absence is equivalent to ‘UNKNOWN’.) string See Note on Decedent Name
10 Decedent’s Legal Name–Suffix SUFF   name.suffix , name.use = official string -
NA Gender NO IJE MAPPING   gender codeable AdministrativeGenderVS - See Note on Decedent Gender
13 Sex SEX   extension[NVSS-SexAtDeath] codeable AdministrativeGenderVS
15 Social Security Number SSN   identifier.value where system = ‘http://hl7.org/fhir/sid/us-ssn and type.coding.code=”SB” string -
19 Date of Birth–Year DOB_YR   birthDate dateTime See PartialDatesAndTimes
20 Date of Birth–Month DOB_MO   birthDate dateTime See PartialDatesAndTimes
21 Date of Birth–Day DOB_DY   birthDate dateTime See PartialDatesAndTimes
22 Birthplace–Country BPLACE_CNT   extension[patient-birthPlace].value[x].country string BirthplaceCountryVS
23 State, U.S. Territory or Canadian Province of Birth - code BPLACE_ST   extension[patient-birthPlace].value[x].state string StatesTerritoriesProvincesVS
24 Decedent’s Residence–City CITYC   address.city.extension[ cityCode ] integer see CityCodes
25 Decedent’s Residence–County COUNTYC   address.district.extension[ districtCode ] integer see CountyCodes
26 State, U.S. Territory or Canadian Province of Decedent’s residence - code STATEC   address.state string StatesTerritoriesProvincesVS
27 Decedent’s Residence–Country COUNTRYC   address.country string ResidenceCountryVS
28 Decedent’s Residence–Inside City Limits LIMITS   address.city.extension[ withinCityLimits] codeable YesNoUnknownVS
29 Marital Status MARITAL   maritalStatus codeable MaritalStatusVS
30 Marital Status–Edit Flag MARITAL_BYPASS   maritalStatus.extension[ BypassEditFlag] codeable EditBypass0124VS
143 Decedent’s spouse living at decedent’s DOD? SPOUSELV x extension[ SpouseAlive] codeable SpouseAliveVS
146 Decedent’s Residence - Street number STNUM_R   address.extension[stnum] string -
147 Decedent’s Residence - Pre Directional PREDIR_R   address.extension[predir] string -
148 Decedent’s Residence - Street name STNAME_R   address.extension[stname] string -
149 Decedent’s Residence - Street designator STDESIG_R   address.extension[stdesig] string -
150 Decedent’s Residence - Post Directional POSTDIR_R   address.extension[postdir] string -
151 Decedent’s Residence - Unit or apt number UNITNUM_R   address.extension[unitnum] string -
152 Decedent’s Residence - City or Town name CITYTEXT_R   address.city string -
153 Decedent’s Residence - ZIP code ZIP9_R   address.postalCode string -
154 Decedent’s Residence - County COUNTYTEXT_R   address.district string -
155 Decedent’s Residence - State name STATETEXT_R   address.state (expanded from 2 letter code) string See StateLiterals
156 Decedent’s Residence - COUNTRY name COUNTRYTEXT_R   address.country (expanded from 2 letter code) string See CountryLiterals
157 Long string address for decedent’s place of residence same as above but allows states to choose the way they capture information. ADDRESS_R   address.line[0] string -
166 Middle Name of Decedent DMIDDLE x name.given , name.use = official string -
194 Decedent’s Maiden Name DMAIDEN x name.text , name.use=maiden string -
195 Decedent’s Birth Place City - Code DBPLACECITYCODE x extension[patient-birthPlace].value[x].city.extension[ cityCode] integer see CityCodes
196 Decedent’s Birth Place City - Literal DBPLACECITY x extension[patient-birthPlace].value[x].city string -
201 Informant’s Relationship INFORMRELATE x contact.type.text string (30 characters) -
238 State, U.S. Territory or Canadian Province of Birth - literal STATEBTH x extension[patient-birthPlace].value[x].state or extension[patient-birthPlace].value[x].state.extension[ nationalReportingJurisdictionId] if present (expanded from 2 letter code) string See StateLiterals
246 Marital Descriptor MARITAL_DESCRIP x maritalStatus.text string -

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from USCorePatientProfile

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient USCorePatientProfile
... NVSS-SexAtDeath 0..1CodeableConceptNVSS Sex at Death
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/NVSS-SexAtDeath
Binding: Administrative Gender PHVS_Sex_MFU (required)
... Spouse-Alive 0..1CodeableConceptSpouse Alive?
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/SpouseAlive
Binding: Spouse Alive Value Set (required)
... Patient-BirthPlace 0..1AddressDecedent birthplace
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
.... value[x]
..... city
...... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... cityCode 0..1positiveIntCity Code
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/CityCode
..... state 0..1stringSub-unit of country (abbreviations ok)
Binding: States, Territories and Provinces Value Set (required)
..... country 0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
Binding: Birthplace Country Value Set (required)
.... identifier:ssn 0..1IdentifierSocial Security Number
..... type 0..1CodeableConceptDescription of identifier
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: SB
..... system 1..1uriThe namespace for the identifier value
Required Pattern: http://hl7.org/fhir/sid/us-ssn
... birthDate 0..1dateDate of Birth
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... partialDate 0..1(Complex)partialDate
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/PartialDate
... address 0..*AddressDecedent's Residence
.... withinCityLimitsIndicator 0..1CodingExtension
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/WithinCityLimitsIndicator
Binding: Yes No Unknown (required): Yes No Unknown

.... predir 0..1stringExtension
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/PreDirectional
.... stnum 0..1stringExtension
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/StreetNumber
.... stname 0..1stringExtension
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/StreetName
.... stdesig 0..1stringExtension
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/StreetDesignator
.... postdir 0..1stringExtension
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/PostDirectional
.... unitnumber 0..1stringExtension
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/UnitOrAptNumber
.... city
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... cityCode 0..1positiveIntCity Code
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/CityCode
.... district
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... districtCode 0..1positiveIntCounty code
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/DistrictCode
.... state 0..1stringSub-unit of country (abbreviations ok)
Binding: States, Territories and Provinces Value Set (required)
.... country 0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
Binding: Residence Country Value Set (required)
... maritalStatus 0..1CodeableConceptMarital (civil) status of a patient
Binding: Marital Status Value Set (required)
.... bypassEditFlag 0..1CodeableConceptExtension
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/BypassEditFlag
..... value[x] 1..1CodeableConceptValue of extension
Binding: Edit Bypass 0124 (required)
.... text 0..1stringMarital Description
... contact 0..*BackboneElementInformant information
.... relationship 0..1CodeableConceptInformant Relationship (INFORMRELATE)
..... text 0..1stringInformant Relationship (INFORMRELATE) - first 30 characters will be used

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Patient.extension:Patient-BirthPlace.value[x].staterequiredStatesTerritoriesAndProvincesVS
Patient.extension:Patient-BirthPlace.value[x].countryrequiredBirthplaceCountryVS (a valid code from Country Codes)
Patient.address.staterequiredStatesTerritoriesAndProvincesVS
Patient.address.countryrequiredResidenceCountryVS
Patient.maritalStatusrequiredMaritalStatusVS
Patient.maritalStatus.extension:bypassEditFlag.value[x]requiredEditBypass0124VS
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient C0..*USCorePatientProfileInformation about an individual or animal receiving health care services
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... race 0..1(Complex)US Core Race Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
... ethnicity 0..1(Complex)US Core ethnicity Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
... genderIdentity 0..1CodeableConceptExtension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity
Binding: Gender Identity (extensible)
... NVSS-SexAtDeath 0..1CodeableConceptNVSS Sex at Death
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/NVSS-SexAtDeath
Binding: Administrative Gender PHVS_Sex_MFU (required)
... Spouse-Alive 0..1CodeableConceptSpouse Alive?
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/SpouseAlive
Binding: Spouse Alive Value Set (required)
... Patient-BirthPlace 0..1AddressDecedent birthplace
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
.... extension 0..0
.... url 1..1uri"http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
.... value[x] 1..1AddressValue of extension
..... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
..... state Σ0..1stringSub-unit of country (abbreviations ok)
Binding: States, Territories and Provinces Value Set (required)
..... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
Binding: Birthplace Country Value Set (required)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier SΣ1..*IdentifierAn identifier for this patient
Slice: Unordered, Open by pattern:system
.... identifier:All Slices Content/Rules for all slices
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system SΣ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ1..1stringThe value that is unique within the system.
Example General: 123456
.... identifier:ssn SΣ0..1IdentifierSocial Security Number
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription 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: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: SB
..... system SΣ1..1uriThe namespace for the identifier value
Required Pattern: http://hl7.org/fhir/sid/us-ssn
..... value SΣ1..1stringThe value that is unique within the system.
Example General: 123456
... active ?!Σ0..1booleanWhether this patient's record is in active use
... name SΣ1..*HumanNameA name associated with the patient
.... use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

.... family SΣC0..1stringFamily name (often called 'Surname')
.... given SΣC0..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
... telecom Σ0..*ContactPointA contact detail for the individual
.... system SΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ1..1stringThe actual contact point details
.... use ?!SΣ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
... gender SΣ1..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate SΣ0..1dateDate of Birth
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... partialDate 0..1(Complex)partialDate
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/PartialDate
... deceased[x] ?!Σ0..1Indicates if the individual is deceased or not
.... deceasedBooleanboolean
.... deceasedDateTimedateTime
... address SΣ0..*AddressDecedent's Residence
.... withinCityLimitsIndicator 0..1CodingExtension
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/WithinCityLimitsIndicator
Binding: Yes No Unknown (required): Yes No Unknown


.... predir 0..1stringExtension
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/PreDirectional
.... stnum 0..1stringExtension
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/StreetNumber
.... stname 0..1stringExtension
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/StreetName
.... stdesig 0..1stringExtension
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/StreetDesignator
.... postdir 0..1stringExtension
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/PostDirectional
.... unitnumber 0..1stringExtension
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/UnitOrAptNumber
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... line SΣ0..*stringStreet 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
.... city SΣ0..1stringName of city, town etc.
Example General: Erewhon
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... cityCode 0..1positiveIntCity Code
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/CityCode
.... state SΣ0..1stringSub-unit of country (abbreviations ok)
Binding: States, Territories and Provinces Value Set (required)
.... postalCode SΣ0..1stringUS Zip Codes
Example General: 9132
.... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
Binding: Residence Country Value Set (required)
.... period SΣ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... maritalStatus 0..1CodeableConceptMarital (civil) status of a patient
Binding: Marital Status Value Set (required)
.... bypassEditFlag 0..1CodeableConceptExtension
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/BypassEditFlag
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/us/vrdr/StructureDefinition/BypassEditFlag"
..... value[x] 1..1CodeableConceptValue of extension
Binding: Edit Bypass 0124 (required)
.... text Σ0..1stringMarital Description
... contact C0..*BackboneElementInformant information
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... relationship 0..1CodeableConceptInformant Relationship (INFORMRELATE)
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.


..... text Σ0..1stringInformant Relationship (INFORMRELATE) - first 30 characters will be used
... communication 0..*BackboneElementA language which may be used to communicate with the patient about his or her health
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... language S1..1CodeableConceptThe 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)
... link ?!Σ0..*BackboneElementLink to another patient resource that concerns the same actual person
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... other Σ1..1Reference(Patient | RelatedPerson)The other patient or related person resource that the link refers to
.... type Σ1..1codereplaced-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

PathConformanceValueSet / Code
Patient.extension:Patient-BirthPlace.value[x].userequiredAddressUse
Patient.extension:Patient-BirthPlace.value[x].staterequiredStatesTerritoriesAndProvincesVS
Patient.extension:Patient-BirthPlace.value[x].countryrequiredBirthplaceCountryVS (a valid code from Country Codes)
Patient.identifier.userequiredIdentifierUse
Patient.identifier:ssn.userequiredIdentifierUse
Patient.identifier:ssn.typeextensiblePattern: SB
Patient.name.userequiredNameUse
Patient.telecom.systemrequiredContactPointSystem
Patient.telecom.userequiredContactPointUse
Patient.genderrequiredAdministrativeGender
Patient.address.userequiredAddressUse
Patient.address.staterequiredStatesTerritoriesAndProvincesVS
Patient.address.countryrequiredResidenceCountryVS
Patient.maritalStatusrequiredMaritalStatusVS
Patient.maritalStatus.extension:bypassEditFlag.value[x]requiredEditBypass0124VS
Patient.contact.relationshipextensiblePatientContactRelationship
Patient.communication.languageextensibleLanguageCodesWithLanguageAndOptionallyARegionModifier
Patient.link.typerequiredLinkType
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient C0..*USCorePatientProfileInformation about an individual or animal receiving health care services
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... race 0..1(Complex)US Core Race Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
... ethnicity 0..1(Complex)US Core ethnicity Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
... birthsex 0..1codeExtension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex
Binding: Birth Sex (required): Code for sex assigned at birth


... genderIdentity 0..1CodeableConceptExtension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity
Binding: Gender Identity (extensible)
... NVSS-SexAtDeath 0..1CodeableConceptNVSS Sex at Death
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/NVSS-SexAtDeath
Binding: Administrative Gender PHVS_Sex_MFU (required)
... Spouse-Alive 0..1CodeableConceptSpouse Alive?
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/SpouseAlive
Binding: Spouse Alive Value Set (required)
... Patient-BirthPlace 0..1AddressDecedent birthplace
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
.... value[x] 1..1AddressValue of extension
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
..... type Σ0..1codepostal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
..... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
..... line Σ0..*stringStreet 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
..... city Σ0..1stringName of city, town etc.
Example General: Erewhon
...... id 0..1stringxml:id (or equivalent in JSON)
...... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... cityCode 0..1positiveIntCity Code
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/CityCode
...... value 0..1stringPrimitive value for string
Max Length: 1048576
..... district Σ0..1stringDistrict name (aka county)
Example General: Madison
..... state Σ0..1stringSub-unit of country (abbreviations ok)
Binding: States, Territories and Provinces Value Set (required)
..... postalCode Σ0..1stringPostal code for area
Example General: 9132
..... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
Binding: Birthplace Country Value Set (required)
..... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier SΣ1..*IdentifierAn identifier for this patient
Slice: Unordered, Open by pattern:system
.... identifier:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription 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.

..... system SΣ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ1..1stringThe value that is unique within the system.
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:ssn SΣ0..1IdentifierSocial Security Number
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription 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: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: SB
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... system SΣ1..1uriThe namespace for the identifier value
Required Pattern: http://hl7.org/fhir/sid/us-ssn
..... value SΣ1..1stringThe value that is unique within the system.
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... active ?!Σ0..1booleanWhether this patient's record is in active use
... name SΣ1..*HumanNameA name associated with the patient
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

.... text Σ0..1stringText representation of the full name
.... family SΣC0..1stringFamily name (often called 'Surname')
.... given SΣC0..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... prefix Σ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix Σ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period Σ0..1PeriodTime period when name was/is in use
... telecom Σ0..*ContactPointA contact detail for the individual
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... system SΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ1..1stringThe actual contact point details
.... use ?!SΣ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period Σ0..1PeriodTime period when the contact point was/is in use
... gender SΣ1..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate SΣ0..1dateDate of Birth
.... id 0..1stringxml:id (or equivalent in JSON)
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... partialDate 0..1(Complex)partialDate
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/PartialDate
.... value 0..1datePrimitive value for date
... deceased[x] ?!Σ0..1Indicates if the individual is deceased or not
.... deceasedBooleanboolean
.... deceasedDateTimedateTime
... address SΣ0..*AddressDecedent's Residence
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... withinCityLimitsIndicator 0..1CodingExtension
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/WithinCityLimitsIndicator
Binding: Yes No Unknown (required): Yes No Unknown


.... predir 0..1stringExtension
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/PreDirectional
.... stnum 0..1stringExtension
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/StreetNumber
.... stname 0..1stringExtension
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/StreetName
.... stdesig 0..1stringExtension
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/StreetDesignator
.... postdir 0..1stringExtension
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/PostDirectional
.... unitnumber 0..1stringExtension
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/UnitOrAptNumber
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... type Σ0..1codepostal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
.... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣ0..*stringStreet 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
.... city SΣ0..1stringName of city, town etc.
Example General: Erewhon
..... id 0..1stringxml:id (or equivalent in JSON)
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... cityCode 0..1positiveIntCity Code
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/CityCode
..... value 0..1stringPrimitive value for string
Max Length: 1048576
.... district Σ0..1stringDistrict name (aka county)
Example General: Madison
..... id 0..1stringxml:id (or equivalent in JSON)
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... districtCode 0..1positiveIntCounty code
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/DistrictCode
..... value 0..1stringPrimitive value for string
Max Length: 1048576
.... state SΣ0..1stringSub-unit of country (abbreviations ok)
Binding: States, Territories and Provinces Value Set (required)
.... postalCode SΣ0..1stringUS Zip Codes
Example General: 9132
.... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
Binding: Residence Country Value Set (required)
.... period SΣ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... maritalStatus 0..1CodeableConceptMarital (civil) status of a patient
Binding: Marital Status Value Set (required)
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... bypassEditFlag 0..1CodeableConceptExtension
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/BypassEditFlag
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/us/vrdr/StructureDefinition/BypassEditFlag"
..... value[x] 1..1CodeableConceptValue of extension
Binding: Edit Bypass 0124 (required)
.... coding Σ0..*CodingCode defined by a terminology system
.... text Σ0..1stringMarital Description
... multipleBirth[x] 0..1Whether patient is part of a multiple birth
.... multipleBirthBooleanboolean
.... multipleBirthIntegerinteger
... photo 0..*AttachmentImage of the patient
... contact C0..*BackboneElementInformant information
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... relationship 0..1CodeableConceptInformant Relationship (INFORMRELATE)
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.


..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..*CodingCode defined by a terminology system
..... text Σ0..1stringInformant Relationship (INFORMRELATE) - first 30 characters will be used
.... name 0..1HumanNameA name associated with the contact person
.... telecom 0..*ContactPointA contact detail for the person
.... address 0..1AddressAddress for the contact person
.... gender 0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

.... organization C0..1Reference(Organization)Organization that is associated with the contact
.... period 0..1PeriodThe period during which this contact person or organization is valid to be contacted relating to this patient
... communication 0..*BackboneElementA language which may be used to communicate with the patient about his or her health
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... language S1..1CodeableConceptThe 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)
.... preferred 0..1booleanLanguage preference indicator
... generalPractitioner 0..*Reference(Organization | Practitioner | PractitionerRole)Patient's nominated primary care provider
... managingOrganization Σ0..1Reference(Organization)Organization that is the custodian of the patient record
... link ?!Σ0..*BackboneElementLink to another patient resource that concerns the same actual person
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... other Σ1..1Reference(Patient | RelatedPerson)The other patient or related person resource that the link refers to
.... type Σ1..1codereplaced-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

PathConformanceValueSet / Code
Patient.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Patient.extension:Patient-BirthPlace.value[x].userequiredAddressUse
Patient.extension:Patient-BirthPlace.value[x].typerequiredAddressType
Patient.extension:Patient-BirthPlace.value[x].staterequiredStatesTerritoriesAndProvincesVS
Patient.extension:Patient-BirthPlace.value[x].countryrequiredBirthplaceCountryVS (a valid code from Country Codes)
Patient.identifier.userequiredIdentifierUse
Patient.identifier.typeextensibleIdentifier Type Codes
Patient.identifier:ssn.userequiredIdentifierUse
Patient.identifier:ssn.typeextensiblePattern: SB
Patient.name.userequiredNameUse
Patient.telecom.systemrequiredContactPointSystem
Patient.telecom.userequiredContactPointUse
Patient.genderrequiredAdministrativeGender
Patient.address.userequiredAddressUse
Patient.address.typerequiredAddressType
Patient.address.staterequiredStatesTerritoriesAndProvincesVS
Patient.address.countryrequiredResidenceCountryVS
Patient.maritalStatusrequiredMaritalStatusVS
Patient.maritalStatus.extension:bypassEditFlag.value[x]requiredEditBypass0124VS
Patient.contact.relationshipextensiblePatientContactRelationship
Patient.contact.genderrequiredAdministrativeGender
Patient.communication.languageextensibleLanguageCodesWithLanguageAndOptionallyARegionModifier
Patient.link.typerequiredLinkType

Differential View

This structure is derived from USCorePatientProfile

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient USCorePatientProfile
... NVSS-SexAtDeath 0..1CodeableConceptNVSS Sex at Death
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/NVSS-SexAtDeath
Binding: Administrative Gender PHVS_Sex_MFU (required)
... Spouse-Alive 0..1CodeableConceptSpouse Alive?
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/SpouseAlive
Binding: Spouse Alive Value Set (required)
... Patient-BirthPlace 0..1AddressDecedent birthplace
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
.... value[x]
..... city
...... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... cityCode 0..1positiveIntCity Code
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/CityCode
..... state 0..1stringSub-unit of country (abbreviations ok)
Binding: States, Territories and Provinces Value Set (required)
..... country 0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
Binding: Birthplace Country Value Set (required)
.... identifier:ssn 0..1IdentifierSocial Security Number
..... type 0..1CodeableConceptDescription of identifier
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: SB
..... system 1..1uriThe namespace for the identifier value
Required Pattern: http://hl7.org/fhir/sid/us-ssn
... birthDate 0..1dateDate of Birth
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... partialDate 0..1(Complex)partialDate
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/PartialDate
... address 0..*AddressDecedent's Residence
.... withinCityLimitsIndicator 0..1CodingExtension
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/WithinCityLimitsIndicator
Binding: Yes No Unknown (required): Yes No Unknown

.... predir 0..1stringExtension
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/PreDirectional
.... stnum 0..1stringExtension
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/StreetNumber
.... stname 0..1stringExtension
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/StreetName
.... stdesig 0..1stringExtension
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/StreetDesignator
.... postdir 0..1stringExtension
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/PostDirectional
.... unitnumber 0..1stringExtension
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/UnitOrAptNumber
.... city
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... cityCode 0..1positiveIntCity Code
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/CityCode
.... district
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... districtCode 0..1positiveIntCounty code
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/DistrictCode
.... state 0..1stringSub-unit of country (abbreviations ok)
Binding: States, Territories and Provinces Value Set (required)
.... country 0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
Binding: Residence Country Value Set (required)
... maritalStatus 0..1CodeableConceptMarital (civil) status of a patient
Binding: Marital Status Value Set (required)
.... bypassEditFlag 0..1CodeableConceptExtension
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/BypassEditFlag
..... value[x] 1..1CodeableConceptValue of extension
Binding: Edit Bypass 0124 (required)
.... text 0..1stringMarital Description
... contact 0..*BackboneElementInformant information
.... relationship 0..1CodeableConceptInformant Relationship (INFORMRELATE)
..... text 0..1stringInformant Relationship (INFORMRELATE) - first 30 characters will be used

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Patient.extension:Patient-BirthPlace.value[x].staterequiredStatesTerritoriesAndProvincesVS
Patient.extension:Patient-BirthPlace.value[x].countryrequiredBirthplaceCountryVS (a valid code from Country Codes)
Patient.address.staterequiredStatesTerritoriesAndProvincesVS
Patient.address.countryrequiredResidenceCountryVS
Patient.maritalStatusrequiredMaritalStatusVS
Patient.maritalStatus.extension:bypassEditFlag.value[x]requiredEditBypass0124VS

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient C0..*USCorePatientProfileInformation about an individual or animal receiving health care services
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... race 0..1(Complex)US Core Race Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
... ethnicity 0..1(Complex)US Core ethnicity Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
... genderIdentity 0..1CodeableConceptExtension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity
Binding: Gender Identity (extensible)
... NVSS-SexAtDeath 0..1CodeableConceptNVSS Sex at Death
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/NVSS-SexAtDeath
Binding: Administrative Gender PHVS_Sex_MFU (required)
... Spouse-Alive 0..1CodeableConceptSpouse Alive?
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/SpouseAlive
Binding: Spouse Alive Value Set (required)
... Patient-BirthPlace 0..1AddressDecedent birthplace
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
.... extension 0..0
.... url 1..1uri"http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
.... value[x] 1..1AddressValue of extension
..... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
..... state Σ0..1stringSub-unit of country (abbreviations ok)
Binding: States, Territories and Provinces Value Set (required)
..... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
Binding: Birthplace Country Value Set (required)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier SΣ1..*IdentifierAn identifier for this patient
Slice: Unordered, Open by pattern:system
.... identifier:All Slices Content/Rules for all slices
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system SΣ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ1..1stringThe value that is unique within the system.
Example General: 123456
.... identifier:ssn SΣ0..1IdentifierSocial Security Number
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription 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: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: SB
..... system SΣ1..1uriThe namespace for the identifier value
Required Pattern: http://hl7.org/fhir/sid/us-ssn
..... value SΣ1..1stringThe value that is unique within the system.
Example General: 123456
... active ?!Σ0..1booleanWhether this patient's record is in active use
... name SΣ1..*HumanNameA name associated with the patient
.... use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

.... family SΣC0..1stringFamily name (often called 'Surname')
.... given SΣC0..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
... telecom Σ0..*ContactPointA contact detail for the individual
.... system SΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ1..1stringThe actual contact point details
.... use ?!SΣ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
... gender SΣ1..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate SΣ0..1dateDate of Birth
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... partialDate 0..1(Complex)partialDate
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/PartialDate
... deceased[x] ?!Σ0..1Indicates if the individual is deceased or not
.... deceasedBooleanboolean
.... deceasedDateTimedateTime
... address SΣ0..*AddressDecedent's Residence
.... withinCityLimitsIndicator 0..1CodingExtension
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/WithinCityLimitsIndicator
Binding: Yes No Unknown (required): Yes No Unknown


.... predir 0..1stringExtension
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/PreDirectional
.... stnum 0..1stringExtension
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/StreetNumber
.... stname 0..1stringExtension
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/StreetName
.... stdesig 0..1stringExtension
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/StreetDesignator
.... postdir 0..1stringExtension
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/PostDirectional
.... unitnumber 0..1stringExtension
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/UnitOrAptNumber
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... line SΣ0..*stringStreet 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
.... city SΣ0..1stringName of city, town etc.
Example General: Erewhon
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... cityCode 0..1positiveIntCity Code
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/CityCode
.... state SΣ0..1stringSub-unit of country (abbreviations ok)
Binding: States, Territories and Provinces Value Set (required)
.... postalCode SΣ0..1stringUS Zip Codes
Example General: 9132
.... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
Binding: Residence Country Value Set (required)
.... period SΣ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... maritalStatus 0..1CodeableConceptMarital (civil) status of a patient
Binding: Marital Status Value Set (required)
.... bypassEditFlag 0..1CodeableConceptExtension
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/BypassEditFlag
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/us/vrdr/StructureDefinition/BypassEditFlag"
..... value[x] 1..1CodeableConceptValue of extension
Binding: Edit Bypass 0124 (required)
.... text Σ0..1stringMarital Description
... contact C0..*BackboneElementInformant information
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... relationship 0..1CodeableConceptInformant Relationship (INFORMRELATE)
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.


..... text Σ0..1stringInformant Relationship (INFORMRELATE) - first 30 characters will be used
... communication 0..*BackboneElementA language which may be used to communicate with the patient about his or her health
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... language S1..1CodeableConceptThe 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)
... link ?!Σ0..*BackboneElementLink to another patient resource that concerns the same actual person
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... other Σ1..1Reference(Patient | RelatedPerson)The other patient or related person resource that the link refers to
.... type Σ1..1codereplaced-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

PathConformanceValueSet / Code
Patient.extension:Patient-BirthPlace.value[x].userequiredAddressUse
Patient.extension:Patient-BirthPlace.value[x].staterequiredStatesTerritoriesAndProvincesVS
Patient.extension:Patient-BirthPlace.value[x].countryrequiredBirthplaceCountryVS (a valid code from Country Codes)
Patient.identifier.userequiredIdentifierUse
Patient.identifier:ssn.userequiredIdentifierUse
Patient.identifier:ssn.typeextensiblePattern: SB
Patient.name.userequiredNameUse
Patient.telecom.systemrequiredContactPointSystem
Patient.telecom.userequiredContactPointUse
Patient.genderrequiredAdministrativeGender
Patient.address.userequiredAddressUse
Patient.address.staterequiredStatesTerritoriesAndProvincesVS
Patient.address.countryrequiredResidenceCountryVS
Patient.maritalStatusrequiredMaritalStatusVS
Patient.maritalStatus.extension:bypassEditFlag.value[x]requiredEditBypass0124VS
Patient.contact.relationshipextensiblePatientContactRelationship
Patient.communication.languageextensibleLanguageCodesWithLanguageAndOptionallyARegionModifier
Patient.link.typerequiredLinkType

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient C0..*USCorePatientProfileInformation about an individual or animal receiving health care services
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... race 0..1(Complex)US Core Race Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race
... ethnicity 0..1(Complex)US Core ethnicity Extension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity
... birthsex 0..1codeExtension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex
Binding: Birth Sex (required): Code for sex assigned at birth


... genderIdentity 0..1CodeableConceptExtension
URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity
Binding: Gender Identity (extensible)
... NVSS-SexAtDeath 0..1CodeableConceptNVSS Sex at Death
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/NVSS-SexAtDeath
Binding: Administrative Gender PHVS_Sex_MFU (required)
... Spouse-Alive 0..1CodeableConceptSpouse Alive?
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/SpouseAlive
Binding: Spouse Alive Value Set (required)
... Patient-BirthPlace 0..1AddressDecedent birthplace
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
.... value[x] 1..1AddressValue of extension
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
..... type Σ0..1codepostal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
..... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
..... line Σ0..*stringStreet 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
..... city Σ0..1stringName of city, town etc.
Example General: Erewhon
...... id 0..1stringxml:id (or equivalent in JSON)
...... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
...... cityCode 0..1positiveIntCity Code
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/CityCode
...... value 0..1stringPrimitive value for string
Max Length: 1048576
..... district Σ0..1stringDistrict name (aka county)
Example General: Madison
..... state Σ0..1stringSub-unit of country (abbreviations ok)
Binding: States, Territories and Provinces Value Set (required)
..... postalCode Σ0..1stringPostal code for area
Example General: 9132
..... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
Binding: Birthplace Country Value Set (required)
..... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier SΣ1..*IdentifierAn identifier for this patient
Slice: Unordered, Open by pattern:system
.... identifier:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription 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.

..... system SΣ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ1..1stringThe value that is unique within the system.
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:ssn SΣ0..1IdentifierSocial Security Number
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription 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: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: SB
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... system SΣ1..1uriThe namespace for the identifier value
Required Pattern: http://hl7.org/fhir/sid/us-ssn
..... value SΣ1..1stringThe value that is unique within the system.
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... active ?!Σ0..1booleanWhether this patient's record is in active use
... name SΣ1..*HumanNameA name associated with the patient
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

.... text Σ0..1stringText representation of the full name
.... family SΣC0..1stringFamily name (often called 'Surname')
.... given SΣC0..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... prefix Σ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix Σ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period Σ0..1PeriodTime period when name was/is in use
... telecom Σ0..*ContactPointA contact detail for the individual
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... system SΣC1..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ1..1stringThe actual contact point details
.... use ?!SΣ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period Σ0..1PeriodTime period when the contact point was/is in use
... gender SΣ1..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate SΣ0..1dateDate of Birth
.... id 0..1stringxml:id (or equivalent in JSON)
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... partialDate 0..1(Complex)partialDate
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/PartialDate
.... value 0..1datePrimitive value for date
... deceased[x] ?!Σ0..1Indicates if the individual is deceased or not
.... deceasedBooleanboolean
.... deceasedDateTimedateTime
... address SΣ0..*AddressDecedent's Residence
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... withinCityLimitsIndicator 0..1CodingExtension
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/WithinCityLimitsIndicator
Binding: Yes No Unknown (required): Yes No Unknown


.... predir 0..1stringExtension
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/PreDirectional
.... stnum 0..1stringExtension
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/StreetNumber
.... stname 0..1stringExtension
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/StreetName
.... stdesig 0..1stringExtension
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/StreetDesignator
.... postdir 0..1stringExtension
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/PostDirectional
.... unitnumber 0..1stringExtension
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/UnitOrAptNumber
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... type Σ0..1codepostal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
.... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣ0..*stringStreet 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
.... city SΣ0..1stringName of city, town etc.
Example General: Erewhon
..... id 0..1stringxml:id (or equivalent in JSON)
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... cityCode 0..1positiveIntCity Code
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/CityCode
..... value 0..1stringPrimitive value for string
Max Length: 1048576
.... district Σ0..1stringDistrict name (aka county)
Example General: Madison
..... id 0..1stringxml:id (or equivalent in JSON)
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... districtCode 0..1positiveIntCounty code
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/DistrictCode
..... value 0..1stringPrimitive value for string
Max Length: 1048576
.... state SΣ0..1stringSub-unit of country (abbreviations ok)
Binding: States, Territories and Provinces Value Set (required)
.... postalCode SΣ0..1stringUS Zip Codes
Example General: 9132
.... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
Binding: Residence Country Value Set (required)
.... period SΣ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... maritalStatus 0..1CodeableConceptMarital (civil) status of a patient
Binding: Marital Status Value Set (required)
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... bypassEditFlag 0..1CodeableConceptExtension
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/BypassEditFlag
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/us/vrdr/StructureDefinition/BypassEditFlag"
..... value[x] 1..1CodeableConceptValue of extension
Binding: Edit Bypass 0124 (required)
.... coding Σ0..*CodingCode defined by a terminology system
.... text Σ0..1stringMarital Description
... multipleBirth[x] 0..1Whether patient is part of a multiple birth
.... multipleBirthBooleanboolean
.... multipleBirthIntegerinteger
... photo 0..*AttachmentImage of the patient
... contact C0..*BackboneElementInformant information
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... relationship 0..1CodeableConceptInformant Relationship (INFORMRELATE)
Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.


..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ0..*CodingCode defined by a terminology system
..... text Σ0..1stringInformant Relationship (INFORMRELATE) - first 30 characters will be used
.... name 0..1HumanNameA name associated with the contact person
.... telecom 0..*ContactPointA contact detail for the person
.... address 0..1AddressAddress for the contact person
.... gender 0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

.... organization C0..1Reference(Organization)Organization that is associated with the contact
.... period 0..1PeriodThe period during which this contact person or organization is valid to be contacted relating to this patient
... communication 0..*BackboneElementA language which may be used to communicate with the patient about his or her health
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... language S1..1CodeableConceptThe 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)
.... preferred 0..1booleanLanguage preference indicator
... generalPractitioner 0..*Reference(Organization | Practitioner | PractitionerRole)Patient's nominated primary care provider
... managingOrganization Σ0..1Reference(Organization)Organization that is the custodian of the patient record
... link ?!Σ0..*BackboneElementLink to another patient resource that concerns the same actual person
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... other Σ1..1Reference(Patient | RelatedPerson)The other patient or related person resource that the link refers to
.... type Σ1..1codereplaced-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

PathConformanceValueSet / Code
Patient.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Patient.extension:Patient-BirthPlace.value[x].userequiredAddressUse
Patient.extension:Patient-BirthPlace.value[x].typerequiredAddressType
Patient.extension:Patient-BirthPlace.value[x].staterequiredStatesTerritoriesAndProvincesVS
Patient.extension:Patient-BirthPlace.value[x].countryrequiredBirthplaceCountryVS (a valid code from Country Codes)
Patient.identifier.userequiredIdentifierUse
Patient.identifier.typeextensibleIdentifier Type Codes
Patient.identifier:ssn.userequiredIdentifierUse
Patient.identifier:ssn.typeextensiblePattern: SB
Patient.name.userequiredNameUse
Patient.telecom.systemrequiredContactPointSystem
Patient.telecom.userequiredContactPointUse
Patient.genderrequiredAdministrativeGender
Patient.address.userequiredAddressUse
Patient.address.typerequiredAddressType
Patient.address.staterequiredStatesTerritoriesAndProvincesVS
Patient.address.countryrequiredResidenceCountryVS
Patient.maritalStatusrequiredMaritalStatusVS
Patient.maritalStatus.extension:bypassEditFlag.value[x]requiredEditBypass0124VS
Patient.contact.relationshipextensiblePatientContactRelationship
Patient.contact.genderrequiredAdministrativeGender
Patient.communication.languageextensibleLanguageCodesWithLanguageAndOptionallyARegionModifier
Patient.link.typerequiredLinkType

 

Other representations of profile: CSV, Excel, Schematron