Fact of Death Exchange FHIR Implementation Guide
0.2.0 - CI Build United States of America flag

Fact of Death Exchange FHIR Implementation Guide, published by HL7 International - Public Health Work Group. This guide is not an authorized publication; it is the continuous build for version 0.2.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/shpringman/fhir-fod/ and changes regularly. See the Directory of published versions

Resource Profile: Fact of Death Death Location

Official URL: http://example.org/fhir/us/fod/StructureDefinition/fod-death-location Version: 0.2.0
Standards status: Informative Maturity Level: 1 Computable Name: FODDeathLocation

The place where the death occurred. This profile derives from the VRDR Death Location, which already fixes Location.type to 'death', and requires enough address detail to be useful to a receiver. Senders may generalize the address to city, district, and state where full street detail is not appropriate to disclose; the coded place of death on the Fact of Death Death Date observation remains available in that case.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Location 0..* DeathLocation 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.
... 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 1..1 Address Place of Death address
.... Slices for extension Content/Rules for all slices
..... extension:predir 0..1 string Predirectional
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PreDirectional
..... extension:stnum 0..1 string Street Number
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetNumber
..... extension:stname 0..1 string Street Name
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetName
..... extension:stdesig 0..1 string Street Designator
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetDesignator
..... extension:postdir 0..1 string Postdirectional
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PostDirectional
..... extension: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
...... extension:cityCode 0..1 positiveInt city code
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode
.... district SΣ 0..1 string County
Example General: Madison
..... Slices for extension Content/Rules for all slices
...... extension:districtCode 0..1 positiveInt county code
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/DistrictCode
.... state SΣ 1..1 string Jurisdiction in which the death occurred
Binding: Value Set - States, Territories and Provinces Vital Records (required)
..... Slices for extension Content/Rules for all slices
...... extension: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
... managingOrganization SΣ 0..1 Reference(US Core Organization Profile) Organization responsible for provisioning and upkeep

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Location.status Base required LocationStatus 📍4.0.1 FHIR Std.
Location.type Base extensible ServiceDeliveryLocationRoleType 📦3.0.0 THO v7.3
Location.address.use Base required AddressUse 📍4.0.1 FHIR Std.
Location.address.state Base required Value Set - States, Territories and Provinces Vital Records 📦2.0.0 Vital Records Common Library v2.0

Constraints

Id Grade Path(s) Description Expression
dom-2 error Location If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Location If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Location If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Location If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Location A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from DeathLocation

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Location 0..* DeathLocation Details and position information for a physical place
... name S 1..1 string Name of the facility, where the death occurred at a named facility
... address S 1..1 Address Place of Death address
.... city S 0..1 string City
.... district S 0..1 string County
.... state S 1..1 string Jurisdiction in which the death occurred

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Location 0..* DeathLocation 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... 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 the facility, where the death occurred at a named facility
... 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 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
..... extension:predir 0..1 string Predirectional
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PreDirectional
..... extension:stnum 0..1 string Street Number
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetNumber
..... extension:stname 0..1 string Street Name
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetName
..... extension:stdesig 0..1 string Street Designator
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetDesignator
..... extension:postdir 0..1 string Postdirectional
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PostDirectional
..... extension: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
...... extension: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 SΣ 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
...... extension: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Σ 1..1 string Jurisdiction in which the death occurred
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
...... extension: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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Location.language Base preferred Common Languages 📦4.0.1 FHIR Std.
Location.status Base required LocationStatus 📍4.0.1 FHIR Std.
Location.operationalStatus Base preferred hl7VS-bedStatus 📦3.0.0 THO v7.3
Location.mode Base required LocationMode 📍4.0.1 FHIR Std.
Location.type Base extensible ServiceDeliveryLocationRoleType 📦3.0.0 THO v7.3
Location.address.use Base required AddressUse 📍4.0.1 FHIR Std.
Location.address.type Base required AddressType 📍4.0.1 FHIR Std.
Location.address.state Base required Value Set - States, Territories and Provinces Vital Records 📦2.0.0 Vital Records Common Library v2.0
Location.address.country Base required Value Set - Residence Country Vital Records 📦2.0.0 Vital Records Common Library v2.0
Location.physicalType Base example Location type 📦4.0.1 FHIR Std.
Location.hoursOfOperation.​daysOfWeek Base required DaysOfWeek 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Location If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Location If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Location If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Location If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Location A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from DeathLocation

