Real Time Location Services Implementation Guide
1.0.0-ballot - CI Build International flag

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

Resource Profile: RTLS Subscription Topic Profile ( Experimental )

Official URL: http://hl7.org/fhir/uv/rtls/StructureDefinition/rtlsSubscriptionTopic Version: 1.0.0-ballot
Standards status: Informative Computable Name: RTLSSubscriptionTopic

SubscriptionTopic resource used in RTLS workflows

This profile defines minimum expectations for defined subscription topics by a RTLS.

Usage:

Formal Views of Profile Content

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

This structure is derived from SubscriptionTopic

NameFlagsCard.TypeDescription & Constraintsdoco
.. SubscriptionTopic 0..*SubscriptionTopicThe definition of a specific topic for triggering events within the Subscriptions framework
... url S1..1uriCanonical identifier for this subscription topic, represented as an absolute URI (globally unique)
... status S1..1codedraft | active | retired | unknown
... effectivePeriod S0..1PeriodThe effective date range for the SubscriptionTopic
.... event S1..1CodeableConceptEvent which can trigger a notification from the SubscriptionTopic
Binding: RTLS Subscription Topic Events Valueset (extensible)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
SubscriptionTopic.eventTrigger.eventextensibleRTLSSubscriptionTopicEvents (a valid code from RTLS Subscription Events)
NameFlagsCard.TypeDescription & Constraintsdoco
.. SubscriptionTopic 0..*SubscriptionTopicThe definition of a specific topic for triggering events within the Subscriptions framework
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... contained 0..*ResourceContained, inline Resources
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... status ?!SΣ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... effectivePeriod SΣ0..1PeriodThe effective date range for the SubscriptionTopic
... eventTrigger SΣ1..*BackboneElementEvent definitions the SubscriptionTopic
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... event SΣ1..1CodeableConceptEvent which can trigger a notification from the SubscriptionTopic
Binding: RTLS Subscription Topic Events Valueset (extensible)
.... resource Σ1..1uriData Type or Resource (reference to definition) for this trigger definition
Binding: SubscriptionTypes (extensible): A type of resource, or a Reference (from all versions)


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
SubscriptionTopic.statusrequiredPublicationStatus
SubscriptionTopic.eventTrigger.eventextensibleRTLSSubscriptionTopicEvents (a valid code from RTLS Subscription Events)
SubscriptionTopic.eventTrigger.resourceextensibleSubscriptionTypes

Constraints

IdGradePath(s)DetailsRequirements
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()
NameFlagsCard.TypeDescription & Constraintsdoco
.. SubscriptionTopic 0..*SubscriptionTopicThe definition of a specific topic for triggering events within the Subscriptions framework
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: AllLanguages (required): IETF language tag for a human language

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... url SΣ1..1uriCanonical identifier for this subscription topic, represented as an absolute URI (globally unique)
... identifier Σ0..*IdentifierBusiness identifier for subscription topic
... version Σ0..1stringBusiness version of the subscription topic
... versionAlgorithm[x] Σ0..1How to compare versions
Binding: VersionAlgorithm (extensible)
.... versionAlgorithmStringstring
.... versionAlgorithmCodingCoding
... name Σ0..1stringName for this subscription topic (computer friendly)
... title Σ0..1stringName for this subscription topic (human friendly)
... derivedFrom Σ0..*canonical(SubscriptionTopic)Based on FHIR protocol or definition
... status ?!SΣ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental Σ0..1booleanIf for testing purposes, not real usage
... date Σ0..1dateTimeDate status first applied
... publisher Σ0..1stringThe name of the individual or organization that published the SubscriptionTopic
... contact Σ0..*ContactDetailContact details for the publisher
... description 0..1markdownNatural language description of the SubscriptionTopic
... useContext Σ0..*UsageContextContent intends to support these contexts
... jurisdiction ΣXD0..*CodeableConceptIntended jurisdiction of the SubscriptionTopic (if applicable)
Binding: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... purpose 0..1markdownWhy this SubscriptionTopic is defined
... copyright 0..1markdownUse and/or publishing restrictions
... copyrightLabel 0..1stringCopyright holder and year(s)
... approvalDate 0..1dateWhen SubscriptionTopic is/was approved by publisher
... lastReviewDate 0..1dateDate the Subscription Topic was last reviewed by the publisher
... effectivePeriod SΣ0..1PeriodThe effective date range for the SubscriptionTopic
... resourceTrigger Σ0..*BackboneElementDefinition of a resource-based trigger for the subscription topic
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... description Σ0..1markdownText representation of the resource trigger
.... resource Σ1..1uriData Type or Resource (reference to definition) for this trigger definition
Binding: SubscriptionTypes (extensible): A type of resource, or a Reference (from all versions)

