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/rtlsMessageHeader | Version: 1.0.0-ballot | |||
| Standards status: Informative | Computable Name: RTLSMessageHeader | |||
MessageHeader resource for FHIR messages sent in RTLS workflows.
This profile defines minimum expectations for the MessageHeader resource to be used in RTLS workflows.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from MessageHeader
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  MessageHeader | 0..* | MessageHeader | A resource that describes a message that is exchanged between systems | |
  event | S | 1..1 | Coding, canonical(EventDefinition) | Event code or link to EventDefinition Binding: RTLS Message Events Valueset (extensible) |
  focus | S | 1..* | Reference(RTLS Tag Device Profile | RTLS Message Bundle Profile) | The actual content of the message |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| MessageHeader.event | extensible | RTLSMessageEvents (a valid code from RTLS Message Events) |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MessageHeader | 0..* | MessageHeader | A resource that describes a message that is exchanged between systems | |
 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 |
  event[x] | SΣ | 1..1 | Event code or link to EventDefinition Slice: Unordered, Open by type:$this Binding: RTLS Message Events Valueset (extensible) | |
   eventCoding | Coding | |||
 eventCanonical | canonical(EventDefinition) | |||
| source | Σ | 1..1 | BackboneElement | Message source application |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| focus | SΣ | 1..* | Reference(RTLS Tag Device Profile | RTLS Message Bundle Profile) | The actual content of the message |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| MessageHeader.event[x] | extensible | RTLSMessageEvents (a valid code from RTLS Message Events) |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | MessageHeader | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | MessageHeader | 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 | MessageHeader | 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 | MessageHeader | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | MessageHeader | 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 |
|---|---|---|---|---|
| MessageHeader | 0..* | MessageHeader | A resource that describes a message that is exchanged between systems | |
| 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 |
| event[x] | SΣ | 1..1 | Event code or link to EventDefinition Slice: Unordered, Open by type:$this Binding: RTLS Message Events Valueset (extensible) | |
| eventCoding | Coding | |||
| eventCanonical | canonical(EventDefinition) | |||
| destination | Σ | 0..* | BackboneElement | Message destination application(s) |
| 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 |
 endpoint[x] | Σ | 0..1 | Actual destination address or Endpoint resource | |
