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
HL7 International - Patient Administration Work Group
SubscriptionTopic resource used in RTLS workflows.
This profile defines minimum expectations for defined subscription topics by a RTLS.
The definition of a specific topic for triggering events within the Subscriptions framework
Describes a stream of resource state changes or events and annotated with labels useful to filter projections from this topic.
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.
The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
A set of rules under which this content was created
A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.
This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
The base language in which the resource is written.
Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
Text summary of the resource, for human interpretation
A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.
This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.
Additional content defined by implementations
May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Must have either extensions or value[x], not both
May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R5/extensibility.html#modifierExtension).
Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Canonical identifier for this subscription topic, represented as an absolute URI (globally unique)
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.
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](http://hl7.org/fhir/R5/resource.html#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](http://hl7.org/fhir/R5/resource.html#meta) 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.
Allows the subscription topic to be referenced by a single globally unique identifier.
Business identifier for subscription topic
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.
Note: This is a business identifier, not a resource identifier (see [discussion](http://hl7.org/fhir/R5/resource.html#identifiers)). 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.
Allows identification of the subscription topic as it is known by various participating systems and in a way that remains consistent across servers.
Business version of the subscription topic
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.
There may be multiple different instances of a subscription topic that have the same identifier but different versions.
Indicates the mechanism used to compare versions to determine which is more current.
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.
Name for this subscription topic (computer friendly)
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.
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.
Support human navigation and code generation.
Name for this subscription topic (human friendly)
A short, descriptive, user-friendly title for the subscription topic. For example, "admission".
This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.
The canonical URL pointing to another FHIR-defined SubscriptionTopic that is adhered to in whole or in part by this SubscriptionTopic.
SubscriptionTopics may be refinements of more generic topics.
The current state of the SubscriptionTopic.
A nominal state-transition diagram can be found in the [Definition pattern](definition.html#statemachine) 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](http://hl7.org/fhir/R5/canonicalresource.html#localization).
This is labeled as "Is Modifier" because applications should not use a retired SubscriptionTopic without due consideration
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.
Allows filtering of SubscriptionTopic that are appropriate for use vs. not.
Enables experimental content to be developed following the same life-cycle as a production-level SubscriptionTopic would.
If absent, this resource is treated as though it is not experimental.
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.
See guidance around (not) making local changes to elements [here](http://hl7.org/fhir/R5/canonicalresource.html#localization).
The name of the individual or organization that published the SubscriptionTopic
Helps establish the "authority/credibility" of the SubscriptionTopic. May also allow for contact.
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.
Definition.publisher {as string instead of CodeableConcept}
Contact details to assist a user in finding and communicating with the publisher.
May be a web site, an email address, a telephone number, etc. See guidance around (not) making local changes to elements [here](http://hl7.org/fhir/R5/canonicalresource.html#localization).
Natural language description of the SubscriptionTopic
A free text natural language description of the Topic from the consumer's perspective.
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.
Content intends to support these contexts
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.
When multiple usageContexts are specified, there is no expectation for whether all or any of the contexts apply.
Assist in searching for appropriate content.
Intended jurisdiction of the SubscriptionTopic (if applicable)
A jurisdiction in which the Topic is intended to be used.
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.)
Countries and regions within which this artifact is targeted for use.
Explains why this Topic is needed and why it has been designed as it has.
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.
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.
Consumers of the TSubscriptionTopicopic must be able to determine any legal restrictions on the use of the artifact and/or its content.
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').
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.
Defines the content expected to be rendered in all representations of the artifact.
When SubscriptionTopic is/was approved by publisher
The date on which the asset content was approved by the publisher. Approval happens once when the content is officially approved for usage.
The date may be more recent than the approval date because of minor changes / editorial corrections.
Date the Subscription Topic was last reviewed by the publisher
The date on which the asset content was last reviewed. Review happens periodically after that, but doesn't change the original approval date.
If specified, this is usually after the approval date.
.outboundRelationship[typeCode="SUBJ"; subsetCode="RECENT"].act[classCode=CACT;moodCode=EVN;code="review"].effectiveTime
The effective date range for the SubscriptionTopic
The period during which the SubscriptionTopic content was or is planned to be effective.
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.
Definition of a resource-based trigger for the subscription topic
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).
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Extensions that cannot be ignored even if unrecognized
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Text representation of the resource trigger
The human readable description of this resource trigger for the SubscriptionTopic - for example, "An Encounter enters the 'in-progress' state".
Implementation of particular subscription topics might not use a computable definition and instead base their design on the definition.
Data Type or Resource (reference to definition) for this trigger 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 ElementDefinition.type.code.
A type of resource, or a Reference (from all versions)
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.
FHIR RESTful interaction used to filter a resource-based SubscriptionTopic trigger.
The FHIR query based rules that the server should use to determine when to trigger a notification for this subscription topic.
The FHIR query based rules are applied to the previous resource state (e.g., state before an update).
The rules are search criteria (without the [base] part). Like Bundle.entry.request.url, it has no leading slash character (`/`).
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).
Behavior a server can exhibit when a criteria state does not exist (e.g., state prior to a create or after a delete).
The FHIR query based rules are applied to the current resource state (e.g., state after an update).
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).
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`.
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.
The FHIRPath based rules that the server should use to determine when to trigger a notification for this topic.
FHIRPath expression with %previous and %current vars.
Event definition which can be used to trigger the SubscriptionTopic.
Text representation of the event trigger
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).
Event which can trigger a notification from the SubscriptionTopic
A well-defined event which can be used to trigger notifications from the SubscriptionTopic.
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 ElementDefinition.type.code.
Properties by which a Subscription can filter notifications from the SubscriptionTopic
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).
Description of how this filtering parameter is intended to be used.
URL of the triggering Resource that this filter applies to
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.
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 ElementDefinition.type.code.
Human-readable and computation-friendly name for a filter parameter usable by subscriptions on this topic, via Subscription.filterBy.filterParameter
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.
Chained parameters are allowed (like "patient.gender") - but can not use colons or modifiers.
Canonical URL for a filterParameter 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").
eq | ne | gt | lt | ge | le | sa | eb | ap
Comparators allowed for the filter parameter.
If no comparators are listed, clients should not expect servers to support any comparators.
Search Comparator Codes supported in this filter.
missing | exact | contains | not | text | in | not-in | below | above | type | identifier | of-type | code-text | text-advanced | iterate
Modifiers allowed for the filter parameter.
If no modifiers are listed, clients should not expect servers to support any modifiers.
Search Modifier Codes supported in this filter.
Properties for describing the shape of notifications generated by this topic
List of properties to describe the shape (e.g., resources) included in notifications from this Subscription Topic.
URL of the Resource that is the focus (main) resource in a notification shape
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.
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 ElementDefinition.type.code.
Include directives, rooted in the resource for this shape
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.
Reverse include directives, rooted in the resource for this shape
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.