type: resource-definitionsresource: SubscriptionTopic

SubscriptionTopic Definitions

SubscriptionTopic

The definition of a specific topic for triggering events within the Subscriptions framework

Definition: Describes a stream of resource state changes or events and annotated with labels useful to filter projections from this topic.

Cardinality: 0..*

Mappings: workflow=Definition; rim=Act[moodCode<=DEFN]; w5=infrastructure.exchange

SubscriptionTopic.url

Canonical identifier for this subscription topic, represented as an absolute URI (globally unique)

Definition: An absolute URI that is used to identify this subscription topic when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this subscription topic is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the subscription topic is stored on different servers.

Comments: Can be a urn:uuid: or a urn:oid: but real http/s: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.

The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions.

In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found.

When this is a locally defined topic or derived from a topic defined in the FHIR spec or an IG, this uniquely identifies the topic and functionality. Ideally this URL resolves to documentation about the use cases.

When this is a topic derived from another topic (e.g., it adds additional filters or functionality to a topic defined in an IG), then this URL should be different than the base and the derivedFromCanonical should be filled out with the unique uri as defined in the IG.

When this is a direct implementation from another IG or registered topic (with no additional filters, etc., so not derived), then this url is the unique url for this topic as defined by the IG.

Requirements: Allows the subscription topic to be referenced by a single globally unique identifier.

Cardinality: 1..1

Type: uri

Summary: true

Mappings: workflow=Definition.url; w5=FiveWs.identifier; rim=.identifier

SubscriptionTopic.identifier

Business identifier for subscription topic

Definition: Business identifiers assigned to this subscription topic by the performer and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server.

Comments: Note: This is a business identifier, not a resource identifier (see discussion). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.

Requirements: Allows identification of the subscription topic as it is known by various participating systems and in a way that remains consistent across servers.

Cardinality: 0..*

Type: Identifier

Summary: true

Mappings: workflow=Definition.identifier; w5=FiveWs.identifier; rim=.identifier

SubscriptionTopic.version

Business version of the subscription topic

Definition: The identifier that is used to identify this version of the subscription topic when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the Topic author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions are orderable.

Comments: There may be multiple different instances of a subscription topic that have the same identifier but different versions.

Cardinality: 0..1

Type: string

Summary: true

Mappings: workflow=Definition.version; w5=FiveWs.version; rim=N/A (to add?)

SubscriptionTopic.versionAlgorithm[x]

How to compare versions

Definition: Indicates the mechanism used to compare versions to determine which is more current.

Comments: If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined.

Cardinality: 0..1

Type: string, Coding

Binding: extensible:version-algorithm

Summary: true

Mappings: workflow=Definition.versionAlgorithm

SubscriptionTopic.name

Name for this subscription topic (computer friendly)

Definition: A natural language name identifying the subscription topic This name should be usable as an identifier for the module by machine processing applications such as code generation.

Comments: The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.

Requirements: Support human navigation and code generation.

Cardinality: 0..1

Type: string

Summary: true

Mappings: workflow=Definition.name

SubscriptionTopic.title

Name for this subscription topic (human friendly)

Definition: A short, descriptive, user-friendly title for the subscription topic. For example, "admission".

Comments: This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.

Aliases: Name, SubscriptionTopic Name

Cardinality: 0..1

Type: string

Summary: true

Mappings: workflow=Definition.title; rim=.title

SubscriptionTopic.derivedFrom

Based on FHIR protocol or definition

Definition: The canonical URL pointing to another FHIR-defined SubscriptionTopic that is adhered to in whole or in part by this SubscriptionTopic.

Requirements: SubscriptionTopics may be refinements of more generic topics.

Cardinality: 0..*

Type: canonical

Summary: true

Mappings: workflow=Definition.derivedFromCanonical; v2=Varies by domain; rim=.outboundRelationship[typeCode=DEFN].target

SubscriptionTopic.status

draft | active | retired | unknown

Definition: The current state of the SubscriptionTopic.

Comments: A nominal state-transition diagram can be found in the Definition pattern documentation

Unknown does not represent "other" - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is.

See guidance around (not) making local changes to elements here.

Cardinality: 1..1

Type: code

Binding: required:publication-status

Summary: true

Is Modifier: true (Reason: This is labeled as "Is Modifier" because applications should not use a retired SubscriptionTopic without due consideration)

