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.r4b.core
derivation: specialization
name: Subscription
type: Subscription
elements:
  status:
    isModifier: true
    short: requested | active | error | off
    index: 0
    type: code
    mustSupport: false
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/subscription-status|4.3.0'}
    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
  contact: {isModifier: false, short: Contact details for source (e.g. troubleshooting), type: ContactPoint, mustSupport: false, array: true, isSummary: true, index: 1}
  end: {isModifier: false, short: When to automatically delete the subscription, type: instant, mustSupport: false, isSummary: true, index: 2}
  reason: {isModifier: false, short: Description of why this subscription was created, type: string, mustSupport: false, isSummary: true, index: 3}
  criteria: {isModifier: false, short: Rule for server push, type: string, mustSupport: false, isSummary: true, index: 4}
  error: {isModifier: false, short: Latest error note, type: string, mustSupport: false, isSummary: true, index: 5}
  channel:
    isModifier: false
    short: The channel on which to report matches to the criteria
    index: 6
    type: BackboneElement
    mustSupport: false
    elements:
      type:
        isModifier: false
        short: rest-hook | websocket | email | sms | message
        type: code
        mustSupport: false
        binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/subscription-channel-type|4.3.0'}
        isSummary: true
        index: 7
      endpoint: {isModifier: false, short: Where the channel points to, type: url, mustSupport: false, isSummary: true, index: 8}
      payload:
        isModifier: false
        short: MIME type to send, or omit for no payload
        type: code
        mustSupport: false
        binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/mimetypes|4.3.0'}
        isSummary: true
        index: 9
      header: {isModifier: false, short: Usage depends on the channel type, type: string, mustSupport: false, array: true, isSummary: true, index: 10}
    required: [type]
    isSummary: true
package_version: 4.3.0
class: resource
kind: resource
url: http://hl7.org/fhir/StructureDefinition/Subscription
base: http://hl7.org/fhir/StructureDefinition/DomainResource
version: 4.3.0
required: [status, reason, channel, criteria]