description: 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.
package_name: hl7.fhir.core
derivation: specialization
name: Subscription
type: Subscription
elements:
  status:
    isModifier: true
    short: requested | active | error | off
    type: code
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/subscription-status'}
    isModifierReason: This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
    isSummary: true
    index: 0
  contact: {short: Contact details for source (e.g. troubleshooting), type: ContactPoint, array: true, isSummary: true, index: 1}
  end: {short: When to automatically delete the subscription, type: instant, isSummary: true, index: 2}
  reason: {short: Description of why this subscription was created, type: string, isSummary: true, index: 3}
  criteria: {short: Rule for server push, type: string, isSummary: true, index: 4}
  error: {type: string, short: Latest error note, isSummary: true, index: 5}
  channel:
    type: BackboneElement
    short: The channel on which to report matches to the criteria
    isSummary: true
    index: 6
    elements:
      type:
        short: rest-hook | websocket | email | sms | message
        type: code
        binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/subscription-channel-type'}
        isSummary: true
        index: 7
      endpoint: {short: Where the channel points to, type: url, isSummary: true, index: 8}
      payload: {short: 'MIME type to send, or omit for no payload', type: string, isSummary: true, index: 9}
      header: {short: Usage depends on the channel type, type: string, array: true, isSummary: true, index: 10}
    required: [type]
  tag:
    short: A tag to add to matching resources
    type: Coding
    array: true
    binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/subscription-tag'}
    isSummary: true
    index: 11
package_version: 3.5.0
class: resource
kind: resource
url: http://hl7.org/fhir/StructureDefinition/Subscription
base: http://hl7.org/fhir/StructureDefinition/DomainResource
version: null
required: [status, reason, channel, criteria]