subscriptions

post

/organizations/{organizationId}/fhir/3/subscription

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 is able to take an appropriate action.

Request

Headers


content-type*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params

Params


organizationId*	string\|string		id\|slug

Body


resourceType*	string	Subscription	This is a Subscription resource
status	string	requested\|active\|error\|off	The status of the subscription, which marks the server state for managing the subscription.
contact	array(ContactPoint)		Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting.
end	string		The time for the server to turn the subscription off.
reason	string		A description of why this subscription is defined.
criteria	string		The rules that the server should use to determine when to generate notifications for this subscription.
error	string		A record of the last error that occurred when the server processed a notification.
channel*	Subscription_Channel		Details where to send notifications when resources are received that meet the criteria.
tag	array(Coding)		A tag to add to any resource that matches the criteria, after the subscription is processed.

Response

200 400 401 404

patch

/organizations/{organizationId}/fhir/3/subscription/{resourceId}

Request

Headers


content-type*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params

Params


organizationId*	string\|string		id\|slug
resourceId*

Body


resourceType*	string	Subscription	This is a Subscription resource
status	string	requested\|active\|error\|off	The status of the subscription, which marks the server state for managing the subscription.
contact	array(ContactPoint)		Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting.
end	string		The time for the server to turn the subscription off.
reason	string		A description of why this subscription is defined.
criteria	string		The rules that the server should use to determine when to generate notifications for this subscription.
error	string		A record of the last error that occurred when the server processed a notification.
channel*	Subscription_Channel		Details where to send notifications when resources are received that meet the criteria.
tag	array(Coding)		A tag to add to any resource that matches the criteria, after the subscription is processed.

Response

200 400 401 404

get

/organizations/{organizationId}/fhir/3/subscription/{resourceId}

Request

Headers


content-type*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 400 401 404

get

/organizations/{organizationId}/fhir/3/subscription/{resourceId}/_history

Request

Headers


content-type*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_count	string
_since	string

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 400 401 404

get

/organizations/{organizationId}/fhir/3/subscription/{resourceId}/_history/{versionId}

Request

Headers


content-type*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params

Params


organizationId*	string\|string	id\|slug
resourceId*
versionId*

Response

200 400 401 404

delete

/organizations/{organizationId}/fhir/3/subscription/{resourceId}

Request

Headers


content-type*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 400 401 404

get

/organizations/{organizationId}/fhir/3/subscription

Request

Headers


content-type*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_id	string
_language	string
add-tag	string
contact	string
criteria	string
payload	string
status	string
type	string
url	string

Params


organizationId*	string\|string		id\|slug

Response

200 400 401 404

get

/organizations/{organizationId}/fhir/3/subscription/_history

Request

Headers


content-type*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_count	string
_since	string

Params


organizationId*	string\|string		id\|slug

Response

200 400 401 404

post

/organizations/{organizationId}/fhir/3/subscription/_search

Request

Headers


content-type*	string	application/json\|application/x-www-form-urlencoded	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_id	string
_language	string
add-tag	string
contact	string
criteria	string
payload	string
status	string
type	string
url	string

Params


organizationId*	string\|string		id\|slug

Body


resourceType*	string	Subscription	This is a Subscription resource
status	string	requested\|active\|error\|off	The status of the subscription, which marks the server state for managing the subscription.
contact	array(ContactPoint)		Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting.
end	string		The time for the server to turn the subscription off.
reason	string		A description of why this subscription is defined.
criteria	string		The rules that the server should use to determine when to generate notifications for this subscription.
error	string		A record of the last error that occurred when the server processed a notification.
channel*	Subscription_Channel		Details where to send notifications when resources are received that meet the criteria.
tag	array(Coding)		A tag to add to any resource that matches the criteria, after the subscription is processed.

Response

200 400 401 404

put

/organizations/{organizationId}/fhir/3/subscription/{resourceId}

Request

Headers


content-type*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params

Params


organizationId*	string\|string		id\|slug
resourceId*

Body


resourceType*	string	Subscription	This is a Subscription resource
status	string	requested\|active\|error\|off	The status of the subscription, which marks the server state for managing the subscription.
contact	array(ContactPoint)		Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting.
end	string		The time for the server to turn the subscription off.
reason	string		A description of why this subscription is defined.
criteria	string		The rules that the server should use to determine when to generate notifications for this subscription.
error	string		A record of the last error that occurred when the server processed a notification.
channel*	Subscription_Channel		Details where to send notifications when resources are received that meet the criteria.
tag	array(Coding)		A tag to add to any resource that matches the criteria, after the subscription is processed.

Response

200 400 401 404