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 can take an appropriate action.
These interaction paths describe standard FHIR R4 patterns. Availability can depend on the API capabilities enabled for your Ovok project.
| Interaction | Method | Path |
|---|---|---|
| Read | GET | /fhir/R4/Subscription/[id] |
| Vread | GET | /fhir/R4/Subscription/[id]/_history/[vid] |
| Update | PUT | /fhir/R4/Subscription/[id] |
| Patch | PATCH | /fhir/R4/Subscription/[id] |
| Delete | DELETE | /fhir/R4/Subscription/[id] |
| Create | POST | /fhir/R4/Subscription |
| Search | GET | /fhir/R4/Subscription |
| History | GET | /fhir/R4/Subscription/[id]/_history |
Top-level elements
| Element | Type | Cardinality | Description |
|---|---|---|---|
id | string | 0..1 | Logical id of this artifact |
meta | Meta | 0..1 | Metadata about the resource |
implicitRules | uri | 0..1 | A set of rules under which this content was created |
language | code | 0..1 | Language of the resource content |
text | Narrative | 0..1 | Text summary of the resource, for human interpretation |
contained | Resource | 0..* | Contained, inline Resources |
extension | Extension | 0..* | Additional content defined by implementations |
modifierExtension | Extension | 0..* | Extensions that cannot be ignored |
status | code | 1..1 | requested | active | error | off |
contact | ContactPoint | 0..* | Contact details for source (e.g. troubleshooting) |
end | instant | 0..1 | When to automatically delete the subscription |
reason | string | 1..1 | Description of why this subscription was created |
criteria | string | 1..1 | Rule for server push |
error | string | 0..1 | Latest error note |
channel | BackboneElement | 1..1 | The channel on which to report matches to the criteria |
Resource-specific search parameters
| Parameter | Type | Description |
|---|---|---|
contact | token | Contact details for the subscription |
criteria | string | The search rules used to determine when to send a notification |
payload | token | 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 |
Reference
Official FHIR R4 spec: Subscription.
Maturity: Trial Use 3 (FMM 3).