SDOH Clinical Care
3.1.0 - STU 3.1 Draft United States of America flag

SDOH Clinical Care, published by HL7 International / Patient Care. This guide is not an authorized publication; it is the continuous build for version 3.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-sdoh-clinicalcare/ and changes regularly. See the Directory of published versions

Resource Profile: SDOHCC Location

Official URL: http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-Location Version: 3.1.0
Standards status: Trial-use Maturity Level: 2 Computable Name: SDOHCCLocation
Other Identifiers: OID:2.16.840.1.113883.4.642.40.6.42.10

Profile that describes address information for a healthcare service.

Purpose

SDOHCC Location provides the address of a Healthcare Service to which a subject is referred. When a subject of care is referred to a Healthcare Service, SDOHCC Task For Patient (via Task.input) references SDOHCC Healthcare Service which (via HealthcareService.location) references SDOHCC Location which requires Location.address.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Location 0..* USCoreLocationProfile(8.0.1) Details and position information for a physical place
This profile also complies with the profile US Core Location Profile (6.1.0)
Location.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Location.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Location.identifier This element must be supported. This element is included in summaries. 0..* Identifier Unique business identifier for facility or location.
Location.status This element is a modifier element. This element must be supported. This element is included in summaries. 0..1 code active | suspended | inactive
Binding: LocationStatus (required): Indicates whether the location is still in use.
Location.name This element must be supported. This element is included in summaries. 1..1 string Name by which a facility or location is known.
Location.type This element must be supported. This element is included in summaries. 0..* CodeableConcept Category of service or resource available in a location.
Binding: ServiceDeliveryLocationRoleType (3.0.0) (extensible)
Additional BindingsPurposeDocumentation
Healthcare Service Location Type Combined Extensible
USCDI applicable vocabulary standard Healthcare Service Location Codes (HSLOC) or SNOMED-CT Healthcare Facility Type codes
CMS Place of Service Codes (POS) Extensible
NUBC Place of Service (POS) codes

Location.type.coding This element must be supported. This element is included in summaries. 1..* Coding Code defined by a terminology system
Location.type.coding.system This element must be supported. This element is included in summaries. 1..1 uri Identity of the terminology system
Location.type.coding.code This element must be supported. This element is included in summaries. 1..1 code Symbol in syntax defined by the system
Location.telecom This element must be supported. 0..* ContactPoint Contact details of the location
Location.address This element must be supported. 1..1 Address Physical location
Location.address.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
Location.address.line This element must be supported. This element is included in summaries. 0..* string Street 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
Example US Core: 49 MEADOW ST
Location.address.city This element must be supported. This element is included in summaries. 0..1 string Name of city, town etc.
Example General: Erewhon
Example US Core: EVERYTOWN
Location.address.state This element must be supported. This element is included in summaries. 0..1 string Sub-unit of country (abbreviations ok)
Binding: UspsTwoLetterAlphabeticCodes (2.0.0) (extensible): Two letter USPS alphabetic codes.
Example US Core: OK
Location.address.postalCode This element must be supported. This element is included in summaries. 0..1 string US Zip Codes
Example General: 9132
Example US Core: 74047
Location.managingOrganization This element must be supported. This element is included in summaries. 0..1 Reference(US Core Organization Profile(8.0.1)) 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.2
Location.address.use Base required AddressUse 📍4.0.1 FHIR Std.
Location.address.state Base extensible USPS Two Letter Alphabetic Codes 📍2.0.0 THO v7.2

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 USCoreLocationProfile

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Location 0..* USCoreLocationProfile(8.0.1) Details and position information for a physical place
This profile also complies with the profile US Core Location Profile (6.1.0)
Location.address 1..1 Address Physical location

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Location 0..* USCoreLocationProfile(8.0.1) Details and position information for a physical place
This profile also complies with the profile US Core Location Profile (6.1.0)
Location.id This element is included in summaries. 0..1 id Logical id of this artifact
Location.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Location.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Location.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Location.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
Location.contained 0..* Resource Contained, inline Resources
Location.extension 0..* Extension Additional content defined by implementations
Location.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Location.identifier This element must be supported. This element is included in summaries. 0..* Identifier Unique business identifier for facility or location.
Location.status This element is a modifier element. This element must be supported. This element is included in summaries. 0..1 code active | suspended | inactive
Binding: LocationStatus (required): Indicates whether the location is still in use.
Location.operationalStatus This element is included in summaries. 0..1 Coding The operational status of the location (typically only for a bed/room)
Binding: Hl7VSBedStatus (3.0.0) (preferred): The operational status if the location (where typically a bed/room).
Location.name This element must be supported. This element is included in summaries. 1..1 string Name by which a facility or location is known.
Location.alias 0..* string A list of alternate names that the location is known as, or was known as, in the past
Location.description This element is included in summaries. 0..1 string Additional details about the location that could be displayed as further information to identify the location beyond its name
Location.mode This element is included in summaries. 0..1 code instance | kind
Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations.
Location.type This element must be supported. This element is included in summaries. 0..* CodeableConcept Category of service or resource available in a location.
Binding: ServiceDeliveryLocationRoleType (3.0.0) (extensible)
Additional BindingsPurposeDocumentation
Healthcare Service Location Type Combined Extensible
USCDI applicable vocabulary standard Healthcare Service Location Codes (HSLOC) or SNOMED-CT Healthcare Facility Type codes
CMS Place of Service Codes (POS) Extensible
NUBC Place of Service (POS) codes

