Vital Records Death Reporting (VRDR) FHIR Implementation Guide
2.0.0 - STU 2 US

This page is part of the Vital Records Mortality and Morbidity Reporting FHIR IG (v2.0.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: Death Location

Official URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/vrdr-death-location Version: 2.0.0
Active as of 2022-08-31 Computable Name: DeathLocation

Death Location (USCoreLocation)

Usage

# Description IJE Name IJE only Field Type Value Set
2 State, U.S. Territory or Canadian Province of Death - code DSTATE   address.state or address.state.extension[nationalReportingJurisdictionId ] codeable StatesTerritoriesProvincesVS in state field or JurisdictionVS in extension
32 County of Death Occurrence COD   address.district.extension[countyCode] integer see CountyCodes
129 Death Institution name DINSTI x name string -
130 Long String address for place of death ADDRESS_D x address.line string -
131 Place of death. Street number STNUM_D x address.extension[stnum] string -
132 Place of death. Pre Directional PREDIR_D x address.extension[predir] string -
133 Place of death. Street name STNAME_D x address.extension[stname] string -
134 Place of death. Street designator STDESIG_D x address.extension[stdesig] string -
135 Place of death. Post Directional POSTDIR_D x address.extension[postdir] string -
136 Place of death. City or Town name CITYTEXT_D x address.city string -
137 Place of death. State name literal STATETEXT_D x address.state (expanded from 2 letter code) string -
138 Place of death. Zip code ZIP9_D x address.postalCode string -
139 Place of death. County of Death COUNTYTEXT_D x address.district string -
140 Place of death. City FIPS code CITYCODE_D x address.city.extension[ cityCode] integer see CityCodes
141 Place of death. Longitude LONG_D x position.longitude float -
142 Place of Death. Latitude LAT_D x position.latitude float -
239 Country of Death - Code DTHCOUNTRYCD x address.country string ResidenceCountryVS. Note: For US Death certificates should be US
240 Country of Death - Literal DTHCOUNTRY x address.country (expanded from 2 letter code) string See CountryLIterals. Not used. For US Death certificates should be ‘United States’.

Usage:

Formal Views of Profile Content

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

This structure is derived from USCoreLocation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..*USCoreLocationDetails and position information for a physical place
... name 1..1stringName of Death Location
... type 1..1CodeableConceptType of function performed
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://hl7.org/fhir/us/vrdr/CodeSystem/vrdr-location-type-cs
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: death
... address 1..1AddressPlace of Death address
.... 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
.... line 0..*stringAddress text
.... city 0..1stringAddress 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 0..1stringAddress county
..... 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 1..1stringState/Jurisdiction of death. Use value in Jurisdiction if present.
Binding: States, Territories and Provinces Value Set (required)
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... nationalReportingJurisdictionId 0..1stringExtension
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/Location-Jurisdiction-Id
Binding: Jurisdictions Value Set (required)
.... postalCode 0..1stringAddress zip
.... country 0..1stringAddress country
Binding: Residence Country Value Set (required)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..*USCoreLocationDetails and position information for a physical place
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierUnique code or number identifying the location to its users
... status ?!SΣ0..1codeactive | suspended | inactive
Binding: LocationStatus (required): Indicates whether the location is still in use.

... operationalStatus Σ0..1CodingThe operational status of the location (typically only for a bed/room)
Binding: hl7VS-bedStatus (preferred): The operational status if the location (where typically a bed/room).

... name SΣ1..1stringName of Death Location
... alias 0..*stringA list of alternate names that the location is known as, or was known as, in the past
... description Σ0..1stringAdditional details about the location that could be displayed as further information to identify the location beyond its name
... mode Σ0..1codeinstance | kind
Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations.

... type Σ1..1CodeableConceptType of function performed
Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location.



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://hl7.org/fhir/us/vrdr/CodeSystem/vrdr-location-type-cs
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: death
..... display0..1stringRepresentation defined by the system
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
... telecom S0..*ContactPointContact details of the location
... address S1..1AddressPlace of Death address
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... predir 0..1stringOptional Extensions Element
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/PreDirectional
.... stnum 0..1stringOptional Extensions Element
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/StreetNumber
.... stname 0..1stringOptional Extensions Element
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/StreetName
.... stdesig 0..1stringOptional Extensions Element
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/StreetDesignator
.... postdir 0..1stringOptional Extensions Element
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/PostDirectional
.... unitnumber 0..1stringOptional Extensions Element
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..*stringAddress text
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city SΣ0..1stringAddress city
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..1stringAddress 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Σ1..1stringState/Jurisdiction of death. Use value in Jurisdiction if present.
Binding: States, Territories and Provinces Value Set (required)
..... id 0..1stringxml:id (or equivalent in JSON)
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... nationalReportingJurisdictionId 0..1stringOptional Extensions Element
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/Location-Jurisdiction-Id
Binding: Jurisdictions Value Set (required)
..... value 0..1stringPrimitive value for string
Max Length: 1048576
.... postalCode SΣ0..1stringAddress zip
Example General: 9132
.... country Σ0..1stringAddress country
Binding: Residence Country Value Set (required)
.... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... physicalType Σ0..1CodeableConceptPhysical form of the location
Binding: LocationType (example): Physical form of the location.

... position 0..1BackboneElementPlace of death lat/long
.... 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
.... longitude 1..1decimalLongitude with WGS84 datum
.... latitude 1..1decimalLatitude with WGS84 datum
.... altitude 0..1decimalAltitude with WGS84 datum
... managingOrganization SΣ0..1Reference(US Core Organization Profile)Organization responsible for provisioning and upkeep
... partOf 0..1Reference(Location)Another Location this one is physically a part of
... hoursOfOperation 0..*BackboneElementWhat days/times during a week is this location usually open
.... 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
.... daysOfWeek 0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.


.... allDay 0..1booleanThe Location is open all day
.... openingTime 0..1timeTime that the Location opens
.... closingTime 0..1timeTime that the Location closes
... availabilityExceptions 0..1stringDescription of availability exceptions
... endpoint 0..*Reference(Endpoint)Technical endpoints providing access to services operated for the location

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..*USCoreLocationDetails and position information for a physical place
... status ?!Σ0..1codeactive | suspended | inactive
Binding: LocationStatus (required): Indicates whether the location is still in use.

... name Σ1..1stringName of Death Location
... telecom 0..*ContactPointContact details of the location
.... line Σ0..*stringAddress text
This repeating element order: The order in which lines should appear in an address label
.... city Σ0..1stringAddress city
.... state Σ1..1stringState/Jurisdiction of death. Use value in Jurisdiction if present.
Binding: States, Territories and Provinces Value Set (required)
.... postalCode Σ0..1stringAddress zip
... managingOrganization Σ0..1Reference(US Core Organization Profile)Organization responsible for provisioning and upkeep

doco Documentation for this format

Differential View

This structure is derived from USCoreLocation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..*USCoreLocationDetails and position information for a physical place
... name 1..1stringName of Death Location
... type 1..1CodeableConceptType of function performed
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://hl7.org/fhir/us/vrdr/CodeSystem/vrdr-location-type-cs
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: death
... address 1..1AddressPlace of Death address
.... 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
.... line 0..*stringAddress text
.... city 0..1stringAddress 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 0..1stringAddress county
..... 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 1..1stringState/Jurisdiction of death. Use value in Jurisdiction if present.
Binding: States, Territories and Provinces Value Set (required)
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... nationalReportingJurisdictionId 0..1stringExtension
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/Location-Jurisdiction-Id
Binding: Jurisdictions Value Set (required)
.... postalCode 0..1stringAddress zip
.... country 0..1stringAddress country
Binding: Residence Country Value Set (required)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..*USCoreLocationDetails and position information for a physical place
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierUnique code or number identifying the location to its users
... status ?!SΣ0..1codeactive | suspended | inactive
Binding: LocationStatus (required): Indicates whether the location is still in use.

... operationalStatus Σ0..1CodingThe operational status of the location (typically only for a bed/room)
Binding: hl7VS-bedStatus (preferred): The operational status if the location (where typically a bed/room).

... name SΣ1..1stringName of Death Location
... alias 0..*stringA list of alternate names that the location is known as, or was known as, in the past
... description Σ0..1stringAdditional details about the location that could be displayed as further information to identify the location beyond its name
... mode Σ0..1codeinstance | kind
Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations.

... type Σ1..1CodeableConceptType of function performed
Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location.



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://hl7.org/fhir/us/vrdr/CodeSystem/vrdr-location-type-cs
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: death
..... display0..1stringRepresentation defined by the system
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
... telecom S0..*ContactPointContact details of the location
... address S1..1AddressPlace of Death address
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... predir 0..1stringOptional Extensions Element
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/PreDirectional
.... stnum 0..1stringOptional Extensions Element
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/StreetNumber
.... stname 0..1stringOptional Extensions Element
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/StreetName
.... stdesig 0..1stringOptional Extensions Element
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/StreetDesignator
.... postdir 0..1stringOptional Extensions Element
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/PostDirectional
.... unitnumber 0..1stringOptional Extensions Element
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..*stringAddress text
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city SΣ0..1stringAddress city
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..1stringAddress 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Σ1..1stringState/Jurisdiction of death. Use value in Jurisdiction if present.
Binding: States, Territories and Provinces Value Set (required)
..... id 0..1stringxml:id (or equivalent in JSON)
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... nationalReportingJurisdictionId 0..1stringOptional Extensions Element
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/Location-Jurisdiction-Id
Binding: Jurisdictions Value Set (required)
..... value 0..1stringPrimitive value for string
Max Length: 1048576
.... postalCode SΣ0..1stringAddress zip
Example General: 9132
.... country Σ0..1stringAddress country
Binding: Residence Country Value Set (required)
.... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... physicalType Σ0..1CodeableConceptPhysical form of the location
Binding: LocationType (example): Physical form of the location.

... position 0..1BackboneElementPlace of death lat/long
.... 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
.... longitude 1..1decimalLongitude with WGS84 datum
.... latitude 1..1decimalLatitude with WGS84 datum
.... altitude 0..1decimalAltitude with WGS84 datum
... managingOrganization SΣ0..1Reference(US Core Organization Profile)Organization responsible for provisioning and upkeep
... partOf 0..1Reference(Location)Another Location this one is physically a part of
... hoursOfOperation 0..*BackboneElementWhat days/times during a week is this location usually open
.... 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
.... daysOfWeek 0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.


.... allDay 0..1booleanThe Location is open all day
.... openingTime 0..1timeTime that the Location opens
.... closingTime 0..1timeTime that the Location closes
... availabilityExceptions 0..1stringDescription of availability exceptions
... endpoint 0..*Reference(Endpoint)Technical endpoints providing access to services operated for the location

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet / Code
Location.languagepreferredCommonLanguages
Max Binding: AllLanguages
Location.statusrequiredLocationStatus
Location.operationalStatuspreferredHl7VSBedStatus
Location.moderequiredLocationMode
Location.typeextensiblePattern: death
Location.address.userequiredAddressUse
Location.address.typerequiredAddressType
Location.address.staterequiredStatesTerritoriesAndProvincesVS
Location.address.countryrequiredResidenceCountryVS
Location.physicalTypeexampleLocationType
Location.hoursOfOperation.daysOfWeekrequiredDaysOfWeek