US Core Implementation Guide
8.0.1 - STU 8

US Core Implementation Guide, published by HL7 International / Cross-Group Projects. This guide is not an authorized publication; it is the continuous build for version 8.0.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/US-Core/ and changes regularly. See the Directory of published versions

## Resource Profile: US Core Location Profile

Official URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-location | Version: 8.0.1
Standards status: Trial-use | Maturity Level: 3 | Computable Name: USCoreLocationProfile
Other Identifiers: OID:2.16.840.1.113883.4.642.40.2.42.36
Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License

The US Core Location Profile inherits from the FHIR Location resource; refer to it for scope and usage definitions. This profile sets minimum expectations for the Location resource for recording, searching, and fetching a "physical place of available services or resources." It specifies which core elements, extensions, vocabularies, and value sets SHALL be present and constrains how the elements are used. Providing the floor for standards development for specific use cases promotes interoperability and adoption.

### Mandatory and Must Support Data Elements

The following data elements must always be present (Mandatory definition) or must be supported if the data is present in the sending system (Must Support definition). They are presented below in a simple human-readable explanation. Profile specific guidance and examples are provided as well. The Formal Views below provides the formal summary, definitions, and terminology requirements.

Each Location Must Have:

1. A name

Each Location Must Support:

1. Location or facility identifier
2. A status (whether in use)
3. The type of location or facility*
4. Contact details of the location
5. A Location address*
6. The managing organization

*see guidance below

Additional Profile specific implementation guidance:

- US Core Encounter Profile and the US Core Immunization Profile link directly to US Core Location via `Encounter.location` and `Immunization.location`.
- The following US Core Profiles indirectly reference the location/facility through references to US Core Encounter:
  - US Core DiagnosticReport Profile for Laboratory Results Reporting
  - US Core Immunization Profile
  - US Core MedicationDispense Profile
  - US Core Observation Clinical Result Profile
  - US Core Procedure Profile
  - US Core ServiceRequest Profile

  If the event facility/location differs from the `Encounter.location`, systems SHOULD reference it directly:

  - Systems SHALL use the `location` element for all resources where the element is available.
  - Systems MAY use the standard Event Location Extension for US Core DiagnosticReport Profile for Laboratory Results Reporting and US Core Observation Clinical Result Profile.
- *There are three bindings for `Location.type` to meet multiple industry needs for identifying service locations:
  - The extensibly bound Service Delivery Location Role Type value set is inherited from the base resource. Its binding strength has been revised to preferred in FHIR R5/R6, and for US Core, implementers may treat it as preferred.
  - This guide uses a grouped value set that includes concepts from Healthcare Service Location Codes (HSLOC) and SNOMED-CT Healthcare Facility Type codes to meet the USCDI applicable vocabulary standard. Implementers can use a code from either vocabulary.
  - The NUBC Place of Service (POS) codes meet the Health Insurance Portability and Accountability Act of 1996 (HIPAA) requirements for billing and Payers.
- * Systems SHOULD follow the Project US@ Technical Specification for Patient Addresses Final Version 1.0 as the standard style guide for `Location.address.line` and `Location.address.city`.

Usages:

- Refer to this Profile: US Core DiagnosticReport Profile for Laboratory Results Reporting, US Core DiagnosticReport Profile for Report and Note Exchange, US Core Encounter Profile, US Core Immunization Profile... Show 6 more, US Core Observation Clinical Result Profile, US Core Observation Screening Assessment Profile, US Core PractitionerRole Profile, US Core ServiceRequest Profile, US Core Simple Observation Profile and US Core Specimen Profile
- Examples for this Profile: Health Level Seven International - Amherst and Holy Family Hospital
- CapabilityStatements using this Profile: US Core Client CapabilityStatement and US Core Server CapabilityStatement

You can also check for usages in the FHIR IG Statistics

Changes since version 7.0.0:

- The data elements list has changed

### Formal Views of Profile Content

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

