DSTU2

This page is part of the FHIR Specification (v1.0.2: DSTU 2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2

6.14.9 Resource Subscription - Detailed Descriptions

Detailed Descriptions for the elements in the Subscription resource.

Subscription
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 is able to take an appropriate action.

Control1..1
Alternate NamesWebHook; Hook; Routing Rule
Summarytrue
Subscription.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 a search criteria (without the [base] part). Like Bundle.entry.request.url, it has no leading "/".

Subscription.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.reason
Definition

A description of why this subscription is defined.

Control1..1
Typestring
Summarytrue
Subscription.status
Definition

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

Control1..1
BindingSubscriptionStatus: The status of a subscription. (Required)
Typecode
Is Modifiertrue
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.

Subscription.error
Definition

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

Control0..1
Typestring
Summarytrue
Subscription.channel
Definition

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

Control1..1
Summarytrue
Subscription.channel.type
Definition

The type of channel to send notifications on.

Control1..1
BindingSubscriptionChannelType: The type of method used to execute a subscription. (Required)
Typecode
Summarytrue
Subscription.channel.endpoint
Definition

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

Control0..1
Typeuri
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 their may be more than one, clients should avoid using relative URIs).

Subscription.channel.payload
Definition

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

Control1..1
Typestring
Summarytrue
Comments

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

Subscription.channel.header
Definition

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

Control0..1
Typestring
Summarytrue
Comments

Exactly what these mean depend on the channel type. The can convey additional information to the recipient and/or meet security requirements.

Subscription.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.tag
Definition

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

Control0..*
BindingSubscriptionTag: Tags to put on a resource after subscriptions have been sent. (Example)
TypeCoding
Summarytrue
Comments

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