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.

Subscription is a FHIR R4 Foundation resource — server push subscription criteria. It defines 23 elements and supports 15 search parameters.

Official spec

Path	Card.	Type	Description & Constraints
Subscription	0..*	—	Server push subscription criteria
.idΣ	0..1	String	Logical id of this artifact
.metaΣ	0..1	Meta	Metadata about the resource
.implicitRules?!Σ	0..1	uri	A set of rules under which this content was created
.language	0..1	code	Language of the resource content Bindinglanguages(preferred)
.text	0..1	Narrative	Text summary of the resource, for human interpretation
.contained	0..*	Resource	Contained, inline Resources
.extension	0..*	Extension	Additional content defined by implementations
.modifierExtension?!	0..*	Extension	Extensions that cannot be ignored
.status?!Σ	1..1	code	requested \| active \| error \| off Bindingsubscription-status(required)
.contactΣ	0..*	ContactPoint	Contact details for source (e.g. troubleshooting)
.endΣ	0..1	instant	When to automatically delete the subscription
.reasonΣ	1..1	string	Description of why this subscription was created
.criteriaΣ	1..1	string	Rule for server push
.errorΣ	0..1	string	Latest error note
.channelΣ	1..1	BackboneElement	The channel on which to report matches to the criteria
.id	0..1	String	Unique id for inter-element referencing
.extension	0..*	Extension	Additional content defined by implementations
.modifierExtension?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
.typeΣ	1..1	code	rest-hook \| websocket \| email \| sms \| message Bindingsubscription-channel-type(required)
.endpointΣ	0..1	url	Where the channel points to
.payloadΣ	0..1	code	MIME type to send, or omit for no payload Bindingmimetypes(required)
.headerΣ	0..*	string	Usage depends on the channel type

More Foundation resources