- Key Elements Table
- Differential Table
- Snapshot Table
- Statistics/References
- All

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Location |  | 0..* | Location | 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
identifier | S Σ | 0..* | Identifier | Unique business identifier for facility or location.
status | ?!S Σ | 0..1 | code | active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use.
name | S Σ | 1..1 | string | Name by which a facility or location is known.
type | S Σ | 0..* | CodeableConcept | Category of service or resource available in a location. Binding: ServiceDeliveryLocationRoleType (extensible)
Additional Bindings | Purpose | Documentation
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
coding | S Σ | 1..* | Coding | Code defined by a terminology system
system | S Σ | 1..1 | uri | Identity of the terminology system
code | S Σ | 1..1 | code | Symbol in syntax defined by the system
telecom | S | 0..* | ContactPoint | Contact details of the location
address | S | 0..1 | Address | Physical location
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 | 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
city | S Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon Example US Core: EVERYTOWN
state | 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
postalCode | S Σ | 0..1 | string | US Zip Codes Example General: 9132 Example US Core: 74047
managingOrganization | S Σ | 0..1 | Reference(US Core Organization Profile) | Organization responsible for provisioning and upkeep
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.0
Location.address.use | Base | required | AddressUse | 📍4.0.1 | FHIR Std.
Location.address.state | Base | extensible | USPS Two Letter Alphabetic Codes | 📦1.0.0 | THO v7.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 Location

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Location |  | 0..* | Location | Details and position information for a physical place
identifier | S | 0..* | Identifier | Unique business identifier for facility or location.
status | S | 0..1 | code | active | suspended | inactive
name | S | 1..1 | string | Name by which a facility or location is known.
type | S | 0..* | CodeableConcept | Category of service or resource available in a location. Binding: ServiceDeliveryLocationRoleType (extensible)
Additional Bindings | Purpose | Documentation
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
coding | S | 1..* | Coding | Code defined by a terminology system
system | S | 1..1 | uri | Identity of the terminology system
code | S | 1..1 | code | Symbol in syntax defined by the system
telecom | S | 0..* | ContactPoint | Contact details of the location
address | S | 0..1 | Address | Physical location
line | S | 0..* | string | Street name, number, direction & P.O. Box etc. Example US Core: 49 MEADOW ST
city | S | 0..1 | string | Name of city, town etc. Example US Core: EVERYTOWN
state | 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
postalCode | S | 0..1 | string | US Zip Codes Example US Core: 74047
managingOrganization | S | 0..1 | Reference(US Core Organization Profile) | Organization responsible for provisioning and upkeep
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
Location.type | Base | extensible | ServiceDeliveryLocationRoleType | 📦3.0.0 | THO v7.0
Location.address.state | Base | extensible | USPS Two Letter Alphabetic Codes | 📦1.0.0 | THO v7.0

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Location |  | 0..* | Location | Details and position information for a physical place
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
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 | S Σ | 0..* | Identifier | Unique business identifier for facility or location.
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 by which a facility or location is known.
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 | S Σ | 0..* | CodeableConcept | Category of service or resource available in a location. Binding: ServiceDeliveryLocationRoleType (extensible)
Additional Bindings | Purpose | Documentation
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
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
coding | S Σ | 1..* | Coding | Code defined by a terminology system
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
system | S Σ | 1..1 | uri | Identity of the terminology system
version | Σ | 0..1 | string | Version of the system - if relevant
code | S Σ | 1..1 | code | Symbol in syntax defined by the system
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 | 0..1 | Address | Physical location
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
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 | 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
city | S Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon Example US Core: EVERYTOWN
district | Σ | 0..1 | string | District name (aka county) Example General: Madison
state | 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
postalCode | S Σ | 0..1 | string | US Zip Codes Example General: 9132 Example US Core: 74047
country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code)
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 | The absolute geographic location
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
longitude |  | 1..1 | decimal | Longitude with WGS84 datum
latitude |  | 1..1 | decimal | Latitude with WGS84 datum
altitude |  | 0..1 | decimal | Altitude with WGS84 datum
managingOrganization | S Σ | 0..1 | Reference(US Core Organization Profile) | Organization responsible for provisioning and upkeep
partOf |  | 0..1 | Reference(Location) | Another Location this one is physically a part of
hoursOfOperation |  | 0..* | BackboneElement | What days/times during a week is this location usually open
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
daysOfWeek |  | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week.
allDay |  | 0..1 | boolean | The Location is open all day
openingTime |  | 0..1 | time | Time that the Location opens
closingTime |  | 0..1 | time | Time that the Location closes
availabilityExceptions |  | 0..1 | string | Description of availability exceptions
endpoint |  | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the location
Documentation for this format