.... supportedInteraction Σ0..*codecreate | update | delete
Binding: InteractionTrigger (required): FHIR RESTful interaction used to filter a resource-based SubscriptionTopic trigger.


.... queryCriteria Σ0..1BackboneElementQuery based trigger rule
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... previous Σ0..1stringRule applied to previous resource state
..... resultForCreate Σ0..1codetest-passes | test-fails
Binding: CriteriaNotExistsBehavior (required): Behavior a server can exhibit when a criteria state does not exist (e.g., state prior to a create or after a delete).

..... current Σ0..1stringRule applied to current resource state
..... resultForDelete Σ0..1codetest-passes | test-fails
Binding: CriteriaNotExistsBehavior (required): Behavior a server can exhibit when a criteria state does not exist (e.g., state prior to a create or after a delete).

..... requireBoth Σ0..1booleanBoth must be true flag
.... fhirPathCriteria Σ0..1stringFHIRPath based trigger rule
... eventTrigger SΣ1..*BackboneElementEvent definitions the SubscriptionTopic
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... description Σ0..1markdownText representation of the event trigger
.... event SΣ1..1CodeableConceptEvent which can trigger a notification from the SubscriptionTopic
Binding: RTLS Subscription Topic Events Valueset (extensible)
.... resource Σ1..1uriData Type or Resource (reference to definition) for this trigger definition
Binding: SubscriptionTypes (extensible): A type of resource, or a Reference (from all versions)

... canFilterBy Σ0..*BackboneElementProperties by which a Subscription can filter notifications from the SubscriptionTopic
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... description Σ0..1markdownDescription of this filter parameter
.... resource Σ0..1uriURL of the triggering Resource that this filter applies to
Binding: SubscriptionTypes (extensible): A type of resource, or a Reference (from all versions)

.... filterParameter Σ1..1stringHuman-readable and computation-friendly name for a filter parameter usable by subscriptions on this topic, via Subscription.filterBy.filterParameter
.... filterDefinition Σ0..1uriCanonical URL for a filterParameter definition
.... comparator 0..*codeeq | ne | gt | lt | ge | le | sa | eb | ap
Binding: SearchComparator (required): Search Comparator Codes supported in this filter.


.... modifier 0..*codemissing | exact | contains | not | text | in | not-in | below | above | type | identifier | of-type | code-text | text-advanced | iterate
Binding: SearchModifierCode (required): Search Modifier Codes supported in this filter.


... notificationShape Σ0..*BackboneElementProperties for describing the shape of notifications generated by this topic
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... resource Σ1..1uriURL of the Resource that is the focus (main) resource in a notification shape
Binding: SubscriptionTypes (extensible): A type of resource, or a Reference (from all versions)

.... include Σ0..*stringInclude directives, rooted in the resource for this shape
.... revInclude Σ0..*stringReverse include directives, rooted in the resource for this shape

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
SubscriptionTopic.languagerequiredAllLanguages
SubscriptionTopic.versionAlgorithm[x]extensibleVersionAlgorithm
SubscriptionTopic.statusrequiredPublicationStatus
SubscriptionTopic.jurisdictionextensibleJurisdictionValueSet
SubscriptionTopic.resourceTrigger.resourceextensibleSubscriptionTypes
SubscriptionTopic.resourceTrigger.supportedInteractionrequiredInteractionTrigger
SubscriptionTopic.resourceTrigger.queryCriteria.resultForCreaterequiredCriteriaNotExistsBehavior
SubscriptionTopic.resourceTrigger.queryCriteria.resultForDeleterequiredCriteriaNotExistsBehavior
SubscriptionTopic.eventTrigger.eventextensibleRTLSSubscriptionTopicEvents (a valid code from RTLS Subscription Events)
SubscriptionTopic.eventTrigger.resourceextensibleSubscriptionTypes
SubscriptionTopic.canFilterBy.resourceextensibleSubscriptionTypes
SubscriptionTopic.canFilterBy.comparatorrequiredSearchComparator
SubscriptionTopic.canFilterBy.modifierrequiredSearchModifierCode
SubscriptionTopic.notificationShape.resourceextensibleSubscriptionTypes