Mappings: workflow=Definition.status; w5=FiveWs.status; rim=.status

SubscriptionTopic.experimental

If For testing only - never for real usage

Definition: A flag to indicate that this TopSubscriptionTopicic is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.

Comments: Allows filtering of SubscriptionTopic that are appropriate for use vs. not. Experimental resources might include example instances in implementation guides, instances created solely for testing purposes, etc. If experimental is 'true' for any version of a resource, it should be true for all versions of the resource. (If experimental changes, then it is being misused or a resource that was never intended for real-world use has unexpectedly changed its purpose.).

Experimental resources are not expected to be stable and may well have breaking changes without a corresponding change to the 'version' element.

Requirements: Enables experimental content to be developed following the same life-cycle as a production-level SubscriptionTopic would.

Meaning if Missing: If absent, this resource is treated as though it is not experimental.

Cardinality: 0..1

Type: boolean

Summary: true

Mappings: workflow=Definition.experimental; w5=FiveWs.class; rim=N/A (to add?)

SubscriptionTopic.date

Date status first applied

Definition: The date (and optionally time) when the subscription topic was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the subscription topic changes.

Comments: See guidance around (not) making local changes to elements here.

Aliases: created

Cardinality: 0..1

Type: dateTime

Summary: true

Mappings: workflow=Definition.date; w5=FiveWs.recorded; rim=.participation[typeCode=AUT].time

SubscriptionTopic.publisher

The name of the individual or organization that published the SubscriptionTopic

Definition: Helps establish the "authority/credibility" of the SubscriptionTopic. May also allow for contact.

Requirements: Usually an organization, but may be an individual. The publisher (or steward) of the SubscriptionTopic is the organization or individual primarily responsible for the maintenance and upkeep of the Topic. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the Topic. This item SHOULD be populated unless the information is available from context.

Aliases: author

Cardinality: 0..1

Type: string

Summary: true

Mappings: workflow=Definition.publisher {as string instead of CodeableConcept}; w5=FiveWs.author; rim=.participation[typeCode=AUT].role

SubscriptionTopic.contact

Contact details for the publisher

Definition: Contact details to assist a user in finding and communicating with the publisher.

Comments: May be a web site, an email address, a telephone number, etc.

See guidance around (not) making local changes to elements here.

Cardinality: 0..*

Type: ContactDetail

Summary: true

Mappings: workflow=Definition.contact; rim=.participation[typeCode=CALLBCK].role

SubscriptionTopic.description

Natural language description of the SubscriptionTopic

Definition: A free text natural language description of the Topic from the consumer's perspective.

Comments: This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the module as conveyed in the text field of the resource itself. This item SHOULD be populated unless the information is available from context.

Cardinality: 0..1

Type: markdown

Mappings: workflow=Definition.description; rim=.text

SubscriptionTopic.useContext

Content intends to support these contexts

Definition: The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of code system definitions.

Comments: When multiple usageContexts are specified, there is no expectation for whether all or any of the contexts apply.

Requirements: Assist in searching for appropriate content.

Cardinality: 0..*

Type: UsageContext

Summary: true

Mappings: workflow=Definition.useContext; rim=N/A (to add?)

SubscriptionTopic.jurisdiction

Intended jurisdiction of the SubscriptionTopic (if applicable)

Definition: A jurisdiction in which the Topic is intended to be used.

Comments: DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.)

Cardinality: 0..*

Type: CodeableConcept

Binding: extensible:jurisdiction

Summary: true

Mappings: workflow=Definition.jurisdiction; rim=N/A (to add?)

SubscriptionTopic.purpose

Why this SubscriptionTopic is defined

Definition: Explains why this Topic is needed and why it has been designed as it has.

Comments: This element does not describe the usage of the Topic. Rather it is for traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this Topic.

Cardinality: 0..1

Type: markdown

Mappings: workflow=Definition.purpose; w5=FiveWs.why[x]; rim=.reasonCode.text

SubscriptionTopic.copyright

Notice about intellectual property ownership, can include restrictions on use

Definition: A copyright statement relating to the SubscriptionTopic and/or its contents. Copyright statements are notices of intellectual property ownership and can include restrictions on the use and publishing of the SubscriptionTopic.

Comments: ...

Requirements: Consumers of the TSubscriptionTopicopic must be able to determine any legal restrictions on the use of the artifact and/or its content.

