description: The subscription resource describes a particular client's request to be notified about a Topic.
package_name: hl7.fhir.r5.core
derivation: specialization
name: Subscription
type: Subscription
elements:
  eventCount: {type: unsignedInt, short: Notification event counter, isSummary: true, index: 12}
  name: {type: string, short: Human readable name for this subscription, isSummary: true, index: 1}
  channel:
    type: BackboneElement
    short: The channel on which to report matches to the criteria
    isSummary: true
    index: 13
    elements:
      type:
        short: rest-hook | websocket | email | message
        type: CodeableConcept
        binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/subscription-channel-type'}
        isSummary: true
        index: 14
      endpoint: {short: Where the channel points to, type: url, isSummary: true, index: 15}
      header: {short: Usage depends on the channel type, type: string, array: true, isSummary: true, index: 16}
      heartbeatPeriod: {type: unsignedInt, short: Interval in seconds to send 'heartbeat' notification, isSummary: true, index: 17}
      payload:
        type: BackboneElement
        short: Payload definition
        isSummary: true
        index: 18
        elements:
          contentType:
            short: MIME type to send, or omit for no payload
            type: code
            binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/mimetypes|4.2.0'}
            isSummary: true
            index: 19
          content:
            short: empty | id-only | full-resource
            type: code
            binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/subscription-payload-content|4.2.0'}
            isSummary: true
            index: 20
    required: [type]
  topic:
    short: Reference to the topic being subscribed to
    refers: ['http://hl7.org/fhir/StructureDefinition/Topic']
    type: Reference
    isSummary: true
    index: 3
  reason: {short: Description of why this subscription was created, type: string, isSummary: true, index: 6}
  status:
    isModifier: true
    short: requested | active | error | off
    type: code
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/subscription-status|4.2.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
    index: 2
  identifier: {short: Additional identifiers (business identifier), type: Identifier, array: true, isSummary: true, index: 0}
  error:
    short: Latest error code or note
    type: CodeableConcept
    array: true
    binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/subscription-error'}
    isSummary: true
    index: 11
  end: {short: When to automatically delete the subscription, type: instant, isSummary: true, index: 5}
  filterBy:
    type: BackboneElement
    short: Criteria for narrowing the topic stream
    isSummary: true
    array: true
    index: 7
    elements:
      name: {type: string, short: Filter label defined in Topic, isSummary: true, index: 8}
      matchType:
        short: = | in | not-in | above | below
        type: code
        binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/subscription-operator|4.2.0'}
        isSummary: true
        index: 9
      value: {type: string, short: Literal value or resource path, isSummary: true, index: 10}
    required: [name, value]
  contact: {short: Contact details for source (e.g. troubleshooting), type: ContactPoint, array: true, isSummary: true, index: 4}
package_version: 4.2.0
class: resource
kind: resource
url: http://hl7.org/fhir/StructureDefinition/Subscription
base: http://hl7.org/fhir/StructureDefinition/DomainResource
version: 4.2.0
required: [status, channel, topic]