Vital Records Death Reporting (VRDR) FHIR Implementation Guide
2.2.0 - STU 2.2
Vital Records Death Reporting (VRDR) FHIR Implementation Guide
2.2.0 - STU 2.2
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
| Official URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/vrdr-death-location | Version: 2.2.0 | |||
| Active as of 2023-10-17 | Computable Name: DeathLocation | |||
Death Location (USCoreLocation)
| # | 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.extensiondistrictCode | 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:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from USCoreLocation
| Path | Conformance | ValueSet |
| Location.address.state | required | StatesTerritoriesAndProvincesVS |
| Location.address.country | required | ResidenceCountryVS |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Location | 0..* | USCoreLocation | 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 of function performed 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 | 1..1 | Address | Place of Death address |
 predir | 0..1 | string | Extension URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/PreDirectional | |
| stnum | 0..1 | string | Extension URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/StreetNumber | |
| stname | 0..1 | string | Extension URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/StreetName | |
| stdesig | 0..1 | string | Extension URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/StreetDesignator | |
| postdir | 0..1 | string | Extension URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/PostDirectional | |
| unitnumber | 0..1 | string | Extension URL: http://hl7.org/fhir/us/vrdr/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 | Address city Example General: Erewhon |
 Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| cityCode | 0..1 | positiveInt | City Code URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/CityCode | |