Constraints

IdGradePath(s)DetailsRequirements
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 SubscriptionTopic

Summary

Mandatory: 1 element
Must-Support: 5 elements

Differential View

This structure is derived from SubscriptionTopic

NameFlagsCard.TypeDescription & Constraintsdoco
.. SubscriptionTopic 0..*SubscriptionTopicThe definition of a specific topic for triggering events within the Subscriptions framework
... url S1..1uriCanonical identifier for this subscription topic, represented as an absolute URI (globally unique)
... status S1..1codedraft | active | retired | unknown
... effectivePeriod S0..1PeriodThe effective date range for the SubscriptionTopic
.... event S1..1CodeableConceptEvent which can trigger a notification from the SubscriptionTopic
Binding: RTLS Subscription Topic Events Valueset (extensible)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
SubscriptionTopic.eventTrigger.eventextensibleRTLSSubscriptionTopicEvents (a valid code from RTLS Subscription Events)

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. SubscriptionTopic 0..*SubscriptionTopicThe definition of a specific topic for triggering events within the Subscriptions framework
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... contained 0..*ResourceContained, inline Resources
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... status ?!SΣ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... effectivePeriod SΣ0..1PeriodThe effective date range for the SubscriptionTopic
... eventTrigger SΣ1..*BackboneElementEvent definitions the SubscriptionTopic
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... event SΣ1..1CodeableConceptEvent which can trigger a notification from the SubscriptionTopic
Binding: RTLS Subscription Topic Events Valueset (extensible)
.... resource Σ1..1uriData Type or Resource (reference to definition) for this trigger definition
Binding: SubscriptionTypes (extensible): A type of resource, or a Reference (from all versions)


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
SubscriptionTopic.statusrequiredPublicationStatus
SubscriptionTopic.eventTrigger.eventextensibleRTLSSubscriptionTopicEvents (a valid code from RTLS Subscription Events)
SubscriptionTopic.eventTrigger.resourceextensibleSubscriptionTypes

Constraints

IdGradePath(s)DetailsRequirements
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()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. SubscriptionTopic 0..*SubscriptionTopicThe definition of a specific topic for triggering events within the Subscriptions framework
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: AllLanguages (required): IETF language tag for a human language

... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... url SΣ1..1uriCanonical identifier for this subscription topic, represented as an absolute URI (globally unique)
... identifier Σ0..*IdentifierBusiness identifier for subscription topic
... version Σ0..1stringBusiness version of the subscription topic
... versionAlgorithm[x] Σ0..1How to compare versions
Binding: VersionAlgorithm (extensible)
.... versionAlgorithmStringstring
.... versionAlgorithmCodingCoding
... name Σ0..1stringName for this subscription topic (computer friendly)
... title Σ0..1stringName for this subscription topic (human friendly)
... derivedFrom Σ0..*canonical(SubscriptionTopic)Based on FHIR protocol or definition
... status ?!SΣ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental Σ0..1booleanIf for testing purposes, not real usage
... date Σ0..1dateTimeDate status first applied
... publisher Σ0..1stringThe name of the individual or organization that published the SubscriptionTopic
... contact Σ0..*ContactDetailContact details for the publisher
... description 0..1markdownNatural language description of the SubscriptionTopic
... useContext Σ0..*UsageContextContent intends to support these contexts
... jurisdiction ΣXD0..*CodeableConceptIntended jurisdiction of the SubscriptionTopic (if applicable)
Binding: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... purpose 0..1markdownWhy this SubscriptionTopic is defined
... copyright 0..1markdownUse and/or publishing restrictions
... copyrightLabel 0..1stringCopyright holder and year(s)
... approvalDate 0..1dateWhen SubscriptionTopic is/was approved by publisher
... lastReviewDate 0..1dateDate the Subscription Topic was last reviewed by the publisher
... effectivePeriod SΣ0..1PeriodThe effective date range for the SubscriptionTopic
... resourceTrigger Σ0..*BackboneElementDefinition of a resource-based trigger for the subscription topic
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... description Σ0..1markdownText representation of the resource trigger
.... resource Σ1..1uriData Type or Resource (reference to definition) for this trigger definition
Binding: SubscriptionTypes (extensible): A type of resource, or a Reference (from all versions)

