MissingPages1.1

Subscription

Subscription	I		Subscription	Element Id Subscription Short description Server push subscription criteria Alternate names WebHook, Hook, Routing Rule Definition 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. Data Type Subscription Constraints dom-2:If the resource is contained in another resource, it SHALL NOT contain nested Resources `contained.contained.empty()` dom-4:If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()` dom-3:If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource `contained.where((('#'+id in (%resource.descendants().reference \| %resource.descendants().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()` dom-6:A resource should have narrative for robust management text.`div`.exists() dom-5:If a resource is contained in another resource, it SHALL NOT have a security label `contained.meta.security.empty()` Mappings rim:Entity. Role, or Act rim:N/A
status	Σ ?!	1..1	codeBinding	Element Id Subscription.status Short description requested \| active \| error \| off Definition The status of the subscription, which marks the server state for managing the subscription. Comments A client can only submit subscription resources in the requested or off state. Only the server can move a subscription from requested to active, and then to error. Either the server or the client can turn a subscription off. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid. Data Type code Binding The status of a subscription. SubscriptionStatus (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a w5:FiveWs.status
contact	Σ I	0..*	ContactPoint	Element Id Subscription.contact Short description Contact details for source (e.g. troubleshooting) Definition Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting. Data Type ContactPoint Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` cpt-2:A system is required if a value is provided. `value.empty() or system.exists()` Mappings rim:n/a v2:XTN rim:TEL servd:ContactPoint w5:FiveWs.subject[x] w5:FiveWs.subject
end	Σ	0..1	instant	Element Id Subscription.end Short description When to automatically delete the subscription Definition The time for the server to turn the subscription off. Comments The server is permitted to deviate from this time but should observe it. Data Type instant Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a w5:FiveWs.done[x]
reason	Σ	1..1	string	Element Id Subscription.reason Short description Description of why this subscription was created Definition A description of why this subscription is defined. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a w5:FiveWs.why[x]
criteria	Σ	1..1	string	Element Id Subscription.criteria Short description Rule for server push Definition The rules that the server should use to determine when to generate notifications for this subscription. Comments The rules are search criteria (without the [base] part). Like Bundle.entry.request.url, it has no leading "/". Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
error	Σ	0..1	string	Element Id Subscription.error Short description Latest error note Definition A record of the last error that occurred when the server processed a notification. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
channel	Σ	1..1	BackboneElement	Element Id Subscription.channel Short description The channel on which to report matches to the criteria Definition Details where to send notifications when resources are received that meet the criteria. Data Type BackboneElement Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
type	Σ	1..1	codeBinding	Element Id Subscription.channel.type Short description rest-hook \| websocket \| email \| sms \| message Definition The type of channel to send notifications on. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type code Binding The type of method used to execute a subscription. SubscriptionChannelType (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
endpoint	Σ	0..1	url	Element Id Subscription.channel.endpoint Short description Where the channel points to Definition The url that describes the actual end-point to send messages to. Comments For rest-hook, and websocket, the end-point must be an http: or https: URL; for email, a mailto: url, for sms, a tel: url, and for message the endpoint can be in any form of url the server understands (usually, http: or mllp:). The URI is allowed to be relative; in which case, it is relative to the server end-point (since there may be more than one, clients should avoid using relative URIs). Data Type url Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
payload	Σ	0..1	codeBinding	Element Id Subscription.channel.payload Short description MIME type to send, or omit for no payload Definition The mime type to send the payload in - either application/fhir+xml, or application/fhir+json. If the payload is not present, then there is no payload in the notification, just a notification. The mime type "text/plain" may also be used for Email and SMS subscriptions. Comments Sending the payload has obvious security implications. The server is responsible for ensuring that the content is appropriately secured. Data Type code Binding The mime type of an attachment. Any valid mime type is allowed. Mime Types (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a
header	Σ	0..*	string	Element Id Subscription.channel.header Short description Usage depends on the channel type Definition Additional headers / information to send as part of the notification. Comments Exactly what these mean depend on the channel type. They can convey additional information to the recipient and/or meet security requirements; for example, support of multiple headers in the outgoing notifications for rest-hook type subscriptions. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a

Profile	Description	Status	URL
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.	draft	http://hl7.org/fhir/StructureDefinition/Subscription

Profile

Description

Status

URL

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.

draft

http://hl7.org/fhir/StructureDefinition/Subscription