Location.type.id 0..1 string Unique id for inter-element referencing
Location.type.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Location.type.coding This element must be supported. This element is included in summaries. 1..* Coding Code defined by a terminology system
Location.type.coding.id 0..1 string Unique id for inter-element referencing
Location.type.coding.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Location.type.coding.system This element must be supported. This element is included in summaries. 1..1 uri Identity of the terminology system
Location.type.coding.version This element is included in summaries. 0..1 string Version of the system - if relevant
Location.type.coding.code This element must be supported. This element is included in summaries. 1..1 code Symbol in syntax defined by the system
Location.type.coding.display This element is included in summaries. 0..1 string Representation defined by the system
Location.type.coding.userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user
Location.type.text This element is included in summaries. 0..1 string Plain text representation of the concept
Location.telecom This element must be supported. 0..* ContactPoint Contact details of the location
Location.address This element must be supported. 1..1 Address Physical location
Location.address.id 0..1 string Unique id for inter-element referencing
Location.address.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Location.address.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
Location.address.type This element is included in summaries. 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
Location.address.text This element is included in summaries. 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
Location.address.line This element must be supported. This element is included in summaries. 0..* string Street 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
Example US Core: 49 MEADOW ST
Location.address.city This element must be supported. This element is included in summaries. 0..1 string Name of city, town etc.
Example General: Erewhon
Example US Core: EVERYTOWN
Location.address.district This element is included in summaries. 0..1 string District name (aka county)
Example General: Madison
Location.address.state This element must be supported. This element is included in summaries. 0..1 string Sub-unit of country (abbreviations ok)
Binding: UspsTwoLetterAlphabeticCodes (2.0.0) (extensible): Two letter USPS alphabetic codes.
Example US Core: OK
Location.address.postalCode This element must be supported. This element is included in summaries. 0..1 string US Zip Codes
Example General: 9132
Example US Core: 74047
Location.address.country This element is included in summaries. 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
Location.address.period This element is included in summaries. 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
Location.physicalType This element is included in summaries. 0..1 CodeableConcept Physical form of the location
Binding: LocationType (example): Physical form of the location.
Location.position 0..1 BackboneElement The absolute geographic location
Location.position.id 0..1 string Unique id for inter-element referencing
Location.position.extension 0..* Extension Additional content defined by implementations
Location.position.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Location.position.longitude 1..1 decimal Longitude with WGS84 datum
Location.position.latitude 1..1 decimal Latitude with WGS84 datum
Location.position.altitude 0..1 decimal Altitude with WGS84 datum
Location.managingOrganization This element must be supported. This element is included in summaries. 0..1 Reference(US Core Organization Profile(8.0.1)) Organization responsible for provisioning and upkeep
Location.partOf 0..1 Reference(Location) Another Location this one is physically a part of
Location.hoursOfOperation 0..* BackboneElement What days/times during a week is this location usually open
Location.hoursOfOperation.id 0..1 string Unique id for inter-element referencing
Location.hoursOfOperation.extension 0..* Extension Additional content defined by implementations
Location.hoursOfOperation.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Location.hoursOfOperation.daysOfWeek 0..* code mon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.
Location.hoursOfOperation.allDay 0..1 boolean The Location is open all day
Location.hoursOfOperation.openingTime 0..1 time Time that the Location opens
Location.hoursOfOperation.closingTime 0..1 time Time that the Location closes
Location.availabilityExceptions 0..1 string Description of availability exceptions
Location.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.2
Location.mode Base required LocationMode 📍4.0.1 FHIR Std.
Location.type Base extensible ServiceDeliveryLocationRoleType 📍3.0.0 THO v7.2
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 extensible USPS Two Letter Alphabetic Codes 📍2.0.0 THO v7.2
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 USCoreLocationProfile