| district | Σ | 0..1 | string | Address county Example General: Madison |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| districtCode | 0..1 | positiveInt | County code URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/DistrictCode | |
| state | SΣ | 1..1 | string | State/Jurisdiction of death. Use value in Jurisdiction if present. Binding: States, Territories and Provinces Value Set (required) |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| nationalReportingJurisdictionId | 0..1 | string | Extension URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/Location-Jurisdiction-Id Binding: Jurisdictions Value Set (required) | |
| postalCode | SΣ | 0..1 | string | Address zip Example General: 9132 |
| country | Σ | 0..1 | string | Address country Binding: Residence Country Value Set (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 | Longitude with WGS84 datum | |
| latitude | 1..1 | decimal | Latitude with WGS84 datum | |
 managingOrganization | SΣ | 0..1 | Reference(US Core Organization Profile) | Organization responsible for provisioning and upkeep |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Location.status | required | LocationStatus |
| Location.type | extensible | Pattern: death |
| Location.address.use | required | AddressUse |
| Location.address.state | required | StatesTerritoriesAndProvincesVS |
| Location.address.country | required | ResidenceCountryVS |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Location | 0..* | USCoreLocation | 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 of function performed 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 | 1..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 | Extension URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/PreDirectional | |||||
| stnum | 0..1 | string | Extension URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/StreetNumber | |||||
| stname | 0..1 | string | Extension URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/StreetName | |||||
| stdesig | 0..1 | string | Extension URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/StreetDesignator | |||||
| postdir | 0..1 | string | Extension URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/PostDirectional | |||||
| unitnumber | 0..1 | string | Extension URL: http://hl7.org/fhir/us/vrdr/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 | Address 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/vrdr/StructureDefinition/CityCode | |||||
| value | 0..1 | string | Primitive value for string Max Length: 1048576 | |||||
| district | Σ | 0..1 | string | Address 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/vrdr/StructureDefinition/DistrictCode | |||||
| value | 0..1 | string | Primitive value for string Max Length: 1048576 | |||||
| state | SΣ | 1..1 | string | State/Jurisdiction of death. Use value in Jurisdiction if present. Binding: States, Territories and Provinces Value Set (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 | Extension URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/Location-Jurisdiction-Id Binding: Jurisdictions Value Set (required) | |||||
| value | 0..1 | string | Primitive value for string Max Length: 1048576 | |||||
| postalCode | SΣ | 0..1 | string | Address zip Example General: 9132 | ||||
| country | Σ | 0..1 | string | Address country Binding: Residence Country Value Set (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 | Longitude with WGS84 datum | |||||
| latitude | 1..1 | decimal | Latitude with WGS84 datum | |||||
| 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 | ||||
| Location.language | preferred | CommonLanguages
| ||||
| Location.status | required | LocationStatus | ||||
| Location.operationalStatus | preferred | Hl7VSBedStatus | ||||
| Location.mode | required | LocationMode | ||||
| Location.type | extensible | Pattern: death | ||||
| Location.address.use | required | AddressUse | ||||
| Location.address.type | required | AddressType | ||||
| Location.address.state | required | StatesTerritoriesAndProvincesVS | ||||
| Location.address.country | required | ResidenceCountryVS | ||||
| Location.physicalType | example | LocationType | ||||
| Location.hoursOfOperation.daysOfWeek | required | DaysOfWeek |
This structure is derived from USCoreLocation
Summary
Mandatory: 3 elements
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from USCoreLocation
| Path | Conformance | ValueSet |
| Location.address.state | required | StatesTerritoriesAndProvincesVS |
| Location.address.country | required | ResidenceCountryVS |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Location | 0..* | USCoreLocation | 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 of function performed 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 | 1..1 | Address | Place of Death address |
| predir | 0..1 | string | Extension URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/PreDirectional | |
| stnum | 0..1 | string | Extension URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/StreetNumber | |
| stname | 0..1 | string | Extension URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/StreetName | |
| stdesig | 0..1 | string | Extension URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/StreetDesignator | |
| postdir | 0..1 | string | Extension URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/PostDirectional | |
| unitnumber | 0..1 | string | Extension URL: http://hl7.org/fhir/us/vrdr/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 | Address city Example General: Erewhon |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| cityCode | 0..1 | positiveInt | City Code URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/CityCode | |
| district | Σ | 0..1 | string | Address county Example General: Madison |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| districtCode | 0..1 | positiveInt | County code URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/DistrictCode | |
| state | SΣ | 1..1 | string | State/Jurisdiction of death. Use value in Jurisdiction if present. Binding: States, Territories and Provinces Value Set (required) |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| nationalReportingJurisdictionId | 0..1 | string | Extension URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/Location-Jurisdiction-Id Binding: Jurisdictions Value Set (required) | |
| postalCode | SΣ | 0..1 | string | Address zip Example General: 9132 |
| country | Σ | 0..1 | string | Address country Binding: Residence Country Value Set (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 | Longitude with WGS84 datum | |
| latitude | 1..1 | decimal | Latitude with WGS84 datum | |
| managingOrganization | SΣ | 0..1 | Reference(US Core Organization Profile) | Organization responsible for provisioning and upkeep |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Location.status | required | LocationStatus |
| Location.type | extensible | Pattern: death |
| Location.address.use | required | AddressUse |
| Location.address.state | required | StatesTerritoriesAndProvincesVS |
| Location.address.country | required | ResidenceCountryVS |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Location | 0..* | USCoreLocation | 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 of function performed 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 | 1..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 | Extension URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/PreDirectional | |||||
| stnum | 0..1 | string | Extension URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/StreetNumber | |||||
| stname | 0..1 | string | Extension URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/StreetName | |||||
| stdesig | 0..1 | string | Extension URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/StreetDesignator | |||||
| postdir | 0..1 | string | Extension URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/PostDirectional | |||||
| unitnumber | 0..1 | string | Extension URL: http://hl7.org/fhir/us/vrdr/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 | Address 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/vrdr/StructureDefinition/CityCode | |||||
| value | 0..1 | string | Primitive value for string Max Length: 1048576 | |||||
| district | Σ | 0..1 | string | Address 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/vrdr/StructureDefinition/DistrictCode | |||||
| value | 0..1 | string | Primitive value for string Max Length: 1048576 | |||||
| state | SΣ | 1..1 | string | State/Jurisdiction of death. Use value in Jurisdiction if present. Binding: States, Territories and Provinces Value Set (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 | Extension URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/Location-Jurisdiction-Id Binding: Jurisdictions Value Set (required) | |||||
| value | 0..1 | string | Primitive value for string Max Length: 1048576 | |||||
| postalCode | SΣ | 0..1 | string | Address zip Example General: 9132 | ||||
| country | Σ | 0..1 | string | Address country Binding: Residence Country Value Set (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 | Longitude with WGS84 datum | |||||
| latitude | 1..1 | decimal | Latitude with WGS84 datum | |||||
| 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 | ||||
| Location.language | preferred | CommonLanguages
| ||||
| Location.status | required | LocationStatus | ||||
| Location.operationalStatus | preferred | Hl7VSBedStatus | ||||
| Location.mode | required | LocationMode | ||||
| Location.type | extensible | Pattern: death | ||||
| Location.address.use | required | AddressUse | ||||
| Location.address.type | required | AddressType | ||||
| Location.address.state | required | StatesTerritoriesAndProvincesVS | ||||
| Location.address.country | required | ResidenceCountryVS | ||||
| Location.physicalType | example | LocationType | ||||
| Location.hoursOfOperation.daysOfWeek | required | DaysOfWeek |
This structure is derived from USCoreLocation
Summary
Mandatory: 3 elements
Extensions
This structure refers to these extensions:
Other representations of profile: CSV, Excel, Schematron
IG © 2022+ HL7 International / Public Health. Package hl7.fhir.us.vrdr#2.2.0 based on FHIR 4.0.1. Generated 2023-10-17
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change
