This page is part of the Validated Healthcare Directory FHIR IG (v0.2.0: STU 1 Ballot 2) based on FHIR (HL7® FHIR® Standard) v3.5.0. The current version which supersedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions
StructureDefinition-vhdir-location
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 modifies the base Lractitioner resource in the following manner:
-
Constrains the cardinality of
location.status
(1..1),location.operationalStatus
(0..0),location.mode
(0..0),location.telecom.system
(1..1), andlocation.telecom.value
(1..1), -
All references SHALL conform to the appropriate Validated Healthcare Directory Implementation Guide profile
-
Adds extensions:
- Identifier status (1..1) - indicates the status of a location’s identifier
- Via intermediary (0..1) - a reference to an alternative point of contact for this location
- Available time (0..*) - indicates when a location is available for contact
- Boundary-geojson (0..*) - indicates a region/area for the location
- Accessibility (0..*) - indicates accessibility options available at the location (e.g. handicap accessibility)
- EHR (0..*) - provides information about the EHR product(s) used at the location
- NewPatients (0..*) - indicates whether the location is accepting new patients
- NewPatientProfile (0..*) - a description of the type of patients the location accepts (e.g. pediatric only)
- Restriction (0..*) - indicates whether disclosure of any data associated with a location is restricted
- Adds new value sets/updates value set bindings:
TBD
Examples:
The following are example uses for the vhdir-location profile:
Mandatory Data Elements
The following data-elements are mandatory (i.e data MUST be present). These are presented below in a simple human-readable explanation. The Formal Profile Definition below provides the formal summary, definitions, and terminology requirements.
Each Location must have:
- One coded value in
location.status
Profile specific implementation guidance:
- TBD
Formal Views of Profile Content
Description of Profiles, Differentials, and Snapshots.
The official URL for this profile is: http://hl7.org/fhir/uv/vhdir/StructureDefinition/vhdir-location
Published on Tue Oct 03 22:49:16 AEST 2017 as a active by HL7 International.
This profile builds on Location
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | I | 0..* | Details and position information for a physical place | |
![]() ![]() ![]() | Σ | 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: Common Languages (preferred) | |
![]() ![]() ![]() | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
![]() ![]() ![]() | 0..* | Resource | Contained, inline Resources | |
![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() | I | 0..* | Attachment | Extension URL: http://hl7.org/fhir/StructureDefinition/location-boundary-geojson |
![]() ![]() ![]() | 0..* | CodeableConcept | Extension URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/accessibility Binding: VhDir Accessibility Value Set (example) | |
![]() ![]() ![]() | 0..* | (Complex) | Extension URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/ehr | |
![]() ![]() ![]() | 0..1 | (Complex) | Extension URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/newpatients | |
![]() ![]() ![]() | 0..* | string | Extension URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/newpatientprofile | |
![]() ![]() ![]() | 0..* | Reference(VhDir Restriction) | Restriction URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction | |
![]() ![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() | Σ | 0..* | Identifier | Unique code or number identifying the location to its users |
![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() | 1..1 | code | Extension URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status Binding: VhDir Identifier Status Value Set (example) | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() | 1..1 | "http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status" | ||
![]() ![]() ![]() ![]() ![]() | 1..1 | code | active|inactive|issued in error|revoked|pending Binding: VhDir Identifier Status Value Set (example) | |
![]() ![]() ![]() ![]() | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
![]() ![]() ![]() ![]() | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
![]() ![]() ![]() ![]() | Σ | 0..1 | uri | The namespace for the identifier value Example General': http://www.acme.com/identifiers/patient |
![]() ![]() ![]() ![]() | Σ | 0..1 | string | The value that is unique Example General': 123456 |
![]() ![]() ![]() ![]() | Σ | 0..1 | Period | Time period when id is/was valid for use |
![]() ![]() ![]() ![]() | Σ | 0..1 | Reference(VhDir Organization) | Organization that issued id (may be just text) |
![]() ![]() ![]() | ?!Σ | 1..1 | code | active | suspended | inactive Binding: LocationStatus (required) |
![]() ![]() ![]() | Σ | 0..1 | string | Name of the location as used by humans |
![]() ![]() ![]() | 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..* | CodeableConcept | Type of function performed Binding: http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType (extensible) |
![]() ![]() ![]() | 0..* | ContactPoint | Contact details of the location | |
![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() | 0..* | (Complex) | Extension URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Days of week | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | "daysOfWeek" | ||
![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | code | Days of the week - mon|tue|wed|thu|fri|sat|sun Binding: DaysOfWeek (required) | |
![]() ![]() ![]() ![]() ![]() | 0..1 | Extension | All day | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | "allDay" | ||
![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | boolean | All day | |
![]() ![]() ![]() ![]() ![]() | 0..1 | Extension | Available start time | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | "availableStartTime" | ||
![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | time | Available start time | |
![]() ![]() ![]() ![]() ![]() | 0..1 | Extension | Available end time | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | "availableEndTime" | ||
![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | time | Available end time | |
![]() ![]() ![]() ![]() ![]() | 1..1 | "http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime" | ||
![]() ![]() ![]() ![]() | 0..1 | Reference(VhDir Practitionerrole | VhDir Organization | VhDir OrganizationAffiliation | VhDir Location) | Extension URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() | 1..1 | "http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary" | ||
![]() ![]() ![]() ![]() ![]() | 1..1 | Reference(VhDir Practitionerrole | VhDir Organization | VhDir OrganizationAffiliation | VhDir Location) | Via intermediary | |
![]() ![]() ![]() ![]() | ΣI | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) |
![]() ![]() ![]() ![]() | Σ | 1..1 | string | The actual contact point details |
![]() ![]() ![]() ![]() | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) |
![]() ![]() ![]() ![]() | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
![]() ![]() ![]() ![]() | Σ | 0..1 | Period | Time period when the contact point was/is in use |
![]() ![]() ![]() | 0..1 | Address | Physical location | |
![]() ![]() ![]() | Σ | 0..1 | CodeableConcept | Physical form of the location Binding: LocationType (example) |
![]() ![]() ![]() | I | 0..1 | BackboneElement | The absolute geographic location |
![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored if unrecognized |
![]() ![]() ![]() ![]() | 1..1 | decimal | Longitude with WGS84 datum | |
![]() ![]() ![]() ![]() | 1..1 | decimal | Latitude with WGS84 datum | |
![]() ![]() ![]() ![]() | 0..1 | decimal | Altitude with WGS84 datum | |
![]() ![]() ![]() | Σ | 0..1 | Reference(VhDir Organization) | Organization responsible for provisioning and upkeep |
![]() ![]() ![]() | 0..1 | Reference(VhDir Location) | Another Location this one is physically part of | |
![]() ![]() ![]() | I | 0..* | BackboneElement | What days/times during a week is this location usually open |
![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored if unrecognized |
![]() ![]() ![]() ![]() | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required) | |
![]() ![]() ![]() ![]() | 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(VhDir Endpoint) | Technical endpoints providing access to services operated for the location | |
![]() |
Summary
Mandatory: 1 element (3 nested mandatory elements)
Prohibited: 2 elements
Structures
This structure refers to these other structures:
- http://hl7.org/fhir/uv/vhdir/StructureDefinition/vhdir-organization
- http://hl7.org/fhir/uv/vhdir/StructureDefinition/vhdir-location
- http://hl7.org/fhir/uv/vhdir/StructureDefinition/vhdir-endpoint
Extensions
This structure refers to these extensions:
- http://hl7.org/fhir/StructureDefinition/location-boundary-geojson
- http://hl7.org/fhir/uv/vhdir/StructureDefinition/accessibility
- http://hl7.org/fhir/uv/vhdir/StructureDefinition/ehr
- http://hl7.org/fhir/uv/vhdir/StructureDefinition/newpatients
- http://hl7.org/fhir/uv/vhdir/StructureDefinition/newpatientprofile
- http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction
- http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status
- http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime
- http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary
Differential View
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | I | 0..* | Details and position information for a physical place | |
![]() ![]() ![]() | Σ | 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: Common Languages (preferred) | |
![]() ![]() ![]() | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
![]() ![]() ![]() | 0..* | Resource | Contained, inline Resources | |
![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() | I | 0..* | Attachment | Extension URL: http://hl7.org/fhir/StructureDefinition/location-boundary-geojson |
![]() ![]() ![]() | 0..* | CodeableConcept | Extension URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/accessibility Binding: VhDir Accessibility Value Set (example) | |
![]() ![]() ![]() | 0..* | (Complex) | Extension URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/ehr | |
![]() ![]() ![]() | 0..1 | (Complex) | Extension URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/newpatients | |
![]() ![]() ![]() | 0..* | string | Extension URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/newpatientprofile | |
![]() ![]() ![]() | 0..* | Reference(VhDir Restriction) | Restriction URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction | |
![]() ![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() | Σ | 0..* | Identifier | Unique code or number identifying the location to its users |
![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() | 1..1 | code | Extension URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status Binding: VhDir Identifier Status Value Set (example) | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() | 1..1 | "http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status" | ||
![]() ![]() ![]() ![]() ![]() | 1..1 | code | active|inactive|issued in error|revoked|pending Binding: VhDir Identifier Status Value Set (example) | |
![]() ![]() ![]() ![]() | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
![]() ![]() ![]() ![]() | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
![]() ![]() ![]() ![]() | Σ | 0..1 | uri | The namespace for the identifier value Example General': http://www.acme.com/identifiers/patient |
![]() ![]() ![]() ![]() | Σ | 0..1 | string | The value that is unique Example General': 123456 |
![]() ![]() ![]() ![]() | Σ | 0..1 | Period | Time period when id is/was valid for use |
![]() ![]() ![]() ![]() | Σ | 0..1 | Reference(VhDir Organization) | Organization that issued id (may be just text) |
![]() ![]() ![]() | ?!Σ | 1..1 | code | active | suspended | inactive Binding: LocationStatus (required) |
![]() ![]() ![]() | Σ | 0..1 | string | Name of the location as used by humans |
![]() ![]() ![]() | 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..* | CodeableConcept | Type of function performed Binding: http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType (extensible) |
![]() ![]() ![]() | 0..* | ContactPoint | Contact details of the location | |
![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() | 0..* | (Complex) | Extension URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Days of week | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | "daysOfWeek" | ||
![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | code | Days of the week - mon|tue|wed|thu|fri|sat|sun Binding: DaysOfWeek (required) | |
![]() ![]() ![]() ![]() ![]() | 0..1 | Extension | All day | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | "allDay" | ||
![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | boolean | All day | |
![]() ![]() ![]() ![]() ![]() | 0..1 | Extension | Available start time | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | "availableStartTime" | ||
![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | time | Available start time | |
![]() ![]() ![]() ![]() ![]() | 0..1 | Extension | Available end time | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | "availableEndTime" | ||
![]() ![]() ![]() ![]() ![]() ![]() | 1..1 | time | Available end time | |
![]() ![]() ![]() ![]() ![]() | 1..1 | "http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime" | ||
![]() ![]() ![]() ![]() | 0..1 | Reference(VhDir Practitionerrole | VhDir Organization | VhDir OrganizationAffiliation | VhDir Location) | Extension URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary | |
![]() ![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() | 1..1 | "http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary" | ||
![]() ![]() ![]() ![]() ![]() | 1..1 | Reference(VhDir Practitionerrole | VhDir Organization | VhDir OrganizationAffiliation | VhDir Location) | Via intermediary | |
![]() ![]() ![]() ![]() | ΣI | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required) |
![]() ![]() ![]() ![]() | Σ | 1..1 | string | The actual contact point details |
![]() ![]() ![]() ![]() | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) |
![]() ![]() ![]() ![]() | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
![]() ![]() ![]() ![]() | Σ | 0..1 | Period | Time period when the contact point was/is in use |
![]() ![]() ![]() | 0..1 | Address | Physical location | |
![]() ![]() ![]() | Σ | 0..1 | CodeableConcept | Physical form of the location Binding: LocationType (example) |
![]() ![]() ![]() | I | 0..1 | BackboneElement | The absolute geographic location |
![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored if unrecognized |
![]() ![]() ![]() ![]() | 1..1 | decimal | Longitude with WGS84 datum | |
![]() ![]() ![]() ![]() | 1..1 | decimal | Latitude with WGS84 datum | |
![]() ![]() ![]() ![]() | 0..1 | decimal | Altitude with WGS84 datum | |
![]() ![]() ![]() | Σ | 0..1 | Reference(VhDir Organization) | Organization responsible for provisioning and upkeep |
![]() ![]() ![]() | 0..1 | Reference(VhDir Location) | Another Location this one is physically part of | |
![]() ![]() ![]() | I | 0..* | BackboneElement | What days/times during a week is this location usually open |
![]() ![]() ![]() ![]() | 0..1 | string | xml:id (or equivalent in JSON) | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored if unrecognized |
![]() ![]() ![]() ![]() | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required) | |
![]() ![]() ![]() ![]() | 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(VhDir Endpoint) | Technical endpoints providing access to services operated for the location | |
![]() |
Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron
Quick Start
Below is an overview of the required set of RESTful FHIR interactions - for example, search and read operations - for this profile. See the Conformance requirements for a complete list of supported RESTful interactions for this IG.
Supported Searches
GET [base]/Location?accessibility=[code]
Support: MAY support search by the location-accessibility
parameter
- including the modifiers:
text
GET [base]/Location?address=[string]
Support: SHALL support search by the location-address
parameter
- including the modifiers:
contains
,exact
GET [base]/Location?endpoint=[id]
Support: SHOULD support search by the location-endpoint
parameter
- with a target type:
Endpoint
- including these search paramaters which may be chained:
endpoint-identifier
,endpoint-connection-type
,endpoint-organization
GET [base]/Location?identifier=[code]
Support: SHALL support search by the location-identifier
parameter
- including the modifiers:
text
,ofType
GET [base]/Location?identifier-assigner=[id]
Support: MAY support search by the location-identifier-assigner
parameter
- with a target type:
Organization
- including the modifiers:
below
- including these search paramaters which may be chained:
organization-identifier
,organization-name
GET [base]/Location?new-patient=[code]
Support: SHOULD support search by the location-new-patient
parameter
GET [base]/Location?new-patient-network=[id]
Support: SHOULD support search by the location-new-patient-network
parameter
- with a target type:
Organization
- including these search paramaters which may be chained:
organization-identifier
,organization-name
,organization-partof
GET [base]/Location?organization=[id]
Support: SHALL support search by the location-organization
parameter
- with a target type:
Organization
- including the modifiers:
above
,below
- including these search paramaters which may be chained:
organization-identifier
,organization-name
,organization-address
,organization-partof
,organization-type
GET [base]/Location?partof=[id]
Support: SHOULD support search by the location-partof
parameter
- with a target type:
Location
- including the modifiers:
above
,below
- including these search paramaters which may be chained:
location-identifier
,location-type
,location-address
,location-organization
GET [base]/Location?contains=-83.694810|42.256500
Support: MAY support search by the location-contains
parameter
This is a special search parameter which might leverage a systems geo-spatial
features to test that the geocoded point provided
(expressed as [latitude]|[longitude] using the WGS84 datum)
is contained by the boundary stored in the standard extension location-boundary-geojson
Support for multiple points can also be provided using the ,
syntax which
is interpretted as the location returned in the search contains at least 1 of the
provided co-ordinates.
GET [base]/Location?status=[code]
Support: SHALL support search by the location-status
parameter
GET [base]/Location?type=[code]
Support: SHALL support search by the location-type
parameter
- including the modifiers:
text
GET [base]/Location?via-intermediary=[id]
Support: MAY support search by the location-via-intermediary
parameter
- with a target type:
PractitionerRole
,Organization
,OrganizationAffiliation
,Location