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

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

Resource Profile: Disposition Location

Official URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/vrdr-disposition-location Version: 2.1.0
Active as of 2023-03-24 Computable Name: DispositionLocation

Disposition Location (USCoreLocation)

Usage

Implementors are free to use the name field for the name of the disposition location.

# Description IJE Name IJE only Field Type Value Set
202 State, U.S. Territory or Canadian Province of Disposition - code DISPSTATECD x address.state string StatesTerritoriesProvincesVS
203 Disposition State or Territory - Literal DISPSTATE x address.state (expanded from 2 letter code) string See StateLiterals
204 Disposition City - Code DISPCITYCODE x address.city.extension[ cityCode].value integer see CityCodes
205 Disposition City - Literal DISPCITY x address.city string -

Usage:

Formal Views of Profile Content

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

This structure is derived from USCoreLocation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..*USCoreLocationDetails and position information for a physical place
... name 1..1stringName of Disposition Location
... type 1..1CodeableConceptType of function performed
Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/vrdr/CodeSystem/vrdr-location-type-cs
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: disposition
... address 1..1AddressPhysical location
.... city
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... cityCode 0..1positiveIntCity Code
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/CityCode
.... district
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... districtCode 0..1positiveIntCounty code
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/DistrictCode
.... state 0..1stringSub-unit of country (abbreviations ok)
Binding: States, Territories and Provinces Value Set (required)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Location.address.staterequiredStatesTerritoriesAndProvincesVS
NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..*USCoreLocationDetails and position information for a physical place
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!SΣ0..1codeactive | suspended | inactive
Binding: LocationStatus (required): Indicates whether the location is still in use.

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



Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/vrdr/CodeSystem/vrdr-location-type-cs
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: disposition
... telecom S0..*ContactPointContact details of the location
... address S1..1AddressPhysical location
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... line SΣ0..*stringStreet name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city SΣ0..1stringName of city, town etc.
Example General: Erewhon
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... cityCode 0..1positiveIntCity Code
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/CityCode
.... state SΣ0..1stringSub-unit of country (abbreviations ok)
Binding: States, Territories and Provinces Value Set (required)
.... postalCode SΣ0..1stringUS Zip Codes
Example General: 9132
... managingOrganization SΣ0..1Reference(US Core Organization Profile)Organization responsible for provisioning and upkeep

doco Documentation for this format

Terminology Bindings

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

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

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

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



Required Pattern: At least the following
.... id0..1stringUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/vrdr/CodeSystem/vrdr-location-type-cs
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: disposition
..... display0..1stringRepresentation defined by the system
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
... telecom S0..*ContactPointContact details of the location
... address S1..1AddressPhysical location
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


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


Example General: both
.... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣ0..*stringStreet name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city SΣ0..1stringName of city, town etc.
Example General: Erewhon
..... id 0..1stringxml:id (or equivalent in JSON)
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... cityCode 0..1positiveIntCity Code
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/CityCode
..... value 0..1stringPrimitive value for string
Max Length: 1048576
.... district Σ0..1stringDistrict name (aka county)
Example General: Madison
..... id 0..1stringxml:id (or equivalent in JSON)
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... districtCode 0..1positiveIntCounty code
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/DistrictCode
..... value 0..1stringPrimitive value for string
Max Length: 1048576
.... state SΣ0..1stringSub-unit of country (abbreviations ok)
Binding: States, Territories and Provinces Value Set (required)
.... postalCode SΣ0..1stringUS Zip Codes
Example General: 9132
.... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
.... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... physicalType Σ0..1CodeableConceptPhysical form of the location
Binding: LocationType (example): Physical form of the location.

... position 0..1BackboneElementThe absolute geographic location
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... longitude 1..1decimalLongitude with WGS84 datum
.... latitude 1..1decimalLatitude with WGS84 datum
.... altitude 0..1decimalAltitude with WGS84 datum
... managingOrganization SΣ0..1Reference(US Core Organization Profile)Organization responsible for provisioning and upkeep
... partOf 0..1Reference(Location)Another Location this one is physically a part of
... hoursOfOperation 0..*BackboneElementWhat days/times during a week is this location usually open
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... daysOfWeek 0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.


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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Location.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Location.statusrequiredLocationStatus
Location.operationalStatuspreferredHl7VSBedStatus
Location.moderequiredLocationMode
Location.typeextensiblePattern: disposition
Location.address.userequiredAddressUse
Location.address.typerequiredAddressType
Location.address.staterequiredStatesTerritoriesAndProvincesVS
Location.physicalTypeexampleLocationType
Location.hoursOfOperation.daysOfWeekrequiredDaysOfWeek

