Real Time Location Services Implementation Guide
1.0.0-ballot2 - STU 1 - Ballot 2 International flag

Real Time Location Services Implementation Guide, published by HL7 International / Patient Administration. This guide is not an authorized publication; it is the continuous build for version 1.0.0-ballot2 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/rtls-ig/ and changes regularly. See the Directory of published versions

Resource Profile: RTLS Message Unenrollment Header Resource Profile ( Experimental )

Official URL: http://hl7.org/fhir/uv/rtls/StructureDefinition/rtlsMessageUnenrollmentHeader Version: 1.0.0-ballot2
Standards status: Informative Computable Name: RTLSMessageUnenrollmentHeader

MessageHeader resource for FHIR Unenrollment messages sent in RTLS workflows.

This profile defines minimum expectations for the MessageHeader resource to be used in RTLS Unenrollment workflows.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for event[x] SΣ 1..1 Coding Code for the event this message represents or link to event definition
Slice: Unordered, Closed by type:$this
Binding: RTLS Message Events Valueset (extensible)
.... event[x]:eventCoding SΣ 1..1 Coding Fixed RTLS event code
Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR.
Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/uv/rtls/CodeSystem/rtlsMessageEvents
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: unenroll-tag
..... display 0..1 string Representation defined by the system
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... endpoint Σ 1..1 url Actual message source address or id
... focus SΣ 1..* Reference(RTLS Tag Device Profile) The actual content of the message

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
MessageHeader.event[x]extensibleRTLSMessageEvents(a valid code from RTLS Message Events)
http://hl7.org/fhir/uv/rtls/ValueSet/rtlsMessageEvents
From this IG
MessageHeader.event[x]:eventCodingexamplePattern Value: unenroll-tag
http://hl7.org/fhir/ValueSet/message-events
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMessageHeaderIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMessageHeaderIf 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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorMessageHeaderIf 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-5errorMessageHeaderIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMessageHeaderA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from MessageHeader

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MessageHeader MessageHeader
... event[x] S 1..1 Coding Code for the event this message represents or link to event definition
Binding: RTLS Message Events Valueset (extensible)
... eventCoding S 1..1 Coding Fixed RTLS event code
Required Pattern: At least the following
.... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/uv/rtls/CodeSystem/rtlsMessageEvents
.... code 1..1 code Symbol in syntax defined by the system
Fixed Value: unenroll-tag
... focus S 1..* Reference(RTLS Tag Device Profile) The actual content of the message

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
MessageHeader.event[x]extensibleRTLSMessageEvents(a valid code from RTLS Message Events)
http://hl7.org/fhir/uv/rtls/ValueSet/rtlsMessageEvents
From this IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for event[x] SΣ 1..1 Coding Code for the event this message represents or link to event definition
Slice: Unordered, Closed by type:$this
Binding: RTLS Message Events Valueset (extensible)
.... event[x]:eventCoding SΣ 1..1 Coding Fixed RTLS event code
Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR.
Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/uv/rtls/CodeSystem/rtlsMessageEvents
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: unenroll-tag
..... display 0..1 string Representation defined by the system
..... userSelected 0..1 boolean If this coding was chosen directly by the user
... 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
.... name Σ 0..1 string Name of system
.... target Σ 0..1 Reference(Device) Particular delivery destination within the destination
.... endpoint Σ 1..1 url Actual destination address or id
.... receiver Σ 0..1 Reference(Practitioner | PractitionerRole | Organization) Intended "real-world" recipient for the data
... sender Σ 0..1 Reference(Practitioner | PractitionerRole | Organization) Real world sender of the message
... enterer Σ 0..1 Reference(Practitioner | PractitionerRole) The source of the data entry
... author Σ 0..1 Reference(Practitioner | PractitionerRole) 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
.... 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
.... endpoint Σ 1..1 url Actual message source address or id
... 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 id Id 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) The actual content of the message
... definition Σ 0..1 canonical(MessageDefinition) Link to the definition for this message

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
MessageHeader.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
MessageHeader.event[x]extensibleRTLSMessageEvents(a valid code from RTLS Message Events)
http://hl7.org/fhir/uv/rtls/ValueSet/rtlsMessageEvents
From this IG
MessageHeader.event[x]:eventCodingexamplePattern Value: unenroll-tag
http://hl7.org/fhir/ValueSet/message-events
From the FHIR Standard
MessageHeader.reasonexampleExampleMessageReasonCodes
http://hl7.org/fhir/ValueSet/message-reason-encounter
From the FHIR Standard
MessageHeader.response.coderequiredResponseType
http://hl7.org/fhir/ValueSet/response-code|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMessageHeaderIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMessageHeaderIf 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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorMessageHeaderIf 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-5errorMessageHeaderIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMessageHeaderA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from MessageHeader

