US Public Health Profiles Library
1.0.0-ballot - STU Ballot
US
US Public Health Profiles Library
1.0.0-ballot - STU Ballot
US
This page is part of the US Public Health Profiles Library (v1.0.0-ballot: STU 1 Ballot 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions 
| Official URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-location | Version: 1.0.0-ballot | |||
| Active as of 2022-08-05 | Computable Name: USPublicHealthLocation | |||
This Location profile represents the location/facility in which care was provided. It is based on the US Core Location profile.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from USCoreLocation
This structure is derived from USCoreLocation
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Location | 0..* | USCoreLocation | US Public Health Location | |
  identifier | S | 0..* | Identifier | Facility ID Number |
| type | S | 1..* | CodeableConcept | Facility Type Binding: ServiceDeliveryLocationRoleType (extensible): ServiceDeliveryLocationRoleType |
 address | S | 1..1 | Address | Physical location |
 city | S | 1..1 | string | Name of city, town etc. |
 state | S | 1..1 | string | Sub-unit of country (abbreviations ok) |
 managingOrganization | S | 0..1 | Reference(US Public Health Organization) | Organization responsible for provisioning and upkeep |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Location | 0..* | USCoreLocation | US Public Health Location | |||||
 id | Σ | 0..1 | string | 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.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| 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 | Facility ID Number | ||||
| 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 of the location as used by humans | ||||
| 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Σ | 1..* | CodeableConcept | Facility Type Binding: ServiceDeliveryLocationRoleType (extensible): ServiceDeliveryLocationRoleType | ||||
| telecom | S | 0..* | ContactPoint | Contact details of the location | ||||
| address | S | 1..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 | ||||
| city | SΣ | 1..1 | string | Name of city, town etc. Example General: Erewhon | ||||
| district | Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||
| state | SΣ | 1..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes. | ||||
| postalCode | SΣ | 0..1 | string | US Zip Codes Example General: 9132 | ||||
| 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 Public Health Organization) | 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 | ||||||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Location | 0..* | USCoreLocation | US Public Health Location | |
| identifier | Σ | 0..* | Identifier | Facility ID Number |
| status | ?!Σ | 0..1 | code | active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use. |
| name | Σ | 1..1 | string | Name of the location as used by humans |
| type | Σ | 1..* | CodeableConcept | Facility Type Binding: ServiceDeliveryLocationRoleType (extensible): ServiceDeliveryLocationRoleType |
| telecom | 0..* | ContactPoint | Contact details of the location | |
| address | 1..1 | Address | Physical location | |
| line | Σ | 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 |
| city | Σ | 1..1 | string | Name of city, town etc. |
| state | Σ | 1..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes. |
| postalCode | Σ | 0..1 | string | US Zip Codes |
| managingOrganization | Σ | 0..1 | Reference(US Public Health Organization) | Organization responsible for provisioning and upkeep |
| Documentation for this format | ||||
This structure is derived from USCoreLocation
Differential View
This structure is derived from USCoreLocation
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Location | 0..* | USCoreLocation | US Public Health Location | |
| identifier | S | 0..* | Identifier | Facility ID Number |
| type | S | 1..* | CodeableConcept | Facility Type Binding: ServiceDeliveryLocationRoleType (extensible): ServiceDeliveryLocationRoleType |
| address | S | 1..1 | Address | Physical location |
| city | S | 1..1 | string | Name of city, town etc. |
| state | S | 1..1 | string | Sub-unit of country (abbreviations ok) |
| managingOrganization | S | 0..1 | Reference(US Public Health Organization) | Organization responsible for provisioning and upkeep |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Location | 0..* | USCoreLocation | US Public Health Location | |||||
| id | Σ | 0..1 | string | 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.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| 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 | Facility ID Number | ||||
| 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 of the location as used by humans | ||||
| 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Σ | 1..* | CodeableConcept | Facility Type Binding: ServiceDeliveryLocationRoleType (extensible): ServiceDeliveryLocationRoleType | ||||
| telecom | S | 0..* | ContactPoint | Contact details of the location | ||||
| address | S | 1..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 | ||||
| city | SΣ | 1..1 | string | Name of city, town etc. Example General: Erewhon | ||||
| district | Σ | 0..1 | string | District name (aka county) Example General: Madison | ||||
| state | SΣ | 1..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes. | ||||
| postalCode | SΣ | 0..1 | string | US Zip Codes Example General: 9132 | ||||
| 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 Public Health Organization) | 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 | ||||||||
Other representations of profile: CSV, Excel, Schematron
| Path | Conformance | ValueSet |
| Location.language | preferred | CommonLanguages Max Binding: AllLanguages |
| Location.status | required | LocationStatus |
| Location.operationalStatus | preferred | Hl7VSBedStatus |
| Location.mode | required | LocationMode |
| Location.type | extensible | ServiceDeliveryLocationRoleType |
| Location.address.use | required | AddressUse |
| Location.address.type | required | AddressType |
| Location.address.state | extensible | UspsTwoLetterAlphabeticCodes |
| Location.physicalType | example | LocationType |
| Location.hoursOfOperation.daysOfWeek | required | DaysOfWeek |
| Id | Grade | Path | Details | Requirements |
| 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 | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Location.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Location.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Location.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Location.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Location.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Location.modifierExtension | 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() | |
| ele-1 | error | Location.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Location.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Location.operationalStatus | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Location.name | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Location.alias | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Location.description | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Location.mode | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Location.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Location.telecom | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Location.address | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Location.address.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Location.address.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Location.address.use | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Location.address.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Location.address.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Location.address.line | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Location.address.city | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Location.address.district | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Location.address.state | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Location.address.postalCode | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Location.address.country | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Location.address.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Location.physicalType | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Location.position | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Location.position.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Location.position.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Location.position.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Location.position.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Location.position.longitude | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Location.position.latitude | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Location.position.altitude | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Location.managingOrganization | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Location.partOf | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Location.hoursOfOperation | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Location.hoursOfOperation.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Location.hoursOfOperation.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Location.hoursOfOperation.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Location.hoursOfOperation.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | Location.hoursOfOperation.daysOfWeek | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Location.hoursOfOperation.allDay | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Location.hoursOfOperation.openingTime | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Location.hoursOfOperation.closingTime | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Location.availabilityExceptions | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | Location.endpoint | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
IG © 2020+ HL7 Public Health Work Group (http://www.hl7.org/Special/committees/pher/index.cfm). Package hl7.fhir.us.ph-library#1.0.0-ballot based on FHIR 4.0.1. Generated 2022-08-05
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change