#### 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 | 📦2.0.0 | THO v7.0
Location.mode | Base | required | LocationMode | 📍4.0.1 | FHIR Std.
Location.type | Base | extensible | ServiceDeliveryLocationRoleType | 📦3.0.0 | THO v7.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 | 📦1.0.0 | THO v7.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 Location

Summary

Mandatory: 1 element(3 nested mandatory elements)
Must-Support: 14 elements

Structures

This structure refers to these other structures:

- US Core Organization Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization)

Maturity: 3

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Location |  | 0..* | Location | 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
identifier | S Σ | 0..* | Identifier | Unique business identifier for facility or location.
status | ?!S Σ | 0..1 | code | active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use.
name | S Σ | 1..1 | string | Name by which a facility or location is known.
type | S Σ | 0..* | CodeableConcept | Category of service or resource available in a location. Binding: ServiceDeliveryLocationRoleType (extensible)
Additional Bindings | Purpose | Documentation
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
coding | S Σ | 1..* | Coding | Code defined by a terminology system
system | S Σ | 1..1 | uri | Identity of the terminology system
code | S Σ | 1..1 | code | Symbol in syntax defined by the system
telecom | S | 0..* | ContactPoint | Contact details of the location
address | S | 0..1 | Address | Physical location
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 | 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
city | S Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon Example US Core: EVERYTOWN
state | 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
postalCode | S Σ | 0..1 | string | US Zip Codes Example General: 9132 Example US Core: 74047
managingOrganization | S Σ | 0..1 | Reference(US Core Organization Profile) | Organization responsible for provisioning and upkeep
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.0
Location.address.use | Base | required | AddressUse | 📍4.0.1 | FHIR Std.
Location.address.state | Base | extensible | USPS Two Letter Alphabetic Codes | 📦1.0.0 | THO v7.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 Location

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Location |  | 0..* | Location | Details and position information for a physical place
identifier | S | 0..* | Identifier | Unique business identifier for facility or location.
status | S | 0..1 | code | active | suspended | inactive
name | S | 1..1 | string | Name by which a facility or location is known.
type | S | 0..* | CodeableConcept | Category of service or resource available in a location. Binding: ServiceDeliveryLocationRoleType (extensible)
Additional Bindings | Purpose | Documentation
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
coding | S | 1..* | Coding | Code defined by a terminology system
system | S | 1..1 | uri | Identity of the terminology system
code | S | 1..1 | code | Symbol in syntax defined by the system
telecom | S | 0..* | ContactPoint | Contact details of the location
address | S | 0..1 | Address | Physical location
line | S | 0..* | string | Street name, number, direction & P.O. Box etc. Example US Core: 49 MEADOW ST
city | S | 0..1 | string | Name of city, town etc. Example US Core: EVERYTOWN
state | 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
postalCode | S | 0..1 | string | US Zip Codes Example US Core: 74047
managingOrganization | S | 0..1 | Reference(US Core Organization Profile) | Organization responsible for provisioning and upkeep
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
Location.type | Base | extensible | ServiceDeliveryLocationRoleType | 📦3.0.0 | THO v7.0
Location.address.state | Base | extensible | USPS Two Letter Alphabetic Codes | 📦1.0.0 | THO v7.0

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Location |  | 0..* | Location | Details and position information for a physical place
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
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 | S Σ | 0..* | Identifier | Unique business identifier for facility or location.
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 by which a facility or location is known.
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 | S Σ | 0..* | CodeableConcept | Category of service or resource available in a location. Binding: ServiceDeliveryLocationRoleType (extensible)
Additional Bindings | Purpose | Documentation
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
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
coding | S Σ | 1..* | Coding | Code defined by a terminology system
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
system | S Σ | 1..1 | uri | Identity of the terminology system
version | Σ | 0..1 | string | Version of the system - if relevant
code | S Σ | 1..1 | code | Symbol in syntax defined by the system
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 | 0..1 | Address | Physical location
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
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 | 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
city | S Σ | 0..1 | string | Name of city, town etc. Example General: Erewhon Example US Core: EVERYTOWN
district | Σ | 0..1 | string | District name (aka county) Example General: Madison
state | 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
postalCode | S Σ | 0..1 | string | US Zip Codes Example General: 9132 Example US Core: 74047
country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code)
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 | The absolute geographic location
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
longitude |  | 1..1 | decimal | Longitude with WGS84 datum
latitude |  | 1..1 | decimal | Latitude with WGS84 datum
altitude |  | 0..1 | decimal | Altitude with WGS84 datum
managingOrganization | S Σ | 0..1 | Reference(US Core Organization Profile) | Organization responsible for provisioning and upkeep
partOf |  | 0..1 | Reference(Location) | Another Location this one is physically a part of
hoursOfOperation |  | 0..* | BackboneElement | What days/times during a week is this location usually open
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
daysOfWeek |  | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week.
allDay |  | 0..1 | boolean | The Location is open all day
openingTime |  | 0..1 | time | Time that the Location opens
closingTime |  | 0..1 | time | Time that the Location closes
availabilityExceptions |  | 0..1 | string | Description of availability exceptions
endpoint |  | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the location
Documentation for this format