| endpointUrl | url | |||
| endpointReference | Reference(Endpoint) | |||
| name | Σ | 0..1 | string | Name of system |
| target | Σ | 0..1 | Reference(Device) | Particular delivery destination within the destination |
| receiver | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Intended "real-world" recipient for the data |
| sender | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Device | Organization) | Real world sender of the message |
| author | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Device | Organization) | The source of the decision |
| source | Σ | 1..1 | BackboneElement | Message source application |
| 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 |
| endpoint[x] | Σ | 0..1 | Actual source address or Endpoint resource | |
| endpointUrl | url | |||
| endpointReference | Reference(Endpoint) | |||
| name | Σ | 0..1 | string | Name of system |
| software | Σ | 0..1 | string | Name of software running the system |
| version | Σ | 0..1 | string | Version of software running |
| contact | Σ | 0..1 | ContactPoint | Human contact for problems |
| responsible | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Final responsibility for event |
| reason | Σ | 0..1 | CodeableConcept | Cause of event Binding: ExampleMessageReasonCodes (example): Reason for event occurrence. |
| response | Σ | 0..1 | BackboneElement | If this is a reply to prior message |
| 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 |
| identifier | Σ | 1..1 | Identifier | Bundle.identifier of original message |
| code | Σ | 1..1 | code | ok | transient-error | fatal-error Binding: ResponseType (required): The kind of response to a message. |
| details | Σ | 0..1 | Reference(OperationOutcome) | Specific list of hints/warnings/errors |
| focus | SΣ | 1..* | Reference(RTLS Tag Device Profile | RTLS Message Bundle Profile) | The actual content of the message |
| definition | Σ | 0..1 | canonical(MessageDefinition) | Link to the definition for this message |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| MessageHeader.language | required | AllLanguages |
| MessageHeader.event[x] | extensible | RTLSMessageEvents (a valid code from RTLS Message Events) |
| MessageHeader.reason | example | ExampleMessageReasonCodes |
| MessageHeader.response.code | required | ResponseType |
| 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 MessageHeader
Differential View
This structure is derived from MessageHeader
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MessageHeader | 0..* | MessageHeader | A resource that describes a message that is exchanged between systems | |
| event | S | 1..1 | Coding, canonical(EventDefinition) | Event code or link to EventDefinition Binding: RTLS Message Events Valueset (extensible) |
| focus | S | 1..* | Reference(RTLS Tag Device Profile | RTLS Message Bundle Profile) | The actual content of the message |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| MessageHeader.event | extensible | RTLSMessageEvents (a valid code from RTLS Message Events) |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MessageHeader | 0..* | MessageHeader | A resource that describes a message that is exchanged between systems | |
| 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 |
| event[x] | SΣ | 1..1 | Event code or link to EventDefinition Slice: Unordered, Open by type:$this Binding: RTLS Message Events Valueset (extensible) | |
| eventCoding | Coding | |||
| eventCanonical | canonical(EventDefinition) | |||
| source | Σ | 1..1 | BackboneElement | Message source application |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| focus | SΣ | 1..* | Reference(RTLS Tag Device Profile | RTLS Message Bundle Profile) | The actual content of the message |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| MessageHeader.event[x] | extensible | RTLSMessageEvents (a valid code from RTLS Message Events) |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | MessageHeader | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | MessageHeader | 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 | MessageHeader | 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 | MessageHeader | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | MessageHeader | 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 |
|---|---|---|---|---|
| MessageHeader | 0..* | MessageHeader | A resource that describes a message that is exchanged between systems | |
| 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 |
| event[x] | SΣ | 1..1 | Event code or link to EventDefinition Slice: Unordered, Open by type:$this Binding: RTLS Message Events Valueset (extensible) | |
| eventCoding | Coding | |||
| eventCanonical | canonical(EventDefinition) | |||
| destination | Σ | 0..* | BackboneElement | Message destination application(s) |
| 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 |
| endpoint[x] | Σ | 0..1 | Actual destination address or Endpoint resource | |
| endpointUrl | url | |||
| endpointReference | Reference(Endpoint) | |||
| name | Σ | 0..1 | string | Name of system |
| target | Σ | 0..1 | Reference(Device) | Particular delivery destination within the destination |
| receiver | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Intended "real-world" recipient for the data |
| sender | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Device | Organization) | Real world sender of the message |
| author | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Device | Organization) | The source of the decision |
| source | Σ | 1..1 | BackboneElement | Message source application |
| 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 |
| endpoint[x] | Σ | 0..1 | Actual source address or Endpoint resource | |
| endpointUrl | url | |||
| endpointReference | Reference(Endpoint) | |||
| name | Σ | 0..1 | string | Name of system |
| software | Σ | 0..1 | string | Name of software running the system |
| version | Σ | 0..1 | string | Version of software running |
| contact | Σ | 0..1 | ContactPoint | Human contact for problems |
| responsible | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Final responsibility for event |
| reason | Σ | 0..1 | CodeableConcept | Cause of event Binding: ExampleMessageReasonCodes (example): Reason for event occurrence. |
| response | Σ | 0..1 | BackboneElement | If this is a reply to prior message |
| 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 |
| identifier | Σ | 1..1 | Identifier | Bundle.identifier of original message |
| code | Σ | 1..1 | code | ok | transient-error | fatal-error Binding: ResponseType (required): The kind of response to a message. |
| details | Σ | 0..1 | Reference(OperationOutcome) | Specific list of hints/warnings/errors |
| focus | SΣ | 1..* | Reference(RTLS Tag Device Profile | RTLS Message Bundle Profile) | The actual content of the message |
| definition | Σ | 0..1 | canonical(MessageDefinition) | Link to the definition for this message |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| MessageHeader.language | required | AllLanguages |
| MessageHeader.event[x] | extensible | RTLSMessageEvents (a valid code from RTLS Message Events) |
| MessageHeader.reason | example | ExampleMessageReasonCodes |
| MessageHeader.response.code | required | ResponseType |
| 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 MessageHeader
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