Subscription

Subscription

draftFHIR Core package4.3.0resource5 key elements

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.

Metadata

hl7.org/fhir
Canonical URL
http://hl7.org/fhir/StructureDefinition/Subscription
ID
Subscription
Type
Subscription
Base Definition
DomainResource
Derivation
specialization
Mandatory and Must-Support Elements

Elements with cardinality > 0 or marked as Must Support (S)

PathCard.TypeFlagsDescription
status1..1
code
1+
requested | active | error | off
reason1..1
string
1+
Description of why this subscription was created
criteria1..1
string
1+
Rule for server push
channel1..1
BackboneElement
1+
The channel on which to report matches to the criteria
channel.type1..1
code
1+
rest-hook | websocket | email | sms | message