Validated Healthcare Directory, published by HL7 International - Patient Administration Work Group. This is not an authorized publication; it is the continuous build for version 0.2.0). This version is based on the current content of https://github.com/HL7/VhDir/ and changes regularly. See the Directory of published versions
Defining URL: | http://hl7.org/fhir/uv/vhdir/StructureDefinition/vhdir-location |
Version: | 0.2.0 |
Name: | VhdirLocation |
Title: | VhDir Location |
Status: | Active as of 2017-10-03 11:49:16+1100 |
Definition: | Defines the basic constraints and extensions on the Location resource for use in a Validated Healthcare Directory |
Publisher: | HL7 International - Patient Administration Work Group |
Copyright: | HL7 International |
Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
http://hl7.org/fhir/uv/vhdir/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 Practitioner 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), and location.telecom.value
(1..1),
All references SHALL conform to the appropriate Validated Healthcare Directory Implementation Guide profile
Adds extensions:
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:
location.status
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Location
Summary
Mandatory: 1 element (3 nested mandatory elements)
Must-Support: 44 elements
Prohibited: 2 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
This structure is derived from Location
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | Location | Details and position information for a physical place | |
![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() | S | 0..1 | Attachment | A boundary shape that represents the outside edge of the location (in GeoJSON format) URL: http://hl7.org/fhir/StructureDefinition/location-boundary-geojson |
![]() ![]() ![]() | S | 0..* | CodeableConcept | Accessibility options offered by the location URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/accessibility Binding: VhDir Accessibility Value Set (example) |
![]() ![]() ![]() | S | 0..* | (Complex) | EHR at the location URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/ehr |
![]() ![]() ![]() | S | 0..* | (Complex) | Whether the location is accepting new patients URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/newpatients |
![]() ![]() ![]() | S | 0..* | string | Type of new patients accepted URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/newpatientprofile |
![]() ![]() ![]() | S | 0..* | Reference(VhDir Restriction) | Restriction URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction |
![]() ![]() ![]() | S | 0..* | Identifier | Unique code or number identifying the location to its users |
![]() ![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() | S | 1..1 | code | Status URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status Binding: VhDir Identifier Status Value Set (required) |
![]() ![]() ![]() ![]() | S | 0..1 | code | usual | official | temp | secondary | old (If known) |
![]() ![]() ![]() ![]() | S | 0..1 | CodeableConcept | Description of identifier |
![]() ![]() ![]() ![]() | S | 0..1 | uri | The namespace for the identifier value |
![]() ![]() ![]() ![]() | S | 0..1 | string | The value that is unique |
![]() ![]() ![]() ![]() | S | 0..1 | Period | Time period when id is/was valid for use |
![]() ![]() ![]() ![]() | S | 0..1 | Reference(VhDir Organization) | Organization that issued id (may be just text) |
![]() ![]() ![]() | S | 1..1 | code | active | suspended | inactive |
![]() ![]() ![]() | S | 0..0 | ||
![]() ![]() ![]() | S | 0..1 | string | Name of the location as used by humans |
![]() ![]() ![]() | S | 0..* | string | A list of alternate names that the location is known as, or was known as, in the past |
![]() ![]() ![]() | S | 0..1 | string | Additional details about the location that could be displayed as further information to identify the location beyond its name |
![]() ![]() ![]() | S | 0..0 | ||
![]() ![]() ![]() | S | 0..* | CodeableConcept | Type of function performed |
![]() ![]() ![]() | S | 0..* | ContactPoint | Contact details of the location |
![]() ![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() | S | 0..* | (Complex) | Available time URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime |
![]() ![]() ![]() ![]() | S | 0..1 | Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location) | viaintermediary URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary |
![]() ![]() ![]() ![]() | S | 1..1 | code | phone | fax | email | pager | url | sms | other |
![]() ![]() ![]() ![]() | S | 1..1 | string | The actual contact point details |
![]() ![]() ![]() ![]() | S | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point |
![]() ![]() ![]() ![]() | S | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
![]() ![]() ![]() ![]() | S | 0..1 | Period | Time period when the contact point was/is in use |
![]() ![]() ![]() | S | 0..1 | Address | Physical location |
![]() ![]() ![]() | S | 0..1 | CodeableConcept | Physical form of the location |
![]() ![]() ![]() | S | 0..1 | BackboneElement | The absolute geographic location |
![]() ![]() ![]() ![]() | S | 1..1 | decimal | Longitude with WGS84 datum |
![]() ![]() ![]() ![]() | S | 1..1 | decimal | Latitude with WGS84 datum |
![]() ![]() ![]() ![]() | S | 0..1 | decimal | Altitude with WGS84 datum |
![]() ![]() ![]() | S | 0..1 | Reference(VhDir Organization) | Organization responsible for provisioning and upkeep |
![]() ![]() ![]() | S | 0..1 | Reference(VhDir Location) | Another Location this one is physically a part of |
![]() ![]() ![]() | S | 0..* | BackboneElement | What days/times during a week is this location usually open |
![]() ![]() ![]() ![]() | S | 0..* | code | mon | tue | wed | thu | fri | sat | sun |
![]() ![]() ![]() ![]() | S | 0..1 | boolean | The Location is open all day |
![]() ![]() ![]() ![]() | S | 0..1 | time | Time that the Location opens |
![]() ![]() ![]() ![]() | S | 0..1 | time | Time that the Location closes |
![]() ![]() ![]() | S | 0..1 | string | Description of availability exceptions |
![]() ![]() ![]() | S | 0..* | Reference(VhDir Endpoint) | Technical endpoints providing access to services operated for the location |
![]() |
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | Location | Details and position information for a physical place | |
![]() ![]() ![]() | Σ | 0..1 | string | 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) Max Binding: AllLanguages: A human language. | |
![]() ![]() ![]() | 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 | |
![]() ![]() ![]() | S | 0..1 | Attachment | A boundary shape that represents the outside edge of the location (in GeoJSON format) URL: http://hl7.org/fhir/StructureDefinition/location-boundary-geojson |
![]() ![]() ![]() | S | 0..* | CodeableConcept | Accessibility options offered by the location URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/accessibility Binding: VhDir Accessibility Value Set (example) |
![]() ![]() ![]() | S | 0..* | (Complex) | EHR at the location URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/ehr |
![]() ![]() ![]() | S | 0..* | (Complex) | Whether the location is accepting new patients URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/newpatients |
![]() ![]() ![]() | S | 0..* | string | Type of new patients accepted URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/newpatientprofile |
![]() ![]() ![]() | S | 0..* | Reference(VhDir Restriction) | Restriction URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction |
![]() ![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() | SΣ | 0..* | Identifier | Unique code or number identifying the location to its users |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() | S | 1..1 | code | Status URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status Binding: VhDir Identifier Status Value Set (required) |
![]() ![]() ![]() ![]() | ?!SΣ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() ![]() | SΣ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
![]() ![]() ![]() ![]() | SΣ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() ![]() | SΣ | 0..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() ![]() | SΣ | 0..1 | Period | Time period when id is/was valid for use |
![]() ![]() ![]() ![]() | SΣ | 0..1 | Reference(VhDir Organization) | Organization that issued id (may be just text) |
![]() ![]() ![]() | ?!SΣ | 1..1 | code | active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use. |
![]() ![]() ![]() | SΣ | 0..1 | string | Name of the location as used by humans |
![]() ![]() ![]() | S | 0..* | string | A list of alternate names that the location is known as, or was known as, in the past |
![]() ![]() ![]() | SΣ | 0..1 | string | Additional details about the location that could be displayed as further information to identify the location beyond its name |
![]() ![]() ![]() | SΣ | 0..* | CodeableConcept | Type of function performed Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location. |
![]() ![]() ![]() | S | 0..* | ContactPoint | Contact details of the location |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() | S | 0..* | (Complex) | Available time URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime |
![]() ![]() ![]() ![]() | S | 0..1 | Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location) | viaintermediary URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary |
![]() ![]() ![]() ![]() | SΣI | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
![]() ![]() ![]() ![]() | SΣ | 1..1 | string | The actual contact point details |
![]() ![]() ![]() ![]() | ?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
![]() ![]() ![]() ![]() | SΣ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
![]() ![]() ![]() ![]() | SΣ | 0..1 | Period | Time period when the contact point was/is in use |
![]() ![]() ![]() | S | 0..1 | Address | Physical location |
![]() ![]() ![]() | SΣ | 0..1 | CodeableConcept | Physical form of the location Binding: LocationType (example): Physical form of the location. |
![]() ![]() ![]() | S | 0..1 | BackboneElement | The absolute geographic location |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | S | 1..1 | decimal | Longitude with WGS84 datum |
![]() ![]() ![]() ![]() | S | 1..1 | decimal | Latitude with WGS84 datum |
![]() ![]() ![]() ![]() | S | 0..1 | decimal | Altitude with WGS84 datum |
![]() ![]() ![]() | SΣ | 0..1 | Reference(VhDir Organization) | Organization responsible for provisioning and upkeep |
![]() ![]() ![]() | S | 0..1 | Reference(VhDir Location) | Another Location this one is physically a part of |
![]() ![]() ![]() | S | 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 | |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | S | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week. |
![]() ![]() ![]() ![]() | S | 0..1 | boolean | The Location is open all day |
![]() ![]() ![]() ![]() | S | 0..1 | time | Time that the Location opens |
![]() ![]() ![]() ![]() | S | 0..1 | time | Time that the Location closes |
![]() ![]() ![]() | S | 0..1 | string | Description of availability exceptions |
![]() ![]() ![]() | S | 0..* | Reference(VhDir Endpoint) | Technical endpoints providing access to services operated for the location |
![]() |
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | Location | Details and position information for a physical place | |
![]() ![]() ![]() | 0..1 | Attachment | A boundary shape that represents the outside edge of the location (in GeoJSON format) URL: http://hl7.org/fhir/StructureDefinition/location-boundary-geojson | |
![]() ![]() ![]() | 0..* | CodeableConcept | Accessibility options offered by the location URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/accessibility Binding: VhDir Accessibility Value Set (example) | |
![]() ![]() ![]() | 0..* | (Complex) | EHR at the location URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/ehr | |
![]() ![]() ![]() | 0..* | (Complex) | Whether the location is accepting new patients URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/newpatients | |
![]() ![]() ![]() | 0..* | string | Type of new patients accepted 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..* | Identifier | Unique code or number identifying the location to its users |
![]() ![]() ![]() ![]() | 1..1 | code | Status URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status Binding: VhDir Identifier Status Value Set (required) | |
![]() ![]() ![]() ![]() | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() ![]() | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
![]() ![]() ![]() ![]() | Σ | 0..1 | uri | The namespace for the identifier value |
![]() ![]() ![]() ![]() | Σ | 0..1 | string | The value that is unique |
![]() ![]() ![]() ![]() | Σ | 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): Indicates whether the location is still in use. |
![]() ![]() ![]() | Σ | 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: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location. |
![]() ![]() ![]() | 0..* | ContactPoint | Contact details of the location | |
![]() ![]() ![]() ![]() | 0..* | (Complex) | Available time URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime | |
![]() ![]() ![]() ![]() | 0..1 | Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location) | viaintermediary URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary | |
![]() ![]() ![]() ![]() | ΣI | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
![]() ![]() ![]() ![]() | Σ | 1..1 | string | The actual contact point details |
![]() ![]() ![]() ![]() | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
![]() ![]() ![]() ![]() | Σ | 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): Physical form of the location. |
![]() ![]() ![]() | 0..1 | BackboneElement | The absolute geographic location | |
![]() ![]() ![]() ![]() | 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 a part of | |
![]() ![]() ![]() | 0..* | BackboneElement | What days/times during a week is this location usually open | |
![]() ![]() ![]() ![]() | 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(VhDir Endpoint) | Technical endpoints providing access to services operated for the location | |
![]() |
This structure is derived from Location
Summary
Mandatory: 1 element (3 nested mandatory elements)
Must-Support: 44 elements
Prohibited: 2 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from Location
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | Location | Details and position information for a physical place | |
![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() | S | 0..1 | Attachment | A boundary shape that represents the outside edge of the location (in GeoJSON format) URL: http://hl7.org/fhir/StructureDefinition/location-boundary-geojson |
![]() ![]() ![]() | S | 0..* | CodeableConcept | Accessibility options offered by the location URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/accessibility Binding: VhDir Accessibility Value Set (example) |
![]() ![]() ![]() | S | 0..* | (Complex) | EHR at the location URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/ehr |
![]() ![]() ![]() | S | 0..* | (Complex) | Whether the location is accepting new patients URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/newpatients |
![]() ![]() ![]() | S | 0..* | string | Type of new patients accepted URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/newpatientprofile |
![]() ![]() ![]() | S | 0..* | Reference(VhDir Restriction) | Restriction URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction |
![]() ![]() ![]() | S | 0..* | Identifier | Unique code or number identifying the location to its users |
![]() ![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() | S | 1..1 | code | Status URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status Binding: VhDir Identifier Status Value Set (required) |
![]() ![]() ![]() ![]() | S | 0..1 | code | usual | official | temp | secondary | old (If known) |
![]() ![]() ![]() ![]() | S | 0..1 | CodeableConcept | Description of identifier |
![]() ![]() ![]() ![]() | S | 0..1 | uri | The namespace for the identifier value |
![]() ![]() ![]() ![]() | S | 0..1 | string | The value that is unique |
![]() ![]() ![]() ![]() | S | 0..1 | Period | Time period when id is/was valid for use |
![]() ![]() ![]() ![]() | S | 0..1 | Reference(VhDir Organization) | Organization that issued id (may be just text) |
![]() ![]() ![]() | S | 1..1 | code | active | suspended | inactive |
![]() ![]() ![]() | S | 0..0 | ||
![]() ![]() ![]() | S | 0..1 | string | Name of the location as used by humans |
![]() ![]() ![]() | S | 0..* | string | A list of alternate names that the location is known as, or was known as, in the past |
![]() ![]() ![]() | S | 0..1 | string | Additional details about the location that could be displayed as further information to identify the location beyond its name |
![]() ![]() ![]() | S | 0..0 | ||
![]() ![]() ![]() | S | 0..* | CodeableConcept | Type of function performed |
![]() ![]() ![]() | S | 0..* | ContactPoint | Contact details of the location |
![]() ![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() | S | 0..* | (Complex) | Available time URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime |
![]() ![]() ![]() ![]() | S | 0..1 | Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location) | viaintermediary URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary |
![]() ![]() ![]() ![]() | S | 1..1 | code | phone | fax | email | pager | url | sms | other |
![]() ![]() ![]() ![]() | S | 1..1 | string | The actual contact point details |
![]() ![]() ![]() ![]() | S | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point |
![]() ![]() ![]() ![]() | S | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
![]() ![]() ![]() ![]() | S | 0..1 | Period | Time period when the contact point was/is in use |
![]() ![]() ![]() | S | 0..1 | Address | Physical location |
![]() ![]() ![]() | S | 0..1 | CodeableConcept | Physical form of the location |
![]() ![]() ![]() | S | 0..1 | BackboneElement | The absolute geographic location |
![]() ![]() ![]() ![]() | S | 1..1 | decimal | Longitude with WGS84 datum |
![]() ![]() ![]() ![]() | S | 1..1 | decimal | Latitude with WGS84 datum |
![]() ![]() ![]() ![]() | S | 0..1 | decimal | Altitude with WGS84 datum |
![]() ![]() ![]() | S | 0..1 | Reference(VhDir Organization) | Organization responsible for provisioning and upkeep |
![]() ![]() ![]() | S | 0..1 | Reference(VhDir Location) | Another Location this one is physically a part of |
![]() ![]() ![]() | S | 0..* | BackboneElement | What days/times during a week is this location usually open |
![]() ![]() ![]() ![]() | S | 0..* | code | mon | tue | wed | thu | fri | sat | sun |
![]() ![]() ![]() ![]() | S | 0..1 | boolean | The Location is open all day |
![]() ![]() ![]() ![]() | S | 0..1 | time | Time that the Location opens |
![]() ![]() ![]() ![]() | S | 0..1 | time | Time that the Location closes |
![]() ![]() ![]() | S | 0..1 | string | Description of availability exceptions |
![]() ![]() ![]() | S | 0..* | Reference(VhDir Endpoint) | Technical endpoints providing access to services operated for the location |
![]() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | Location | Details and position information for a physical place | |
![]() ![]() ![]() | Σ | 0..1 | string | 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) Max Binding: AllLanguages: A human language. | |
![]() ![]() ![]() | 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 | |
![]() ![]() ![]() | S | 0..1 | Attachment | A boundary shape that represents the outside edge of the location (in GeoJSON format) URL: http://hl7.org/fhir/StructureDefinition/location-boundary-geojson |
![]() ![]() ![]() | S | 0..* | CodeableConcept | Accessibility options offered by the location URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/accessibility Binding: VhDir Accessibility Value Set (example) |
![]() ![]() ![]() | S | 0..* | (Complex) | EHR at the location URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/ehr |
![]() ![]() ![]() | S | 0..* | (Complex) | Whether the location is accepting new patients URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/newpatients |
![]() ![]() ![]() | S | 0..* | string | Type of new patients accepted URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/newpatientprofile |
![]() ![]() ![]() | S | 0..* | Reference(VhDir Restriction) | Restriction URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction |
![]() ![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() | SΣ | 0..* | Identifier | Unique code or number identifying the location to its users |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() | S | 1..1 | code | Status URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/identifier-status Binding: VhDir Identifier Status Value Set (required) |
![]() ![]() ![]() ![]() | ?!SΣ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() ![]() | SΣ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
![]() ![]() ![]() ![]() | SΣ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() ![]() | SΣ | 0..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() ![]() | SΣ | 0..1 | Period | Time period when id is/was valid for use |
![]() ![]() ![]() ![]() | SΣ | 0..1 | Reference(VhDir Organization) | Organization that issued id (may be just text) |
![]() ![]() ![]() | ?!SΣ | 1..1 | code | active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use. |
![]() ![]() ![]() | SΣ | 0..1 | string | Name of the location as used by humans |
![]() ![]() ![]() | S | 0..* | string | A list of alternate names that the location is known as, or was known as, in the past |
![]() ![]() ![]() | SΣ | 0..1 | string | Additional details about the location that could be displayed as further information to identify the location beyond its name |
![]() ![]() ![]() | SΣ | 0..* | CodeableConcept | Type of function performed Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location. |
![]() ![]() ![]() | S | 0..* | ContactPoint | Contact details of the location |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() | S | 0..* | (Complex) | Available time URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-availabletime |
![]() ![]() ![]() ![]() | S | 0..1 | Reference(VhDir Practitioner Role | VhDir Organization | VhDir Organization Affiliation | VhDir Location) | viaintermediary URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/contactpoint-viaintermediary |
![]() ![]() ![]() ![]() | SΣI | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
![]() ![]() ![]() ![]() | SΣ | 1..1 | string | The actual contact point details |
![]() ![]() ![]() ![]() | ?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
![]() ![]() ![]() ![]() | SΣ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
![]() ![]() ![]() ![]() | SΣ | 0..1 | Period | Time period when the contact point was/is in use |
![]() ![]() ![]() | S | 0..1 | Address | Physical location |
![]() ![]() ![]() | SΣ | 0..1 | CodeableConcept | Physical form of the location Binding: LocationType (example): Physical form of the location. |
![]() ![]() ![]() | S | 0..1 | BackboneElement | The absolute geographic location |
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | S | 1..1 | decimal | Longitude with WGS84 datum |
![]() ![]() ![]() ![]() | S | 1..1 | decimal | Latitude with WGS84 datum |
![]() ![]() ![]() ![]() | S | 0..1 | decimal | Altitude with WGS84 datum |
![]() ![]() ![]() | SΣ | 0..1 | Reference(VhDir Organization) | Organization responsible for provisioning and upkeep |
![]() ![]() ![]() | S | 0..1 | Reference(VhDir Location) | Another Location this one is physically a part of |
![]() ![]() ![]() | S | 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 | |
![]() ![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() | S | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required): The days of the week. |
![]() ![]() ![]() ![]() | S | 0..1 | boolean | The Location is open all day |
![]() ![]() ![]() ![]() | S | 0..1 | time | Time that the Location opens |
![]() ![]() ![]() ![]() | S | 0..1 | time | Time that the Location closes |
![]() ![]() ![]() | S | 0..1 | string | Description of availability exceptions |
![]() ![]() ![]() | S | 0..* | Reference(VhDir Endpoint) | Technical endpoints providing access to services operated for the location |
![]() |
Other representations of profile: CSV, Excel, Schematron
Path | Conformance | ValueSet |
Location.language | preferred | CommonLanguages Max Binding: AllLanguages |
Location.identifier.use | required | IdentifierUse |
Location.identifier.type | extensible | Identifier Type Codes |
Location.status | required | LocationStatus |
Location.type | extensible | ServiceDeliveryLocationRoleType |
Location.telecom.system | required | ContactPointSystem |
Location.telecom.use | required | ContactPointUse |
Location.physicalType | example | LocationType |
Location.hoursOfOperation.daysOfWeek | required | DaysOfWeek |
GET [base]/Location?accessibility=[code]
Support: MAY support search by the accessibility
parameter
text
GET [base]/Location?address=[string]
Support: SHALL support search by the address
parameter
contains
, exact
GET [base]/Location?endpoint=[id]
Support: SHOULD support search by the endpoint
parameter
Endpoint
endpoint.identifier
, endpoint.connection-type
, endpoint.organization
GET [base]/Location?identifier=[code]
Support: SHALL support search by the identifier
parameter
text
, ofType
GET [base]/Location?identifier-assigner=[id]
Support: MAY support search by the identifier-assigner
parameter
Organization
below
identifier-assigner.identifier
, identifier-assigner.name
GET [base]/Location?new-patient=[code]
Support: SHOULD support search by the new-patient
parameter
GET [base]/Location?new-patient-network=[id]
Support: SHOULD support search by the new-patient-network
parameter
Organization
new-patient-network.identifier
, new-patient-network.name
, new-patient-network.partof
GET [base]/Location?organization=[id]
Support: SHALL support search by the organization
parameter
Organization
above
, below
organization.identifier
, organization.name
, organization.address
, organization.partof
, organization-type
GET [base]/Location?partof=[id]
Support: SHOULD support search by the partof
parameter
Location
above
, below
identifier
, type
, address
, organization
GET [base]/Location?contains=-83.694810|42.256500
Support: MAY support search by the 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 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 status
parameter
GET [base]/Location?type=[code]
Support: SHALL support search by the type
parameter
text
GET [base]/Location?via-intermediary=[id]
Support: MAY support search by the via-intermediary
parameter
PractitionerRole
, Organization
, OrganizationAffiliation
, Location
GET [base]/Location?near=-83.694810|42.256500|11.20|km
Support: MAY support search by the near
parameter