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 v5.0.0. . For a full list of available versions, see the Directory of published versions 
| Official URL: http://hl7.org/fhir/uv/rtls/StructureDefinition/rtlsSubscriptionStatus | Version: 1.0.0-ballot | |||
| Standards status: Informative | Computable Name: RTLSSubscriptionStatus | |||
SubscriptionStatus resource used in RTLS workflows
This profile defines minimum expectations for a subscription status resource used in RTLS workflows.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from SubscriptionStatus
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  SubscriptionStatus | 0..* | SubscriptionStatus | Status information about a Subscription provided during event notification | |
  status | S | 0..1 | code | requested | active | error | off | entered-in-error |
| type | S | 1..1 | code | Set to "event-notification" |
 notificationEvent | ||||
 timestamp | S | 1..1 | instant | The instant this event occurred |
  focus | S | 0..1 | Reference(RTLS Tag Device Profile) | Reference to the primary resource or information of this event |
| subscription | S | 1..1 | Reference(Subscription) | Reference to the rtlsSubscription resource responsible for this notification (http://hl7.org/fhir/uv/rtls/StructureDefinition/rtlsSubscription). |
| topic | S | 0..1 | canonical(SubscriptionTopic) | Reference to the rtlsSbuscriptionTopic resource this notification relates to (http://hl7.org/fhir/uv/rtls/StructureDefinition/rtlsSubscriptionTopic). |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| SubscriptionStatus | C | 0..* | SubscriptionStatus | Status information about a Subscription provided during event notification |
 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 |
| status | SΣC | 0..1 | code | requested | active | error | off | entered-in-error Binding: SubscriptionStatusCodes (required): The status of a subscription at the time this notification was generated. |
| type | ?!SΣC | 1..1 | code | Set to "event-notification" Binding: SubscriptionNotificationType (required): The type of notification represented by the status message. |
 notificationEvent | C | 0..* | BackboneElement | Detailed information about any events relevant to this notification |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| eventNumber | 1..1 | integer64 | Sequencing index of this event | |
| timestamp | S | 1..1 | instant | The instant this event occurred |
| focus | S | 0..1 | Reference(RTLS Tag Device Profile) | Reference to the primary resource or information of this event |
| subscription | SΣ | 1..1 | Reference(Subscription) | Reference to the rtlsSubscription resource responsible for this notification (http://hl7.org/fhir/uv/rtls/StructureDefinition/rtlsSubscription). |
| topic | SΣ | 0..1 | canonical(SubscriptionTopic) | Reference to the rtlsSbuscriptionTopic resource this notification relates to (http://hl7.org/fhir/uv/rtls/StructureDefinition/rtlsSubscriptionTopic). |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| SubscriptionStatus.status | required | SubscriptionStatusCodes |
| SubscriptionStatus.type | required | SubscriptionNotificationType |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | SubscriptionStatus | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | SubscriptionStatus | 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 | SubscriptionStatus | 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 | SubscriptionStatus | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | SubscriptionStatus | 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() | |
| sst-1 | error | SubscriptionStatus | Event notifications must contain events : (type = 'event-notification' or type = 'query-event') implies notificationEvent.exists() | |
| sst-2 | error | SubscriptionStatus | Status messages must contain status : type = 'query-status' implies status.exists() |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| SubscriptionStatus | C | 0..* | SubscriptionStatus | Status information about a Subscription provided during event notification |
| 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 |
| status | SΣC | 0..1 | code | requested | active | error | off | entered-in-error Binding: SubscriptionStatusCodes (required): The status of a subscription at the time this notification was generated. |
| type | ?!SΣC | 1..1 | code | Set to "event-notification" Binding: SubscriptionNotificationType (required): The type of notification represented by the status message. |
| eventsSinceSubscriptionStart | Σ | 0..1 | integer64 | Events since the Subscription was created |
| notificationEvent | C | 0..* | BackboneElement | Detailed information about any events relevant to this notification |
| 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 |
| eventNumber | 1..1 | integer64 | Sequencing index of this event | |
| timestamp | S | 1..1 | instant | The instant this event occurred |
| focus | S | 0..1 | Reference(RTLS Tag Device Profile) | Reference to the primary resource or information of this event |
| additionalContext | 0..* | Reference(Resource) | References related to the focus resource and/or context of this event | |
| subscription | SΣ | 1..1 | Reference(Subscription) | Reference to the rtlsSubscription resource responsible for this notification (http://hl7.org/fhir/uv/rtls/StructureDefinition/rtlsSubscription). |
| topic | SΣ | 0..1 | canonical(SubscriptionTopic) | Reference to the rtlsSbuscriptionTopic resource this notification relates to (http://hl7.org/fhir/uv/rtls/StructureDefinition/rtlsSubscriptionTopic). |
| error | Σ | 0..* | CodeableConcept | List of errors on the subscription Binding: SubscriptionErrorCodes (example): Codes to represent subscription error details. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| SubscriptionStatus.language | required | AllLanguages |
| SubscriptionStatus.status | required | SubscriptionStatusCodes |
| SubscriptionStatus.type | required | SubscriptionNotificationType |
| SubscriptionStatus.error | example | SubscriptionErrorCodes |
| 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 SubscriptionStatus
Differential View
This structure is derived from SubscriptionStatus
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| SubscriptionStatus | 0..* | SubscriptionStatus | Status information about a Subscription provided during event notification | |
| status | S | 0..1 | code | requested | active | error | off | entered-in-error |
| type | S | 1..1 | code | Set to "event-notification" |
| notificationEvent | ||||
| timestamp | S | 1..1 | instant | The instant this event occurred |
| focus | S | 0..1 | Reference(RTLS Tag Device Profile) | Reference to the primary resource or information of this event |
| subscription | S | 1..1 | Reference(Subscription) | Reference to the rtlsSubscription resource responsible for this notification (http://hl7.org/fhir/uv/rtls/StructureDefinition/rtlsSubscription). |
| topic | S | 0..1 | canonical(SubscriptionTopic) | Reference to the rtlsSbuscriptionTopic resource this notification relates to (http://hl7.org/fhir/uv/rtls/StructureDefinition/rtlsSubscriptionTopic). |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| SubscriptionStatus | C | 0..* | SubscriptionStatus | Status information about a Subscription provided during event notification |
| 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 |
| status | SΣC | 0..1 | code | requested | active | error | off | entered-in-error Binding: SubscriptionStatusCodes (required): The status of a subscription at the time this notification was generated. |
| type | ?!SΣC | 1..1 | code | Set to "event-notification" Binding: SubscriptionNotificationType (required): The type of notification represented by the status message. |
| notificationEvent | C | 0..* | BackboneElement | Detailed information about any events relevant to this notification |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| eventNumber | 1..1 | integer64 | Sequencing index of this event | |
| timestamp | S | 1..1 | instant | The instant this event occurred |
| focus | S | 0..1 | Reference(RTLS Tag Device Profile) | Reference to the primary resource or information of this event |
| subscription | SΣ | 1..1 | Reference(Subscription) | Reference to the rtlsSubscription resource responsible for this notification (http://hl7.org/fhir/uv/rtls/StructureDefinition/rtlsSubscription). |
| topic | SΣ | 0..1 | canonical(SubscriptionTopic) | Reference to the rtlsSbuscriptionTopic resource this notification relates to (http://hl7.org/fhir/uv/rtls/StructureDefinition/rtlsSubscriptionTopic). |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| SubscriptionStatus.status | required | SubscriptionStatusCodes |
| SubscriptionStatus.type | required | SubscriptionNotificationType |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | SubscriptionStatus | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | SubscriptionStatus | 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 | SubscriptionStatus | 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 | SubscriptionStatus | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | SubscriptionStatus | 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() | |
| sst-1 | error | SubscriptionStatus | Event notifications must contain events : (type = 'event-notification' or type = 'query-event') implies notificationEvent.exists() | |
| sst-2 | error | SubscriptionStatus | Status messages must contain status : type = 'query-status' implies status.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| SubscriptionStatus | C | 0..* | SubscriptionStatus | Status information about a Subscription provided during event notification |
| 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 |
| status | SΣC | 0..1 | code | requested | active | error | off | entered-in-error Binding: SubscriptionStatusCodes (required): The status of a subscription at the time this notification was generated. |
| type | ?!SΣC | 1..1 | code | Set to "event-notification" Binding: SubscriptionNotificationType (required): The type of notification represented by the status message. |
| eventsSinceSubscriptionStart | Σ | 0..1 | integer64 | Events since the Subscription was created |
| notificationEvent | C | 0..* | BackboneElement | Detailed information about any events relevant to this notification |
| 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 |
| eventNumber | 1..1 | integer64 | Sequencing index of this event | |
| timestamp | S | 1..1 | instant | The instant this event occurred |
| focus | S | 0..1 | Reference(RTLS Tag Device Profile) | Reference to the primary resource or information of this event |
| additionalContext | 0..* | Reference(Resource) | References related to the focus resource and/or context of this event | |
| subscription | SΣ | 1..1 | Reference(Subscription) | Reference to the rtlsSubscription resource responsible for this notification (http://hl7.org/fhir/uv/rtls/StructureDefinition/rtlsSubscription). |
| topic | SΣ | 0..1 | canonical(SubscriptionTopic) | Reference to the rtlsSbuscriptionTopic resource this notification relates to (http://hl7.org/fhir/uv/rtls/StructureDefinition/rtlsSubscriptionTopic). |
| error | Σ | 0..* | CodeableConcept | List of errors on the subscription Binding: SubscriptionErrorCodes (example): Codes to represent subscription error details. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| SubscriptionStatus.language | required | AllLanguages |
| SubscriptionStatus.status | required | SubscriptionStatusCodes |
| SubscriptionStatus.type | required | SubscriptionNotificationType |
| SubscriptionStatus.error | example | SubscriptionErrorCodes |
| 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 SubscriptionStatus
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