.... supportedInteraction Σ0..*codecreate | update | delete
Binding: InteractionTrigger (required): FHIR RESTful interaction used to filter a resource-based SubscriptionTopic trigger.


.... queryCriteria Σ0..1BackboneElementQuery based trigger rule
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... previous Σ0..1stringRule applied to previous resource state
..... resultForCreate Σ0..1codetest-passes | test-fails
Binding: CriteriaNotExistsBehavior (required): Behavior a server can exhibit when a criteria state does not exist (e.g., state prior to a create or after a delete).

..... current Σ0..1stringRule applied to current resource state
..... resultForDelete Σ0..1codetest-passes | test-fails
Binding: CriteriaNotExistsBehavior (required): Behavior a server can exhibit when a criteria state does not exist (e.g., state prior to a create or after a delete).

..... requireBoth Σ0..1booleanBoth must be true flag
.... fhirPathCriteria Σ0..1stringFHIRPath based trigger rule
... eventTrigger SΣ1..*BackboneElementEvent definitions the SubscriptionTopic
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... description Σ0..1markdownText representation of the event trigger
.... event SΣ1..1CodeableConceptEvent which can trigger a notification from the SubscriptionTopic
Binding: RTLS Subscription Topic Events Valueset (extensible)
.... resource Σ1..1uriData Type or Resource (reference to definition) for this trigger definition
Binding: SubscriptionTypes (extensible): A type of resource, or a Reference (from all versions)

... canFilterBy Σ0..*BackboneElementProperties by which a Subscription can filter notifications from the SubscriptionTopic
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... description Σ0..1markdownDescription of this filter parameter
.... resource Σ0..1uriURL of the triggering Resource that this filter applies to
Binding: SubscriptionTypes (extensible): A type of resource, or a Reference (from all versions)

.... filterParameter Σ1..1stringHuman-readable and computation-friendly name for a filter parameter usable by subscriptions on this topic, via Subscription.filterBy.filterParameter
.... filterDefinition Σ0..1uriCanonical URL for a filterParameter definition
.... comparator 0..*codeeq | ne | gt | lt | ge | le | sa | eb | ap
Binding: SearchComparator (required): Search Comparator Codes supported in this filter.


.... modifier 0..*codemissing | exact | contains | not | text | in | not-in | below | above | type | identifier | of-type | code-text | text-advanced | iterate
Binding: SearchModifierCode (required): Search Modifier Codes supported in this filter.


... notificationShape Σ0..*BackboneElementProperties for describing the shape of notifications generated by this topic
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... resource Σ1..1uriURL of the Resource that is the focus (main) resource in a notification shape
Binding: SubscriptionTypes (extensible): A type of resource, or a Reference (from all versions)

.... include Σ0..*stringInclude directives, rooted in the resource for this shape
.... revInclude Σ0..*stringReverse include directives, rooted in the resource for this shape

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
SubscriptionTopic.languagerequiredAllLanguages
SubscriptionTopic.versionAlgorithm[x]extensibleVersionAlgorithm
SubscriptionTopic.statusrequiredPublicationStatus
SubscriptionTopic.jurisdictionextensibleJurisdictionValueSet
SubscriptionTopic.resourceTrigger.resourceextensibleSubscriptionTypes
SubscriptionTopic.resourceTrigger.supportedInteractionrequiredInteractionTrigger
SubscriptionTopic.resourceTrigger.queryCriteria.resultForCreaterequiredCriteriaNotExistsBehavior
SubscriptionTopic.resourceTrigger.queryCriteria.resultForDeleterequiredCriteriaNotExistsBehavior
SubscriptionTopic.eventTrigger.eventextensibleRTLSSubscriptionTopicEvents (a valid code from RTLS Subscription Events)
SubscriptionTopic.eventTrigger.resourceextensibleSubscriptionTypes
SubscriptionTopic.canFilterBy.resourceextensibleSubscriptionTypes
SubscriptionTopic.canFilterBy.comparatorrequiredSearchComparator
SubscriptionTopic.canFilterBy.modifierrequiredSearchModifierCode
SubscriptionTopic.notificationShape.resourceextensibleSubscriptionTypes

Constraints

IdGradePath(s)DetailsRequirements
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 SubscriptionTopic

Summary

Mandatory: 1 element
Must-Support: 5 elements

 

Other representations of profile: CSV, Excel, Schematron