FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

FHIR Infrastructure icon Work GroupMaturity Level: 2 Trial UseSecurity Category: Business Compartments: No defined compartments

Detailed Descriptions for the elements in the SubscriptionTopic resource.

SubscriptionTopic
Definition

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

Short DisplayThe definition of a specific topic for triggering events within the Subscriptions framework
Cardinality0..*
TypeCanonicalResource
Summaryfalse
SubscriptionTopic.url
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.

Short DisplayCanonical identifier for this subscription topic, represented as an absolute URI (globally unique)
Cardinality1..1
Typeuri
Requirements

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

Summarytrue
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.

SubscriptionTopic.identifier
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.

Short DisplayBusiness identifier for subscription topic
NoteThis is a business identifier, not a resource identifier (see discussion)
Cardinality0..*
TypeIdentifier
Requirements

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

Summarytrue
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.

SubscriptionTopic.version
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.

Short DisplayBusiness version of the subscription topic
NoteThis is a business versionId, not a resource version id (see discussion)
Cardinality0..1
Typestring
Summarytrue
Comments

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

SubscriptionTopic.versionAlgorithm[x]
Definition

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

Short DisplayHow to compare versions
Cardinality0..1
Terminology BindingVersion Algorithm (Extensible)
Typestring|Coding
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Summarytrue
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.

SubscriptionTopic.name
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.

Short DisplayName for this subscription topic (computer friendly)
Cardinality0..1
Typestring
Requirements

Support human navigation and code generation.

Summarytrue
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.

SubscriptionTopic.title
Definition

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

Short DisplayName for this subscription topic (human friendly)
Cardinality0..1
Typestring
Alternate NamesName; SubscriptionTopic Name
Summarytrue
Comments

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

SubscriptionTopic.derivedFrom
Definition

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

Short DisplayBased on FHIR protocol or definition
Cardinality0..*
Typecanonical(SubscriptionTopic)
Requirements

SubscriptionTopics may be refinements of more generic topics.

Summarytrue
SubscriptionTopic.status
Definition

The current state of the SubscriptionTopic.

Short Displaydraft | active | retired | unknown
Cardinality1..1
Terminology BindingPublicationStatus (Required)
Typecode
Is Modifiertrue (Reason: This is labeled as "Is Modifier" because applications should not use a retired SubscriptionTopic without due consideration)
Summarytrue
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.

SubscriptionTopic.experimental
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.

Short DisplayIf for testing purposes, not real usage
Cardinality0..1
Typeboolean
Meaning if MissingIf absent, this resource is treated as though it is not experimental.
Requirements

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

Summarytrue
Comments

Allows filtering of SubscriptionTopic that are appropriate for use vs. not.

SubscriptionTopic.date
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.

Short DisplayDate status first applied
Cardinality0..1
TypedateTime
Alternate Namescreated
Summarytrue
Comments

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

SubscriptionTopic.publisher
Definition

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

Short DisplayThe name of the individual or organization that published the SubscriptionTopic
Cardinality0..1
Typestring
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.

Alternate Namesauthor
Summarytrue
SubscriptionTopic.contact
Definition

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

Short DisplayContact details for the publisher
Cardinality0..*
TypeContactDetail
Summarytrue
Comments

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

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

SubscriptionTopic.description
Definition

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

Short DisplayNatural language description of the SubscriptionTopic
Cardinality0..1
Typemarkdown
Summaryfalse
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.

SubscriptionTopic.useContext
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.

Short DisplayContent intends to support these contexts
Cardinality0..*
TypeUsageContext
Requirements

Assist in searching for appropriate content.

Summarytrue
Comments

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

SubscriptionTopic.jurisdiction
Standards StatusThis element has a standards status of "Deprecated" which is different from the status of the whole resource
Definition

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

Short DisplayIntended jurisdiction of the SubscriptionTopic (if applicable)
Cardinality0..*
Terminology BindingJurisdiction ValueSet (Extensible)
TypeCodeableConcept
Summarytrue
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.)

SubscriptionTopic.purpose
Definition

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