Summary

Mandatory: 1 element

Maturity: 2

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Location 0..* USCoreLocationProfile(8.0.1) Details and position information for a physical place
This profile also complies with the profile US Core Location Profile (6.1.0)
Location.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Location.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Location.identifier This element must be supported. This element is included in summaries. 0..* Identifier Unique business identifier for facility or location.
Location.status This element is a modifier element. This element must be supported. This element is included in summaries. 0..1 code active | suspended | inactive
Binding: LocationStatus (required): Indicates whether the location is still in use.
Location.name This element must be supported. This element is included in summaries. 1..1 string Name by which a facility or location is known.
Location.type This element must be supported. This element is included in summaries. 0..* CodeableConcept Category of service or resource available in a location.
Binding: ServiceDeliveryLocationRoleType (3.0.0) (extensible)
Additional BindingsPurposeDocumentation
Healthcare Service Location Type Combined Extensible
USCDI applicable vocabulary standard Healthcare Service Location Codes (HSLOC) or SNOMED-CT Healthcare Facility Type codes
CMS Place of Service Codes (POS) Extensible
NUBC Place of Service (POS) codes

Location.type.coding This element must be supported. This element is included in summaries. 1..* Coding Code defined by a terminology system
Location.type.coding.system This element must be supported. This element is included in summaries. 1..1 uri Identity of the terminology system
Location.type.coding.code This element must be supported. This element is included in summaries. 1..1 code Symbol in syntax defined by the system
Location.telecom This element must be supported. 0..* ContactPoint Contact details of the location
Location.address This element must be supported. 1..1 Address Physical location
Location.address.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
Location.address.line This element must be supported. This element is included in summaries. 0..* string Street 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
Example US Core: 49 MEADOW ST
Location.address.city This element must be supported. This element is included in summaries. 0..1 string Name of city, town etc.
Example General: Erewhon
Example US Core: EVERYTOWN
Location.address.state This element must be supported. This element is included in summaries. 0..1 string Sub-unit of country (abbreviations ok)
Binding: UspsTwoLetterAlphabeticCodes (2.0.0) (extensible): Two letter USPS alphabetic codes.
Example US Core: OK
Location.address.postalCode This element must be supported. This element is included in summaries. 0..1 string US Zip Codes
Example General: 9132
Example US Core: 74047
Location.managingOrganization This element must be supported. This element is included in summaries. 0..1 Reference(US Core Organization Profile(8.0.1)) 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.2
Location.address.use Base required AddressUse 📍4.0.1 FHIR Std.
Location.address.state Base extensible USPS Two Letter Alphabetic Codes 📍2.0.0 THO v7.2

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 USCoreLocationProfile

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Location 0..* USCoreLocationProfile(8.0.1) Details and position information for a physical place
This profile also complies with the profile US Core Location Profile (6.1.0)
Location.address 1..1 Address Physical location

doco Documentation for this format

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Location 0..* USCoreLocationProfile(8.0.1) Details and position information for a physical place
This profile also complies with the profile US Core Location Profile (6.1.0)
Location.id This element is included in summaries. 0..1 id Logical id of this artifact
Location.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Location.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Location.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Location.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
Location.contained 0..* Resource Contained, inline Resources
Location.extension 0..* Extension Additional content defined by implementations
Location.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Location.identifier This element must be supported. This element is included in summaries. 0..* Identifier Unique business identifier for facility or location.
Location.status This element is a modifier element. This element must be supported. This element is included in summaries. 0..1 code active | suspended | inactive
Binding: LocationStatus (required): Indicates whether the location is still in use.
Location.operationalStatus This element is included in summaries. 0..1 Coding The operational status of the location (typically only for a bed/room)
Binding: Hl7VSBedStatus (3.0.0) (preferred): The operational status if the location (where typically a bed/room).
Location.name This element must be supported. This element is included in summaries. 1..1 string Name by which a facility or location is known.
Location.alias 0..* string A list of alternate names that the location is known as, or was known as, in the past
Location.description This element is included in summaries. 0..1 string Additional details about the location that could be displayed as further information to identify the location beyond its name
Location.mode This element is included in summaries. 0..1 code instance | kind
Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations.
Location.type This element must be supported. This element is included in summaries. 0..* CodeableConcept Category of service or resource available in a location.
Binding: ServiceDeliveryLocationRoleType (3.0.0) (extensible)
Additional BindingsPurposeDocumentation
Healthcare Service Location Type Combined Extensible
USCDI applicable vocabulary standard Healthcare Service Location Codes (HSLOC) or SNOMED-CT Healthcare Facility Type codes
CMS Place of Service Codes (POS) Extensible
NUBC Place of Service (POS) codes

