Skip to main content


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.


id0..1stringLogical id of this artifact
meta0..1MetaMetadata about the resource
implicitRules0..1uriA set of rules under which this content was created
language0..1codeLanguage of the resource content
text0..1NarrativeText summary of the resource, for human interpretation
contained0..*ResourceContained, inline Resources
extension0..*ExtensionAdditional content defined by implementations
modifierExtension0..*ExtensionExtensions that cannot be ignored
status1..1coderequested | active | error | off
contact0..*ContactPointContact details for source (e.g. troubleshooting)
end0..1instantWhen to automatically delete the subscription
reason1..1stringDescription of why this subscription was created
criteria1..1stringRule for server push
error0..1stringLatest error note
channel1..1BackboneElementThe channel on which to report matches to the criteria

Search Parameters

contacttokenContact details for the
criteriastringThe search rules used to determine when to send a notificationSubscription.criteria
payloadtokenThe mime-type of the notification
statustokenThe current state of the subscriptionSubscription.status
typetokenThe type of channel for the sent
urluriThe uri that will receive the