| Name | Flags | Card. | Type |
Description & Constraints
|
||||
|---|---|---|---|---|---|---|---|---|
SubscriptionTopic
|
TU | DomainResource | The definition of a specific topic for triggering events within the Subscriptions framework
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension Interfaces Implemented: CanonicalResource |
|||||
url
|
Σ | 1..1 | uri | Canonical identifier for this subscription topic, represented as an absolute URI (globally unique)
|
||||
identifier
|
Σ | 0..* | Identifier | Business identifier for subscription topic
|
||||
|
version
|
Σ | 0..1 | string | Business version of the subscription topic
|
||||
versionAlgorithm[x]
|
Σ | 0..1 | How to compare versions
Binding: Version Algorithm ( Extensible) |
|||||
versionAlgorithmString
|
string | |||||||
versionAlgorithmCoding
|
Coding | |||||||
|
name
|
Σ | 0..1 | string | Name for this subscription topic (computer friendly)
|
||||
|
title
|
Σ T | 0..1 | string | Name for this subscription topic (human friendly)
|
||||
derivedFrom
|
Σ | 0..* | canonical( SubscriptionTopic) | Based on FHIR protocol or definition
|
||||
|
status
|
?! Σ | 1..1 | code | draft | active | retired | unknown
Binding: PublicationStatus ( Required) |
||||
|
experimental
|
Σ | 0..1 | boolean | If for testing purposes, not real usage
|
||||
|
date
|
Σ | 0..1 | dateTime | Date status first applied
|
||||
|
publisher
|
Σ T | 0..1 | string | The name of the individual or organization that published the SubscriptionTopic
|
||||
|
contact
|
Σ | 0..* | ContactDetail | Contact details for the publisher
|
||||
|
description
|
T | 0..1 | markdown | Natural language description of the SubscriptionTopic
|
||||
|
useContext
|
Σ | 0..* | UsageContext | Content intends to support these contexts
|
||||
|
jurisdiction
|
Σ XD | 0..* | CodeableConcept | Intended jurisdiction of the SubscriptionTopic (if applicable)
Binding: Jurisdiction ValueSet ( Extensible) |
||||
|
purpose
|
T | 0..1 | markdown | Why this SubscriptionTopic is defined
|
||||
|
copyright
|
T | 0..1 | markdown | Use and/or publishing restrictions
|
||||
|
copyrightLabel
|
T | 0..1 | string | Copyright holder and year(s)
|
||||
|
approvalDate
|
0..1 | date | When SubscriptionTopic is/was approved by publisher
|
|||||
|
lastReviewDate
|
0..1 | date | Date the Subscription Topic was last reviewed by the publisher
|
|||||
|
effectivePeriod
|
Σ | 0..1 | Period | The effective date range for the SubscriptionTopic
|
||||
trigger
|
Σ | 0..* | BackboneElement | Definition of a trigger for the subscription topic
|
||||
description
|
Σ | 0..1 | markdown | Text representation of the resource trigger
|
||||
|
resource
|
Σ | 1..1 | uri | Key Data Type, Resource (reference to definition), or relevant definition for this trigger
Binding: Types used with Subscriptions ( Extensible)
|
||||
|
supportedInteraction
|
Σ | 0..* | code | create | update | delete
Binding: Interaction Trigger ( Required) |
||||
|
queryCriteria
|
Σ | 0..1 | BackboneElement | Query based trigger rule
|
||||
|
previous
|
Σ | 0..1 | string | Rule applied to previous resource state
|
||||
|
resultForCreate
|
Σ | 0..1 | code | test-passes | test-fails
Binding: Criteria Not Exists Behavior ( Required) |
||||
|
current
|
Σ | 0..1 | string | Rule applied to current resource state
|
||||
|
resultForDelete
|
Σ | 0..1 | code | test-passes | test-fails
Binding: Criteria Not Exists Behavior ( Required) |
||||
|
requireBoth
|
Σ | 0..1 | boolean | Both must be true flag
|
||||
|
fhirPathCriteria
|
Σ | 0..1 | string | FHIRPath based trigger rule
|
||||
|
event
|
Σ | 0..1 | CodeableConcept | Event which can trigger a notification from the SubscriptionTopic
Binding: hl7VS-eventTypeCode ( Example) |
||||
|
canFilterBy
|
Σ | 0..* | BackboneElement | Properties by which a Subscription can filter notifications based on this trigger
|
||||
|
description
|
Σ | 0..1 | markdown | Description of this filter parameter
|
||||
|
resource
|
Σ | 0..1 | uri | URL of the triggering Resource that this filter applies to
Binding: Types used with Subscriptions ( Extensible)
|
||||
|
filterParameter
|
Σ | 1..1 | string | Human-readable and computation-friendly name for a filter parameter usable by subscriptions on this topic, via Subscription.filterBy.filterParameter
|
||||
|
filterDefinition
|
Σ | 0..1 | uri | Canonical URL for a filterParameter definition
|
||||
|
comparator
|
0..* | code | eq | ne | gt | lt | ge | le | sa | eb | ap
Binding: Search Comparator ( Required) |
|||||
|
modifier
|
0..* | code | missing | exact | contains | not | text | in | not-in | below | above | type | identifier | of-type | code-text | text-advanced | iterate
Binding: Search Modifier Code ( Required) |
|||||
|
notificationShape
|
Σ | 0..* | BackboneElement | Properties for describing the shape of notifications generated by this trigger
|
||||
|
resource
|
Σ | 1..1 | uri | URL of the key definition that is the focus in a notification shape
Binding: Types used with Subscriptions ( Extensible)
|
||||
|
include
|
Σ | 0..* | string | Include directives, rooted in the resource for this shape
|
||||
|
revInclude
|
Σ | 0..* | string | Reverse include directives, rooted in the resource for this shape
|
||||
|
relatedQuery
|
Σ | 0..* | BackboneElement | Query describing data relevant to this notification
|
||||
|
queryType
|
Σ | 0..1 | Coding | Coded information describing the type of data this query provides
|
||||
|
query
|
Σ | 1..1 | string | Query to perform
|
||||
|
Documentation for this format
|
||||||||