This structure is derived from USCoreLocation

Summary

Mandatory: 2 elements

Extensions

This structure refers to these extensions:

Differential View

This structure is derived from USCoreLocation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..*USCoreLocationDetails and position information for a physical place
... name 1..1stringName of Disposition Location
... type 1..1CodeableConceptType of function performed
Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/vrdr/CodeSystem/vrdr-location-type-cs
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: disposition
... address 1..1AddressPhysical location
.... city
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... cityCode 0..1positiveIntCity Code
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/CityCode
.... district
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... districtCode 0..1positiveIntCounty code
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/DistrictCode
.... state 0..1stringSub-unit of country (abbreviations ok)
Binding: States, Territories and Provinces Value Set (required)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Location.address.staterequiredStatesTerritoriesAndProvincesVS

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Location 0..*USCoreLocationDetails and position information for a physical place
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!SΣ0..1codeactive | suspended | inactive
Binding: LocationStatus (required): Indicates whether the location is still in use.

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



Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/vrdr/CodeSystem/vrdr-location-type-cs
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: disposition
... telecom S0..*ContactPointContact details of the location
... address S1..1AddressPhysical location
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... line SΣ0..*stringStreet name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city SΣ0..1stringName of city, town etc.
Example General: Erewhon
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... cityCode 0..1positiveIntCity Code
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/CityCode
.... state SΣ0..1stringSub-unit of country (abbreviations ok)
Binding: States, Territories and Provinces Value Set (required)
.... postalCode SΣ0..1stringUS Zip Codes
Example General: 9132
... managingOrganization SΣ0..1Reference(US Core Organization Profile)Organization responsible for provisioning and upkeep

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Location.statusrequiredLocationStatus
Location.typeextensiblePattern: disposition
Location.address.userequiredAddressUse
Location.address.staterequiredStatesTerritoriesAndProvincesVS

Snapshot View

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

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

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

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



Required Pattern: At least the following
.... id0..1stringUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/vrdr/CodeSystem/vrdr-location-type-cs
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: disposition
..... display0..1stringRepresentation defined by the system
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
... telecom S0..*ContactPointContact details of the location
... address S1..1AddressPhysical location
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


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


Example General: both
.... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣ0..*stringStreet name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city SΣ0..1stringName of city, town etc.
Example General: Erewhon
..... id 0..1stringxml:id (or equivalent in JSON)
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... cityCode 0..1positiveIntCity Code
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/CityCode
..... value 0..1stringPrimitive value for string
Max Length: 1048576
.... district Σ0..1stringDistrict name (aka county)
Example General: Madison
..... id 0..1stringxml:id (or equivalent in JSON)
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... districtCode 0..1positiveIntCounty code
URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/DistrictCode
..... value 0..1stringPrimitive value for string
Max Length: 1048576
.... state SΣ0..1stringSub-unit of country (abbreviations ok)
Binding: States, Territories and Provinces Value Set (required)
.... postalCode SΣ0..1stringUS Zip Codes
Example General: 9132
.... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
.... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... physicalType Σ0..1CodeableConceptPhysical form of the location
Binding: LocationType (example): Physical form of the location.

... position 0..1BackboneElementThe absolute geographic location
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... longitude 1..1decimalLongitude with WGS84 datum
.... latitude 1..1decimalLatitude with WGS84 datum
.... altitude 0..1decimalAltitude with WGS84 datum
... managingOrganization SΣ0..1Reference(US Core Organization Profile)Organization responsible for provisioning and upkeep
... partOf 0..1Reference(Location)Another Location this one is physically a part of
... hoursOfOperation 0..*BackboneElementWhat days/times during a week is this location usually open
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... daysOfWeek 0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.


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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Location.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Location.statusrequiredLocationStatus
Location.operationalStatuspreferredHl7VSBedStatus
Location.moderequiredLocationMode
Location.typeextensiblePattern: disposition
Location.address.userequiredAddressUse
Location.address.typerequiredAddressType
Location.address.staterequiredStatesTerritoriesAndProvincesVS
Location.physicalTypeexampleLocationType
Location.hoursOfOperation.daysOfWeekrequiredDaysOfWeek

This structure is derived from USCoreLocation

Summary

Mandatory: 2 elements

Extensions

This structure refers to these extensions:

 

Other representations of profile: CSV, Excel, Schematron