SubscriptionTopic

Trial Use 2 Foundation

Describes a stream of resource state changes identified by trigger criteria and annotated with labels useful to filter projections from this topic.

Endpoints

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

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

Top-level elements

Element	Type(s)	Cardinality	Description
url	uri	1..1	Canonical identifier for this subscription topic, represented as an absolute URI (globally unique)
identifier	Identifier	0..*	Business identifier for subscription topic
version	string	0..1	Business version of the subscription topic
versionAlgorithm[x]	string / Coding	0..1	How to compare versions
name	string	0..1	Name for this subscription topic (computer friendly)
title	string	0..1	Name for this subscription topic (human friendly)
derivedFrom	canonical	0..*	Based on FHIR protocol or definition
status	code	1..1	draft
experimental	boolean	0..1	If for testing purposes, not real usage
date	dateTime	0..1	Date status first applied
publisher	string	0..1	The name of the individual or organization that published the SubscriptionTopic
contact	ContactDetail	0..*	Contact details for the publisher
description	markdown	0..1	Natural language description of the SubscriptionTopic
useContext	UsageContext	0..*	Content intends to support these contexts
jurisdiction	CodeableConcept	0..*	Intended jurisdiction of the SubscriptionTopic (if applicable)
purpose	markdown	0..1	Why this SubscriptionTopic is defined
copyright	markdown	0..1	Use and/or publishing restrictions
copyrightLabel	string	0..1	Copyright holder and year(s)
approvalDate	date	0..1	When SubscriptionTopic is/was approved by publisher
lastReviewDate	date	0..1	Date the Subscription Topic was last reviewed by the publisher
effectivePeriod	Period	0..1	The effective date range for the SubscriptionTopic
resourceTrigger	BackboneElement	0..*	Definition of a resource-based trigger for the subscription topic
eventTrigger	BackboneElement	0..*	Event definitions the SubscriptionTopic
canFilterBy	BackboneElement	0..*	Properties by which a Subscription can filter notifications from the SubscriptionTopic
notificationShape	BackboneElement	0..*	Properties for describing the shape of notifications generated by this topic

Resource-specific search parameters

Parameter	Type	Description
date	date	The activity definition publication date
derived-or-self	uri	A server defined search that matches either the url or derivedFrom
effective	date	Effective period
event	token	Event trigger
identifier	token	External identifier for the activity definition
resource	uri	Allowed resource for this definition
status	token	The current status of the activity definition
title	string	The human-friendly name of the activity definition
trigger-description	string	Text representation of the trigger
url	uri	The uri that identifies the activity definition
version	token	The business version of the activity definition

Reference

• Official FHIR R5 spec: SubscriptionTopic
• Maturity: Trial Use 2 (FMM 2).