Real Time Location Services Implementation Guide
1.0.0-ballot - CI Build
Real Time Location Services Implementation Guide
1.0.0-ballot - CI Build
This page is part of the Real Time Location Services Implementation Guide (v1.0.0-ballot: STU 1.0 Ballot 1) based on FHIR (HL7® FHIR® Standard) v5.0.0. No current official version has been published yet. For a full list of available versions, see the Directory of published versions
| Official URL: http://hl7.org/fhir/uv/rtls/StructureDefinition/rtlsLocation | Version: 1.0.0-ballot | |||
| Standards status: Informative | Computable Name: RTLSLocation | |||
Location resource profile for RTLS workflows.
Defines minimum expectations for the location resource used in RTLS workflows
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Location
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Location | 0..* | Location | Details and position information for a place | |
  identifier | S | 1..* | Identifier | Unique code or number identifying the location to its users |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Location | 0..* | Location | Details and position information for a place | |
  implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| contained | 0..* | Resource | Contained, inline Resources | |
 modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
 identifier | SΣ | 1..* | Identifier | Unique code or number identifying the location to its users |
| status | ?!Σ | 0..1 | code | active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Location.status | required | LocationStatus |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Location | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Location | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Location | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Location | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Location | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Location | 0..* | Location | Details and position information for a 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 |
| language | 0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
 extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| identifier | SΣ | 1..* | Identifier | Unique code or number identifying the location to its users |
| status | ?!Σ | 0..1 | code | active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use. |
| operationalStatus | Σ | 0..1 | Coding | The operational status of the location (typically only for a bed/room) Binding: hl7VS-bedStatus (preferred): The operational status if the location (where typically a bed/room). |
| name | Σ | 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 | markdown | Additional details about the location that could be displayed as further information to identify the location beyond its name |
| mode | Σ | 0..1 | code | instance | kind Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations. |
| type | Σ | 0..* | CodeableConcept | Type of function performed Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location. |
| contact | 0..* | ExtendedContactDetail | Official contact details for the location | |
| address | 0..1 | Address | Physical location | |
| form | Σ | 0..1 | CodeableConcept | Physical form of the location Binding: LocationForm (example): Physical form of the location. |
 position | 0..1 | BackboneElement | The absolute geographic location | |
 id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| longitude | 1..1 | decimal | Longitude with WGS84 datum | |
| latitude | 1..1 | decimal | Latitude with WGS84 datum | |
| altitude | 0..1 | decimal | Altitude with WGS84 datum | |
 managingOrganization | Σ | 0..1 | Reference(Organization) | Organization responsible for provisioning and upkeep |
| partOf | 0..1 | Reference(Location) | Another Location this one is physically a part of | |
| characteristic | 0..* | CodeableConcept | Collection of characteristics (attributes) Binding: LocationCharacteristic (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy). | |
| hoursOfOperation | 0..* | Availability | What days/times during a week is this location usually open (including exceptions) | |
| virtualService | 0..* | VirtualServiceDetail | Connection details of a virtual service (e.g. conference call) | |
| endpoint | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the location | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Location.language | required | AllLanguages |
| Location.status | required | LocationStatus |
| Location.operationalStatus | preferred | Hl7VSBedStatus |
| Location.mode | required | LocationMode |
| Location.type | extensible | ServiceDeliveryLocationRoleType |
| Location.form | example | LocationForm |
| Location.characteristic | example | LocationCharacteristic |
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Location
Differential View
This structure is derived from Location
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Location | 0..* | Location | Details and position information for a place | |
| identifier | S | 1..* | Identifier | Unique code or number identifying the location to its users |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Location | 0..* | Location | Details and position information for a place | |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| contained | 0..* | Resource | Contained, inline Resources | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| identifier | SΣ | 1..* | Identifier | Unique code or number identifying the location to its users |
| status | ?!Σ | 0..1 | code | active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Location.status | required | LocationStatus |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Location | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Location | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Location | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Location | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Location | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Location | 0..* | Location | Details and position information for a 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 |
| language | 0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| identifier | SΣ | 1..* | Identifier | Unique code or number identifying the location to its users |
| status | ?!Σ | 0..1 | code | active | suspended | inactive Binding: LocationStatus (required): Indicates whether the location is still in use. |
| operationalStatus | Σ | 0..1 | Coding | The operational status of the location (typically only for a bed/room) Binding: hl7VS-bedStatus (preferred): The operational status if the location (where typically a bed/room). |
| name | Σ | 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 | markdown | Additional details about the location that could be displayed as further information to identify the location beyond its name |
| mode | Σ | 0..1 | code | instance | kind Binding: LocationMode (required): Indicates whether a resource instance represents a specific location or a class of locations. |
| type | Σ | 0..* | CodeableConcept | Type of function performed Binding: ServiceDeliveryLocationRoleType (extensible): Indicates the type of function performed at the location. |
| contact | 0..* | ExtendedContactDetail | Official contact details for the location | |
| address | 0..1 | Address | Physical location | |
| form | Σ | 0..1 | CodeableConcept | Physical form of the location Binding: LocationForm (example): Physical form of the location. |
| position | 0..1 | BackboneElement | The absolute geographic location | |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| longitude | 1..1 | decimal | Longitude with WGS84 datum | |
| latitude | 1..1 | decimal | Latitude with WGS84 datum | |
| altitude | 0..1 | decimal | Altitude with WGS84 datum | |
| managingOrganization | Σ | 0..1 | Reference(Organization) | Organization responsible for provisioning and upkeep |
| partOf | 0..1 | Reference(Location) | Another Location this one is physically a part of | |
| characteristic | 0..* | CodeableConcept | Collection of characteristics (attributes) Binding: LocationCharacteristic (example): A custom attribute that could be provided at a service (e.g. Wheelchair accessibiliy). | |
| hoursOfOperation | 0..* | Availability | What days/times during a week is this location usually open (including exceptions) | |
| virtualService | 0..* | VirtualServiceDetail | Connection details of a virtual service (e.g. conference call) | |
| endpoint | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the location | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Location.language | required | AllLanguages |
| Location.status | required | LocationStatus |
| Location.operationalStatus | preferred | Hl7VSBedStatus |
| Location.mode | required | LocationMode |
| Location.type | extensible | ServiceDeliveryLocationRoleType |
| Location.form | example | LocationForm |
| Location.characteristic | example | LocationCharacteristic |
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Location
Other representations of profile: CSV, Excel, Schematron
IG © 2022+ HL7 International - Patient Administration Work Group. Package hl7.fhir.uv.rtls#1.0.0-ballot based on FHIR 5.0.0. Generated 2023-03-30
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change