Subscription - FHIR v3.4.0
Current Build
FHIR Infrastructure Work GroupMaturity Level: 3 Trial Use Compartments: Not linked to any defined compartments

Detailed Descriptions for the elements in the Subscription resource.

Subscription
Element IdSubscription
Definition

The subscription resource is used to define a push-based subscription from a server to another system. Once a subscription is registered with the server, the server checks every resource that is created or updated, and if the resource matches the given criteria, it sends a message on the defined "channel" so that another system can take an appropriate action.

Control1..1
TypeDomainResource
Alternate NamesWebHook; Hook; Routing Rule
Summarytrue
Subscription.status
Element IdSubscription.status
Definition

The status of the subscription, which marks the server state for managing the subscription.

Control1..1
Terminology BindingSubscriptionStatus (Required)
Typecode
Is Modifiertrue (Reason: This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid)
Summarytrue
Comments

A client can only submit subscription resources in the requested or off state. Only the server can move a subscription from requested to active, and then to error. Either the server or the client can turn a subscription off.

This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.

Subscription.contact
Element IdSubscription.contact
Definition

Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting.

Control0..*
TypeContactPoint
Summarytrue
Subscription.end
Element IdSubscription.end
Definition

The time for the server to turn the subscription off.

Control0..1
Typeinstant
Summarytrue
Comments

The server is permitted to deviate from this time but should observe it.

Subscription.reason
Element IdSubscription.reason
Definition

A description of why this subscription is defined.

Control1..1
Typestring
Summarytrue
Subscription.criteria
Element IdSubscription.criteria
Definition

The rules that the server should use to determine when to generate notifications for this subscription.

Control1..1
Typestring
Summarytrue
Comments

The rules are search criteria (without the [base] part). Like Bundle.entry.request.url, it has no leading "/".

Subscription.error
Element IdSubscription.error
Definition

A record of the last error that occurred when the server processed a notification.

Control0..1
Typestring
Summarytrue
Subscription.channel
Element IdSubscription.channel
Definition

Details where to send notifications when resources are received that meet the criteria.

Control1..1
Summarytrue
Subscription.channel.type
Element IdSubscription.channel.type
Definition

The type of channel to send notifications on.

Control1..1
Terminology BindingSubscriptionChannelType (Required)
Typecode
Summarytrue
Subscription.channel.endpoint
Element IdSubscription.channel.endpoint
Definition

The url that describes the actual end-point to send messages to.

Control0..1
Typeurl
Summarytrue
Comments

For rest-hook, and websocket, the end-point must be an http: or https: URL; for email, a mailto: url, for sms, a tel: url, and for message the endpoint can be in any form of url the server understands (usually, http: or mllp:). The URI is allowed to be relative; in which case, it is relative to the server end-point (since there may be more than one, clients should avoid using relative URIs).

Subscription.channel.payload
Element IdSubscription.channel.payload
Definition

The mime type to send the payload in - either application/fhir+xml, or application/fhir+json. If the payload is not present, then there is no payload in the notification, just a notification.

Control0..1
Typestring
Summarytrue
Comments

Sending the payload has obvious security implications. The server is responsible for ensuring that the content is appropriately secured.

Subscription.channel.header
Element IdSubscription.channel.header
Definition

Additional headers / information to send as part of the notification.

Control0..*
Typestring
Summarytrue
Comments

Exactly what these mean depend on the channel type. They can convey additional information to the recipient and/or meet security requirements; for example, support of multiple headers in the outgoing notifications for rest-hook type subscriptions.

Subscription.tag
Element IdSubscription.tag
Definition

A tag to add to any resource that matches the criteria, after the subscription is processed.

Control0..*
Terminology BindingSubscriptionTag (Example)
TypeCoding
Summarytrue
Comments

So that other systems can tell which resources have been the subject of a notification.