US Public Health Profiles Library
2.0.0 -
US Public Health Profiles Library, published by HL7 International / Public Health. This guide is not an authorized publication; it is the continuous build for version 2.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-us-ph-library/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-location | Version: 2.0.0 | |||
| Standards status: Trial-use Active as of 2025-10-23 | Maturity Level: 3 | Computable Name: USPublicHealthLocation | ||
| Other Identifiers: OID:2.16.840.1.113883.4.642.40.58.42.35 | ||||
This Location profile represents the location/facility in which care was provided.
It is based on the US Core Location profile and further constrains it:
| Use Case | Data Class | Data Element Name |
|---|---|---|
| Case Reporting | Facility Information | Facility Address |
| Case Reporting | Facility Information | Facility Fax |
| Case Reporting | Facility Information | Facility Identifier |
| Case Reporting | Facility Information | Facility Managing Organization Identifier |
| Case Reporting | Facility Information | Facility Name |
| Case Reporting | Facility Information | Facility Phone |
| Case Reporting | Facility Information | Facility Type |
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..* | USCoreLocation(6.1.0) | US Public Health Location | |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 |
![]() ![]() |
SΣ | 0..* | Identifier | (USCDI+) Facility Identifier |
![]() ![]() |
?!SΣ | 0..1 | code | active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use. |
![]() ![]() |
SΣ | 1..1 | string | (USCDI+) Facility Name |
![]() ![]() |
SΣ | 1..* | CodeableConcept | Facility Type Binding: ServiceDeliveryLocationRoleType (3.0.0) (extensible): ServiceDeliveryLocationRoleType |
![]() ![]() |
S | 0..* | ContactPoint | (USCDI+) Facility Fax, (USCDI+) Facility Phone, Facility Email |
![]() ![]() |
S | 1..1 | Address | (USCDI+) Facility Address |
![]() ![]() ![]() |
?!Σ | 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 |
![]() ![]() ![]() |
SΣ | 1..1 | string | Name of city, town etc. Example General: Erewhon |
![]() ![]() ![]() |
SΣ | 1..1 | string | Sub-unit of country (abbreviations ok) Binding: UspsTwoLetterAlphabeticCodes (6.1.0) (extensible): Two letter USPS alphabetic codes. |
![]() ![]() ![]() |
SΣ | 0..1 | string | US Zip Codes Example General: 9132 |
![]() ![]() |
SΣ | 0..1 | Reference(US Public Health Organization(2.0.0)) | (USCDI+) Facility Managing Organization Identifier (contained in referenced US Public Health Organization) |
Documentation for this format | ||||
| 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 v6.5 |
| Location.address.use | Base | required | AddressUse | 📍4.0.1 | FHIR Std. |
| Location.address.state | Base | extensible | USPS Two Letter Alphabetic Codes | 📍6.1.0 | US Core v6.1 |
| 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 | Location.implicitRules, Location.modifierExtension, Location.identifier, Location.status, Location.name, Location.type, Location.telecom, Location.address, Location.address.use, Location.address.line, Location.address.city, Location.address.state, Location.address.postalCode, Location.managingOrganization | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Location.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | USCoreLocation(6.1.0) | US Public Health Location | |
![]() ![]() |
S | 0..* | Identifier | (USCDI+) Facility Identifier |
![]() ![]() |
1..1 | string | (USCDI+) Facility Name | |
![]() ![]() |
S | 1..* | CodeableConcept | Facility Type Binding: ServiceDeliveryLocationRoleType (3.0.0) (extensible): ServiceDeliveryLocationRoleType |
![]() ![]() |
0..* | ContactPoint | (USCDI+) Facility Fax, (USCDI+) Facility Phone, Facility Email | |
![]() ![]() |
1..1 | Address | (USCDI+) Facility Address | |
![]() ![]() ![]() |
1..1 | string | Name of city, town etc. | |
![]() ![]() ![]() |
1..1 | string | Sub-unit of country (abbreviations ok) | |
![]() ![]() |
0..1 | Reference(US Public Health Organization(2.0.0)) | (USCDI+) Facility Managing Organization Identifier (contained in referenced US Public Health Organization) | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Location.type | Base | extensible | ServiceDeliveryLocationRoleType | 📍3.0.0 | THO v6.5 |
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | USCoreLocation(6.1.0) | US Public Health Location | |||||
![]() ![]() |
Σ | 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 Constraints: ext-1 | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
![]() ![]() |
SΣ | 0..* | Identifier | (USCDI+) Facility Identifier | ||||
![]() ![]() |
?!SΣ | 0..1 | code | active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use. | ||||
![]() ![]() |
Σ | 0..1 | Coding | The operational status of the location (typically only for a bed/room) Binding: Hl7VSBedStatus (2.0.0) (preferred): The operational status if the location (where typically a bed/room). | ||||
![]() ![]() |
SΣ | 1..1 | string | (USCDI+) Facility Name | ||||
![]() ![]() |
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Σ | 1..* | CodeableConcept | Facility Type Binding: ServiceDeliveryLocationRoleType (3.0.0) (extensible): ServiceDeliveryLocationRoleType | ||||
![]() ![]() |
S | 0..* | ContactPoint | (USCDI+) Facility Fax, (USCDI+) Facility Phone, Facility Email | ||||
![]() ![]() |
S | 1..1 | Address | (USCDI+) Facility Address | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 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 | ||||
![]() ![]() ![]() |
SΣ | 1..1 | string | Name of city, town etc. Example General: Erewhon | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||
![]() ![]() ![]() |
SΣ | 1..1 | string | Sub-unit of country (abbreviations ok) Binding: UspsTwoLetterAlphabeticCodes (6.1.0) (extensible): Two letter USPS alphabetic codes. | ||||
![]() ![]() ![]() |
SΣ | 0..1 | string | US Zip Codes Example General: 9132 | ||||
![]() ![]() ![]() |
Σ | 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 Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
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 Public Health Organization(2.0.0)) | (USCDI+) Facility Managing Organization Identifier (contained in referenced US Public Health Organization) | ||||
![]() ![]() |
0..1 | Reference(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 Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
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 | 📍2.0.0 | THO v6.5 |
| Location.mode | Base | required | LocationMode | 📍4.0.1 | FHIR Std. |
| Location.type | Base | extensible | ServiceDeliveryLocationRoleType | 📍3.0.0 | THO v6.5 |
| 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 | 📍6.1.0 | US Core v6.1 |
| 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 | Location.meta, Location.implicitRules, Location.language, Location.text, Location.extension, Location.modifierExtension, Location.identifier, Location.status, Location.operationalStatus, Location.name, Location.alias, Location.description, Location.mode, Location.type, Location.telecom, Location.address, Location.address.extension, Location.address.use, Location.address.type, Location.address.text, Location.address.line, Location.address.city, Location.address.district, Location.address.state, Location.address.postalCode, Location.address.country, Location.address.period, Location.physicalType, Location.position, Location.position.extension, Location.position.modifierExtension, Location.position.longitude, Location.position.latitude, Location.position.altitude, Location.managingOrganization, Location.partOf, Location.hoursOfOperation, Location.hoursOfOperation.extension, Location.hoursOfOperation.modifierExtension, Location.hoursOfOperation.daysOfWeek, Location.hoursOfOperation.allDay, Location.hoursOfOperation.openingTime, Location.hoursOfOperation.closingTime, Location.availabilityExceptions, Location.endpoint | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Location.extension, Location.modifierExtension, Location.address.extension, Location.position.extension, Location.position.modifierExtension, Location.hoursOfOperation.extension, Location.hoursOfOperation.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Summary
Mandatory: 4 elements
Must-Support: 2 elements
Structures
This structure refers to these other structures:
Maturity: 3
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | USCoreLocation(6.1.0) | US Public Health Location | |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 |
![]() ![]() |
SΣ | 0..* | Identifier | (USCDI+) Facility Identifier |
![]() ![]() |
?!SΣ | 0..1 | code | active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use. |
![]() ![]() |
SΣ | 1..1 | string | (USCDI+) Facility Name |
![]() ![]() |
SΣ | 1..* | CodeableConcept | Facility Type Binding: ServiceDeliveryLocationRoleType (3.0.0) (extensible): ServiceDeliveryLocationRoleType |
![]() ![]() |
S | 0..* | ContactPoint | (USCDI+) Facility Fax, (USCDI+) Facility Phone, Facility Email |
![]() ![]() |
S | 1..1 | Address | (USCDI+) Facility Address |
![]() ![]() ![]() |
?!Σ | 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 |
![]() ![]() ![]() |
SΣ | 1..1 | string | Name of city, town etc. Example General: Erewhon |
![]() ![]() ![]() |
SΣ | 1..1 | string | Sub-unit of country (abbreviations ok) Binding: UspsTwoLetterAlphabeticCodes (6.1.0) (extensible): Two letter USPS alphabetic codes. |
![]() ![]() ![]() |
SΣ | 0..1 | string | US Zip Codes Example General: 9132 |
![]() ![]() |
SΣ | 0..1 | Reference(US Public Health Organization(2.0.0)) | (USCDI+) Facility Managing Organization Identifier (contained in referenced US Public Health Organization) |
Documentation for this format | ||||
| 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 v6.5 |
| Location.address.use | Base | required | AddressUse | 📍4.0.1 | FHIR Std. |
| Location.address.state | Base | extensible | USPS Two Letter Alphabetic Codes | 📍6.1.0 | US Core v6.1 |
| 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 | Location.implicitRules, Location.modifierExtension, Location.identifier, Location.status, Location.name, Location.type, Location.telecom, Location.address, Location.address.use, Location.address.line, Location.address.city, Location.address.state, Location.address.postalCode, Location.managingOrganization | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Location.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Differential View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | USCoreLocation(6.1.0) | US Public Health Location | |
![]() ![]() |
S | 0..* | Identifier | (USCDI+) Facility Identifier |
![]() ![]() |
1..1 | string | (USCDI+) Facility Name | |
![]() ![]() |
S | 1..* | CodeableConcept | Facility Type Binding: ServiceDeliveryLocationRoleType (3.0.0) (extensible): ServiceDeliveryLocationRoleType |
![]() ![]() |
0..* | ContactPoint | (USCDI+) Facility Fax, (USCDI+) Facility Phone, Facility Email | |
![]() ![]() |
1..1 | Address | (USCDI+) Facility Address | |
![]() ![]() ![]() |
1..1 | string | Name of city, town etc. | |
![]() ![]() ![]() |
1..1 | string | Sub-unit of country (abbreviations ok) | |
![]() ![]() |
0..1 | Reference(US Public Health Organization(2.0.0)) | (USCDI+) Facility Managing Organization Identifier (contained in referenced US Public Health Organization) | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Location.type | Base | extensible | ServiceDeliveryLocationRoleType | 📍3.0.0 | THO v6.5 |
Snapshot ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | USCoreLocation(6.1.0) | US Public Health Location | |||||
![]() ![]() |
Σ | 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 Constraints: ext-1 | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
![]() ![]() |
SΣ | 0..* | Identifier | (USCDI+) Facility Identifier | ||||
![]() ![]() |
?!SΣ | 0..1 | code | active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use. | ||||
![]() ![]() |
Σ | 0..1 | Coding | The operational status of the location (typically only for a bed/room) Binding: Hl7VSBedStatus (2.0.0) (preferred): The operational status if the location (where typically a bed/room). | ||||
![]() ![]() |
SΣ | 1..1 | string | (USCDI+) Facility Name | ||||
![]() ![]() |
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Σ | 1..* | CodeableConcept | Facility Type Binding: ServiceDeliveryLocationRoleType (3.0.0) (extensible): ServiceDeliveryLocationRoleType | ||||
![]() ![]() |
S | 0..* | ContactPoint | (USCDI+) Facility Fax, (USCDI+) Facility Phone, Facility Email | ||||
![]() ![]() |
S | 1..1 | Address | (USCDI+) Facility Address | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 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 | ||||
![]() ![]() ![]() |
SΣ | 1..1 | string | Name of city, town etc. Example General: Erewhon | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||
![]() ![]() ![]() |
SΣ | 1..1 | string | Sub-unit of country (abbreviations ok) Binding: UspsTwoLetterAlphabeticCodes (6.1.0) (extensible): Two letter USPS alphabetic codes. | ||||
![]() ![]() ![]() |
SΣ | 0..1 | string | US Zip Codes Example General: 9132 | ||||
![]() ![]() ![]() |
Σ | 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 Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
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 Public Health Organization(2.0.0)) | (USCDI+) Facility Managing Organization Identifier (contained in referenced US Public Health Organization) | ||||
![]() ![]() |
0..1 | Reference(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 Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
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 | 📍2.0.0 | THO v6.5 |
| Location.mode | Base | required | LocationMode | 📍4.0.1 | FHIR Std. |
| Location.type | Base | extensible | ServiceDeliveryLocationRoleType | 📍3.0.0 | THO v6.5 |
| 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 | 📍6.1.0 | US Core v6.1 |
| 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 | Location.meta, Location.implicitRules, Location.language, Location.text, Location.extension, Location.modifierExtension, Location.identifier, Location.status, Location.operationalStatus, Location.name, Location.alias, Location.description, Location.mode, Location.type, Location.telecom, Location.address, Location.address.extension, Location.address.use, Location.address.type, Location.address.text, Location.address.line, Location.address.city, Location.address.district, Location.address.state, Location.address.postalCode, Location.address.country, Location.address.period, Location.physicalType, Location.position, Location.position.extension, Location.position.modifierExtension, Location.position.longitude, Location.position.latitude, Location.position.altitude, Location.managingOrganization, Location.partOf, Location.hoursOfOperation, Location.hoursOfOperation.extension, Location.hoursOfOperation.modifierExtension, Location.hoursOfOperation.daysOfWeek, Location.hoursOfOperation.allDay, Location.hoursOfOperation.openingTime, Location.hoursOfOperation.closingTime, Location.availabilityExceptions, Location.endpoint | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Location.extension, Location.modifierExtension, Location.address.extension, Location.position.extension, Location.position.modifierExtension, Location.hoursOfOperation.extension, Location.hoursOfOperation.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Summary
Mandatory: 4 elements
Must-Support: 2 elements
Structures
This structure refers to these other structures:
Maturity: 3
Other representations of profile: CSV, Excel, Schematron