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*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

Params

organizationId*string|stringid|slug

Body

resourceType*stringSubscriptionThis is a Subscription resource
statusstringrequested|active|error|offThe status of the subscription, which marks the server state for managing the subscription.
contactarray(ContactPoint)Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting.
endstringThe time for the server to turn the subscription off.
reasonstringA description of why this subscription is defined.
criteriastringThe rules that the server should use to determine when to generate notifications for this subscription.
errorstringA record of the last error that occurred when the server processed a notification.
channel*Subscription_ChannelDetails where to send notifications when resources are received that meet the criteria.
tagarray(Coding)A tag to add to any resource that matches the criteria, after the subscription is processed.

Response

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

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*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringSubscriptionThis is a Subscription resource
statusstringrequested|active|error|offThe status of the subscription, which marks the server state for managing the subscription.
contactarray(ContactPoint)Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting.
endstringThe time for the server to turn the subscription off.
reasonstringA description of why this subscription is defined.
criteriastringThe rules that the server should use to determine when to generate notifications for this subscription.
errorstringA record of the last error that occurred when the server processed a notification.
channel*Subscription_ChannelDetails where to send notifications when resources are received that meet the criteria.
tagarray(Coding)A tag to add to any resource that matches the criteria, after the subscription is processed.

Response

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

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

Params

organizationId*string|stringid|slug
resourceId*

Response

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

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug
resourceId*

Response

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

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

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

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

Params

organizationId*string|stringid|slug
resourceId*

Response

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

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
add-tagstring
contactstring
criteriastring
payloadstring
statusstring
typestring
urlstring

Params

organizationId*string|stringid|slug

Response

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

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug

Response

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

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*stringapplication/json|application/x-www-form-urlencodedapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
add-tagstring
contactstring
criteriastring
payloadstring
statusstring
typestring
urlstring

Params

organizationId*string|stringid|slug

Body

resourceType*stringSubscriptionThis is a Subscription resource
statusstringrequested|active|error|offThe status of the subscription, which marks the server state for managing the subscription.
contactarray(ContactPoint)Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting.
endstringThe time for the server to turn the subscription off.
reasonstringA description of why this subscription is defined.
criteriastringThe rules that the server should use to determine when to generate notifications for this subscription.
errorstringA record of the last error that occurred when the server processed a notification.
channel*Subscription_ChannelDetails where to send notifications when resources are received that meet the criteria.
tagarray(Coding)A tag to add to any resource that matches the criteria, after the subscription is processed.

Response

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

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*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringSubscriptionThis is a Subscription resource
statusstringrequested|active|error|offThe status of the subscription, which marks the server state for managing the subscription.
contactarray(ContactPoint)Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting.
endstringThe time for the server to turn the subscription off.
reasonstringA description of why this subscription is defined.
criteriastringThe rules that the server should use to determine when to generate notifications for this subscription.
errorstringA record of the last error that occurred when the server processed a notification.
channel*Subscription_ChannelDetails where to send notifications when resources are received that meet the criteria.
tagarray(Coding)A tag to add to any resource that matches the criteria, after the subscription is processed.

Response