Location.type.id 0..1 string Unique id for inter-element referencing
Location.type.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Location.type.coding This element must be supported. This element is included in summaries. 1..* Coding Code defined by a terminology system
Location.type.coding.id 0..1 string Unique id for inter-element referencing
Location.type.coding.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Location.type.coding.system This element must be supported. This element is included in summaries. 1..1 uri Identity of the terminology system
Location.type.coding.version This element is included in summaries. 0..1 string Version of the system - if relevant
Location.type.coding.code This element must be supported. This element is included in summaries. 1..1 code Symbol in syntax defined by the system
Location.type.coding.display This element is included in summaries. 0..1 string Representation defined by the system
Location.type.coding.userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user
Location.type.text This element is included in summaries. 0..1 string Plain text representation of the concept
Location.telecom This element must be supported. 0..* ContactPoint Contact details of the location
Location.address This element must be supported. 1..1 Address Physical location
Location.address.id 0..1 string Unique id for inter-element referencing
Location.address.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Location.address.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.
Example General: home
Location.address.type This element is included in summaries. 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).
Example General: both
Location.address.text This element is included in summaries. 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
Location.address.line This element must be supported. This element is included in summaries. 0..* string Street 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
Example US Core: 49 MEADOW ST
Location.address.city This element must be supported. This element is included in summaries. 0..1 string Name of city, town etc.
Example General: Erewhon
Example US Core: EVERYTOWN
Location.address.district This element is included in summaries. 0..1 string District name (aka county)
Example General: Madison
Location.address.state This element must be supported. This element is included in summaries. 0..1 string Sub-unit of country (abbreviations ok)
Binding: UspsTwoLetterAlphabeticCodes (2.0.0) (extensible): Two letter USPS alphabetic codes.
Example US Core: OK
Location.address.postalCode This element must be supported. This element is included in summaries. 0..1 string US Zip Codes
Example General: 9132
Example US Core: 74047
Location.address.country This element is included in summaries. 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
Location.address.period This element is included in summaries. 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
Location.physicalType This element is included in summaries. 0..1 CodeableConcept Physical form of the location
Binding: LocationType (example): Physical form of the location.
Location.position 0..1 BackboneElement The absolute geographic location
Location.position.id 0..1 string Unique id for inter-element referencing
Location.position.extension 0..* Extension Additional content defined by implementations
Location.position.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Location.position.longitude 1..1 decimal Longitude with WGS84 datum
Location.position.latitude 1..1 decimal Latitude with WGS84 datum
Location.position.altitude 0..1 decimal Altitude with WGS84 datum
Location.managingOrganization This element must be supported. This element is included in summaries. 0..1 Reference(US Core Organization Profile(8.0.1)) Organization responsible for provisioning and upkeep
Location.partOf 0..1 Reference(Location) Another Location this one is physically a part of
Location.hoursOfOperation 0..* BackboneElement What days/times during a week is this location usually open
Location.hoursOfOperation.id 0..1 string Unique id for inter-element referencing
Location.hoursOfOperation.extension 0..* Extension Additional content defined by implementations
Location.hoursOfOperation.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Location.hoursOfOperation.daysOfWeek 0..* code mon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.
Location.hoursOfOperation.allDay 0..1 boolean The Location is open all day
Location.hoursOfOperation.openingTime 0..1 time Time that the Location opens
Location.hoursOfOperation.closingTime 0..1 time Time that the Location closes
Location.availabilityExceptions 0..1 string Description of availability exceptions
Location.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.2
Location.mode Base required LocationMode 📍4.0.1 FHIR Std.
Location.type Base extensible ServiceDeliveryLocationRoleType 📍3.0.0 THO v7.2
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 extensible USPS Two Letter Alphabetic Codes 📍2.0.0 THO v7.2
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 USCoreLocationProfile

Summary

Mandatory: 1 element

Maturity: 2

 

Other representations of profile: CSV, Excel, Schematron