Short DisplayWhy this SubscriptionTopic is defined
Cardinality0..1
Typemarkdown
Summaryfalse
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.

SubscriptionTopic.copyright
Definition

A copyright statement relating to the SubscriptionTopic and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the SubscriptionTopic.

Short DisplayUse and/or publishing restrictions
Cardinality0..1
Typemarkdown
Requirements

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

Alternate NamesLicense; Restrictions
Summaryfalse
Comments

...

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 resctricted. (e.g. 'All rights reserved', 'Some rights reserved').

Short DisplayCopyright holder and year(s)
Cardinality0..1
Typestring
Requirements

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

Summaryfalse
Comments

The (c) symbol 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.

SubscriptionTopic.approvalDate
Definition

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

Short DisplayWhen SubscriptionTopic is/was approved by publisher
Cardinality0..1
Typedate
Summaryfalse
Comments

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

SubscriptionTopic.lastReviewDate
Definition

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

Short DisplayDate the Subscription Topic was last reviewed by the publisher
Cardinality0..1
Typedate
Summaryfalse
Comments

If specified, this is usually after the approval date.

SubscriptionTopic.effectivePeriod
Definition

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

Short DisplayThe effective date range for the SubscriptionTopic
Cardinality0..1
TypePeriod
Summarytrue
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.

SubscriptionTopic.resourceTrigger
Definition

A definition of a resource-based event that triggers a notification based on the SubscriptionTopic. The criteria may be just a human readable description and/or a full FHIR search string or FHIRPath expression. Multiple triggers are considered OR joined (e.g., a resource update matching ANY of the definitions will trigger a notification).

Short DisplayDefinition of a resource-based trigger for the subscription topic
Cardinality0..*
Summarytrue
SubscriptionTopic.resourceTrigger.description
Definition

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

Short DisplayText representation of the resource trigger
Cardinality0..1
Typemarkdown
Summarytrue
Comments

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

SubscriptionTopic.resourceTrigger.resource
Definition

URL of the Resource that is the type used in this resource 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>.

Short DisplayData Type or Resource (reference to definition) for this trigger definition
Cardinality1..1
Terminology BindingTypes used with Subscriptions (Extensible)
Additional BindingsPurpose
All Resource TypesUI Binding
Typeuri
Summarytrue
SubscriptionTopic.resourceTrigger.supportedInteraction
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.

Short Displaycreate | update | delete
Cardinality0..*
Terminology BindingInteraction Trigger (Required)
Typecode
Summarytrue
SubscriptionTopic.resourceTrigger.queryCriteria
Definition

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

Short DisplayQuery based trigger rule
Cardinality0..1
Summarytrue
SubscriptionTopic.resourceTrigger.queryCriteria.previous
Definition

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

Short DisplayRule applied to previous resource state
Cardinality0..1
Typestring
Summarytrue
Comments

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

SubscriptionTopic.resourceTrigger.queryCriteria.resultForCreate
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).

Short Displaytest-passes | test-fails
Cardinality0..1
Terminology BindingCriteria Not Exists Behavior (Required)
Typecode
Summarytrue
SubscriptionTopic.resourceTrigger.queryCriteria.current
Definition

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

Short DisplayRule applied to current resource state
Cardinality0..1
Typestring
Summarytrue
Comments

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

SubscriptionTopic.resourceTrigger.queryCriteria.resultForDelete
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).

Short Displaytest-passes | test-fails
Cardinality0..1
Terminology BindingCriteria Not Exists Behavior (Required)
Typecode
Summarytrue
SubscriptionTopic.resourceTrigger.queryCriteria.requireBoth
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.

Short DisplayBoth must be true flag
Cardinality0..1
Typeboolean
Summarytrue
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.

SubscriptionTopic.resourceTrigger.fhirPathCriteria
Definition

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

Short DisplayFHIRPath based trigger rule
Cardinality0..1
Typestring
Summarytrue
Comments

FHIRPath expression with %previous and %current vars.

SubscriptionTopic.eventTrigger
Definition

Event definition which can be used to trigger the SubscriptionTopic.

