Subscription

Trial Use 3 Foundation

The subscription resource describes a particular client's request to be notified about a SubscriptionTopic.

Endpoints

devhttps://api.sandbox.ovok.com/fhir/R5/Subscription

Interaction	Method	Path
Read	GET	/fhir/R5/Subscription/[id]
Vread	GET	/fhir/R5/Subscription/[id]/_history/[vid]
Update	PUT	/fhir/R5/Subscription/[id]
Patch	PATCH	/fhir/R5/Subscription/[id]
Delete	DELETE	/fhir/R5/Subscription/[id]
Create	POST	/fhir/R5/Subscription
Search	GET	/fhir/R5/Subscription?...
History	GET	/fhir/R5/Subscription/[id]/_history
Type-history	GET	/fhir/R5/Subscription/_history

Top-level elements

Element	Type(s)	Cardinality	Description
identifier	Identifier	0..*	Additional identifiers (business identifier)
name	string	0..1	Human readable name for this subscription
status	code	1..1	requested
topic	canonical	1..1	Reference to the subscription topic being subscribed to
contact	ContactPoint	0..*	Contact details for source (e.g. troubleshooting)
end	instant	0..1	When to automatically delete the subscription
managingEntity	Reference	0..1	Entity responsible for Subscription changes
reason	string	0..1	Description of why this subscription was created
filterBy	BackboneElement	0..*	Criteria for narrowing the subscription topic stream
channelType	Coding	1..1	Channel type for notifications
endpoint	url	0..1	Where the channel points to
parameter	BackboneElement	0..*	Channel type
heartbeatPeriod	unsignedInt	0..1	Interval in seconds to send 'heartbeat' notification
timeout	unsignedInt	0..1	Timeout in seconds to attempt notification delivery
contentType	code	0..1	MIME type to send, or omit for no payload
content	code	0..1	empty
maxCount	positiveInt	0..1	Maximum number of events that can be combined in a single notification

Resource-specific search parameters

Parameter	Type	Description
contact	token	Contact details for the subscription
content-level	token	Content level included in notifications
filter-value	string	Filter value used to narrow notifications
identifier	token	A subscription identifier
name	string	A human-readable name
owner	reference	The managing entity
payload	token	The mime-type of notifications
status	token	The current state of the subscription
topic	uri	The canonical topic url that triggers notifications
type	token	The type of channel for the sent notifications
url	uri	The uri that will receive the notifications

Reference

• Official FHIR R5 spec: Subscription
• Maturity: Trial Use 3 (FMM 3).