This page is part of the FHIR Specification v6.0.0-ballot1: Release 6 Ballot (1st Draft) (see Ballot Notes). The current version is 5.0.0. For a full list of available versions, see the Directory of published versions

• Content
• Examples
• Detailed Descriptions
• Mappings
• Operations
• Search Params
• Profiles
• Extensions
• R4 Conversions

2.12 Resource Subscription - Content

FHIR Infrastructure Work Group

Maturity Level: 3

Trial Use

Security Category: Business

Compartments: No defined compartments

The subscription resource describes a particular client's request to be notified about a SubscriptionTopic.

2.12.3 References to this Resource

• Resource References: SubscriptionStatus

2.12.4 Resource Content

 

Additional definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) + see the extensions, the spreadsheet version & the dependency analysis

2.12.4.1 Terminology Bindings

Path	ValueSet	Type	Documentation
Subscription.status	SubscriptionStatusCodes (a valid code from Subscription Status)	Required	State values for FHIR Subscriptions.
Subscription.filterBy.resource	SubscriptionTypes	Extensible	Types used with Subscriptions
	All Resource Types	ui
Subscription.filterBy.comparator	SearchComparator	Required	What Search Comparator Codes are supported in search.
Subscription.filterBy.modifier	SearchModifierCode	Required	A supported modifier for a search parameter.
Subscription.channelType	SubscriptionChannelType (a valid code from SubscriptionChannel Type Codes )	Extensible	Core-defined FHIR channel types allowed for use in Subscriptions.
Subscription.contentType	MimeTypes (a valid code from urn:ietf:bcp:13)	Required	This value set includes all possible codes from BCP-13 (see http://tools.ietf.org/html/bcp13)
Subscription.content	SubscriptionPayloadContent	Required	Codes to represent how much resource content to send in the notification payload.

2.12.4.2 Constraints

2.12.5 Safety and Security

Applications are responsible for following FHIR security guidance. Some recommendations specific to subscriptions are provided on the Subscriptions Framework page.

2.12.6 Multi-Resource Subscriptions

As indicated on the Subscriptions Framework and SubscriptionTopic resource pages, subscriptions can have more than a single resource in scope (e.g., a subscription that triggers on both Condition and Observation resources, a topic tied to all resources, etc.). If there are filters that do not apply to every resource available in a topic, clients SHOULD ensure that the filterBy.resourceType element is filled appropriately. More detail can be found in the Filters and Resource Types section of the Subscriptions Framework page.

2.12.7 Payload Types

There are three options available when specifying the contents of a Notification: empty, id-only, and full-resource. These options change the level of detail conveyed in the notification Bundle.

When deciding which payload type to request, systems SHOULD consider both ease of processing and security of PHI. To mitigate the risk of information leakage, systems SHOULD use the minimum level of detail consistent with the use case. In practice, id-only provides a good balance between security and performance for many real-world scenarios.

If a server cannot or will not honor a payload type (e.g., will not send full-resource over HTTP), it SHOULD reject the Subscription request. A server MAY instead accept the subscription with modifications and return the accepted version to the client.

When sending event notifications servers SHALL populate the SubscriptionStatus.notificationEvent structure with relevant information, depending on the payload type.

2.12.7.1 empty

An example notification with an empty payload can be found here.

With the content type of empty, all information about the resources involved in triggering the notification is only available via channels other than the Subscription itself (e.g., the REST API or $events operation). This mitigates many security concerns by both removing most PHI from the notification and allows servers to consolidate authorization and authentication logic. When the subscriber receives a notification of this type, it may query the server to fetch all the relevant resources based on the SubscriptionTopic and applicable filters. The client might include a _lastUpdated query parameter, supplying its last query timestamp to retrieve only the most recent resources. For example, if the notification is for a topic about patient admission, the subscriber will generally query for recent Encounters for a patient or group of patients, then fetch them as needed.

When populating the SubscriptionStatus.notificationEvent structure for a notification with an empty payload, a server SHALL NOT include references to resources (e.g., SubscriptionStatus.notificationEvent.focus and SubscriptionStatus.notificationEvent.additionalContext SHALL NOT be present).

When the content type is empty, notification bundles SHALL NOT contain Bundle.entry elements other than the SubscriptionStatus for the notification.

2.12.7.2 id-only

An example notification with an id-only payload can be found here.

With the content type of id-only, the resources involved in triggering the notification are only available through other channels (e.g., REST API), but notifications include URLs which can be used to access those resources. This allows servers to consolidate authorization and authentication logic, while removing the need for expensive queries by subscribers. When a subscriber receives a notification of this type, it may directly fetch all the relevant resources using the supplied resource ids. For example, if the notification is for a topic about patient admission, the subscriber may fetch the Encounter(s) for a patient or group of patients.

When the content type is id-only, the SubscriptionStatus.notificationEvent structure SHALL include references to the appropriate focus resources in the SubscriptionStatus.notificationEvent.focus element. This provides clients a fixed location to consolidate IDs for all notification types.

Additionally, notification bundles MAY contain, in addition to the SubscriptionStatus, at least one Bundle.entry for each resource relevant to the notification. For example, a notification for a topic based on Encounter MAY include a reference to the Encounter and MAY also include additional resources deemed relevant (e.g., the linked Patient).

2.12.7.3 full-resource

An example notification with a full-resource payload can be found here.

With the content type of full-resource, the resources involved in triggering the notification are included in the notification bundle. When a subscriber receives a notification of this type, resources are already present in the bundle, though the subscriber may need to fetch additional resources from the server. For example, the if the notification is for a topic about patient admission, the subscriber may require related Observation resources.

When the content type is full-resource, the SubscriptionStatus.notificationEvent structure SHALL include references to the appropriate focus resources in the SubscriptionStatus.notificationEvent.focus element. This provides clients a fixed location to consolidate IDs for all notification types.

Notification bundles for full-resource subscriptions SHALL contain, in addition to the SubscriptionStatus, at least one Bundle.entry for each resource relevant to the notification. For example, a notification for a topic based on Encounter SHALL include an Encounter and MAY include additional resources deemed relevant (e.g., the relevant Patient). Each Bundle.entry for a full-resource notification SHALL contain a relevant resource in the entry.resource element. If a server cannot include the resource contents due to an issue with a specific notification, the server SHALL populate the entry.request and/or entry.response elements.

2.12.8 Batching Results

Subscriptions allow servers to batch multiple notifications into a single subscription-notification Bundle. For example, if a server has a high-frequency of updates (e.g., several per second), it could be beneficial to combine notifications to reduce traffic and overhead. Note that servers SHALL NOT delay sending notification longer than time span specified by Subscription.heartbeat.

2.12.9 Channels

2.12.9.1 Deciding on Channel Type

This specification defines a core set of channel types to cover the majority of common use cases. Servers MAY define additional channel types as needed. Below is some guidance for implementers to consider when selecting a channel type.

2.12.9.1.1 REST-Hook

The FHIR standard makes extensive use of the RESTful model. Given the popularity of REST and widespread adoption, most implementers should consider using REST-hook channels whenever possible. In general, REST-based systems are well-supported (e.g., tooling, infrastructure, documentation, etc.), and will present the lowest bar for implementation.

2.12.9.1.2 Websocket

Websockets are unique in the pre-defined channel types in being the only channel that does not require the client to have an endpoint. Due to this property, the websocket channel is very useful for clients where creating an endpoint would be difficult or impossible (e.g., mobile clients, web-based clients, etc.).

2.12.9.1.3 Email

The Email channel is the only channel that could contest REST in non-FHIR implementations. That said, Email communication is often high-latency and is typically used for communication to individuals - not applications. Email channels are particularly useful in the context of these non-application use cases, such as public health notifications. For example, if a public health agency does not have the ability or desire to build a custom RESTful solution (e.g., creating and maintaining an endpoint to receive notifications, as well as software to consume those notifications), it is straightforward to map notifications to email addresses or aliases.

2.12.9.1.4 FHIR Messaging

FHIR Messaging is a mechanism defined to allow for non-RESTful communication between FHIR servers and clients. One common use case is when connectivity is an issue (e.g., remote sites that batch all communications when connections are available). This channel defines how to integrate topic-based subscriptions with the FHIR Messaging model.

2.12.9.1.5 Custom Channels

For use cases that are not well-met by any of the predefined channels, the Subscriptions Framework allows for custom channel definitions. Some examples of scenarios where custom channels may be applicable include:

• requirements for reliable (guaranteed) delivery (e.g., message queues)
• implementations using other communication protocols (e.g., protocols specific to a cloud-based provider)
• implementations using a non-standard serialization format

2.12.9.2 REST Hook

To receive notifications via HTTP/S POST, a client requests a subscription with the channel type of `rest-hook` (from the subscription-channel-type Code System) and and an endpoint (Subscription.endpoint) with the desired URL. Note that this URL must be accessible by the hosting server.

To convey an event notification, the server POSTs a notification Bundle to the client's nominated endpoint URL per the format requests in the Subscription:

• The content-type of the POST SHALL match the MIME type on the Subscription Subscription.contentType.
• Each Subscription.parameter indicates an HTTP request header and SHALL be sent as {parameter.name}: {parameter.value}.

When a subscription is created for a REST Hook channel type, the server SHALL set initial status to requested, pending verification of the nominated endpoint URL. After a successful handshake notification has been sent and accepted, the server SHALL update the status to active. Any errors in the initial handshake SHALL result in the status being changed to error.

An example workflow for establishing a rest-hook subscription is shown below.

1. Client creates a Subscription with the channelType set to rest-hook.
2. Server responds with a success code and creates the subscription with a state of requested.
3. Server performs an HTTP POST to the requested endpoint with a handshake notification.
4. Client Endpoint accepts the POST and returns a success HTTP code (e.g., 200).
5. Server sends a notification of type heartbeat at any time (SHOULD at least once per heartbeatPeriod).
6. Client Endpoint accepts a heartbeat via HTTP POST and returns an HTTP success code (e.g., 200).
7. Server sends a notification of type event-notification when triggered.
8. Client Endpoint accepts an event-notification via HTTP POST and returns an HTTP code (e.g., 200).

2.12.9.2.1 Channel Security Notes

HTTP is neither a secure nor an encrypted channel, nor does it provide endpoint verification. It is strongly recommended that implementations refuse requests to send notifications to URLs using the HTTP protocol (use HTTPS instead).

2.12.9.3 WebSockets

While the primary interface for FHIR servers is the FHIR REST API, notifications need not occur via REST. Indeed, some subscribers may be unable to expose an outward-facing HTTP server to receive triggered notifications. For example, a pure client-side Web app or mobile app may want to subscribe to a data feed. This can be accomplished using a websocket notification channel from the subscription-channel-type Code System.

To receive notifications via WebSocket, a client requests a subscription with the channel type (Subscription.channelType) of websocket (from the subscription-channel-type Code System). Note that no endpoint (Subscription.endpoint) is used in websocket channels, since clients connect to a server-hosted websocket URL.

An example workflow for receiving notifications via websockets is shown below:

1. Client creates a Subscription with the channelType set to websocket.
2. Server responds with a success code and creates the subscription.
3. Client requests a websocket binding token, by invoking the $get-ws-binding-token operation via REST. Note: this call is intended to be repeated as necessary (e.g., prior to a token expiring, a client should request a new one).
4. Client parses the response of the $get-ws-binding-token operation to extract a token, expiration, and websocket-url.
5. Client connects to the server via websockets, via the returned websocket-url (wss:// preferred).
6. Client sends a bind-with-token message via websockets, with the token provided by the server. Note: this operation can be repeated concurrently for multiple subscriptions that share the same websocket-url, and serially for continued operation over a single websocket connection.
7. Server sends one or more handshake messages via websockets (one per Subscription included in the token). Note: some servers may additionally send one or more event-notification messages at this time (e.g., all messages since last connected, last 'n' messages, etc.). Clients are expected to handle either flow.
8. Server sends a notification of type heartbeat at any time (SHOULD at least once per heartbeatPeriod).
9. Server sends a notification of type event-notification when triggered.
10. If the token is expiring soon and the Client wishes to continue receiving notifications, it should invoke the $get-ws-binding-token operation via REST.
11. Server responds with at least a token, expiration, and websocket-url. Note that the token and websocket-url MAY be the same or new values, as determined by the server.
12. If the websocket-url is different from the existing connection, the Client establishes a new connection to the Client Endpoint.
13. Client sends a bind-with-token message via websockets, with the token provided by the server. Note: this operation can be repeated concurrently for multiple subscriptions that return the same websocket-url, and serially for continued operation over a single websocket connection.
14. Server sends one or more handshake messages via websockets (one per Subscription included in the token). Note: some servers may additionally send one or more event-notification messages at this time (e.g., all messages since last connected, last 'n' messages, etc.). Clients are expected to handle either flow.
15. Either the server or the client may close the websocket connection.

Notes:

• Notifications sent from the server SHALL be in the MIME Type specified by the Subscription.contentType, however, if notifications are requested for multiple subscriptions with different MIME types, the server MAY choose to send all notifications in a single MIME type.
• Notifications SHALL conform to the content level specified by Subscription.content.
• When receiving notifications, a connected websocket client has no responsibilities beyond reading the message (e.g., there is no acknowledgement message).

Note to Implementers: The Websocket channel type needs more testing and feedback to ensure all requirements are met before finalizing the specification.

2.12.9.3.1 Channel Security Notes

WebSocket security poses several challenges specific to the channel. When implementing websockets for notifications, please keep in mind the following list of some areas of concern:

• Authentication of WebSockets is not generically interoperable with JWT or other 'Authentication header' protocols - the JavaScript WebSocket API does not include the ability to include them.
• Given client limitations on concurrent WebSocket connections (commonly 6), it is recommended that a single connection be able to authenticate to multiple Subscription resources.
• Unlike HTTP/S requests, WebSockets can be long-lived. Because of this, the case of revoking access of an active connection must be considered.
• This specification does not describe the security details of Websocket tokens issued by the $get-ws-binding-token operation. Issued tokens MAY be single-use (e.g., re-establishing a connection require a new token) or reusable until their expiration (e.g., re-establishing a connection can reuse an existing token). Additionally, servers are free to issue tokens as either single-client or shared. Servers SHOULD document their policy on token issuance.

2.12.9.4 Email

While the primary interface for FHIR servers is the FHIR REST API, notifications need not occur via REST. Indeed, some subscribers may be unable to maintain an outward-facing HTTP server to receive triggered notifications. For example, a public health organization may want to be notified of outbreaks of various illnesses. This can be accomplished using an email notification channel.

To receive notifications via Email, a client requests a subscription with the channel type (Subscription.channelType) of email (from the subscription-channel-type Code System) and an endpoint (Subscription.endpoint) with the desired email URI (e.g., mailto:public_health_notifications@example.org).

The server will send a new message each time a notification should be sent (e.g., per event or per batch). The server will create a message based on the values present in the Subscription.contentType and Subscription.content fields. If a server cannot honor the requested combination, the server should reject the Subscription request rather than send unexpected email messages.

The email channel sets two guidelines about content:

• Message Body content SHALL be human readable
• Message Attachments SHOULD be machine readable

Due to these guidelines, the Subscription.contentType refers to the content of the body of the message. Attachment type information can be appended as a MIME parameter, for example:

• text/plain: a plain-text body with no attachment
• text/html: an HTML body with no attachment
• text/plain;attach=application/fhir+json: a plain-text body with a FHIR JSON bundle attached
• text/html;attach=application/fhir+xml: an HTML body with a FHIR XML bundle attached

The Subscription.content field SHALL be applied to any attachments, and MAY be applied to body contents (depending on server implementation). However, a server must not include a body which exceeds the specified content level. For example, a server may choose to always include a standard message in the body of the message containing no PHI and vary the attachment, but cannot include PHI in the body of an email when the content is set to empty.

An example workflow using the email channel type is included below.

1. Client creates a Subscription with the channelType set to email.
2. Server MAY respond with a success code and create the subscription with a state of active.
3. Server MAY respond with a success code and create the subscription with a state of requested.
4. Server sends an initial message via the specified email server (e.g., verify the request, opt-out instructions, etc.).
5. Email Server responds with a channel appropriate response code (e.g., 250: OK).
6. Server may send an email for a notification of type heartbeat at any time (SHOULD at least once per heartbeatPeriod).
7. Server may send an email for a notification of type event-notification at any time.

2.12.9.4.1 Channel Security Notes

Email (SMTP) is not a secure channel. Implementers must ensure that any messages containing PHI have been secured according to their policy requirements (e.g., use of a system such as Direct ).

2.12.9.5 Messaging

There are times when it is desireable to use Subscriptions as a communication channel between FHIR servers that are connected via Messaging instead of REST. This can be accomplished using a Subscription with the channel type of message.

To receive notifications via messaging, a client should request a subscription with the channel type (Subscription.channelType) of message and set the endpoint (Subscription.endpoint) to the destination FHIR server base URL. Note that this URL must be accessible by the hosting server.

The FHIR server hosting the subscription (server) will send FHIR messages to the destination FHIR server (endpoint) as needed. These messages will, as the contents of the message, have a fully-formed subscription-notification Bundle. An example message can be found here.

An example workflow using the message channel type is included below.

1. Client creates a Subscription with the channelType set to message.
2. Server responds with a success code and creates the subscription with a state of requested.
3. Server sends a FHIR Message to the requested endpoint with a handshake notification.
4. Client Endpoint accepts the Message and returns success.
5. Server may send a Message containing a notification of type heartbeat at any time (SHOULD at least once per heartbeatPeriod).
6. Server may send a Message containing a notification of type event-notification at any time.

Note to Implementers: The Messaging channel type needs more testing and feedback to ensure all requirements are met before finalizing the specification.

2.12.9.5.1 Channel Security Notes

Servers MAY require that the end-point is white-listed prior to allowing these kinds of subscriptions. Additionally, servers MAY impose authorization/authentication requirements for server to server communication (e.g., certificate pinning, etc.).

2.12.10 Defining Channel Types

Defining a new channel type requires clear communication to implementers of both clients and servers around requirements and expectations. Below are some areas which should be considered when creating a channel. Anyone defining a channel type is encouraged to publish their definition at registry.fhir.org .

Note to Implementers: Warning: This section is still in early drafting; feedback from topic authors is welcome to refine the following guidance.

2.12.10.1 Channel Basics

At a minimum, the following items should be defined:

• A system for Subscription.channelType that reflects the publisher of the definition (e.g., "https://myorg.example.org" instead of "urn:uuid:be35238b-0ed6-4062-93cf-818b8023a103")
• A generally descriptive code for Subscription.channelType (e.g., 'secure-mq' instead of 'channel')
• The type of data required in Subscription.endpoint (e.g., URI, etc.)
• The meaning of Subscription.parameter field values (e.g., REST-hook defines as HTTP headers included in a POST). Note that channels can specify general behavior and/or specific parameters by name.
• Any additions or variations on MIME types for Subscription.contentType (e.g., email defines this as the email body, with allowable attachments.)
• Whether handshake notifications are used, and guidance on usage if they are
• Whether heartbeat notifications are used, and guidance on timings if they are

2.12.10.2 Channel Security Considerations

Defining a channel has security implications. While it is not expected that authors cover all aspects of security, guidance specific to the channel SHOULD be provided. For example, when discussing REST-hooks, this specification includes guidance about using HTTPS over HTTP.

If the channel CANNOT be secured, that should be stated with a warning not to transfer PHI. If the channel is or can be secured, guidance should be given on how configurations relate to PHI safety, for example:

• Does the channel determine the legitimacy of both endpoints?
• Is the channel secure from third-party monitoring?

2.12.11 Managing Subscriptions and Errors

The subscription resource is authored by the client with an initial status of requested. A new subscription is created on the server using the RESTful create or update interaction. After a successful transaction, the client parses the Location header and saves the new Subscription's logical id for use in subsequent operations.

When the server receives a subscription, it SHOULD check that it is prepared to accept/process the subscription. If it is, it sets the subscription to requested and process it like a normal create. If it isn't, it SHOULD return an error with an OperationOutcome instead of processing the create.

The criteria are subject to the same limitations as the client that created it, such as access to patient compartments etc. Note that the subscription MAY remain active after the client access tokens expire.

Once the server has activated the subscription, it sets the status to active (note: the server may do this as it accepts the resource if it wants).

An appropriately authorized client can use search and/or history operations to see what subscriptions are currently active on the server. Once the subscription is no longer desired, the client deletes the subscription from the server.

The server may retry the notification a fixed number of times and/or refer errors to its own alert logs. If the notification fails, the server SHOULD set the status to error and mark the error in the resource. If the notification succeeds, the server SHOULD update the status to active and may remove any error codes. If a subscription fails consistently a server may choose set the subscription status to off and stop trying to send notifications.

Errors a server wishes to make accessible to clients are communicated via SubscriptionStatus.error. Clients MAY receive these errors in notifications sent by the server or detect them by running the $status operation on a subscription. Servers should provide a mechanism for clearing errors (e.g., when resetting a Subscription.status back to requested after an error).

2.12.12 Search Parameters

Search parameters for this resource. See also the full list of search parameters for this resource, and check the Extensions registry for search parameters on extensions related to this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

Name	Type	Description	Expression	In Common
contact	token	Contact details for the subscription	Subscription.contact
content-level	token	Content level included in notifications	Subscription.content
filter-value	string	Filter value used to narrow notifications	Subscription.filterBy.value
identifier	token	A subscription identifier	Subscription.identifier
name	string	A human-readable name	Subscription.name
owner	reference	The managing entity	Subscription.managingEntity (Practitioner, Organization, CareTeam, Patient, HealthcareService, PractitionerRole, RelatedPerson)
payload N	token	The mime-type of notifications	Subscription.contentType
status	token	The current state of the subscription	Subscription.status
topic	uri	The canonical topic url that triggers notifications	Subscription.topic
type	token	The type of channel for the sent notifications	Subscription.channelType
url	uri	The uri that will receive the notifications	Subscription.endpoint