US Quality Core Implementation Guide, published by HL7 International / Clinical Quality Information. This guide is not an authorized publication; it is the continuous build for version 1.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-us-quality-core/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/us/quality-core/StructureDefinition/us-quality-core-location | Version: 1.0.0-ballot | ||||
| Standards status: Trial-use | Maturity Level: 4 | Computable Name: USQualityCoreLocation | |||
| Other Identifiers: OID:2.16.840.1.113883.4.642.40.78.42.23 | |||||
Profile of Location for decision support/quality metrics. Defines the core set of elements and extensions for quality rule and measure authors.
Systems are expected to support this profile as part of implementing USCDI+ Quality V2 in FHIR and meeting the conformance requirements of this guide.
The following elements are specifically relevant to USCDI+ Quality V2 data classes and elements. Systems are expected to support these elements as applicable to their role in US Quality Core data exchange. See the Must Support section of this guide for more information. These elements are flagged as (USCDI+ Quality) in the formal profile views.
USCDI+ Quality Elements:
| Profile element | Description | USCDI+ Quality Data Element(s) |
|---|---|---|
address |
Physical location | Facility Information: Facility Address |
identifier |
Unique business identifier for facility or location. | Facility Information: Facility Identifier |
name |
Name by which a facility or location is known. | Facility Information: Facility Name |
type |
Category of service or resource available in a location. | Facility Information: Facility Type |
Because this profile is derived directly or indirectly from US Core, systems are also expected to support the Must Support and Additional USCDI requirements specified by the US Core profile this profile inherits from. For more information about those requirements, refer to the US Core Location Profile. The Formal Views section also provides the formal summary, definitions, terminology requirements, and mandatory element requirements.
Usages:
You can also check for usages in the FHIR IG Statistics
Description Differentials, Snapshots, and other representations.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | USCoreLocationProfile(9.0.0) | Details and position information for a physical place | |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
SΣ | 0..* | Identifier | (USCDI+ Quality) Unique business identifier for facility or location. |
![]() ![]() |
?!SΣ | 0..1 | code | active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use. Fixed Value: active |
![]() ![]() |
SΣ | 1..1 | string | (USCDI+ Quality) Name by which a facility or location is known. |
![]() ![]() |
SΣ | 0..* | CodeableConcept | (USCDI+ Quality) Category of service or resource available in a location. Binding: US Core Location Type Codes (extensible) |
![]() ![]() ![]() |
SΣ | 1..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() |
S | 0..* | ContactPoint | Contact details of the location |
![]() ![]() |
S | 0..1 | Address | (USCDI+ Quality) Physical location |
![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
![]() ![]() ![]() |
SΣ | 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 |
![]() ![]() ![]() |
SΣ | 0..1 | string | Name of city, town etc. Example General: Erewhon Example US Core: EVERYTOWN |
![]() ![]() ![]() |
SΣ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes. Example US Core: OK |
![]() ![]() ![]() |
SΣ | 0..1 | string | US Zip Codes Example General: 9132 Example US Core: 74047 |
![]() ![]() |
SΣ | 0..1 | Reference(US Quality Core Organization) | Organization responsible for provisioning and upkeep |
![]() ![]() |
0..1 | Reference(US Quality Core Location) | Another Location this one is physically a part of | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Location.status | Base | required | LocationStatus | 📍4.0.1 | FHIR Std. |
| Location.type | Base | extensible | US Core Location Type Codes | 📦9.0.0 | US Core v9.0 |
| 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 |
| 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()
|
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | USCoreLocationProfile(9.0.0) | Details and position information for a physical place | |
![]() ![]() |
0..* | Identifier | (USCDI+ Quality) Unique business identifier for facility or location. | |
![]() ![]() |
0..1 | code | active | suspended | inactive Fixed Value: active | |
![]() ![]() |
1..1 | string | (USCDI+ Quality) Name by which a facility or location is known. | |
![]() ![]() |
0..* | CodeableConcept | (USCDI+ Quality) Category of service or resource available in a location. | |
![]() ![]() |
0..1 | Address | (USCDI+ Quality) Physical location | |
![]() ![]() |
0..1 | Reference(US Quality Core Organization) | Organization responsible for provisioning and upkeep | |
![]() ![]() |
0..1 | Reference(US Quality Core Location) | Another Location this one is physically a part of | |
Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | USCoreLocationProfile(9.0.0) | Details and position information for a physical place | |||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
SΣ | 0..* | Identifier | (USCDI+ Quality) Unique business identifier for facility or location. | ||||
![]() ![]() |
?!SΣ | 0..1 | code | active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use. Fixed Value: active | ||||
![]() ![]() |
Σ | 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). | ||||
![]() ![]() |
SΣ | 1..1 | string | (USCDI+ Quality) Name by which a facility or location is known. | ||||
![]() ![]() |
0..* | string | A list of alternate names that the location is known as, or was known as, in the past | |||||
![]() ![]() |
Σ | 0..1 | string | Additional details about the location that could be displayed as further information to identify the location beyond its name | ||||
![]() ![]() |
Σ | 0..1 | code | instance | kind Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations. | ||||
![]() ![]() |
SΣ | 0..* | CodeableConcept | (USCDI+ Quality) Category of service or resource available in a location. Binding: US Core Location Type Codes (extensible) | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
SΣ | 1..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() |
S | 0..* | ContactPoint | Contact details of the location | ||||
![]() ![]() |
S | 0..1 | Address | (USCDI+ Quality) Physical location | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | ||||
![]() ![]() ![]() |
Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
![]() ![]() ![]() |
SΣ | 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 | ||||
![]() ![]() ![]() |
SΣ | 0..1 | string | Name of city, town etc. Example General: Erewhon Example US Core: EVERYTOWN | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||
![]() ![]() ![]() |
SΣ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes. Example US Core: OK | ||||
![]() ![]() ![]() |
SΣ | 0..1 | string | US Zip Codes Example General: 9132 Example US Core: 74047 | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | ||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
![]() ![]() |
Σ | 0..1 | CodeableConcept | Physical form of the location Binding: LocationType (example): Physical form of the location. | ||||
![]() ![]() |
0..1 | BackboneElement | The absolute geographic location | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
1..1 | decimal | Longitude with WGS84 datum | |||||
![]() ![]() ![]() |
1..1 | decimal | Latitude with WGS84 datum | |||||
![]() ![]() ![]() |
0..1 | decimal | Altitude with WGS84 datum | |||||
![]() ![]() |
SΣ | 0..1 | Reference(US Quality Core Organization) | Organization responsible for provisioning and upkeep | ||||
![]() ![]() |
0..1 | Reference(US Quality Core Location) | Another Location this one is physically a part of | |||||
![]() ![]() |
0..* | BackboneElement | What days/times during a week is this location usually open | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week. | |||||
![]() ![]() ![]() |
0..1 | boolean | The Location is open all day | |||||
![]() ![]() ![]() |
0..1 | time | Time that the Location opens | |||||
![]() ![]() ![]() |
0..1 | time | Time that the Location closes | |||||
![]() ![]() |
0..1 | string | Description of availability exceptions | |||||
![]() ![]() |
0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the location | |||||
Documentation for this format | ||||||||
| 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 | US Core Location Type Codes | 📦9.0.0 | US Core v9.0 |
| 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. |
| 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()
|
Summary
Fixed: 1 element
Structures
This structure refers to these other structures:
Maturity: 4
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | USCoreLocationProfile(9.0.0) | Details and position information for a physical place | |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
SΣ | 0..* | Identifier | (USCDI+ Quality) Unique business identifier for facility or location. |
![]() ![]() |
?!SΣ | 0..1 | code | active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use. Fixed Value: active |
![]() ![]() |
SΣ | 1..1 | string | (USCDI+ Quality) Name by which a facility or location is known. |
![]() ![]() |
SΣ | 0..* | CodeableConcept | (USCDI+ Quality) Category of service or resource available in a location. Binding: US Core Location Type Codes (extensible) |
![]() ![]() ![]() |
SΣ | 1..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() |
S | 0..* | ContactPoint | Contact details of the location |
![]() ![]() |
S | 0..1 | Address | (USCDI+ Quality) Physical location |
![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
![]() ![]() ![]() |
SΣ | 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 |
![]() ![]() ![]() |
SΣ | 0..1 | string | Name of city, town etc. Example General: Erewhon Example US Core: EVERYTOWN |
![]() ![]() ![]() |
SΣ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes. Example US Core: OK |
![]() ![]() ![]() |
SΣ | 0..1 | string | US Zip Codes Example General: 9132 Example US Core: 74047 |
![]() ![]() |
SΣ | 0..1 | Reference(US Quality Core Organization) | Organization responsible for provisioning and upkeep |
![]() ![]() |
0..1 | Reference(US Quality Core Location) | Another Location this one is physically a part of | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Location.status | Base | required | LocationStatus | 📍4.0.1 | FHIR Std. |
| Location.type | Base | extensible | US Core Location Type Codes | 📦9.0.0 | US Core v9.0 |
| 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 |
| 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
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | USCoreLocationProfile(9.0.0) | Details and position information for a physical place | |
![]() ![]() |
0..* | Identifier | (USCDI+ Quality) Unique business identifier for facility or location. | |
![]() ![]() |
0..1 | code | active | suspended | inactive Fixed Value: active | |
![]() ![]() |
1..1 | string | (USCDI+ Quality) Name by which a facility or location is known. | |
![]() ![]() |
0..* | CodeableConcept | (USCDI+ Quality) Category of service or resource available in a location. | |
![]() ![]() |
0..1 | Address | (USCDI+ Quality) Physical location | |
![]() ![]() |
0..1 | Reference(US Quality Core Organization) | Organization responsible for provisioning and upkeep | |
![]() ![]() |
0..1 | Reference(US Quality Core Location) | Another Location this one is physically a part of | |
Documentation for this format | ||||
Snapshot ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | USCoreLocationProfile(9.0.0) | Details and position information for a physical place | |||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
SΣ | 0..* | Identifier | (USCDI+ Quality) Unique business identifier for facility or location. | ||||
![]() ![]() |
?!SΣ | 0..1 | code | active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use. Fixed Value: active | ||||
![]() ![]() |
Σ | 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). | ||||
![]() ![]() |
SΣ | 1..1 | string | (USCDI+ Quality) Name by which a facility or location is known. | ||||
![]() ![]() |
0..* | string | A list of alternate names that the location is known as, or was known as, in the past | |||||
![]() ![]() |
Σ | 0..1 | string | Additional details about the location that could be displayed as further information to identify the location beyond its name | ||||
![]() ![]() |
Σ | 0..1 | code | instance | kind Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations. | ||||
![]() ![]() |
SΣ | 0..* | CodeableConcept | (USCDI+ Quality) Category of service or resource available in a location. Binding: US Core Location Type Codes (extensible) | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
SΣ | 1..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() |
S | 0..* | ContactPoint | Contact details of the location | ||||
![]() ![]() |
S | 0..1 | Address | (USCDI+ Quality) Physical location | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | ||||
![]() ![]() ![]() |
Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
![]() ![]() ![]() |
SΣ | 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 | ||||
![]() ![]() ![]() |
SΣ | 0..1 | string | Name of city, town etc. Example General: Erewhon Example US Core: EVERYTOWN | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||
![]() ![]() ![]() |
SΣ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes. Example US Core: OK | ||||
![]() ![]() ![]() |
SΣ | 0..1 | string | US Zip Codes Example General: 9132 Example US Core: 74047 | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | ||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
![]() ![]() |
Σ | 0..1 | CodeableConcept | Physical form of the location Binding: LocationType (example): Physical form of the location. | ||||
![]() ![]() |
0..1 | BackboneElement | The absolute geographic location | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
1..1 | decimal | Longitude with WGS84 datum | |||||
![]() ![]() ![]() |
1..1 | decimal | Latitude with WGS84 datum | |||||
![]() ![]() ![]() |
0..1 | decimal | Altitude with WGS84 datum | |||||
![]() ![]() |
SΣ | 0..1 | Reference(US Quality Core Organization) | Organization responsible for provisioning and upkeep | ||||
![]() ![]() |
0..1 | Reference(US Quality Core Location) | Another Location this one is physically a part of | |||||
![]() ![]() |
0..* | BackboneElement | What days/times during a week is this location usually open | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week. | |||||
![]() ![]() ![]() |
0..1 | boolean | The Location is open all day | |||||
![]() ![]() ![]() |
0..1 | time | Time that the Location opens | |||||
![]() ![]() ![]() |
0..1 | time | Time that the Location closes | |||||
![]() ![]() |
0..1 | string | Description of availability exceptions | |||||
![]() ![]() |
0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the location | |||||
Documentation for this format | ||||||||
| 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 | US Core Location Type Codes | 📦9.0.0 | US Core v9.0 |
| 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. |
| 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()
|
Summary
Fixed: 1 element
Structures
This structure refers to these other structures:
Maturity: 4
Other representations of profile: CSV, Excel, Schematron
Badges identify the profile layer where each conformance indicator is first introduced. Indicators introduced in an earlier layer remain applicable in later derived profiles.
| Profile element | FHIR | US Core | US Quality Core |
|---|---|---|---|
identifier |
Must Support | USCDI+ Quality | |
status |
Must Support | ||
name |
Mandatory Must Support | USCDI+ Quality | |
type |
Must Support | USCDI+ Quality | |
type.coding |
Mandatory Must Support | ||
type.coding.system |
Mandatory Must Support | ||
type.coding.code |
Mandatory Must Support | ||
telecom |
Must Support | ||
address |
Must Support | USCDI+ Quality | |
address.line |
Must Support | ||
address.city |
Must Support | ||
address.state |
Must Support | ||
address.postalCode |
Must Support | ||
position.longitude |
Mandatory | ||
position.latitude |
Mandatory | ||
managingOrganization |
Must Support |
Cardinality note: “Mandatory” means the element has a minimum cardinality greater than zero. For nested elements, the cardinality indicator applies when the containing element is present.