Generated Narrative: StructureDefinition ext-R5-SubscriptionTopic Name Flags Card. Type Description & Constraints Extension 0..* Extension(4.0.1) The definition of a specific topic for triggering events within the Subscriptions framework #xD; Slices for extension 2..* Extension Extension Slice: Unordered, Closed by value:url #xD; <a href="StructureDefinition-ext-R5-SubscriptionTopic-definitions.html#Extension.extension:url" title="Slice url: 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.">extension:url 1..1 Extension Canonical identifier for this subscription topic, represented as an absolute URI (globally unique) #xD; url 1..1 uri "url" #xD; <a href="StructureDefinition-ext-R5-SubscriptionTopic-definitions.html#Extension.extension:url.value[x]" title="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.">value[x] 0..1 uri Canonical identifier for this subscription topic, represented as an absolute URI (globally unique) #xD; <a href="StructureDefinition-ext-R5-SubscriptionTopic-definitions.html#Extension.extension:version" title="Slice version: 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.">extension:version 0..1 Extension Business version of the subscription topic #xD; url 1..1 uri "version" #xD; <a href="StructureDefinition-ext-R5-SubscriptionTopic-definitions.html#Extension.extension:version.value[x]" title="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.">value[x] 0..1 string Business version of the subscription topic #xD; extension:versionAlgorithm[x] 0..1 Extension How to compare versions #xD; url 1..1 uri "versionAlgorithm[x]" #xD; value[x] 0..1 How to compare versions Binding: R5_version_algorithm_for_R4 (0.0.1-snapshot-2) (extensible) #xD; valueString string #xD; valueCoding Coding #xD; extension:name 0..1 Extension Name for this subscription topic (computer friendly) #xD; url 1..1 uri "name" #xD; value[x] 0..1 string Name for this subscription topic (computer friendly) #xD; extension:title 0..1 Extension Name for this subscription topic (human friendly) #xD; url 1..1 uri "title" #xD; value[x] 0..1 string Name for this subscription topic (human friendly) #xD; extension:derivedFrom 0..* Extension Based on FHIR protocol or definition #xD; url 1..1 uri "derivedFrom" #xD; value[x] 0..1 canonical() Based on FHIR protocol or definition #xD; extension:status 1..1 Extension draft | active | retired | unknown #xD; url 1..1 uri "status" #xD; value[x] 0..1 code draft | active | retired | unknown Binding: R5_publication_status_for_R4 (0.0.1-snapshot-2) (required): The lifecycle status of an artifact. #xD; extension:experimental 0..1 Extension If for testing purposes, not real usage #xD; url 1..1 uri "experimental" #xD; value[x] 0..1 boolean If for testing purposes, not real usage #xD; extension:date 0..1 Extension Date status first applied #xD; url 1..1 uri "date" #xD; value[x] 0..1 dateTime Date status first applied #xD; extension:publisher 0..1 Extension The name of the individual or organization that published the SubscriptionTopic #xD; url 1..1 uri "publisher" #xD; value[x] 0..1 string The name of the individual or organization that published the SubscriptionTopic #xD; extension:contact 0..* Extension Contact details for the publisher #xD; url 1..1 uri "contact" #xD; value[x] 0..1 ContactDetail Contact details for the publisher #xD; extension:description 0..1 Extension Natural language description of the SubscriptionTopic #xD; url 1..1 uri "description" #xD; value[x] 0..1 markdown Natural language description of the SubscriptionTopic #xD; extension:useContext 0..* Extension Content intends to support these contexts #xD; url 1..1 uri "useContext" #xD; value[x] 0..1 UsageContext Content intends to support these contexts #xD; extension:jurisdiction 0..* Extension Intended jurisdiction of the SubscriptionTopic (if applicable) #xD; url 1..1 uri "jurisdiction" #xD; value[x] 0..1 CodeableConcept Intended jurisdiction of the SubscriptionTopic (if applicable) Binding: R5_jurisdiction_for_R4 (0.0.1-snapshot-2) (extensible): Countries and regions within which this artifact is targeted for use. #xD; extension:purpose 0..1 Extension Why this SubscriptionTopic is defined #xD; url 1..1 uri "purpose" #xD; value[x] 0..1 markdown Why this SubscriptionTopic is defined #xD; extension:copyright 0..1 Extension Use and/or publishing restrictions #xD; url 1..1 uri "copyright" #xD; value[x] 0..1 markdown Use and/or publishing restrictions #xD; <a href="StructureDefinition-ext-R5-SubscriptionTopic-definitions.html#Extension.extension:copyrightLabel" title="Slice copyrightLabel: 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').">extension:copyrightLabel 0..1 Extension Copyright holder and year(s) #xD; url 1..1 uri "copyrightLabel" #xD; <a href="StructureDefinition-ext-R5-SubscriptionTopic-definitions.html#Extension.extension:copyrightLabel.value[x]" title="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').">value[x] 0..1 string Copyright holder and year(s) #xD; extension:approvalDate 0..1 Extension When SubscriptionTopic is/was approved by publisher #xD; url 1..1 uri "approvalDate" #xD; value[x] 0..1 date When SubscriptionTopic is/was approved by publisher #xD; extension:lastReviewDate 0..1 Extension Date the Subscription Topic was last reviewed by the publisher #xD; url 1..1 uri "lastReviewDate" #xD; value[x] 0..1 date Date the Subscription Topic was last reviewed by the publisher #xD; extension:effectivePeriod 0..1 Extension The effective date range for the SubscriptionTopic #xD; url 1..1 uri "effectivePeriod" #xD; value[x] 0..1 Period The effective date range for the SubscriptionTopic #xD; <a href="StructureDefinition-ext-R5-SubscriptionTopic-definitions.html#Extension.extension:resourceTrigger" title="Slice resourceTrigger: 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).">extension:resourceTrigger 0..* Extension Definition of a resource-based trigger for the subscription topic #xD; Slices for extension 1..* Extension Extension Slice: Unordered, Closed by value:url #xD; extension:description 0..1 Extension Text representation of the resource trigger #xD; url 1..1 uri "description" #xD; value[x] 0..1 markdown Text representation of the resource trigger #xD; <a href="StructureDefinition-ext-R5-SubscriptionTopic-definitions.html#Extension.extension:resourceTrigger.extension:resource" title="Slice resource: 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](https://hl7.org/fhir/elementdefinition-definition.html#ElementDefinition.type.code).">extension:resource 1..1 Extension Data Type or Resource (reference to definition) for this trigger definition #xD; url 1..1 uri "resource" #xD; <a href="StructureDefinition-ext-R5-SubscriptionTopic-definitions.html#Extension.extension:resourceTrigger.extension:resource.value[x]" title="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](https://hl7.org/fhir/elementdefinition-definition.html#ElementDefinition.type.code).">value[x] 0..1 uri Data Type or Resource (reference to definition) for this trigger definition Binding: R5_subscription_types_for_R4 (0.0.1-snapshot-2) (extensible): A type of resource, or a Reference (from all versions) #xD; extension:supportedInteraction 0..* Extension create | update | delete #xD; url 1..1 uri "supportedInteraction" #xD; value[x] 0..1 code create | update | delete Binding: R5_interaction_trigger_for_R4 (0.0.1-snapshot-2) (required): FHIR RESTful interaction used to filter a resource-based SubscriptionTopic trigger. #xD; extension:queryCriteria 0..1 Extension Query based trigger rule #xD; Slices for extension 0..* Extension Extension Slice: Unordered, Closed by value:url #xD; extension:previous 0..1 Extension Rule applied to previous resource state #xD; url 1..1 uri "previous" #xD; value[x] 0..1 string Rule applied to previous resource state #xD; extension:resultForCreate 0..1 Extension test-passes | test-fails #xD; url 1..1 uri "resultForCreate" #xD; value[x] 0..1 code test-passes | test-fails Binding: R5_subscriptiontopic_cr_behavior_for_R4 (0.0.1-snapshot-2) (required): Behavior a server can exhibit when a criteria state does not exist (e.g., state prior to a create or after a delete). #xD; extension:current 0..1 Extension Rule applied to current resource state #xD; url 1..1 uri "current" #xD; value[x] 0..1 string Rule applied to current resource state #xD; extension:resultForDelete 0..1 Extension test-passes | test-fails #xD; url 1..1 uri "resultForDelete" #xD; value[x] 0..1 code test-passes | test-fails Binding: R5_subscriptiontopic_cr_behavior_for_R4 (0.0.1-snapshot-2) (required): Behavior a server can exhibit when a criteria state does not exist (e.g., state prior to a create or after a delete). #xD; <a href="StructureDefinition-ext-R5-SubscriptionTopic-definitions.html#Extension.extension:resourceTrigger.extension:queryCriteria.extension:requireBoth" title="Slice requireBoth: 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`.">extension:requireBoth 0..1 Extension Both must be true flag #xD; url 1..1 uri "requireBoth" #xD; <a href="StructureDefinition-ext-R5-SubscriptionTopic-definitions.html#Extension.extension:resourceTrigger.extension:queryCriteria.extension:requireBoth.value[x]" title="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`.">value[x] 0..1 boolean Both must be true flag #xD; url 1..1 uri "queryCriteria" #xD; extension:fhirPathCriteria 0..1 Extension FHIRPath based trigger rule #xD; url 1..1 uri "fhirPathCriteria" #xD; value[x] 0..1 string FHIRPath based trigger rule #xD; url 1..1 uri "resourceTrigger" #xD; extension:eventTrigger 0..* Extension Event definitions the SubscriptionTopic #xD; Slices for extension 2..* Extension Extension Slice: Unordered, Closed by value:url #xD; <a href="StructureDefinition-ext-R5-SubscriptionTopic-definitions.html#Extension.extension:eventTrigger.extension:description" title="Slice description: 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).">extension:description 0..1 Extension Text representation of the event trigger #xD; url 1..1 uri "description" #xD; value[x] 0..1 markdown Text representation of the event trigger #xD; extension:event 1..1 Extension Event which can trigger a notification from the SubscriptionTopic #xD; url 1..1 uri "event" #xD; value[x] 0..1 CodeableConcept Event which can trigger a notification from the SubscriptionTopic Binding: R5_v2_0003_for_R4 (0.0.1-snapshot-2) (example): FHIR Value set/code system definition for HL7 V2 table 0003 (EVENT TYPE CODE). #xD; <a href="StructureDefinition-ext-R5-SubscriptionTopic-definitions.html#Extension.extension:eventTrigger.extension:resource" title="Slice resource: 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](https://hl7.org/fhir/elementdefinition-definition.html#ElementDefinition.type.code).">extension:resource 1..1 Extension Data Type or Resource (reference to definition) for this trigger definition #xD; url 1..1 uri "resource" #xD; <a href="StructureDefinition-ext-R5-SubscriptionTopic-definitions.html#Extension.extension:eventTrigger.extension:resource.value[x]" title="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](https://hl7.org/fhir/elementdefinition-definition.html#ElementDefinition.type.code).">value[x] 0..1 uri Data Type or Resource (reference to definition) for this trigger definition Binding: R5_subscription_types_for_R4 (0.0.1-snapshot-2) (extensible): A type of resource, or a Reference (from all versions) #xD; url 1..1 uri "eventTrigger" #xD; extension:canFilterBy 0..* Extension Properties by which a Subscription can filter notifications from the SubscriptionTopic #xD; Slices for extension 1..* Extension Extension Slice: Unordered, Closed by value:url #xD; extension:description 0..1 Extension Description of this filter parameter #xD; url 1..1 uri "description" #xD; value[x] 0..1 markdown Description of this filter parameter #xD; <a href="StructureDefinition-ext-R5-SubscriptionTopic-definitions.html#Extension.extension:canFilterBy.extension:resource" title="Slice resource: 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.">extension:resource 0..1 Extension URL of the triggering Resource that this filter applies to #xD; url 1..1 uri "resource" #xD; <a href="StructureDefinition-ext-R5-SubscriptionTopic-definitions.html#Extension.extension:canFilterBy.extension:resource.value[x]" title="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.">value[x] 0..1 uri URL of the triggering Resource that this filter applies to Binding: R5_subscription_types_for_R4 (0.0.1-snapshot-2) (extensible): A type of resource, or a Reference (from all versions) #xD; extension:filterParameter 1..1 Extension Human-readable and computation-friendly name for a filter parameter usable by subscriptions on this topic, via Subscription.filterBy.filterParameter #xD; url 1..1 uri "filterParameter" #xD; value[x] 0..1 string Human-readable and computation-friendly name for a filter parameter usable by subscriptions on this topic, via Subscription.filterBy.filterParameter #xD; extension:filterDefinition 0..1 Extension Canonical URL for a filterParameter definition #xD; url 1..1 uri "filterDefinition" #xD; value[x] 0..1 uri Canonical URL for a filterParameter definition #xD; extension:comparator 0..* Extension eq | ne | gt | lt | ge | le | sa | eb | ap #xD; url 1..1 uri "comparator" #xD; value[x] 0..1 code eq | ne | gt | lt | ge | le | sa | eb | ap Binding: SearchComparator (required): Search Comparator Codes supported in this filter. #xD; extension:modifier 0..* Extension missing | exact | contains | not | text | in | not-in | below | above | type | identifier | of-type | code-text | text-advanced | iterate #xD; url 1..1 uri "modifier" #xD; value[x] 0..1 code missing | exact | contains | not | text | in | not-in | below | above | type | identifier | of-type | code-text | text-advanced | iterate Binding: R5_search_modifier_code_for_R4 (0.0.1-snapshot-2) (required): Search Modifier Codes supported in this filter. #xD; url 1..1 uri "canFilterBy" #xD; extension:notificationShape 0..* Extension Properties for describing the shape of notifications generated by this topic #xD; Slices for extension 1..* Extension Extension Slice: Unordered, Closed by value:url #xD; <a href="StructureDefinition-ext-R5-SubscriptionTopic-definitions.html#Extension.extension:notificationShape.extension:resource" title="Slice resource: 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.">extension:resource 1..1 Extension URL of the Resource that is the focus (main) resource in a notification shape #xD; url 1..1 uri "resource" #xD; <a href="StructureDefinition-ext-R5-SubscriptionTopic-definitions.html#Extension.extension:notificationShape.extension:resource.value[x]" title="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.">value[x] 0..1 uri URL of the Resource that is the focus (main) resource in a notification shape Binding: R5_subscription_types_for_R4 (0.0.1-snapshot-2) (extensible): A type of resource, or a Reference (from all versions) #xD; <a href="StructureDefinition-ext-R5-SubscriptionTopic-definitions.html#Extension.extension:notificationShape.extension:include" title="Slice include: 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.">extension:include 0..* Extension Include directives, rooted in the resource for this shape #xD; url 1..1 uri "include" #xD; <a href="StructureDefinition-ext-R5-SubscriptionTopic-definitions.html#Extension.extension:notificationShape.extension:include.value[x]" title="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.">value[x] 0..1 string Include directives, rooted in the resource for this shape #xD; <a href="StructureDefinition-ext-R5-SubscriptionTopic-definitions.html#Extension.extension:notificationShape.extension:revInclude" title="Slice revInclude: 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.">extension:revInclude 0..* Extension Reverse include directives, rooted in the resource for this shape #xD; url 1..1 uri "revInclude" #xD; <a href="StructureDefinition-ext-R5-SubscriptionTopic-definitions.html#Extension.extension:notificationShape.extension:revInclude.value[x]" title="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.">value[x] 0..1 string Reverse include directives, rooted in the resource for this shape #xD; url 1..1 uri "notificationShape" #xD; url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-SubscriptionTopic" #xD; Documentation for this format
Cross-version Extension for R5.SubscriptionTopic for use in FHIR R4
This cross-version extension represents SubscriptionTopic from http://hl7.org/fhir/StructureDefinition/SubscriptionTopic|5.0.0 for use in FHIR R4.
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.
All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
Must have either extensions or value[x], not both
exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Extensions are always sliced by (at least) url
exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
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.
Additional content defined by implementations
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 manageable, 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.
Source of the definition for the extension code - a logical name or a URL.
The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
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.
Indicates the mechanism used to compare versions to determine which is more current.
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.
Name for this subscription topic (human friendly)
A short, descriptive, user-friendly title for the subscription topic. For example, "admission".
The canonical URL pointing to another FHIR-defined SubscriptionTopic that is adhered to in whole or in part by this SubscriptionTopic.
The current state of the SubscriptionTopic.
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.
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.
The name of the individual or organization that published the SubscriptionTopic
Helps establish the "authority/credibility" of the SubscriptionTopic. May also allow for contact.
Contact details to assist a user in finding and communicating with the publisher.
Natural language description of the SubscriptionTopic
A free text natural language description of the Topic from the consumer's perspective.
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.
Intended jurisdiction of the SubscriptionTopic (if applicable)
A jurisdiction in which the Topic is intended to be used.
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.
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.
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').
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.
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.
The effective date range for the SubscriptionTopic
The period during which the SubscriptionTopic content was or is planned to be effective.
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).
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".
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](https://hl7.org/fhir/elementdefinition-definition.html#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).
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`.
Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R4/extensibility.html) for a list).
The FHIRPath based rules that the server should use to determine when to trigger a notification for this topic.
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.
FHIR Value set/code system definition for HL7 V2 table 0003 (EVENT TYPE CODE).
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](https://hl7.org/fhir/elementdefinition-definition.html#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.
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.
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.
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.
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.
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.