#### 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 | 📦2.0.0 | THO v7.0
Location.mode | Base | required | LocationMode | 📍4.0.1 | FHIR Std.
Location.type | Base | extensible | ServiceDeliveryLocationRoleType | 📦3.0.0 | THO v7.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 | 📦1.0.0 | THO v7.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 Location

Summary

Mandatory: 1 element(3 nested mandatory elements)
Must-Support: 14 elements

Structures

This structure refers to these other structures:

- US Core Organization Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization)

Maturity: 3

Other representations of profile: CSV, Excel, Schematron

### Notes:

Quick Start

Below is an overview of the required Server RESTful FHIR interactions for this profile - for example, search and read operations - when supporting the US Core interactions to access this profile's information (Profile Support + Interaction Support). Note that systems that support only US Core Profiles (Profile Only Support) are not required to support these interactions. See the US Core Server CapabilityStatement for a complete list of supported RESTful interactions for this IG.

- See the Scopes Format section for a description of the SMART scopes syntax.
- See the Search Syntax section for a description of the US Core search syntax.
- See the General Requirements section for additional rules and expectations when a Server requires status parameters.
- See the General Guidance section for additional guidance on searching for multiple patients.

#### US Core Scopes

Servers providing access to data MAY support these US Core SMART Scopes:

- resource level scopes: `<patient|user|system>/Location.rs`

#### Mandatory Search Parameters:

The following search parameters and search parameter combinations SHALL be supported:

1. SHALL support searching by location name using the `name` search parameter:

   `GET [base]/Location?name=[string]`

   Example:

   1. GET [base]/Location?name=Health

   Implementation Notes: Fetches a bundle of all Location resources that match the name (how to search by string)

2. SHALL support searching location based on text address using the `address` search parameter:

   `GET [base]/Location?address=[string]`

   Example:

   1. GET [base]/Location?address=Arbor

   Implementation Notes: Fetches a bundle of all Location resources that match the address string (how to search by string)

#### Optional Search Parameters:

The following search parameter combinations SHOULD be supported:

1. SHOULD support searching using the `address-city` search parameter:

   `GET [base]/Location?address-city=[string]`

   Example:

   1. GET [base]/Location?address-city=Ann Arbor

   Implementation Notes: Fetches a bundle of all Location resources for the city (how to search by string)

2. SHOULD support searching using the `address-state` search parameter:

   `GET [base]/Location?address-state=[string]`

   Example:

   1. GET [base]/Location?address-state=MI

   Implementation Notes: Fetches a bundle of all Location resources for the state (how to search by string)

3. SHOULD support searching using the `address-postalcode` search parameter:

   `GET [base]/Location?address-postalcode=[string]`

   Example:

   1. GET [base]/Location?address-postalcode=48104

   Implementation Notes: Fetches a bundle of all Location resources for the ZIP code (how to search by string)