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/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:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from SubscriptionTopic
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
SubscriptionTopic | 0..* | SubscriptionTopic | The definition of a specific topic for triggering events within the Subscriptions framework | |
url | S | 1..1 | uri | Canonical identifier for this subscription topic, represented as an absolute URI (globally unique) |
status | S | 1..1 | code | draft | active | retired | unknown |
effectivePeriod | S | 0..1 | Period | The effective date range for the SubscriptionTopic |
eventTrigger | S | 1..* | BackboneElement | Event definitions the SubscriptionTopic |
event | S | 1..1 | CodeableConcept | Event which can trigger a notification from the SubscriptionTopic Binding: RTLS Subscription Topic Events Valueset (extensible) |
Documentation for this format |
Path | Conformance | ValueSet |
SubscriptionTopic.eventTrigger.event | extensible | RTLSSubscriptionTopicEvents (a valid code from RTLS Subscription Events) |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
SubscriptionTopic | 0..* | SubscriptionTopic | The definition of a specific topic for triggering events within the Subscriptions framework | |
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 |
url | SΣ | 1..1 | uri | Canonical identifier for this subscription topic, represented as an absolute URI (globally unique) |
status | ?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
effectivePeriod | SΣ | 0..1 | Period | The effective date range for the SubscriptionTopic |
eventTrigger | SΣ | 1..* | BackboneElement | Event definitions the SubscriptionTopic |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
event | SΣ | 1..1 | CodeableConcept | Event which can trigger a notification from the SubscriptionTopic Binding: RTLS Subscription Topic Events Valueset (extensible) |
resource | Σ | 1..1 | uri | Data Type or Resource (reference to definition) for this trigger definition Binding: SubscriptionTypes (extensible): A type of resource, or a Reference (from all versions) |
Documentation for this format |
Path | Conformance | ValueSet |
SubscriptionTopic.status | required | PublicationStatus |
SubscriptionTopic.eventTrigger.event | extensible | RTLSSubscriptionTopicEvents (a valid code from RTLS Subscription Events) |
SubscriptionTopic.eventTrigger.resource | extensible | SubscriptionTypes |
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() |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
SubscriptionTopic | 0..* | SubscriptionTopic | The definition of a specific topic for triggering events within the Subscriptions framework | |
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 |
url | SΣ | 1..1 | uri | Canonical identifier for this subscription topic, represented as an absolute URI (globally unique) |
identifier | Σ | 0..* | Identifier | Business identifier for subscription topic |
version | Σ | 0..1 | string | Business version of the subscription topic |
versionAlgorithm[x] | Σ | 0..1 | How to compare versions Binding: VersionAlgorithm (extensible) | |
versionAlgorithmString | string | |||
versionAlgorithmCoding | Coding | |||
name | Σ | 0..1 | string | Name for this subscription topic (computer friendly) |
title | Σ | 0..1 | string | Name for this subscription topic (human friendly) |
derivedFrom | Σ | 0..* | canonical(SubscriptionTopic) | Based on FHIR protocol or definition |
status | ?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
experimental | Σ | 0..1 | boolean | If for testing purposes, not real usage |
date | Σ | 0..1 | dateTime | Date status first applied |
publisher | Σ | 0..1 | string | The name of the individual or organization that published the SubscriptionTopic |
contact | Σ | 0..* | ContactDetail | Contact details for the publisher |
description | 0..1 | markdown | Natural language description of the SubscriptionTopic | |
useContext | Σ | 0..* | UsageContext | Content intends to support these contexts |
jurisdiction | ΣXD | 0..* | CodeableConcept | Intended jurisdiction of the SubscriptionTopic (if applicable) Binding: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use. |
purpose | 0..1 | markdown | Why this SubscriptionTopic is defined | |
copyright | 0..1 | markdown | Use and/or publishing restrictions | |
copyrightLabel | 0..1 | string | Copyright holder and year(s) | |
approvalDate | 0..1 | date | When SubscriptionTopic is/was approved by publisher | |
lastReviewDate | 0..1 | date | Date the Subscription Topic was last reviewed by the publisher | |
effectivePeriod | SΣ | 0..1 | Period | The effective date range for the SubscriptionTopic |
resourceTrigger | Σ | 0..* | BackboneElement | Definition of a resource-based trigger for the subscription topic |
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 |
description | Σ | 0..1 | markdown | Text representation of the resource trigger |
resource | Σ | 1..1 | uri | Data 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..* | code | create | update | delete Binding: InteractionTrigger (required): FHIR RESTful interaction used to filter a resource-based SubscriptionTopic trigger. |
queryCriteria | Σ | 0..1 | BackboneElement | Query based trigger rule |
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 |
previous | Σ | 0..1 | string | Rule applied to previous resource state |
resultForCreate | Σ | 0..1 | code | test-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..1 | string | Rule applied to current resource state |
resultForDelete | Σ | 0..1 | code | test-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..1 | boolean | Both must be true flag |
fhirPathCriteria | Σ | 0..1 | string | FHIRPath based trigger rule |
eventTrigger | SΣ | 1..* | BackboneElement | Event definitions the SubscriptionTopic |
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 |
description | Σ | 0..1 | markdown | Text representation of the event trigger |
event | SΣ | 1..1 | CodeableConcept | Event which can trigger a notification from the SubscriptionTopic Binding: RTLS Subscription Topic Events Valueset (extensible) |
resource | Σ | 1..1 | uri | Data 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..* | BackboneElement | Properties by which a Subscription can filter notifications from the SubscriptionTopic |
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 |
description | Σ | 0..1 | markdown | Description of this filter parameter |
resource | Σ | 0..1 | uri | URL of the triggering Resource that this filter applies to Binding: SubscriptionTypes (extensible): A type of resource, or a Reference (from all versions) |
filterParameter | Σ | 1..1 | string | Human-readable and computation-friendly name for a filter parameter usable by subscriptions on this topic, via Subscription.filterBy.filterParameter |
filterDefinition | Σ | 0..1 | uri | Canonical URL for a filterParameter definition |
comparator | 0..* | code | eq | ne | gt | lt | ge | le | sa | eb | ap Binding: SearchComparator (required): Search Comparator Codes supported in this filter. | |
modifier | 0..* | code | missing | 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..* | BackboneElement | Properties for describing the shape of notifications generated by this topic |
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 |
resource | Σ | 1..1 | uri | URL 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..* | string | Include directives, rooted in the resource for this shape |
revInclude | Σ | 0..* | string | Reverse include directives, rooted in the resource for this shape |
Documentation for this format |
Path | Conformance | ValueSet |
SubscriptionTopic.language | required | AllLanguages |
SubscriptionTopic.versionAlgorithm[x] | extensible | VersionAlgorithm |
SubscriptionTopic.status | required | PublicationStatus |
SubscriptionTopic.jurisdiction | extensible | JurisdictionValueSet |
SubscriptionTopic.resourceTrigger.resource | extensible | SubscriptionTypes |
SubscriptionTopic.resourceTrigger.supportedInteraction | required | InteractionTrigger |
SubscriptionTopic.resourceTrigger.queryCriteria.resultForCreate | required | CriteriaNotExistsBehavior |
SubscriptionTopic.resourceTrigger.queryCriteria.resultForDelete | required | CriteriaNotExistsBehavior |
SubscriptionTopic.eventTrigger.event | extensible | RTLSSubscriptionTopicEvents (a valid code from RTLS Subscription Events) |
SubscriptionTopic.eventTrigger.resource | extensible | SubscriptionTypes |
SubscriptionTopic.canFilterBy.resource | extensible | SubscriptionTypes |
SubscriptionTopic.canFilterBy.comparator | required | SearchComparator |
SubscriptionTopic.canFilterBy.modifier | required | SearchModifierCode |
SubscriptionTopic.notificationShape.resource | extensible | SubscriptionTypes |
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 SubscriptionTopic
Differential View
This structure is derived from SubscriptionTopic
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
SubscriptionTopic | 0..* | SubscriptionTopic | The definition of a specific topic for triggering events within the Subscriptions framework | |
url | S | 1..1 | uri | Canonical identifier for this subscription topic, represented as an absolute URI (globally unique) |
status | S | 1..1 | code | draft | active | retired | unknown |
effectivePeriod | S | 0..1 | Period | The effective date range for the SubscriptionTopic |
eventTrigger | S | 1..* | BackboneElement | Event definitions the SubscriptionTopic |
event | S | 1..1 | CodeableConcept | Event which can trigger a notification from the SubscriptionTopic Binding: RTLS Subscription Topic Events Valueset (extensible) |
Documentation for this format |
Path | Conformance | ValueSet |
SubscriptionTopic.eventTrigger.event | extensible | RTLSSubscriptionTopicEvents (a valid code from RTLS Subscription Events) |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
SubscriptionTopic | 0..* | SubscriptionTopic | The definition of a specific topic for triggering events within the Subscriptions framework | |
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 |
url | SΣ | 1..1 | uri | Canonical identifier for this subscription topic, represented as an absolute URI (globally unique) |
status | ?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
effectivePeriod | SΣ | 0..1 | Period | The effective date range for the SubscriptionTopic |
eventTrigger | SΣ | 1..* | BackboneElement | Event definitions the SubscriptionTopic |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
event | SΣ | 1..1 | CodeableConcept | Event which can trigger a notification from the SubscriptionTopic Binding: RTLS Subscription Topic Events Valueset (extensible) |
resource | Σ | 1..1 | uri | Data Type or Resource (reference to definition) for this trigger definition Binding: SubscriptionTypes (extensible): A type of resource, or a Reference (from all versions) |
Documentation for this format |
Path | Conformance | ValueSet |
SubscriptionTopic.status | required | PublicationStatus |
SubscriptionTopic.eventTrigger.event | extensible | RTLSSubscriptionTopicEvents (a valid code from RTLS Subscription Events) |
SubscriptionTopic.eventTrigger.resource | extensible | SubscriptionTypes |
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() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
SubscriptionTopic | 0..* | SubscriptionTopic | The definition of a specific topic for triggering events within the Subscriptions framework | |
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 |
url | SΣ | 1..1 | uri | Canonical identifier for this subscription topic, represented as an absolute URI (globally unique) |
identifier | Σ | 0..* | Identifier | Business identifier for subscription topic |
version | Σ | 0..1 | string | Business version of the subscription topic |
versionAlgorithm[x] | Σ | 0..1 | How to compare versions Binding: VersionAlgorithm (extensible) | |
versionAlgorithmString | string | |||
versionAlgorithmCoding | Coding | |||
name | Σ | 0..1 | string | Name for this subscription topic (computer friendly) |
title | Σ | 0..1 | string | Name for this subscription topic (human friendly) |
derivedFrom | Σ | 0..* | canonical(SubscriptionTopic) | Based on FHIR protocol or definition |
status | ?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
experimental | Σ | 0..1 | boolean | If for testing purposes, not real usage |
date | Σ | 0..1 | dateTime | Date status first applied |
publisher | Σ | 0..1 | string | The name of the individual or organization that published the SubscriptionTopic |
contact | Σ | 0..* | ContactDetail | Contact details for the publisher |
description | 0..1 | markdown | Natural language description of the SubscriptionTopic | |
useContext | Σ | 0..* | UsageContext | Content intends to support these contexts |
jurisdiction | ΣXD | 0..* | CodeableConcept | Intended jurisdiction of the SubscriptionTopic (if applicable) Binding: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use. |
purpose | 0..1 | markdown | Why this SubscriptionTopic is defined | |
copyright | 0..1 | markdown | Use and/or publishing restrictions | |
copyrightLabel | 0..1 | string | Copyright holder and year(s) | |
approvalDate | 0..1 | date | When SubscriptionTopic is/was approved by publisher | |
lastReviewDate | 0..1 | date | Date the Subscription Topic was last reviewed by the publisher | |
effectivePeriod | SΣ | 0..1 | Period | The effective date range for the SubscriptionTopic |
resourceTrigger | Σ | 0..* | BackboneElement | Definition of a resource-based trigger for the subscription topic |
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 |
description | Σ | 0..1 | markdown | Text representation of the resource trigger |
resource | Σ | 1..1 | uri | Data 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..* | code | create | update | delete Binding: InteractionTrigger (required): FHIR RESTful interaction used to filter a resource-based SubscriptionTopic trigger. |
queryCriteria | Σ | 0..1 | BackboneElement | Query based trigger rule |
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 |
previous | Σ | 0..1 | string | Rule applied to previous resource state |
resultForCreate | Σ | 0..1 | code | test-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..1 | string | Rule applied to current resource state |
resultForDelete | Σ | 0..1 | code | test-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..1 | boolean | Both must be true flag |
fhirPathCriteria | Σ | 0..1 | string | FHIRPath based trigger rule |
eventTrigger | SΣ | 1..* | BackboneElement | Event definitions the SubscriptionTopic |
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 |
description | Σ | 0..1 | markdown | Text representation of the event trigger |
event | SΣ | 1..1 | CodeableConcept | Event which can trigger a notification from the SubscriptionTopic Binding: RTLS Subscription Topic Events Valueset (extensible) |
resource | Σ | 1..1 | uri | Data 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..* | BackboneElement | Properties by which a Subscription can filter notifications from the SubscriptionTopic |
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 |
description | Σ | 0..1 | markdown | Description of this filter parameter |
resource | Σ | 0..1 | uri | URL of the triggering Resource that this filter applies to Binding: SubscriptionTypes (extensible): A type of resource, or a Reference (from all versions) |
filterParameter | Σ | 1..1 | string | Human-readable and computation-friendly name for a filter parameter usable by subscriptions on this topic, via Subscription.filterBy.filterParameter |
filterDefinition | Σ | 0..1 | uri | Canonical URL for a filterParameter definition |
comparator | 0..* | code | eq | ne | gt | lt | ge | le | sa | eb | ap Binding: SearchComparator (required): Search Comparator Codes supported in this filter. | |
modifier | 0..* | code | missing | 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..* | BackboneElement | Properties for describing the shape of notifications generated by this topic |
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 |
resource | Σ | 1..1 | uri | URL 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..* | string | Include directives, rooted in the resource for this shape |
revInclude | Σ | 0..* | string | Reverse include directives, rooted in the resource for this shape |
Documentation for this format |
Path | Conformance | ValueSet |
SubscriptionTopic.language | required | AllLanguages |
SubscriptionTopic.versionAlgorithm[x] | extensible | VersionAlgorithm |
SubscriptionTopic.status | required | PublicationStatus |
SubscriptionTopic.jurisdiction | extensible | JurisdictionValueSet |
SubscriptionTopic.resourceTrigger.resource | extensible | SubscriptionTypes |
SubscriptionTopic.resourceTrigger.supportedInteraction | required | InteractionTrigger |
SubscriptionTopic.resourceTrigger.queryCriteria.resultForCreate | required | CriteriaNotExistsBehavior |
SubscriptionTopic.resourceTrigger.queryCriteria.resultForDelete | required | CriteriaNotExistsBehavior |
SubscriptionTopic.eventTrigger.event | extensible | RTLSSubscriptionTopicEvents (a valid code from RTLS Subscription Events) |
SubscriptionTopic.eventTrigger.resource | extensible | SubscriptionTypes |
SubscriptionTopic.canFilterBy.resource | extensible | SubscriptionTypes |
SubscriptionTopic.canFilterBy.comparator | required | SearchComparator |
SubscriptionTopic.canFilterBy.modifier | required | SearchModifierCode |
SubscriptionTopic.notificationShape.resource | extensible | SubscriptionTypes |
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 SubscriptionTopic
Other representations of profile: CSV, Excel, Schematron