Subscription
Subscriptions on MIDATA
Subscriptions may be used to automatically trigger actions on certain conditions. Subscriptions may be created using the “Default Subscriptions” page of the developer portal or using the FHIR API. Read the Subscriptions and Messages guide for more information.
Semantical type
The FHIR resource type is also used as semantical type of the resource. Include the FHIR resource name Subscription into your applications access filter if you need to use this resource.
Resource owner
The creator of the resource is always the owner of the resource.
Read
Read a single Subscription by id.
Request:
[GET] /fhir/Subscription/<id>
Search
Search for resources of type Subscription
Request:
[GET] /fhir/Subscription?searchParams
List of supported search parameters:
Supported query parameters:
Name | Type | Description |
---|---|---|
_id | token | The ID of the resource |
_lastUpdated | date | Only return resources which were last updated as specified by the given range |
add-tag | token | A tag to be added to the resource matching the criteria |
contact | token | Contact details for the subscription |
criteria | string | The search rules used to determine when to send a notification |
payload | string | The mime-type of the notification payload |
status | token | The current state of the subscription |
type | token | The type of channel for the sent notifications |
url | uri | The uri that will receive the notifications |
Create
Create a new resource of type Subscription.
Request:
[POST] /fhir/Subscription
Update
Updates a resource of type Subscription.
Request:
[PUT] /fhir/Subscription/<id>