Real Time Location Services Implementation Guide
1.0.0-ballot - CI Build
Real Time Location Services Implementation Guide
1.0.0-ballot - CI Build
Real Time Location Services Implementation Guide, published by HL7 International - Patient Administration Work Group. This is not an authorized publication; it is the continuous build for version 1.0.0-ballot). This version is based on the current content of https://github.com/HL7/rtls-ig/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/uv/rtls/StructureDefinition/rtlsDevice | Version: 1.0.0-ballot | |||
| Standards status: Informative | Computable Name: RTLSDevice | |||
Device resource profile for tags or badges in RTLS workflows.
This profile defines minimum expectations for the Device resource to be used in RTLS workflows.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Device
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Device | 0..* | Device | Item used in healthcare | |
  identifier | S | 1..* | Identifier | Instance identifier |
| status | 0..1 | code | A status of "active" indicates that a tracking tag is in use (regardless of current assignment to a subject) and "inactive" indicates that a tracking tag is no longer in use. | |
  location | S | 0..1 | Reference(RTLS Location Resource Profile) | Where the device is found |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Device | C | 0..* | Device | Item used in healthcare |
 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 | Instance identifier |
| status | ?!Σ | 0..1 | code | A status of "active" indicates that a tracking tag is in use (regardless of current assignment to a subject) and "inactive" indicates that a tracking tag is no longer in use. Binding: FHIRDeviceStatus (required): The record status of the device. |
| location | S | 0..1 | Reference(RTLS Location Resource Profile) | Where the device is found |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Device.status | required | FHIRDeviceStatus |
| Id | Grade | Path(s) | Details | Requirements |
| dev-1 | error | Device | only one Device.name.display SHALL be true when there is more than one Device.name : name.where(display=true).count() <= 1 | |
| dom-2 | error | Device | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Device | 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 | Device | 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 | Device | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Device | 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 |
|---|---|---|---|---|
| Device | C | 0..* | Device | Item used in healthcare |
| 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 | Instance identifier |
| displayName | 0..1 | string | The name used to display by default when the device is referenced | |
| definition | 0..1 | CodeableReference(DeviceDefinition) | The reference to the definition for the device | |
 udiCarrier | Σ | 0..* | BackboneElement | Unique Device Identifier (UDI) Barcode string |
 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 |
