Subscription

Foundation

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.

PathCard.TypeDescription & Constraints
Subscription0..*Server push subscription criteria
.idΣ0..1StringLogical id of this artifact
.metaΣ0..1MetaMetadata about the resource
.implicitRules?!Σ0..1uriA set of rules under which this content was created
.language0..1codeLanguage of the resource content
Bindinglanguages(preferred)
.text0..1NarrativeText summary of the resource, for human interpretation
.contained0..*ResourceContained, inline Resources
.extension0..*ExtensionAdditional content defined by implementations
.modifierExtension?!0..*ExtensionExtensions that cannot be ignored
.status?!Σ1..1coderequested | active | error | off
Bindingsubscription-status(required)
.contactΣ0..*ContactPointContact details for source (e.g. troubleshooting)
.endΣ0..1instantWhen to automatically delete the subscription
.reasonΣ1..1stringDescription of why this subscription was created
.criteriaΣ1..1stringRule for server push
.errorΣ0..1stringLatest error note
.channelΣ1..1BackboneElementThe channel on which to report matches to the criteria
.id0..1StringUnique id for inter-element referencing
.extension0..*ExtensionAdditional content defined by implementations
.modifierExtension?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.typeΣ1..1coderest-hook | websocket | email | sms | message
Bindingsubscription-channel-type(required)
.endpointΣ0..1urlWhere the channel points to
.payloadΣ0..1codeMIME type to send, or omit for no payload
Bindingmimetypes(required)
.headerΣ0..*stringUsage depends on the channel type