Aliases: License, Restrictions

Cardinality: 0..1

Type: markdown

Mappings: workflow=Definition.copyright; rim=N/A (to add?)

SubscriptionTopic.copyrightLabel

Definition: A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are restricted. (e.g. 'All rights reserved', 'Some rights reserved').

Comments: The copyright symbol and the '(c)' textual representation SHOULD NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.

Requirements: Defines the content expected to be rendered in all representations of the artifact.

Cardinality: 0..1

Type: string

SubscriptionTopic.approvalDate

When SubscriptionTopic is/was approved by publisher

Definition: The date on which the asset content was approved by the publisher. Approval happens once when the content is officially approved for usage.

Comments: The date may be more recent than the approval date because of minor changes / editorial corrections.

Cardinality: 0..1

Type: date

Mappings: workflow=Definition.approvalDate; rim=.outboundRelationship[typeCode="SUBJ"].act[classCode=CACT;moodCode=EVN;code="approval"].effectiveTime

SubscriptionTopic.lastReviewDate

Date the Subscription Topic was last reviewed by the publisher

Definition: The date on which the asset content was last reviewed. Review happens periodically after that, but doesn't change the original approval date.

Comments: If specified, this is usually after the approval date.

Cardinality: 0..1

Type: date

Mappings: workflow=Definition.lastReviewDate; rim=.outboundRelationship[typeCode="SUBJ"; subsetCode="RECENT"].act[classCode=CACT;moodCode=EVN;code="review"].effectiveTime

SubscriptionTopic.effectivePeriod

The effective date range for the SubscriptionTopic

Definition: The period during which the SubscriptionTopic content was or is planned to be effective.

Comments: The effective period for a SubscriptionTopic determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 would be published in 2015.

Cardinality: 0..1

Type: Period

Summary: true

Mappings: workflow=Definition.effectivePeriod; rim=N/A (to add?)

SubscriptionTopic.trigger

Definition of a trigger for the subscription topic

Definition: A definition of a state change or event that triggers a notification based on the SubscriptionTopic. The criteria may be just a human readable description, or may contain a FHIRPath expression, query-based definition, or event coding. Multiple triggers are considered OR joined (e.g., an update matching ANY of the definitions will trigger a notification).

Cardinality: 0..*

Type: BackboneElement

Summary: true

Mappings: rim=N/A (to add?)

SubscriptionTopic.trigger.description

Text representation of the resource trigger

Definition: The human readable description of this trigger for the SubscriptionTopic - for example, "An Encounter enters the 'in-progress' state".

Comments: Implementation of particular subscription topics might not use a computable definition and instead base their design on the definition.

Cardinality: 0..1

Type: markdown

Summary: true

SubscriptionTopic.trigger.resource

Key Data Type, Resource (reference to definition), or relevant definition for this trigger

