Release 5 Preview #2
FHIR Infrastructure Work GroupMaturity Level: 0 Trial UseSecurity Category: Business Compartments: Not linked to any defined compartments

Detailed Descriptions for the elements in the SubscriptionTopic resource.

SubscriptionTopic
Element IdSubscriptionTopic
Definition

Describes a stream of resource state changes identified by trigger criteria and annotated with labels useful to filter projections from this topic.

Cardinality0..*
TypeDomainResource
SubscriptionTopic.url
Element IdSubscriptionTopic.url
Definition

An absolute URL that is used to identify this SubscriptionTopic when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this Topic is (or will be) published. The URL SHOULD include the major version of the Topic. For more information see Technical and Business Versions.

Cardinality1..1
Typeuri
Requirements

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

Summarytrue
Comments

Can be a urn:uuid: or a urn:oid:, but real http: addresses are preferred. This is the URI that will be used when making canonical references to this resource.

SubscriptionTopic.identifier
Element IdSubscriptionTopic.identifier
Definition

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

NoteThis is a business identifier, not a resource identifier (see discussion)
Cardinality0..*
TypeIdentifier
Requirements

Allows identification of the SubscriptionTopic 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
Element IdSubscriptionTopic.version
Definition

The identifier that is used to identify this version of the SubscriptionTopic 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.

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 SubscriptionTopic that have the same identifier but different versions.

SubscriptionTopic.title
Element IdSubscriptionTopic.title
Definition

A short, descriptive, user-friendly title for the SubscriptionTopic, for example, "admission".

Cardinality0..1
Typestring
Alternate NamesName; SubscriptionTopic Name
Summarytrue
SubscriptionTopic.derivedFrom
Element IdSubscriptionTopic.derivedFrom
Definition

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

Cardinality0..*
Typecanonical(SubscriptionTopic)
Requirements

SubscriptionTopics may be refinements of more generic topics.

Summarytrue
SubscriptionTopic.status
Element IdSubscriptionTopic.status
Definition

The current state of the SubscriptionTopic.

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.html#statemachine | 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.

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

Cardinality0..1
Typeboolean
Is Modifiertrue (Reason: This is labeled as "Is Modifier" because applications should not use an experimental SubscriptionTopic in production.)
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
Element IdSubscriptionTopic.date
Definition

For draft definitions, indicates the date of initial creation. For active definitions, represents the date of activation. For withdrawn definitions, indicates the date of withdrawal.

Cardinality0..1
TypedateTime
Alternate Namescreated
Summarytrue
SubscriptionTopic.publisher
Element IdSubscriptionTopic.publisher
Definition

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

Cardinality0..1
TypeReference(Practitioner | PractitionerRole | Organization)
PatternsReference(Practitioner,PractitionerRole,Organization): Common patterns = Participant
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
Element IdSubscriptionTopic.contact
Definition

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

Cardinality0..*
TypeContactDetail
Summarytrue
Comments

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

SubscriptionTopic.description
Element IdSubscriptionTopic.description
Definition

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

Cardinality0..1
Typemarkdown
Comments

This description can be used to capture details such as why the Topic was built, 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
Element IdSubscriptionTopic.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.

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
Element IdSubscriptionTopic.jurisdiction
Definition

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

Cardinality0..*
Terminology BindingJurisdiction (Extensible)
TypeCodeableConcept
Summarytrue
SubscriptionTopic.purpose
Element IdSubscriptionTopic.purpose
Definition

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

Cardinality0..1
Typemarkdown
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
Element IdSubscriptionTopic.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.

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
SubscriptionTopic.approvalDate
Element IdSubscriptionTopic.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.

Cardinality0..1
Typedate
Comments

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

SubscriptionTopic.lastReviewDate
Element IdSubscriptionTopic.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.

Cardinality0..1
Typedate
Comments

If specified, this is usually after the approval date.

SubscriptionTopic.effectivePeriod
Element IdSubscriptionTopic.effectivePeriod
Definition

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

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
Element IdSubscriptionTopic.resourceTrigger
Definition

The criteria for including updates to a nominated resource in the subscription topic. Thie criteria may be just a human readable description and/or a full FHIR search string or FHIRPath expression.

Cardinality0..1
Alternate NamesTrigger; Criteria
Summarytrue
SubscriptionTopic.resourceTrigger.description
Element IdSubscriptionTopic.resourceTrigger.description
Definition

The human readable description of what triggers inclusion into this subscription topic - for example, "Beginning of a clinical encounter".

Cardinality0..1
Typestring
Summarytrue
Comments

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

SubscriptionTopic.resourceTrigger.resourceType
Element IdSubscriptionTopic.resourceTrigger.resourceType
Definition

The list of resource types that are candidates for this subscription topic. For example, the Encounter resource is updated in an 'admission' subscription topic.

Cardinality0..*
Terminology BindingResourceType (Required)
Typecode
Summarytrue
SubscriptionTopic.resourceTrigger.methodCriteria
Element IdSubscriptionTopic.resourceTrigger.methodCriteria
Definition

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

Cardinality0..*
Terminology BindingInteraction Trigger (Required)
Typecode
Summarytrue
SubscriptionTopic.resourceTrigger.queryCriteria
Element IdSubscriptionTopic.resourceTrigger.queryCriteria
Definition

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

Cardinality0..1
Summarytrue
SubscriptionTopic.resourceTrigger.queryCriteria.previous
Element IdSubscriptionTopic.resourceTrigger.queryCriteria.previous
Definition

The FHIR query based rules are applied to the 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 "/".

SubscriptionTopic.resourceTrigger.queryCriteria.current
Element IdSubscriptionTopic.resourceTrigger.queryCriteria.current
Definition

The FHIR query based rules are applied to the 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 "/".

SubscriptionTopic.resourceTrigger.queryCriteria.requireBoth
Element IdSubscriptionTopic.resourceTrigger.queryCriteria.requireBoth
Definition

If set to true, both current and previous criteria must evaluate true to trigger a notification for this topic. Otherwise a notification for this topic will be triggered if either one evaluates to true.

Cardinality0..1
Typeboolean
Summarytrue
SubscriptionTopic.resourceTrigger.fhirPathCriteria
Element IdSubscriptionTopic.resourceTrigger.fhirPathCriteria
Definition

The FHIRPath based rules that the server should use to determine when to trigger a notification for this topic. If there are multiple, FHIRPath filters are joined with AND.

Cardinality0..*
Typestring
Summarytrue
Comments

FHIRPath expression with %previous and %current vars.

SubscriptionTopic.canFilterBy
Element IdSubscriptionTopic.canFilterBy
Definition

List of properties by which Subscriptions on the subscription topic can be filtered.

Cardinality0..*
Summarytrue
SubscriptionTopic.canFilterBy.searchParamName
Element IdSubscriptionTopic.canFilterBy.searchParamName
Definition

A search parameter (like "patient") which is a label for the filter.

Cardinality0..1
Typestring
Summarytrue
Comments

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

SubscriptionTopic.canFilterBy.searchModifier
Element IdSubscriptionTopic.canFilterBy.searchModifier
Definition

Allowable operators to apply when determining matches (Search Modifiers).

Cardinality0..*
Terminology BindingSubscription Search Modifier (Required)
Typecode
Summarytrue
SubscriptionTopic.canFilterBy.documentation
Element IdSubscriptionTopic.canFilterBy.documentation
Definition

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

Cardinality0..1
Typemarkdown
Summarytrue