Summary

Mandatory: 2 elements
Must-Support: 5 elements

Maturity: 1

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Location 0..* DeathLocation 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.
... 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 1..1 Address Place of Death address
.... Slices for extension Content/Rules for all slices
..... extension:predir 0..1 string Predirectional
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PreDirectional
..... extension:stnum 0..1 string Street Number
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetNumber
..... extension:stname 0..1 string Street Name
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetName
..... extension:stdesig 0..1 string Street Designator
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetDesignator
..... extension:postdir 0..1 string Postdirectional
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PostDirectional
..... extension: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
...... extension:cityCode 0..1 positiveInt city code
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode
.... district SΣ 0..1 string County
Example General: Madison
..... Slices for extension Content/Rules for all slices
...... extension:districtCode 0..1 positiveInt county code
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/DistrictCode
.... state SΣ 1..1 string Jurisdiction in which the death occurred
Binding: Value Set - States, Territories and Provinces Vital Records (required)
..... Slices for extension Content/Rules for all slices
...... extension: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
... managingOrganization SΣ 0..1 Reference(US Core Organization Profile) Organization responsible for provisioning and upkeep

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Location.status Base required LocationStatus 📍4.0.1 FHIR Std.
Location.type Base extensible ServiceDeliveryLocationRoleType 📦3.0.0 THO v7.3
Location.address.use Base required AddressUse 📍4.0.1 FHIR Std.
Location.address.state Base required Value Set - States, Territories and Provinces Vital Records 📦2.0.0 Vital Records Common Library v2.0

Constraints

Id Grade Path(s) Description Expression
dom-2 error Location If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Location If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Location If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Location If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Location A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from DeathLocation

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Location 0..* DeathLocation Details and position information for a physical place
... name S 1..1 string Name of the facility, where the death occurred at a named facility
... address S 1..1 Address Place of Death address
.... city S 0..1 string City
.... district S 0..1 string County
.... state S 1..1 string Jurisdiction in which the death occurred

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Location 0..* DeathLocation 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... 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 the facility, where the death occurred at a named facility
... 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 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
..... extension:predir 0..1 string Predirectional
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PreDirectional
..... extension:stnum 0..1 string Street Number
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetNumber
..... extension:stname 0..1 string Street Name
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetName
..... extension:stdesig 0..1 string Street Designator
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetDesignator
..... extension:postdir 0..1 string Postdirectional
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PostDirectional
..... extension: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
...... extension: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 SΣ 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
...... extension: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Σ 1..1 string Jurisdiction in which the death occurred
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
...... extension: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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Location.language Base preferred Common Languages 📦4.0.1 FHIR Std.
Location.status Base required LocationStatus 📍4.0.1 FHIR Std.
Location.operationalStatus Base preferred hl7VS-bedStatus 📦3.0.0 THO v7.3
Location.mode Base required LocationMode 📍4.0.1 FHIR Std.
Location.type Base extensible ServiceDeliveryLocationRoleType 📦3.0.0 THO v7.3
Location.address.use Base required AddressUse 📍4.0.1 FHIR Std.
Location.address.type Base required AddressType 📍4.0.1 FHIR Std.
Location.address.state Base required Value Set - States, Territories and Provinces Vital Records 📦2.0.0 Vital Records Common Library v2.0
Location.address.country Base required Value Set - Residence Country Vital Records 📦2.0.0 Vital Records Common Library v2.0
Location.physicalType Base example Location type 📦4.0.1 FHIR Std.
Location.hoursOfOperation.​daysOfWeek Base required DaysOfWeek 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Location If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Location If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Location If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Location If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Location A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from DeathLocation

Summary

Mandatory: 2 elements
Must-Support: 5 elements

Maturity: 1

 

Other representations of profile: CSV, Excel, Schematron