Definition: URL of the key definition that is relevant to this trigger. Relative URLs are relative to the StructureDefinition root of the implemented FHIR version (e.g., http://hl7.org/fhir/StructureDefinition). For example, "Patient" maps to http://hl7.org/fhir/StructureDefinition/Patient. For more information, see <a href="elementdefinition-definitions.html#ElementDefinition.type.code">ElementDefinition.type.code</a>.

Comments: Note that a query-based definition can only be applied if the resource is set to a FHIR resource. FHIRPath and event-based definitions have more flexibility outside of FHIR.

Cardinality: 1..1

Type: uri

Binding: extensible:subscription-types

Summary: true

SubscriptionTopic.trigger.supportedInteraction

create | update | delete

Definition: The FHIR RESTful interaction which can be used to trigger a notification for the SubscriptionTopic. Multiple values are considered OR joined (e.g., CREATE or UPDATE). If not present, all supported interactions are assumed.

Cardinality: 0..*

Type: code

Binding: required:interaction-trigger

Summary: true

SubscriptionTopic.trigger.queryCriteria

Query based trigger rule

Definition: The FHIR query based rules that the server should use to determine when to trigger a notification for this subscription topic.

Comments: For additional information about query criteria and their application, please see Query Trigger Definitions.

Cardinality: 0..1

Type: BackboneElement

Summary: true

SubscriptionTopic.trigger.queryCriteria.previous

Rule applied to previous resource state

Definition: The FHIR query based rules are applied to the previous resource state (e.g., state before an update).

Comments: The rules are search criteria (without the [base] part). Like Bundle.entry.request.url, it has no leading slash character (/).

Cardinality: 0..1

Type: string

Summary: true

SubscriptionTopic.trigger.queryCriteria.resultForCreate

test-passes | test-fails

Definition: For create interactions, should the previous criteria count as an automatic pass or an automatic fail. If not present, the testing behavior during create interactions is unspecified (server discretion).

Cardinality: 0..1

Type: code

Binding: required:subscriptiontopic-cr-behavior

Summary: true

SubscriptionTopic.trigger.queryCriteria.current

Rule applied to current resource state

Definition: The FHIR query based rules are applied to the current resource state (e.g., state after an update).

Comments: The rules are search criteria (without the [base] part). Like Bundle.entry.request.url, it has no leading slash character (/).

Cardinality: 0..1

Type: string

Summary: true

SubscriptionTopic.trigger.queryCriteria.resultForDelete

test-passes | test-fails

Definition: For 'delete' interactions, should the 'current' query criteria count as an automatic pass or an automatic fail. If not present, the testing behavior during delete interactions is unspecified (server discretion).

Cardinality: 0..1

Type: code

Binding: required:subscriptiontopic-cr-behavior

Summary: true

SubscriptionTopic.trigger.queryCriteria.requireBoth

Both must be true flag

Definition: If set to true, both the current and previous query criteria must evaluate true to trigger a notification for this topic. If set to false or not present, a notification for this topic will be triggered if either the current or previous tests evaluate to true.

Comments: Please note the interaction between this element and the resultForCreate/resultForDelete elements during create and delete interactions. For example, if resultForCreate is set to test-passes, setting requireBoth to false means that every create will trigger a notification while setting requireBoth to true will result in notifications if the current test passes. Similarly, if resultForCreate is set to test-fails, setting requireBoth to true means that no create will be able to generate a notification while setting requireBoth to false will result in notifications if the current test passes.

Cardinality: 0..1

Type: boolean

Summary: true

SubscriptionTopic.trigger.fhirPathCriteria

FHIRPath based trigger rule

Definition: The FHIRPath based rules that the server should use to determine when to trigger a notification for this topic.

Comments: FHIRPath expression with %previous and %current vars.

Cardinality: 0..1

Type: string

Summary: true

SubscriptionTopic.trigger.event

Event which can trigger a notification from the SubscriptionTopic

Definition: A well-defined event which can be used to trigger notifications from the SubscriptionTopic.

Cardinality: 0..1

Type: CodeableConcept

Binding: example:v2-0003

Summary: true

SubscriptionTopic.trigger.canFilterBy

Properties by which a Subscription can filter notifications based on this trigger

Definition: List of properties by which Subscriptions can be filtered. May be defined Search Parameters (e.g., Encounter.patient) or parameters defined within this SubscriptionTopic context (e.g., hub.event).

Cardinality: 0..*

Type: BackboneElement

Summary: true

SubscriptionTopic.trigger.canFilterBy.description

Description of this filter parameter

Definition: Description of how this filtering parameter is intended to be used.

Cardinality: 0..1

Type: markdown

Summary: true

SubscriptionTopic.trigger.canFilterBy.resource

URL of the triggering Resource that this filter applies to

Definition: URL of the Resource that is the type used in this filter. This is the "focus" of the topic (or one of them if there are more than one). It will be the same, a generality, or a specificity of the SubscriptionTopic.trigger.resource if this is present.

Comments: URL of the Resource that is the type used in this filter. Relative URLs are relative to the StructureDefinition root of the implemented FHIR version (e.g., http://hl7.org/fhir/StructureDefinition). For example, "Patient" maps to http://hl7.org/fhir/StructureDefinition/Patient. For more information, see <a href="elementdefinition-definitions.html#ElementDefinition.type.code">ElementDefinition.type.code</a>.

Cardinality: 0..1

Type: uri

Binding: extensible:subscription-types

Summary: true

SubscriptionTopic.trigger.canFilterBy.filterParameter

Human-readable and computation-friendly name for a filter parameter usable by subscriptions on this topic, via Subscription.filterBy.filterParameter

Definition: Either the canonical URL to a search parameter (like "http://hl7.org/fhir/SearchParameter/encounter-patient") or topic-defined parameter (like "hub.event") which is a label for the filter.

Comments: Chained parameters are allowed (like "patient.gender") - but can not use colons or modifiers.

Cardinality: 1..1

Type: string

Summary: true

SubscriptionTopic.trigger.canFilterBy.filterDefinition

Canonical URL for a filterParameter definition

Definition: Either the canonical URL to a search parameter (like "http://hl7.org/fhir/SearchParameter/encounter-patient") or the officially-defined URI for a shared filter concept (like "http://example.org/concepts/shared-common-event").

Comments: Chained parameters are allowed (like "patient.gender") - but can not use colons or modifiers.

Cardinality: 0..1

Type: uri

Summary: true

SubscriptionTopic.trigger.canFilterBy.comparator

eq | ne | gt | lt | ge | le | sa | eb | ap

Definition: Comparators allowed for the filter parameter.

Comments: If no comparators are listed, clients should not expect servers to support any comparators.

Cardinality: 0..*

Type: code

Binding: required:search-comparator

SubscriptionTopic.trigger.canFilterBy.modifier

Definition: Modifiers allowed for the filter parameter.

Comments: If no modifiers are listed, clients should not expect servers to support any modifiers.

Cardinality: 0..*

Type: code

Binding: required:search-modifier-code

SubscriptionTopic.trigger.notificationShape

Properties for describing the shape of notifications generated by this trigger

Definition: List of properties to describe the shape (e.g., resources) included in notifications from this trigger.

Cardinality: 0..*

Type: BackboneElement

Summary: true

Mappings: rim=N/A (to add?)

SubscriptionTopic.trigger.notificationShape.resource

URL of the key definition that is the focus in a notification shape

Definition: URL of the Data Type, Resource, or definition (e.g., logical model) that is the type used in this shape. This is the 'focus' resource of the topic (or one of them if there are more than one) and the root for this shape definition. It will be the same, a generality, or a specificity of SubscriptionTopic.trigger.resource when it is present.

Comments: URL of the key definition that is the type used in this shape. Relative URLs are relative to the StructureDefinition root of the implemented FHIR version (e.g., http://hl7.org/fhir/StructureDefinition). For example, 'Patient' maps to http://hl7.org/fhir/StructureDefinition/Patient. For more information, see <a href="elementdefinition-definitions.html#ElementDefinition.type.code">ElementDefinition.type.code</a>.

Cardinality: 1..1

Type: uri

Binding: extensible:subscription-types

Summary: true

Mappings: rim=N/A (to add?)

SubscriptionTopic.trigger.notificationShape.include

Include directives, rooted in the resource for this shape

Definition: Search-style _include directives, rooted in the resource for this shape. Servers SHOULD include resources listed here, if they exist and the user is authorized to receive them. Clients SHOULD be prepared to receive these additional resources, but SHALL function properly without them.

Cardinality: 0..*

Type: string

Summary: true

Mappings: rim=N/A (to add?)

SubscriptionTopic.trigger.notificationShape.revInclude

Reverse include directives, rooted in the resource for this shape

Definition: Search-style _revinclude directives, rooted in the resource for this shape. Servers SHOULD include resources listed here, if they exist and the user is authorized to receive them. Clients SHOULD be prepared to receive these additional resources, but SHALL function properly without them.

Cardinality: 0..*

Type: string

Summary: true

Mappings: rim=N/A (to add?)

SubscriptionTopic.trigger.notificationShape.relatedQuery

Query describing data relevant to this notification

Definition: Queries and codes that could be included with notifications of this shape. Servers MAY include these queries if supported and desired in the workflow.

Cardinality: 0..*

Type: BackboneElement

Summary: true

Mappings: rim=N/A (to add?)

SubscriptionTopic.trigger.notificationShape.relatedQuery.queryType

Coded information describing the type of data this query provides

Definition: Coded value(s) used to describe the type of information that evaluating this query will provide. Subscribers can use the values to ensure the data they request are relevant and necessary for their use.

Cardinality: 0..1

Type: Coding

Summary: true

Mappings: rim=N/A (to add?)

SubscriptionTopic.trigger.notificationShape.relatedQuery.query

Query to perform

Definition: Query a subscriber can use to retrieve additional information. The exact contents of the query MAY depend on the value of the queryType, however this SHOULD be a query suitable for use as an HTTP GET request (either fully-qualified or partial).

Cardinality: 1..1

Type: string

Summary: true

Mappings: rim=N/A (to add?)