abstractbaseDefinitioncopyrightdescriptionexperimentalfhirVersionjurisdiction
jurisdiction[0]kindnamepublisherpurposestatustitletypeurl| Left: | US Core Location Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-location) |
| Right: | US Core Location Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-location) |
| Name | Value | Comments | |
|---|---|---|---|
| abstract | false | ||
| baseDefinition | http://hl7.org/fhir/StructureDefinition/Location | ||
| copyright | |||
| description | The US Core Location Profile inherits from the FHIR [Location](https://hl7.org/fhir/R4/location.html) 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. | ||
| experimental | false | ||
| fhirVersion | 4.0.1 | ||
| jurisdiction | |||
| jurisdiction[0] | urn:iso:std:iso:3166#US | ||
| kind | resource | ||
| name | USCoreLocationProfile | ||
| publisher | HL7 International / Cross-Group Projects | ||
| purpose | |||
| status | active | ||
| title | US Core Location Profile | ||
| type | Location | ||
| url | http://hl7.org/fhir/us/core/StructureDefinition/us-core-location | ||
| Name | L Flags | L Card. | L Type | L Description & Constraints | R Flags | R Card. | R Type | R Description & Constraints | Comments | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
 Location | 0..* | Location | Details and position information for a physical place | 0..* | Location | Details and position information for a physical place | |||||||||||
 id | 0..1 | id | Logical id of this artifact | 0..1 | id | Logical id of this artifact | |||||||||||
| meta | 0..1 | Meta | Metadata about the resource | 0..1 | Meta | Metadata about the resource | |||||||||||
| implicitRules | 0..1 | uri | A set of rules under which this content was created | 0..1 | uri | A set of rules under which this content was created | |||||||||||
| language | 0..1 | code | Language of the resource content Binding: ?? (preferred): A human language.
| 0..1 | code | Language of the resource content Binding: ?? (preferred): A human language.
| |||||||||||
| 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 | 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 | 0..* | Resource | Contained, inline Resources | |||||||||||
 extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
 modifierExtension | 0..* | Extension | Extensions that cannot be ignored | 0..* | Extension | Extensions that cannot be ignored | |||||||||||
| identifier | 0..* | Identifier | Unique business identifier for facility or location. | 0..* | Identifier | Unique business identifier for facility or location. | |||||||||||
| status | 0..1 | code | active | suspended | inactive Binding: ?? (required): Indicates whether the location is still in use. | 0..1 | code | active | suspended | inactive Binding: ?? (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: ?? (preferred): The operational status if the location (where typically a bed/room). | 0..1 | Coding | The operational status of the location (typically only for a bed/room) Binding: ?? (preferred): The operational status if the location (where typically a bed/room). | |||||||||||
| name | 1..1 | string | Name by which a facility or location is known. | 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 | 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 | 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: ?? (required): Indicates whether a resource instance represents a specific location or a class of locations. | 0..1 | code | instance | kind Binding: ?? (required): Indicates whether a resource instance represents a specific location or a class of locations. | |||||||||||
| type | 0..* | CodeableConcept | Category of service or resource available in a location. Binding: ?? (extensible) | 0..* | CodeableConcept | Category of service or resource available in a location. Binding: ?? (extensible) | |||||||||||
 id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||
| coding | 1..* | Coding | Code defined by a terminology system | 1..* | Coding | Code defined by a terminology system | |||||||||||
| id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||
| system | 1..1 | uri | Identity of the terminology system | 1..1 | uri | Identity of the terminology system | |||||||||||
| version | 0..1 | string | Version of the system - if relevant | 0..1 | string | Version of the system - if relevant | |||||||||||
| code | 1..1 | code | Symbol in syntax defined by the system | 1..1 | code | Symbol in syntax defined by the system | |||||||||||
| display | 0..1 | string | Representation defined by the system | 0..1 | string | Representation defined by the system | |||||||||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | 0..1 | boolean | If this coding was chosen directly by the user | |||||||||||
| text | 0..1 | string | Plain text representation of the concept | 0..1 | string | Plain text representation of the concept | |||||||||||
| telecom | 0..* | ContactPoint | Contact details of the location | 0..* | ContactPoint | Contact details of the location | |||||||||||
| address | 0..1 | Address | Physical location | 0..1 | Address | Physical location | |||||||||||
| id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | 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: ?? (required): The use of an address. Example General: home | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: ?? (required): The use of an address. Example General: home | |||||||||||
| type | 0..1 | code | postal | physical | both Binding: ?? (required): The type of an address (physical / postal). Example General: both | 0..1 | code | postal | physical | both Binding: ?? (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 | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | |||||||||||
| 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 Example General: 137 Nowhere Street Example US Core: 49 MEADOW ST | 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 | 0..1 | string | Name of city, town etc. Example General: Erewhon Example US Core: EVERYTOWN | 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 | 0..1 | string | District name (aka county) Example General: Madison | |||||||||||
| state | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: ?? (extensible): Two letter USPS alphabetic codes. Example US Core: OK | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: ?? (extensible): Two letter USPS alphabetic codes. Example US Core: OK | |||||||||||
| postalCode | 0..1 | string | US Zip Codes Example General: 9132 Example US Core: 74047 | 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) | 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"} | 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: ?? (example): Physical form of the location. | 0..1 | CodeableConcept | Physical form of the location Binding: ?? (example): Physical form of the location. | |||||||||||
| position | 0..1 | BackboneElement | The absolute geographic location | 0..1 | BackboneElement | The absolute geographic location | |||||||||||
| id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
| extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
| modifierExtension | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||||
| longitude | 1..1 | decimal | Longitude with WGS84 datum | 1..1 | decimal | Longitude with WGS84 datum | |||||||||||
| latitude | 1..1 | decimal | Latitude with WGS84 datum | 1..1 | decimal | Latitude with WGS84 datum | |||||||||||
| altitude | 0..1 | decimal | Altitude with WGS84 datum | 0..1 | decimal | Altitude with WGS84 datum | |||||||||||
| managingOrganization | 0..1 | Reference(US Core Organization Profile) | Organization responsible for provisioning and upkeep | 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 | 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 | 0..* | BackboneElement | What days/times during a week is this location usually open | |||||||||||
| id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
| extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
| modifierExtension | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||||
| daysOfWeek | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: ?? (required): The days of the week. | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: ?? (required): The days of the week. | |||||||||||
| allDay | 0..1 | boolean | The Location is open all day | 0..1 | boolean | The Location is open all day | |||||||||||
| openingTime | 0..1 | time | Time that the Location opens | 0..1 | time | Time that the Location opens | |||||||||||
| closingTime | 0..1 | time | Time that the Location closes | 0..1 | time | Time that the Location closes | |||||||||||
| availabilityExceptions | 0..1 | string | Description of availability exceptions | 0..1 | string | Description of availability exceptions | |||||||||||
| endpoint | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the location | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the location | |||||||||||
| Documentation for this format | |||||||||||||||||