| deviceIdentifier | Σ | 1..1 | string | Mandatory fixed portion of UDI |
| issuer | Σ | 1..1 | uri | UDI Issuing Organization |
| jurisdiction | 0..1 | uri | Regional UDI authority | |
| carrierAIDC | Σ | 0..1 | base64Binary | UDI Machine Readable Barcode String |
| carrierHRF | Σ | 0..1 | string | UDI Human Readable Barcode String |
| entryType | 0..1 | code | barcode | rfid | manual | card | self-reported | electronic-transmission | unknown Binding: UDIEntryType (required): Codes to identify how UDI data was entered. | |
| status | ?!Σ | 0..1 | code | A status of "active" indicates that a tracking tag is in use (regardless of current assignment to a subject) and "inactive" indicates that a tracking tag is no longer in use. Binding: FHIRDeviceStatus (required): The record status of the device. |
| availabilityStatus | 0..1 | CodeableConcept | lost | damaged | destroyed | available Binding: FHIRDeviceAvailabilityStatus (extensible): The availability status reason of the device. | |
| biologicalSourceEvent | 0..1 | Identifier | An identifier that supports traceability to the event during which material in this product from one or more biological entities was obtained or pooled | |
| manufacturer | 0..1 | string | Name of device manufacturer | |
| manufactureDate | 0..1 | dateTime | Date when the device was made | |
| expirationDate | 0..1 | dateTime | Date and time of expiry of this device (if applicable) | |
| lotNumber | 0..1 | string | Lot number of manufacture | |
| serialNumber | 0..1 | string | Serial number assigned by the manufacturer | |
| name | C | 0..* | BackboneElement | The name or names of the device as known to the manufacturer and/or patient |
| 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 |
| value | Σ | 1..1 | string | The term that names the device |
| type | Σ | 1..1 | code | registered-name | user-friendly-name | patient-reported-name Binding: DeviceNameType (required): The type of name the device is referred by. |
| display | ?!ΣC | 0..1 | boolean | The preferred device name |
| modelNumber | 0..1 | string | The manufacturer's model number for the device | |
| partNumber | 0..1 | string | The part number or catalog number of the device | |
| category | 0..* | CodeableConcept | Indicates a high-level grouping of the device Binding: FHIRDeviceCategory (example): Categories of medical devices. | |
| type | 0..* | CodeableConcept | The kind or type of device Binding: DeviceType (example): Codes to identify medical devices. | |
| version | 0..* | BackboneElement | The actual design of the device or software version running on the device | |
| 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 |
| type | 0..1 | CodeableConcept | The type of the device version, e.g. manufacturer, approved, internal Binding: DeviceVersionType (example): The type of version indicated for the device. | |
| component | 0..1 | Identifier | The hardware or software module of the device to which the version applies | |
| installDate | 0..1 | dateTime | The date the version was installed on the device | |
| value | 1..1 | string | The version text | |
| conformsTo | 0..* | BackboneElement | Identifies the standards, specifications, or formal guidances for the capabilities supported by the device | |
| 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 |
| category | 0..1 | CodeableConcept | Describes the common type of the standard, specification, or formal guidance. communication | performance | measurement Binding: DeviceSpecificationCategory (example): The kind of standards used by the device. | |
| specification | 1..1 | CodeableConcept | Identifies the standard, specification, or formal guidance that the device adheres to Binding: DeviceSpecificationType (example): The type of version indicated for the device. | |
| version | 0..1 | string | Specific form or variant of the standard | |
| property | 0..* | BackboneElement | Inherent, essentially fixed, characteristics of the device. e.g., time properties, size, material, etc. | |
| 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 |
| type | 1..1 | CodeableConcept | Code that specifies the property being represented Binding: DeviceType (example): Device property type. | |
  value[x] | 1..1 | Value of the property | ||
 valueQuantity | Quantity | |||
