Vital Records Death Reporting (VRDR) FHIR Implementation Guide, published by HL7 International / Public Health. This guide is not an authorized publication; it is the continuous build for version 3.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/vrdr/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/vrdr-death-location | Version: 3.0.0 | |||
Active as of 2024-10-15 | Computable Name: DeathLocation | |||
Other Identifiers: OID:2.16.840.1.113883.4.642.40.10.42.23 |
Death Location (LocationVitalRecords)
Use Case | # | Description | IJE Name | Field | Type | Value Set/Comments |
---|---|---|---|---|---|---|
Mortality | 2 | State, U.S. Territory or Canadian Province of Death - code | DSTATE | address.state or address.state.extension[nationalReportingJurisdictionId] | codeable | ValueSetStatesTerritoriesAndProvincesVitalRecords in state field or ValueSetJurisdictionVitalRecords in extension |
Mortality | 32 | County of Death Occurrence | COD | address.district.extension[districtCode] | integer | see CountyCodes |
Mortality | 129 | Death Institution name | DINSTI | name | string | - |
Mortality | 130 | Long String address for place of death | ADDRESS_D | address.line | string | - |
Mortality | 131 | Place of death. Street number | STNUM_D | address.extension[stnum] | string | - |
Mortality | 132 | Place of death. Pre Directional | PREDIR_D | address.extension[predir] | string | - |
Mortality | 133 | Place of death. Street name | STNAME_D | address.extension[stname] | string | - |
Mortality | 134 | Place of death. Street designator | STDESIG_D | address.extension[stdesig] | string | - |
Mortality | 135 | Place of death. Post Directional | POSTDIR_D | address.extension[postdir] | string | - |
Mortality | 136 | Place of death. City or Town name | CITYTEXT_D | address.city | string | - |
Mortality | 137 | Place of death. State name literal | STATETEXT_D | address.state (expanded from 2 letter code) | string | - |
Mortality | 138 | Place of death. Zip code | ZIP9_D | address.postalCode | string | - |
Mortality | 139 | Place of death. County of Death | COUNTYTEXT_D | address.district | string | - |
Mortality | 140 | Place of death. City FIPS code | CITYCODE_D | address.city.extension[cityCode] | integer | see CityCodes |
Mortality | 141 | Place of death. Longitude | LONG_D | position.longitude | float | - |
Mortality | 142 | Place of Death. Latitude | LAT_D | position.latitude | float | - |
Mortality | 239 | Country of Death - Code | DTHCOUNTRYCD | address.country | string | ValueSetResidenceCountryVitalRecords. Note: For US Death certificates should be US |
Mortality | 240 | Country of Death - Literal | DTHCOUNTRY | address.country (expanded from 2 letter code) | string | See CountryLiterals. Not used. For US Death certificates should be 'United States'. |
Use Case | # | Description | IJE Name | Field | Type | Value Set/Comments |
---|---|---|---|---|---|---|
Mortality Roster | 6 | State, U.S. Territory or Canadian Province of Death - literal | STATETEXT_D | address.state (expanded from 2 letter code) | string | - |
Mortality Roster | 7 | State, U.S. Territory or Canadian Province of Death - code | DSTATE | address.state or address.state.extension[nationalReportingJurisdictionId] | codeable | ValueSetStatesTerritoriesAndProvincesVitalRecords or ValueSetJurisdictionVitalRecords |
Mortality Roster | 30 | Death Country - Code | DCOUNTRYC | address.country | string | ValueSetResidenceCountryVitalRecords. Note: For US Death certificates should be US. |
Item # | Form Field | FHIR Profile Field | Reference |
---|---|---|---|
17 | County of Death | address.district | Certificate of Death |
Usage:
Changes since version true:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from LocationVitalRecords
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Location | LocationVitalRecords | |||
name | 1..1 | string | Name of Death Location | |
type | 1..1 | CodeableConcept | Type is used to differentiate profiles of this abstract profile Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/vrdr/CodeSystem/vrdr-location-type-cs | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: death | |
address | 0..1 | Address | Place of Death address | |
Slices for extension | Content/Rules for all slices | |||
extension:predir | 0..1 | ExtensionPreDirectionalVitalRecords | Predirectional | |
extension:stnum | 0..1 | ExtensionStreetNumberVitalRecords | Street Number | |
extension:stname | 0..1 | ExtensionStreetNameVitalRecords | Street Name | |
extension:stdesig | 0..1 | ExtensionStreetDesignatorVitalRecords | Street Designator | |
extension:postdir | 0..1 | ExtensionPostDirectionalVitalRecords | Postdirectional | |
extension:unitnumber | 0..1 | ExtensionUnitOrAptNumberVitalRecords | Unit Number | |
line | 0..* | string | Address Text | |
city | 0..1 | string | City | |
Slices for extension | Content/Rules for all slices | |||
extension:cityCode | 0..1 | ExtensionCityCodeVitalRecords | city code | |
district | 0..1 | string | County | |
Slices for extension | Content/Rules for all slices | |||
extension:districtCode | 0..1 | ExtensionDistrictCodeVitalRecords | county code | |
state | 0..1 | string | State/Jurisdiction of death. Use value in Jurisdiction if present. | |
Slices for extension | Content/Rules for all slices | |||
extension:nationalReportingJurisdictionId | 0..1 | ExtensionLocationJurisdictionIdVitalRecords | National Reporting Jurisdiction ID | |
postalCode | 0..1 | string | Zip | |
country | 0..1 | string | Country | |
position | 0..1 | BackboneElement | Place of death lat/long | |
longitude | 1..1 | decimal | Place of death longitude | |
latitude | 1..1 | decimal | Place of death latitude | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Location | 0..* | LocationVitalRecords | Details and position information for a physical place | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
status | ?!SΣ | 0..1 | code | active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use. |
name | SΣ | 1..1 | string | Name of Death Location |
type | Σ | 1..1 | CodeableConcept | Type is used to differentiate profiles of this abstract profile Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/vrdr/CodeSystem/vrdr-location-type-cs | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: death | |
telecom | S | 0..* | ContactPoint | Contact details of the location |
address | S | 0..1 | Address | Place of Death address |
Slices for extension | Content/Rules for all slices | |||
predir | 0..1 | string | Predirectional URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PreDirectional | |
stnum | 0..1 | string | Street Number URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetNumber | |
stname | 0..1 | string | Street Name URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetName | |
stdesig | 0..1 | string | Street Designator URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetDesignator | |
postdir | 0..1 | string | Postdirectional URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PostDirectional | |
unitnumber | 0..1 | string | Unit Number URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/UnitOrAptNumber | |
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
line | SΣ | 0..* | string | Address Text This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street |
city | SΣ | 0..1 | string | City Example General: Erewhon |
Slices for extension | Content/Rules for all slices | |||
cityCode | 0..1 | positiveInt | city code URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode | |
district | Σ | 0..1 | string | County Example General: Madison |
Slices for extension | Content/Rules for all slices | |||
districtCode | 0..1 | positiveInt | county code URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/DistrictCode | |
state | SΣ | 0..1 | string | State/Jurisdiction of death. Use value in Jurisdiction if present. Binding: Value Set - States, Territories and Provinces Vital Records (required) |
Slices for extension | Content/Rules for all slices | |||
nationalReportingJurisdictionId | 0..1 | string | National Reporting Jurisdiction ID URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-jurisdiction-id-vr Binding: Value Set - Jurisdictions Vital Records (required) | |
postalCode | SΣ | 0..1 | string | Zip Example General: 9132 |
country | Σ | 0..1 | string | Country Binding: Value Set - Residence Country Vital Records (required) |
position | 0..1 | BackboneElement | Place of death lat/long | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
longitude | 1..1 | decimal | Place of death longitude | |
latitude | 1..1 | decimal | Place of death latitude | |
managingOrganization | SΣ | 0..1 | Reference(US Core Organization Profile) | Organization responsible for provisioning and upkeep |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
Location.status | required | LocationStatushttp://hl7.org/fhir/ValueSet/location-status|4.0.1 from the FHIR Standard | |
Location.type | extensible | Pattern: deathhttp://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType | |
Location.address.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard | |
Location.address.state | required | ValueSetStatesTerritoriesAndProvincesVitalRecordshttp://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-states-territories-provinces-vr | |
Location.address.country | required | ValueSetResidenceCountryVitalRecordshttp://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-residence-country-vr |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Location | 0..* | LocationVitalRecords | Details and position information for a physical place | |||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 0..* | Identifier | Unique code or number identifying the location to its users | ||||
status | ?!SΣ | 0..1 | code | active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use. | ||||
operationalStatus | Σ | 0..1 | Coding | The 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..1 | string | Name of Death Location | ||||
alias | 0..* | string | A list of alternate names that the location is known as, or was known as, in the past | |||||
description | Σ | 0..1 | string | Additional details about the location that could be displayed as further information to identify the location beyond its name | ||||
mode | Σ | 0..1 | code | instance | kind Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations. | ||||
type | Σ | 1..1 | CodeableConcept | Type is used to differentiate profiles of this abstract profile Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/vrdr/CodeSystem/vrdr-location-type-cs | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: death | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
telecom | S | 0..* | ContactPoint | Contact details of the location | ||||
address | S | 0..1 | Address | Place of Death address | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
predir | 0..1 | string | Predirectional URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PreDirectional | |||||
stnum | 0..1 | string | Street Number URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetNumber | |||||
stname | 0..1 | string | Street Name URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetName | |||||
stdesig | 0..1 | string | Street Designator URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetDesignator | |||||
postdir | 0..1 | string | Postdirectional URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PostDirectional | |||||
unitnumber | 0..1 | string | Unit Number URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/UnitOrAptNumber | |||||
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | ||||
type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | ||||
text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
line | SΣ | 0..* | string | Address Text This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street | ||||
city | SΣ | 0..1 | string | City Example General: Erewhon | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
cityCode | 0..1 | positiveInt | city code URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode | |||||
value | 0..1 | string | Primitive value for string Max Length: 1048576 | |||||
district | Σ | 0..1 | string | County Example General: Madison | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
districtCode | 0..1 | positiveInt | county code URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/DistrictCode | |||||
value | 0..1 | string | Primitive value for string Max Length: 1048576 | |||||
state | SΣ | 0..1 | string | State/Jurisdiction of death. Use value in Jurisdiction if present. Binding: Value Set - States, Territories and Provinces Vital Records (required) | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
nationalReportingJurisdictionId | 0..1 | string | National Reporting Jurisdiction ID URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-jurisdiction-id-vr Binding: Value Set - Jurisdictions Vital Records (required) | |||||
value | 0..1 | string | Primitive value for string Max Length: 1048576 | |||||
postalCode | SΣ | 0..1 | string | Zip Example General: 9132 | ||||
country | Σ | 0..1 | string | Country Binding: Value Set - Residence Country Vital Records (required) | ||||
period | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
physicalType | Σ | 0..1 | CodeableConcept | Physical form of the location Binding: LocationType (example): Physical form of the location. | ||||
position | 0..1 | BackboneElement | Place of death lat/long | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
longitude | 1..1 | decimal | Place of death longitude | |||||
latitude | 1..1 | decimal | Place of death latitude | |||||
altitude | 0..1 | decimal | Altitude with WGS84 datum | |||||
managingOrganization | SΣ | 0..1 | Reference(US Core Organization Profile) | Organization responsible for provisioning and upkeep | ||||
partOf | 0..1 | Reference(Location) | Another Location this one is physically a part of | |||||
hoursOfOperation | 0..* | BackboneElement | What days/times during a week is this location usually open | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
daysOfWeek | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week. | |||||
allDay | 0..1 | boolean | The Location is open all day | |||||
openingTime | 0..1 | time | Time that the Location opens | |||||
closingTime | 0..1 | time | Time that the Location closes | |||||
availabilityExceptions | 0..1 | string | Description of availability exceptions | |||||
endpoint | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the location | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
Location.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Location.status | required | LocationStatushttp://hl7.org/fhir/ValueSet/location-status|4.0.1 from the FHIR Standard | ||||
Location.operationalStatus | preferred | Hl7VSBedStatushttp://terminology.hl7.org/ValueSet/v2-0116 | ||||
Location.mode | required | LocationModehttp://hl7.org/fhir/ValueSet/location-mode|4.0.1 from the FHIR Standard | ||||
Location.type | extensible | Pattern: deathhttp://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType | ||||
Location.address.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard | ||||
Location.address.type | required | AddressTypehttp://hl7.org/fhir/ValueSet/address-type|4.0.1 from the FHIR Standard | ||||
Location.address.state | required | ValueSetStatesTerritoriesAndProvincesVitalRecordshttp://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-states-territories-provinces-vr | ||||
Location.address.country | required | ValueSetResidenceCountryVitalRecordshttp://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-residence-country-vr | ||||
Location.physicalType | example | LocationTypehttp://hl7.org/fhir/ValueSet/location-physical-type from the FHIR Standard | ||||
Location.hoursOfOperation.daysOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1 from the FHIR Standard |
This structure is derived from LocationVitalRecords
Differential View
This structure is derived from LocationVitalRecords
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Location | LocationVitalRecords | |||
name | 1..1 | string | Name of Death Location | |
type | 1..1 | CodeableConcept | Type is used to differentiate profiles of this abstract profile Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/vrdr/CodeSystem/vrdr-location-type-cs | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: death | |
address | 0..1 | Address | Place of Death address | |
Slices for extension | Content/Rules for all slices | |||
extension:predir | 0..1 | ExtensionPreDirectionalVitalRecords | Predirectional | |
extension:stnum | 0..1 | ExtensionStreetNumberVitalRecords | Street Number | |
extension:stname | 0..1 | ExtensionStreetNameVitalRecords | Street Name | |
extension:stdesig | 0..1 | ExtensionStreetDesignatorVitalRecords | Street Designator | |
extension:postdir | 0..1 | ExtensionPostDirectionalVitalRecords | Postdirectional | |
extension:unitnumber | 0..1 | ExtensionUnitOrAptNumberVitalRecords | Unit Number | |
line | 0..* | string | Address Text | |
city | 0..1 | string | City | |
Slices for extension | Content/Rules for all slices | |||
extension:cityCode | 0..1 | ExtensionCityCodeVitalRecords | city code | |
district | 0..1 | string | County | |
Slices for extension | Content/Rules for all slices | |||
extension:districtCode | 0..1 | ExtensionDistrictCodeVitalRecords | county code | |
state | 0..1 | string | State/Jurisdiction of death. Use value in Jurisdiction if present. | |
Slices for extension | Content/Rules for all slices | |||
extension:nationalReportingJurisdictionId | 0..1 | ExtensionLocationJurisdictionIdVitalRecords | National Reporting Jurisdiction ID | |
postalCode | 0..1 | string | Zip | |
country | 0..1 | string | Country | |
position | 0..1 | BackboneElement | Place of death lat/long | |
longitude | 1..1 | decimal | Place of death longitude | |
latitude | 1..1 | decimal | Place of death latitude | |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Location | 0..* | LocationVitalRecords | Details and position information for a physical place | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
status | ?!SΣ | 0..1 | code | active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use. |
name | SΣ | 1..1 | string | Name of Death Location |
type | Σ | 1..1 | CodeableConcept | Type is used to differentiate profiles of this abstract profile Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/vrdr/CodeSystem/vrdr-location-type-cs | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: death | |
telecom | S | 0..* | ContactPoint | Contact details of the location |
address | S | 0..1 | Address | Place of Death address |
Slices for extension | Content/Rules for all slices | |||
predir | 0..1 | string | Predirectional URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PreDirectional | |
stnum | 0..1 | string | Street Number URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetNumber | |
stname | 0..1 | string | Street Name URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetName | |
stdesig | 0..1 | string | Street Designator URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetDesignator | |
postdir | 0..1 | string | Postdirectional URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PostDirectional | |
unitnumber | 0..1 | string | Unit Number URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/UnitOrAptNumber | |
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
line | SΣ | 0..* | string | Address Text This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street |
city | SΣ | 0..1 | string | City Example General: Erewhon |
Slices for extension | Content/Rules for all slices | |||
cityCode | 0..1 | positiveInt | city code URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode | |
district | Σ | 0..1 | string | County Example General: Madison |
Slices for extension | Content/Rules for all slices | |||
districtCode | 0..1 | positiveInt | county code URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/DistrictCode | |
state | SΣ | 0..1 | string | State/Jurisdiction of death. Use value in Jurisdiction if present. Binding: Value Set - States, Territories and Provinces Vital Records (required) |
Slices for extension | Content/Rules for all slices | |||
nationalReportingJurisdictionId | 0..1 | string | National Reporting Jurisdiction ID URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-jurisdiction-id-vr Binding: Value Set - Jurisdictions Vital Records (required) | |
postalCode | SΣ | 0..1 | string | Zip Example General: 9132 |
country | Σ | 0..1 | string | Country Binding: Value Set - Residence Country Vital Records (required) |
position | 0..1 | BackboneElement | Place of death lat/long | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
longitude | 1..1 | decimal | Place of death longitude | |
latitude | 1..1 | decimal | Place of death latitude | |
managingOrganization | SΣ | 0..1 | Reference(US Core Organization Profile) | Organization responsible for provisioning and upkeep |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
Location.status | required | LocationStatushttp://hl7.org/fhir/ValueSet/location-status|4.0.1 from the FHIR Standard | |
Location.type | extensible | Pattern: deathhttp://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType | |
Location.address.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard | |
Location.address.state | required | ValueSetStatesTerritoriesAndProvincesVitalRecordshttp://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-states-territories-provinces-vr | |
Location.address.country | required | ValueSetResidenceCountryVitalRecordshttp://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-residence-country-vr |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Location | 0..* | LocationVitalRecords | Details and position information for a physical place | |||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 0..* | Identifier | Unique code or number identifying the location to its users | ||||
status | ?!SΣ | 0..1 | code | active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use. | ||||
operationalStatus | Σ | 0..1 | Coding | The 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..1 | string | Name of Death Location | ||||
alias | 0..* | string | A list of alternate names that the location is known as, or was known as, in the past | |||||
description | Σ | 0..1 | string | Additional details about the location that could be displayed as further information to identify the location beyond its name | ||||
mode | Σ | 0..1 | code | instance | kind Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations. | ||||
type | Σ | 1..1 | CodeableConcept | Type is used to differentiate profiles of this abstract profile Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/vrdr/CodeSystem/vrdr-location-type-cs | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: death | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
telecom | S | 0..* | ContactPoint | Contact details of the location | ||||
address | S | 0..1 | Address | Place of Death address | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
predir | 0..1 | string | Predirectional URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PreDirectional | |||||
stnum | 0..1 | string | Street Number URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetNumber | |||||
stname | 0..1 | string | Street Name URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetName | |||||
stdesig | 0..1 | string | Street Designator URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetDesignator | |||||
postdir | 0..1 | string | Postdirectional URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PostDirectional | |||||
unitnumber | 0..1 | string | Unit Number URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/UnitOrAptNumber | |||||
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | ||||
type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | ||||
text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
line | SΣ | 0..* | string | Address Text This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street | ||||
city | SΣ | 0..1 | string | City Example General: Erewhon | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
cityCode | 0..1 | positiveInt | city code URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode | |||||
value | 0..1 | string | Primitive value for string Max Length: 1048576 | |||||
district | Σ | 0..1 | string | County Example General: Madison | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
districtCode | 0..1 | positiveInt | county code URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/DistrictCode | |||||
value | 0..1 | string | Primitive value for string Max Length: 1048576 | |||||
state | SΣ | 0..1 | string | State/Jurisdiction of death. Use value in Jurisdiction if present. Binding: Value Set - States, Territories and Provinces Vital Records (required) | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
nationalReportingJurisdictionId | 0..1 | string | National Reporting Jurisdiction ID URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Extension-jurisdiction-id-vr Binding: Value Set - Jurisdictions Vital Records (required) | |||||
value | 0..1 | string | Primitive value for string Max Length: 1048576 | |||||
postalCode | SΣ | 0..1 | string | Zip Example General: 9132 | ||||
country | Σ | 0..1 | string | Country Binding: Value Set - Residence Country Vital Records (required) | ||||
period | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
physicalType | Σ | 0..1 | CodeableConcept | Physical form of the location Binding: LocationType (example): Physical form of the location. | ||||
position | 0..1 | BackboneElement | Place of death lat/long | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
longitude | 1..1 | decimal | Place of death longitude | |||||
latitude | 1..1 | decimal | Place of death latitude | |||||
altitude | 0..1 | decimal | Altitude with WGS84 datum | |||||
managingOrganization | SΣ | 0..1 | Reference(US Core Organization Profile) | Organization responsible for provisioning and upkeep | ||||
partOf | 0..1 | Reference(Location) | Another Location this one is physically a part of | |||||
hoursOfOperation | 0..* | BackboneElement | What days/times during a week is this location usually open | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
daysOfWeek | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week. | |||||
allDay | 0..1 | boolean | The Location is open all day | |||||
openingTime | 0..1 | time | Time that the Location opens | |||||
closingTime | 0..1 | time | Time that the Location closes | |||||
availabilityExceptions | 0..1 | string | Description of availability exceptions | |||||
endpoint | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the location | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
Location.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Location.status | required | LocationStatushttp://hl7.org/fhir/ValueSet/location-status|4.0.1 from the FHIR Standard | ||||
Location.operationalStatus | preferred | Hl7VSBedStatushttp://terminology.hl7.org/ValueSet/v2-0116 | ||||
Location.mode | required | LocationModehttp://hl7.org/fhir/ValueSet/location-mode|4.0.1 from the FHIR Standard | ||||
Location.type | extensible | Pattern: deathhttp://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType | ||||
Location.address.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard | ||||
Location.address.type | required | AddressTypehttp://hl7.org/fhir/ValueSet/address-type|4.0.1 from the FHIR Standard | ||||
Location.address.state | required | ValueSetStatesTerritoriesAndProvincesVitalRecordshttp://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-states-territories-provinces-vr | ||||
Location.address.country | required | ValueSetResidenceCountryVitalRecordshttp://hl7.org/fhir/us/vr-common-library/ValueSet/ValueSet-residence-country-vr | ||||
Location.physicalType | example | LocationTypehttp://hl7.org/fhir/ValueSet/location-physical-type from the FHIR Standard | ||||
Location.hoursOfOperation.daysOfWeek | required | DaysOfWeekhttp://hl7.org/fhir/ValueSet/days-of-week|4.0.1 from the FHIR Standard |
This structure is derived from LocationVitalRecords
Other representations of profile: CSV, Excel, Schematron