Subscriptions R5 Backport
1.2.0-ballot - ballot International flag

Subscriptions R5 Backport, published by HL7 International / FHIR Infrastructure. This guide is not an authorized publication; it is the continuous build for version 1.2.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-subscription-backport-ig/ and changes regularly. See the Directory of published versions

Artifacts Summary

Contents:

This page provides a list of the FHIR artifacts defined as part of this implementation guide.

Behavior: Capability Statements

The following artifacts define the specific capabilities that different types of systems are expected to have in order to comply with this implementation guide. Systems conforming to this implementation guide are expected to declare conformance to one or more of the following capability statements.

R4 Topic-Based Subscription Server Capability Statement

CapabilityStatement describing the minimal required capabilities of a FHIR Server supporting backported R5 Subscriptions in R4.
R4B Topic-Based Subscription Server Capability Statement

CapabilityStatement describing the minimal required capabilities of a FHIR Server supporting backported R5 Subscriptions in R4B.

Behavior: Operation Definitions

These are custom operations that can be supported by and/or invoked by systems conforming to this implementation guide.

Get WS Binding Token for Subscription Operation

This operation is used to get a token for a websocket client to use in order to bind to one or more subscriptions.
Subscription Events Operation

This operation is used to return historical events in the backported R5-Style Subscriptions.
Subscription Resend Operation

This operation is used to resend historical events in the backported R5-Style Subscriptions.
Subscription Status Operation

This operation is used to return the current status information about one or more backported R5-Style Subscriptions in R4.

Behavior: Search Parameters

These define the properties by which a RESTful server can be searched. They can also be used for sorting and including related resources.

Search by Canonical URL used in a topic-based subscription

This SearchParameter enables query of subscriptions by canonical topic url.
Search by custom channel types used for notifications

This SearchParameter enables query of subscriptions by additional channel type.
Search by payload types used for notifications

This SearchParameter enables query of subscriptions by payload type.
Search by the filtering criteria used to narrow a topic-based subscription topic

This SearchParameter enables query of subscriptions by filter criteria.

Structures: Resource Profiles

These define constraints on FHIR resources for systems conforming to this implementation guide.

R4 Backported R5 SubscriptionStatus

Profile on Parameters for topic-based subscription notifications in R4.
R4 Topic-Based Subscription Notification Bundle

Profile on the R4 Bundle resource to enable R5-style topic-based subscription notifications in FHIR R4.
R4/B Topic-Based Subscription

Profile on the Subscription resource to enable R5-style topic-based subscriptions in FHIR R4 or R4B.
R4B Topic-Based Subscription Notification Bundle

Profile on the R4B Bundle resource to enable R5-style topic-based subscription notifications in FHIR R4B.

Structures: Extension Definitions

These define constraints on FHIR data types for systems conforming to this implementation guide.

Authorization information relevant to a notification

Authorization context information and value (e.g., token).
Backport R5 Subscription Heartbeat Period

Interval in seconds to send ‘heartbeat’ notifications.
Backport R5 Subscription Payload Content Information

How much of the resource content to deliver in the notification payload. The choices are an empty payload, only the resource id, or the full resource content.
Backport R5 Subscription Timeout

Timeout in seconds to attempt notification delivery.
Backported R5 Additional Channel Types

Additional channel types not defined before FHIR R5.
Backported R5 FilterBy Criteria

Criteria for topic-based filtering (filter-by).
Backported R5 Subscription MaxCount

Maximum number of triggering resources included in notification bundles.
CapabilityStatement SubscriptionTopic Canonical

Extension used to advertise supported SubscriptionTopic canonical URLs in a CapabilityStatement.
Related query information

Combination of coded information and query for information related to a notification event.

Terminology: Value Sets

These define sets of codes used by systems conforming to this implementation guide.

Backported R5 Subscription Content Value Set

Codes to represent how much resource content to send in the notification payload.

Terminology: Code Systems

These define new code systems used by systems conforming to this implementation guide.

Backported R5 Subscription Content Code System

Codes to represent how much resource content to send in the notification payload.

Example: Example Instances

These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.

Backported Subscription: Admission

R4/B Example of a topic-based ‘admission’ subscription.
Backported Subscription: Custom Channel

R4/B Example of a topic-based subscription using a custom channel.
Backported Subscription: Multi-Resource

R4/B Example of a topic-based subscription with additional context resources.
Backported SubscriptionTopic: R4 Encounter Complete

R4 example of a basic-wrapped subscription topic for completed encounters.
Backported SubscriptionTopic: R4B Encounter Complete

R4B example of a subscription topic for completed encounters.
R4 CapabilityStatement: Server Example

R4 example of a CapabilityStatement advertising support for topic-based subscriptions and a few topics.
R4 Notification: Empty

R4 Example of a topic-based subscription event notification with empty content.
R4 Notification: Empty with Authoriztion

R4 Example of a topic-based subscription event notification with empty content.
R4 Notification: Error

R4 Example of a topic-based subscription query-status response with an error state.
R4 Notification: Full Resource

R4 Example of a topic-based subscription event notification with full-resource content.
R4 Notification: Full Resource with related query

R4 Example of a topic-based subscription event notification with full-resource content and related queries.
R4 Notification: Handshake

R4 Example of a topic-based subscription handshake notification.
R4 Notification: Heartbeat

R4 Example of a topic-based subscription heartbeat notification.
R4 Notification: Id Only

R4 Example of a topic-based subscription event notification with id-only content.
R4 Notification: Id Only with Authorization

R4 Example of a topic-based subscription event notification with id-only content and authorization.
R4 Notification: Id Only with Related Query

R4 Example of a topic-based subscription event notification with id-only content and related queries.
R4 Notification: Multiple Resources

R4 Example of a topic-based subscription event notification with full-resource content and a related resource.
R4 Notification: Status

R4 Example of a topic-based subscription notification with status content.
R4B Notification: Empty

R4B Example of a topic-based subscription event notification with empty content.
R4B Notification: Empty with Authorization Hint

R4B Example of a topic-based subscription event notification with empty content and authorization.
R4B Notification: Error

R4B Example of a topic-based subscription query-status response with an error state.
R4B Notification: Full Resource

R4B Example of a topic-based subscription event notification with full-resource content.
R4B Notification: Full Resource with Query

R4B Example of a topic-based subscription event notification with full-resource content.
R4B Notification: Handshake

R4B Example of a topic-based subscription handshake notification.
R4B Notification: Heartbeat

R4B Example of a topic-based subscription heartbeat notification.
R4B Notification: Id Only

R4B Example of a topic-based subscription event notification with id-only content.
R4B Notification: Id Only with Authorization Hint

R4B Example of a topic-based subscription event notification with id-only content and authorization.
R4B Notification: Id Only with Query

R4B Example of a topic-based subscription event notification with id-only content and a related query.
R4B Notification: Multiple Resources

R4B Example of a topic-based subscription event notification with full-resource content and a related resource.
R4B Notification: Status

R4B Example of a topic-based subscription notification with status content.