| valueCodeableConcept | CodeableConcept | |||
| valueString | string | |||
| valueBoolean | boolean | |||
| valueInteger | integer | |||
| valueRange | Range | |||
| valueAttachment | Attachment | |||
| mode | 0..1 | CodeableConcept | The designated condition for performing a task Binding: FHIRDeviceOperationMode (example): Operational mode of a device. | |
| cycle | 0..1 | Count | The series of occurrences that repeats during the operation of the device | |
| duration | 0..1 | Duration | A measurement of time during the device's operation (e.g., days, hours, mins, etc.) | |
| owner | 0..1 | Reference(Organization) | Organization responsible for device | |
| contact | 0..* | ContactPoint | Details for human/organization for support | |
| location | S | 0..1 | Reference(RTLS Location Resource Profile) | Where the device is found |
| url | 0..1 | uri | Network address to contact device | |
| endpoint | 0..* | Reference(Endpoint) | Technical endpoints providing access to electronic services provided by the device | |
| gateway | 0..* | CodeableReference(Device) | Linked device acting as a communication/data collector, translator or controller | |
| note | 0..* | Annotation | Device notes and comments | |
| safety | Σ | 0..* | CodeableConcept | Safety Characteristics of Device Binding: DeviceSafety (example) |
| parent | 0..1 | Reference(Device) | The higher level or encompassing device that this device is a logical part of | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Device.language | required | AllLanguages |
| Device.udiCarrier.entryType | required | UDIEntryType |
| Device.status | required | FHIRDeviceStatus |
| Device.availabilityStatus | extensible | FHIRDeviceAvailabilityStatus |
| Device.name.type | required | DeviceNameType |
| Device.category | example | FHIRDeviceCategory |
| Device.type | example | DeviceType |
| Device.version.type | example | DeviceVersionType |
| Device.conformsTo.category | example | DeviceSpecificationCategory |
| Device.conformsTo.specification | example | DeviceSpecificationType |
| Device.property.type | example | DeviceType |
| Device.mode | example | FHIRDeviceOperationMode |
| Device.safety | example | DeviceSafety |
| 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 Device
Differential View
This structure is derived from Device
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Device | 0..* | Device | Item used in healthcare | |
| identifier | S | 1..* | Identifier | Instance identifier |
| status | 0..1 | code | A status of "active" indicates that a tracking tag is in use (regardless of current assignment to a subject) and "inactive" indicates that a tracking tag is no longer in use. | |
| location | S | 0..1 | Reference(RTLS Location Resource Profile) | Where the device is found |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Device | C | 0..* | Device | Item used in healthcare |
| 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 | Instance identifier |
| status | ?!Σ | 0..1 | code | A status of "active" indicates that a tracking tag is in use (regardless of current assignment to a subject) and "inactive" indicates that a tracking tag is no longer in use. Binding: FHIRDeviceStatus (required): The record status of the device. |
| location | S | 0..1 | Reference(RTLS Location Resource Profile) | Where the device is found |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Device.status | required | FHIRDeviceStatus |
| Id | Grade | Path(s) | Details | Requirements |
| dev-1 | error | Device | only one Device.name.display SHALL be true when there is more than one Device.name : name.where(display=true).count() <= 1 | |
| dom-2 | error | Device | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Device | 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 | Device | 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 | Device | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Device | 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 |
|---|---|---|---|---|
| Device | C | 0..* | Device | Item used in healthcare |
| 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 | Instance identifier |
| displayName | 0..1 | string | The name used to display by default when the device is referenced | |
| definition | 0..1 | CodeableReference(DeviceDefinition) | The reference to the definition for the device | |
| udiCarrier | Σ | 0..* | BackboneElement | Unique Device Identifier (UDI) Barcode string |
| 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 |
| deviceIdentifier | Σ | 1..1 | string | Mandatory fixed portion of UDI |
| issuer | Σ | 1..1 | uri | UDI Issuing Organization |
| jurisdiction | 0..1 | uri | Regional UDI authority | |
| carrierAIDC | Σ | 0..1 | base64Binary | UDI Machine Readable Barcode String |
| carrierHRF | Σ | 0..1 | string | UDI Human Readable Barcode String |
| entryType | 0..1 | code | barcode | rfid | manual | card | self-reported | electronic-transmission | unknown Binding: UDIEntryType (required): Codes to identify how UDI data was entered. | |
| status | ?!Σ | 0..1 | code | A status of "active" indicates that a tracking tag is in use (regardless of current assignment to a subject) and "inactive" indicates that a tracking tag is no longer in use. Binding: FHIRDeviceStatus (required): The record status of the device. |
| availabilityStatus | 0..1 | CodeableConcept | lost | damaged | destroyed | available Binding: FHIRDeviceAvailabilityStatus (extensible): The availability status reason of the device. | |
| biologicalSourceEvent | 0..1 | Identifier | An identifier that supports traceability to the event during which material in this product from one or more biological entities was obtained or pooled | |
| manufacturer | 0..1 | string | Name of device manufacturer | |
| manufactureDate | 0..1 | dateTime | Date when the device was made | |
| expirationDate | 0..1 | dateTime | Date and time of expiry of this device (if applicable) | |
| lotNumber | 0..1 | string | Lot number of manufacture | |
| serialNumber | 0..1 | string | Serial number assigned by the manufacturer | |
| name | C | 0..* | BackboneElement | The name or names of the device as known to the manufacturer and/or patient |
| 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 |
| value | Σ | 1..1 | string | The term that names the device |
| type | Σ | 1..1 | code | registered-name | user-friendly-name | patient-reported-name Binding: DeviceNameType (required): The type of name the device is referred by. |
| display | ?!ΣC | 0..1 | boolean | The preferred device name |
| modelNumber | 0..1 | string | The manufacturer's model number for the device | |
| partNumber | 0..1 | string | The part number or catalog number of the device | |
| category | 0..* | CodeableConcept | Indicates a high-level grouping of the device Binding: FHIRDeviceCategory (example): Categories of medical devices. | |
| type | 0..* | CodeableConcept | The kind or type of device Binding: DeviceType (example): Codes to identify medical devices. | |
| version | 0..* | BackboneElement | The actual design of the device or software version running on the device | |
| 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 |
| type | 0..1 | CodeableConcept | The type of the device version, e.g. manufacturer, approved, internal Binding: DeviceVersionType (example): The type of version indicated for the device. | |
| component | 0..1 | Identifier | The hardware or software module of the device to which the version applies | |
| installDate | 0..1 | dateTime | The date the version was installed on the device | |
| value | 1..1 | string | The version text | |
| conformsTo | 0..* | BackboneElement | Identifies the standards, specifications, or formal guidances for the capabilities supported by the device | |
| 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 |
| category | 0..1 | CodeableConcept | Describes the common type of the standard, specification, or formal guidance. communication | performance | measurement Binding: DeviceSpecificationCategory (example): The kind of standards used by the device. | |
| specification | 1..1 | CodeableConcept | Identifies the standard, specification, or formal guidance that the device adheres to Binding: DeviceSpecificationType (example): The type of version indicated for the device. | |
| version | 0..1 | string | Specific form or variant of the standard | |
| property | 0..* | BackboneElement | Inherent, essentially fixed, characteristics of the device. e.g., time properties, size, material, etc. | |
| 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 |
| type | 1..1 | CodeableConcept | Code that specifies the property being represented Binding: DeviceType (example): Device property type. | |
| value[x] | 1..1 | Value of the property | ||
| valueQuantity | Quantity | |||
| valueCodeableConcept | CodeableConcept | |||
| valueString | string | |||
| valueBoolean | boolean | |||
| valueInteger | integer | |||
| valueRange | Range | |||
| valueAttachment | Attachment | |||
| mode | 0..1 | CodeableConcept | The designated condition for performing a task Binding: FHIRDeviceOperationMode (example): Operational mode of a device. | |
| cycle | 0..1 | Count | The series of occurrences that repeats during the operation of the device | |
| duration | 0..1 | Duration | A measurement of time during the device's operation (e.g., days, hours, mins, etc.) | |
| owner | 0..1 | Reference(Organization) | Organization responsible for device | |
| contact | 0..* | ContactPoint | Details for human/organization for support | |
| location | S | 0..1 | Reference(RTLS Location Resource Profile) | Where the device is found |
| url | 0..1 | uri | Network address to contact device | |
| endpoint | 0..* | Reference(Endpoint) | Technical endpoints providing access to electronic services provided by the device | |
| gateway | 0..* | CodeableReference(Device) | Linked device acting as a communication/data collector, translator or controller | |
| note | 0..* | Annotation | Device notes and comments | |
| safety | Σ | 0..* | CodeableConcept | Safety Characteristics of Device Binding: DeviceSafety (example) |
| parent | 0..1 | Reference(Device) | The higher level or encompassing device that this device is a logical part of | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Device.language | required | AllLanguages |
| Device.udiCarrier.entryType | required | UDIEntryType |
| Device.status | required | FHIRDeviceStatus |
| Device.availabilityStatus | extensible | FHIRDeviceAvailabilityStatus |
| Device.name.type | required | DeviceNameType |
| Device.category | example | FHIRDeviceCategory |
| Device.type | example | DeviceType |
| Device.version.type | example | DeviceVersionType |
| Device.conformsTo.category | example | DeviceSpecificationCategory |
| Device.conformsTo.specification | example | DeviceSpecificationType |
| Device.property.type | example | DeviceType |
| Device.mode | example | FHIRDeviceOperationMode |
| Device.safety | example | DeviceSafety |
| 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 Device
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-05-10
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change