Trial Use 3
Foundation
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.
Endpoints
alphahttps://api.dev.ovok.com/fhir/R4/Subscription
| 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(s) | Cardinality | Description |
|---|
status | code | 1..1 | requested | active | error | off modifier |
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
Reference
- Official FHIR R4 spec:
Subscription
- Maturity: Trial Use 3 (FMM 3).