Subscription

Subscription

draftResource23 elementsv4.0.1

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.

Metadata

hl7.org/fhir
Canonical URL
http://hl7.org/fhir/StructureDefinition/Subscription
ID
Subscription
Type
Base Definition
Derivation
specialization
Publisher
Health Level Seven International (FHIR Infrastructure)
Version
4.0.1
PathCard.TypeDescription
Subscription
0..*
Server push subscription criteria
id
0..1
string
Logical id of this artifact
meta
0..1
Metadata about the resource
implicitRules
0..1
uri
A set of rules under which this content was created
language
0..1
code
Language of the resource contentpreferred: languages
text
0..1
Text summary of the resource, for human interpretation
contained
0..*
Resource
Contained, inline Resources
extension
0..*
Additional content defined by implementations
modifierExtension
0..*
Extensions that cannot be ignored
status
1..1
code
requested | active | error | offrequired: subscription-status
contact
0..*
Contact details for source (e.g. troubleshooting)
end
0..1
instant
When to automatically delete the subscription
reason
1..1
string
Description of why this subscription was created
criteria
1..1
string
Rule for server push
error
0..1
string
Latest error note
channel
1..1
BackboneElement
The channel on which to report matches to the criteria