Summary

Mandatory: 3 elements
Must-Support: 3 elements

Structures

This structure refers to these other structures:

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for event[x] SΣ 1..1 Coding Code for the event this message represents or link to event definition
Slice: Unordered, Closed by type:$this
Binding: RTLS Message Events Valueset (extensible)
.... event[x]:eventCoding SΣ 1..1 Coding Fixed RTLS event code
Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR.
Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/uv/rtls/CodeSystem/rtlsMessageEvents
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: unenroll-tag
..... display 0..1 string Representation defined by the system
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... endpoint Σ 1..1 url Actual message source address or id
... focus SΣ 1..* Reference(RTLS Tag Device Profile) The actual content of the message

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
MessageHeader.event[x]extensibleRTLSMessageEvents(a valid code from RTLS Message Events)
http://hl7.org/fhir/uv/rtls/ValueSet/rtlsMessageEvents
From this IG
MessageHeader.event[x]:eventCodingexamplePattern Value: unenroll-tag
http://hl7.org/fhir/ValueSet/message-events
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMessageHeaderIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMessageHeaderIf 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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorMessageHeaderIf 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-5errorMessageHeaderIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMessageHeaderA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Differential View

This structure is derived from MessageHeader

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MessageHeader MessageHeader
... event[x] S 1..1 Coding Code for the event this message represents or link to event definition
Binding: RTLS Message Events Valueset (extensible)
... eventCoding S 1..1 Coding Fixed RTLS event code
Required Pattern: At least the following
.... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/uv/rtls/CodeSystem/rtlsMessageEvents
.... code 1..1 code Symbol in syntax defined by the system
Fixed Value: unenroll-tag
... focus S 1..* Reference(RTLS Tag Device Profile) The actual content of the message

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
MessageHeader.event[x]extensibleRTLSMessageEvents(a valid code from RTLS Message Events)
http://hl7.org/fhir/uv/rtls/ValueSet/rtlsMessageEvents
From this IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for event[x] SΣ 1..1 Coding Code for the event this message represents or link to event definition
Slice: Unordered, Closed by type:$this
Binding: RTLS Message Events Valueset (extensible)
.... event[x]:eventCoding SΣ 1..1 Coding Fixed RTLS event code
Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR.
Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/uv/rtls/CodeSystem/rtlsMessageEvents
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: unenroll-tag
..... display 0..1 string Representation defined by the system
..... userSelected 0..1 boolean If this coding was chosen directly by the user
... 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
.... name Σ 0..1 string Name of system
.... target Σ 0..1 Reference(Device) Particular delivery destination within the destination
.... endpoint Σ 1..1 url Actual destination address or id
.... receiver Σ 0..1 Reference(Practitioner | PractitionerRole | Organization) Intended "real-world" recipient for the data
... sender Σ 0..1 Reference(Practitioner | PractitionerRole | Organization) Real world sender of the message
... enterer Σ 0..1 Reference(Practitioner | PractitionerRole) The source of the data entry
... author Σ 0..1 Reference(Practitioner | PractitionerRole) 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
.... 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
.... endpoint Σ 1..1 url Actual message source address or id
... 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 id Id 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) The actual content of the message
... definition Σ 0..1 canonical(MessageDefinition) Link to the definition for this message

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
MessageHeader.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
MessageHeader.event[x]extensibleRTLSMessageEvents(a valid code from RTLS Message Events)
http://hl7.org/fhir/uv/rtls/ValueSet/rtlsMessageEvents
From this IG
MessageHeader.event[x]:eventCodingexamplePattern Value: unenroll-tag
http://hl7.org/fhir/ValueSet/message-events
From the FHIR Standard
MessageHeader.reasonexampleExampleMessageReasonCodes
http://hl7.org/fhir/ValueSet/message-reason-encounter
From the FHIR Standard
MessageHeader.response.coderequiredResponseType
http://hl7.org/fhir/ValueSet/response-code|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMessageHeaderIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMessageHeaderIf 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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorMessageHeaderIf 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-5errorMessageHeaderIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMessageHeaderA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from MessageHeader

Summary

Mandatory: 3 elements
Must-Support: 3 elements

Structures

This structure refers to these other structures:

 

Other representations of profile: CSV, Excel, Schematron