description: Base StructureDefinition for Subscription Resource
package_name: hl7.fhir.r2.core
name: Subscription
type: null
elements:
  criteria: {type: string, short: Rule for server push criteria, comments: 'The rules are a search criteria (without the [base] part). Like Bundle.entry.request.url, it has no leading "/".', isSummary: true, index: 0}
  contact: {type: ContactPoint, short: Contact details for source (e.g. troubleshooting), isSummary: true, array: true, index: 1}
  reason: {type: string, short: Description of why this subscription was created, isSummary: true, index: 2}
  status: {isModifier: true, short: requested | active | error | off, 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.', type: code, isSummary: true, index: 3}
  error: {type: string, short: Latest error note, isSummary: true, index: 4}
  channel:
    type: BackboneElement
    short: The channel on which to report matches to the criteria
    isSummary: true
    index: 5
    elements:
      type: {type: code, short: rest-hook | websocket | email | sms | message, isSummary: true, index: 6}
      endpoint: {type: uri, short: Where the channel points 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 their may be more than one, clients should avoid using relative URIs).', isSummary: true, index: 7}
      payload: {type: string, short: 'Mimetype to send, or blank for no payload', comments: Sending the payload has obvious security consequences. The server is responsible for ensuring that the content is appropriately secured., isSummary: true, index: 8}
      header: {type: string, short: Usage depends on the channel type, comments: Exactly what these mean depend on the channel type. The can convey additional information to the recipient and/or meet security requirements., isSummary: true, index: 9}
    required: [type, payload]
  end: {short: When to automatically delete the subscription, comments: 'The server is permitted to deviate from this time, but should observe it.', type: instant, isSummary: true, index: 10}
  tag: {short: A tag to add to matching resources, comments: So that other systems can tell which resources have been the subject of a notification., type: Coding, array: true, isSummary: true, index: 11}
package_version: 1.0.2
class: resource
kind: resource
url: http://hl7.org/fhir/StructureDefinition/Subscription
version: null
required: [status, reason, channel, criteria]