This page is part of the Validated Healthcare Directory FHIR IG (v0.1.0: STU 1 Draft) based on FHIR v3.2.0. . For a full list of available versions, see the Directory of published versions
This profile sets minimum expectations for searching for and fetching information associated with a location. It identifies which core elements, extensions, vocabularies and value sets SHALL be present in the location resource when using this profile.
Background & Scope
A location is the physical place where healthcare services are provided, practitioners are employed, organizations are based, etc. Locations can range in scope from a room in a building to a geographic region/area.
This profile removes location.operationalStatus
because maintaining bed-level information is out of scope for this implementation guide. It also removes location.mode
because maintaining information about kinds of locations (as opposed to actual location instances) is out of scope for this implementation guide.
This profile also adds a number of optional extensions, including extensions for representing a geographic region/area, accessibility options at the location, the EHR product(s) in use at the location, whether the location is accepting new patients, and when the location is available.
Examples:
The following are example uses for the vhdir-location profile:
Mandatory Data Elements
There are no mandatory attributes for the healthcareService resource. However, some attributes have mandatory components if they are included in the resource (including extensions). These are presented below in a simple human-readable explanation. The Formal Profile Definition below provides the formal summary, definitions, and terminology requirements.
location.position.longitude
and one value representing latitude in location.position.latitude
location.boundary.region
(extension)location.accessibility.type
(extension)location.newPatients.acceptingPatients
(extension)location.notAvailable.description
(extension)Profile specific implementation guidance:
Extensions:
Terminology
TBD
The official URL for this profile is:
http://hl7.org/fhir/ig/vhdir/StructureDefinition/vhdir-location
Defines the basic constraints and extensions on the Location resource for use in a Validated Healthcare Directory
This profile builds on Location.
This profile was published on Tue Oct 03 23:49:16 AEDT 2017 as a draft by HL7 International.
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
There are no mandatory attributes for the location resource. However, some attributes have mandatory components if they are included in the resource (including extensions):
location.position.longitude
and one value representing latitude in location.position.latitude
location.boundary.region
(extension)location.accessibility.type
(extension)location.newPatients.acceptingPatients
(extension)location.notAvailable.description
(extension)Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Location | I | 0..* | 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 |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
boundary | 0..* | (Complex) | Extension URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/boundary | |
accessibility | 0..* | (Complex) | Extension URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/accessibility | |
ehr | 0..* | (Complex) | Extension URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/ehr | |
newPatients | 0..1 | (Complex) | Extension URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/newPatients | |
newPatientProfile | 0..* | CodeableConcept | Extension URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/newPatientProfile | |
location-availability | 0..* | (Complex) | Extension URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/location-availability | |
usage-restriction | 0..* | Reference(vhdir-restriction) | Restriction URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/usage-restriction | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 0..* | Identifier | Unique code or number identifying the location to its users |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
identifier-status | 0..1 | code | Extension URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/identifier-status | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
url | 1..1 | uri | "http://hl7.org/fhir/ig/vhdir/StructureDefinition/identifier-status" | |
valueCode | 0..1 | code | Status | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
system | Σ | 0..1 | uri | The namespace for the identifier value Example General': http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri |
value | Σ | 0..1 | string | The value that is unique Example General': 123456 |
period | Σ | 0..1 | Period | Time period when id is/was valid for use |
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
status | ?!Σ | 0..1 | code | active | suspended | inactive Binding: LocationStatus (required) |
name | Σ | 0..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 |
type | Σ | 0..1 | CodeableConcept | Type of function performed Binding: ServiceDeliveryLocationRoleType (extensible) |
telecom | 0..* | ContactPoint | Contact details of the location | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
contactPoint-availableTime | 0..* | (Complex) | Extension URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/contactPoint-availableTime | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Days of week | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
url | 1..1 | uri | "daysOfWeek" | |
valueCode | 0..1 | code | Days of week | |
extension | 0..1 | Extension | All day | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
url | 1..1 | uri | "allDay" | |
valueBoolean | 0..1 | boolean | All day | |
extension | 0..1 | Extension | Available start time | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
url | 1..1 | uri | "availableStartTime" | |
valueTime | 0..1 | time | Available start time | |
extension | 0..1 | Extension | Available end time | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
url | 1..1 | uri | "availableEndTime" | |
valueTime | 0..1 | time | Available end time | |
url | 1..1 | uri | "http://hl7.org/fhir/ig/vhdir/StructureDefinition/contactPoint-availableTime" | |
contactPoint-viaIntermediary | 0..1 | Reference(vhdir-practitioner), Reference(vhdir-organization), Reference(vhdir-location) | Extension URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/contactPoint-viaIntermediary | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
url | 1..1 | uri | "http://hl7.org/fhir/ig/vhdir/StructureDefinition/contactPoint-viaIntermediary" | |
value[x] | 0..1 | Reference(vhdir-practitioner), Reference(vhdir-organization), Reference(vhdir-location) | Via intermediary | |
system | ΣI | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) |
value | Σ | 0..1 | string | The actual contact point details |
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) |
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
period | Σ | 0..1 | Period | Time period when the contact point was/is in use |
address | 0..1 | Address | Physical location | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
address-position | 0..1 | (Complex) | Extension URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/address-position | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 1..1 | Extension | Longitude | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
url | 1..1 | uri | "longitude" | |
valueDecimal | 0..1 | decimal | Longitude | |
extension | 1..1 | Extension | Latitude | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
url | 1..1 | uri | "latitude" | |
valueDecimal | 0..1 | decimal | Latitude | |
extension | 0..1 | Extension | Altitude | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
url | 1..1 | uri | "altitude" | |
valueDecimal | 0..1 | decimal | Altitude | |
url | 1..1 | uri | "http://hl7.org/fhir/ig/vhdir/StructureDefinition/address-position" | |
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required) Example General': home |
type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required) Example General': both |
text | Σ | 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 |
city | Σ | 0..1 | string | Name of city, town etc. Example General': Erewhon |
district | Σ | 0..1 | string | District name (aka county) Example General': Madison |
state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) |
postalCode | Σ | 0..1 | string | Postal code for area 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) |
position | I | 0..1 | BackboneElement | The absolute geographic location |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
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 | Σ | 0..1 | Reference(Organization), Reference(vhdir-organization) | Organization responsible for provisioning and upkeep |
partOf | 0..1 | Reference(Location) | Another Location this one is physically part of | |
hoursOfOperation | I | 0..* | BackboneElement | What days/times during a week is this location usually open |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
daysOfWeek | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required) | |
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 |
There are no mandatory attributes for the location resource. However, some attributes have mandatory components if they are included in the resource (including extensions):
location.position.longitude
and one value representing latitude in location.position.latitude
location.boundary.region
(extension)location.accessibility.type
(extension)location.newPatients.acceptingPatients
(extension)location.notAvailable.description
(extension)Differential View
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Location | I | 0..* | 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 |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
boundary | 0..* | (Complex) | Extension URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/boundary | |
accessibility | 0..* | (Complex) | Extension URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/accessibility | |
ehr | 0..* | (Complex) | Extension URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/ehr | |
newPatients | 0..1 | (Complex) | Extension URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/newPatients | |
newPatientProfile | 0..* | CodeableConcept | Extension URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/newPatientProfile | |
location-availability | 0..* | (Complex) | Extension URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/location-availability | |
usage-restriction | 0..* | Reference(vhdir-restriction) | Restriction URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/usage-restriction | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 0..* | Identifier | Unique code or number identifying the location to its users |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
identifier-status | 0..1 | code | Extension URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/identifier-status | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
url | 1..1 | uri | "http://hl7.org/fhir/ig/vhdir/StructureDefinition/identifier-status" | |
valueCode | 0..1 | code | Status | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
system | Σ | 0..1 | uri | The namespace for the identifier value Example General': http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri |
value | Σ | 0..1 | string | The value that is unique Example General': 123456 |
period | Σ | 0..1 | Period | Time period when id is/was valid for use |
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
status | ?!Σ | 0..1 | code | active | suspended | inactive Binding: LocationStatus (required) |
name | Σ | 0..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 |
type | Σ | 0..1 | CodeableConcept | Type of function performed Binding: ServiceDeliveryLocationRoleType (extensible) |
telecom | 0..* | ContactPoint | Contact details of the location | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
contactPoint-availableTime | 0..* | (Complex) | Extension URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/contactPoint-availableTime | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Days of week | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
url | 1..1 | uri | "daysOfWeek" | |
valueCode | 0..1 | code | Days of week | |
extension | 0..1 | Extension | All day | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
url | 1..1 | uri | "allDay" | |
valueBoolean | 0..1 | boolean | All day | |
extension | 0..1 | Extension | Available start time | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
url | 1..1 | uri | "availableStartTime" | |
valueTime | 0..1 | time | Available start time | |
extension | 0..1 | Extension | Available end time | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
url | 1..1 | uri | "availableEndTime" | |
valueTime | 0..1 | time | Available end time | |
url | 1..1 | uri | "http://hl7.org/fhir/ig/vhdir/StructureDefinition/contactPoint-availableTime" | |
contactPoint-viaIntermediary | 0..1 | Reference(vhdir-practitioner), Reference(vhdir-organization), Reference(vhdir-location) | Extension URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/contactPoint-viaIntermediary | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
url | 1..1 | uri | "http://hl7.org/fhir/ig/vhdir/StructureDefinition/contactPoint-viaIntermediary" | |
value[x] | 0..1 | Reference(vhdir-practitioner), Reference(vhdir-organization), Reference(vhdir-location) | Via intermediary | |
system | ΣI | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) |
value | Σ | 0..1 | string | The actual contact point details |
use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) |
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
period | Σ | 0..1 | Period | Time period when the contact point was/is in use |
address | 0..1 | Address | Physical location | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
address-position | 0..1 | (Complex) | Extension URL: http://hl7.org/fhir/ig/vhdir/StructureDefinition/address-position | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 1..1 | Extension | Longitude | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
url | 1..1 | uri | "longitude" | |
valueDecimal | 0..1 | decimal | Longitude | |
extension | 1..1 | Extension | Latitude | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
url | 1..1 | uri | "latitude" | |
valueDecimal | 0..1 | decimal | Latitude | |
extension | 0..1 | Extension | Altitude | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
url | 1..1 | uri | "altitude" | |
valueDecimal | 0..1 | decimal | Altitude | |
url | 1..1 | uri | "http://hl7.org/fhir/ig/vhdir/StructureDefinition/address-position" | |
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required) Example General': home |
type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required) Example General': both |
text | Σ | 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 |
city | Σ | 0..1 | string | Name of city, town etc. Example General': Erewhon |
district | Σ | 0..1 | string | District name (aka county) Example General': Madison |
state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) |
postalCode | Σ | 0..1 | string | Postal code for area 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) |
position | I | 0..1 | BackboneElement | The absolute geographic location |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
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 | Σ | 0..1 | Reference(Organization), Reference(vhdir-organization) | Organization responsible for provisioning and upkeep |
partOf | 0..1 | Reference(Location) | Another Location this one is physically part of | |
hoursOfOperation | I | 0..* | BackboneElement | What days/times during a week is this location usually open |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
daysOfWeek | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required) | |
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 |
Downloads: StructureDefinition: (XML, JSON, CSV), Schema: XML Schematron
Below is an overview of the required search and read operations for this profile. See the Conformance requirements for the US Core Server for a complete list of supported RESTful operations and search parameters for this IG.
TBD