Short DisplayEvent definitions the SubscriptionTopic
Cardinality0..*
Summarytrue
SubscriptionTopic.eventTrigger.description
Definition

The human readable description of an event to trigger a notification for the SubscriptionTopic - for example, "Patient Admission, as defined in HL7v2 via message ADT^A01". Multiple values are considered OR joined (e.g., matching any single event listed).

Short DisplayText representation of the event trigger
Cardinality0..1
Typemarkdown
Summarytrue
Comments

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

SubscriptionTopic.eventTrigger.event
Definition

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

Short DisplayEvent which can trigger a notification from the SubscriptionTopic
Cardinality1..1
Terminology Bindinghl7VS-eventTypeCode icon (Example)
TypeCodeableConcept
Summarytrue
SubscriptionTopic.eventTrigger.resource
Definition

URL of the Resource that is the focus type used in this event 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>.

Short DisplayData Type or Resource (reference to definition) for this trigger definition
Cardinality1..1
Terminology BindingTypes used with Subscriptions (Extensible)
Additional BindingsPurpose
All Resource TypesUI Binding
Typeuri
Summarytrue
SubscriptionTopic.canFilterBy
Definition

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

Short DisplayProperties by which a Subscription can filter notifications from the SubscriptionTopic
Cardinality0..*
Summarytrue
SubscriptionTopic.canFilterBy.description
Definition

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

Short DisplayDescription of this filter parameter
Cardinality0..1
Typemarkdown
Summarytrue
SubscriptionTopic.canFilterBy.resource
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 SubscriptionTopic.resourceTrigger.resource or SubscriptionTopic.eventTrigger.resource when they are present.

Short DisplayURL of the triggering Resource that this filter applies to
Cardinality0..1
Terminology BindingTypes used with Subscriptions (Extensible)
Additional BindingsPurpose
All Resource TypesUI Binding
Typeuri
Summarytrue
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>.

SubscriptionTopic.canFilterBy.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.

Short DisplayHuman-readable and computation-friendly name for a filter parameter usable by subscriptions on this topic, via Subscription.filterBy.filterParameter
Cardinality1..1
Typestring
Summarytrue
Comments

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

SubscriptionTopic.canFilterBy.filterDefinition
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").

Short DisplayCanonical URL for a filterParameter definition
Cardinality0..1
Typeuri
Summarytrue
Comments

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

SubscriptionTopic.canFilterBy.comparator
Definition

Comparators allowed for the filter parameter.

Short Displayeq | ne | gt | lt | ge | le | sa | eb | ap
Cardinality0..*
Terminology BindingSearch Comparator (Required)
Typecode
Summaryfalse
Comments

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

SubscriptionTopic.canFilterBy.modifier
Definition

Modifiers allowed for the filter parameter.

Short Displaymissing | exact | contains | not | text | in | not-in | below | above | type | identifier | of-type | code-text | text-advanced | iterate
Cardinality0..*
Terminology BindingSearch Modifier Code (Required)
Typecode
Summaryfalse
Comments

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

SubscriptionTopic.notificationShape
Definition

List of properties to describe the shape (e.g., resources) included in notifications from this Subscription Topic.

Short DisplayProperties for describing the shape of notifications generated by this topic
Cardinality0..*
Summarytrue
SubscriptionTopic.notificationShape.resource
Definition

URL of the Resource 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 resource for this shape definition. It will be the same, a generality, or a specificity of SubscriptionTopic.resourceTrigger.resource or SubscriptionTopic.eventTrigger.resource when they are present.

Short DisplayURL of the Resource that is the focus (main) resource in a notification shape
Cardinality1..1
Terminology BindingTypes used with Subscriptions (Extensible)
Additional BindingsPurpose
All Resource TypesUI Binding
Typeuri
Summarytrue
Comments

URL of the Resource 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>.

SubscriptionTopic.notificationShape.include
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.

Short DisplayInclude directives, rooted in the resource for this shape
Cardinality0..*
Typestring
Summarytrue
SubscriptionTopic.notificationShape.revInclude
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.

Short DisplayReverse include directives, rooted in the resource for this shape
Cardinality0..*
Typestring
Summarytrue