description: The subscription resource describes a particular client's request to be notified about a SubscriptionTopic.
package_name: hl7.fhir.r6.examples
derivation: specialization
name: Subscription
type: Subscription
elements:
  maxCount: {isModifier: false, short: Maximum number of events that can be combined in a single notification, type: positiveInt, mustSupport: false, isSummary: true, index: 24}
  content:
    isModifier: false
    short: empty | id-only | full-resource
    type: code
    mustSupport: false
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/subscription-payload-content|6.0.0-ballot3'}
    isSummary: true
    index: 23
  name: {isModifier: false, short: Human readable name for this subscription, type: string, mustSupport: false, isSummary: true, index: 1}
  topic: {isModifier: false, short: Reference to the subscription topic being subscribed to, type: canonical, mustSupport: false, isSummary: true, index: 3}
  reason: {isModifier: false, short: Description of why this subscription was created, type: string, mustSupport: false, isSummary: true, index: 7}
  heartbeatPeriod: {isModifier: false, short: Interval in seconds to send 'heartbeat' notification, type: unsignedInt, mustSupport: false, isSummary: true, index: 20}
  status:
    isModifier: true
    short: requested | active | error | off | entered-in-error
    index: 2
    type: code
    mustSupport: false
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/subscription-status|6.0.0-ballot3'}
    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
  identifier: {isModifier: false, short: Additional identifiers (business identifier), type: Identifier, mustSupport: false, array: true, isSummary: true, index: 0}
  contentType:
    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|6.0.0-ballot3'}
    isSummary: true
    index: 22
  timeout: {isModifier: false, short: Timeout in seconds to attempt notification delivery, type: unsignedInt, mustSupport: false, isSummary: true, index: 21}
  managingEntity:
    isModifier: false
    short: Entity responsible for Subscription changes
    refers: ['http://hl7.org/fhir/StructureDefinition/CareTeam', 'http://hl7.org/fhir/StructureDefinition/HealthcareService', 'http://hl7.org/fhir/StructureDefinition/Organization', 'http://hl7.org/fhir/StructureDefinition/Patient', 'http://hl7.org/fhir/StructureDefinition/Practitioner', 'http://hl7.org/fhir/StructureDefinition/PractitionerRole', 'http://hl7.org/fhir/StructureDefinition/RelatedPerson']
    type: Reference
    mustSupport: false
    isSummary: true
    index: 6
  end: {isModifier: false, short: When to automatically delete the subscription, type: instant, mustSupport: false, isSummary: true, index: 5}
  filterBy:
    constraint:
      scr-1: {human: Subscription filters may only contain a modifier or a comparator, source: 'http://hl7.org/fhir/StructureDefinition/Subscription', severity: error, expression: (comparator.exists() and modifier.exists()).not()}
    isModifier: false
    short: Criteria for narrowing the subscription topic stream
    index: 8
    type: BackboneElement
    mustSupport: false
    array: true
    elements:
      resource:
        isModifier: false
        short: Allowed Resource (reference to definition) for this Subscription filter
        type: uri
        mustSupport: false
        binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/subscription-types'}
        isSummary: true
        index: 9
      filterParameter: {isModifier: false, short: Filter label defined in SubscriptionTopic, type: string, mustSupport: false, isSummary: true, index: 10}
      comparator:
        isModifier: false
        short: eq | ne | gt | lt | ge | le | sa | eb | ap
        type: code
        mustSupport: false
        binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/search-comparator|6.0.0-ballot3'}
        isSummary: false
        index: 11
      modifier:
        isModifier: false
        short: missing | exact | contains | not | text | in | not-in | below | above | type | identifier | of-type | code-text | text-advanced | iterate
        type: code
        mustSupport: false
        binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/search-modifier-code|6.0.0-ballot3'}
        isSummary: false
        index: 12
      value: {isModifier: false, short: Literal value or resource path, type: string, mustSupport: false, isSummary: true, index: 13}
      event:
        isModifier: false
        short: Event to filter by
        type: CodeableConcept
        mustSupport: false
        array: true
        binding: {strength: example, valueSet: 'http://terminology.hl7.org/ValueSet/v2-0003'}
        isSummary: true
        index: 14
    required: [filterParameter, value]
    isSummary: true
  endpoint: {isModifier: false, short: Where the channel points to, type: url, mustSupport: false, isSummary: true, index: 16}
  contact: {isModifier: false, short: Contact details for source (e.g. troubleshooting), type: ContactPoint, mustSupport: false, array: true, isSummary: true, index: 4}
  parameter:
    isModifier: false
    short: Channel type dependent information
    index: 17
    type: BackboneElement
    mustSupport: false
    array: true
    elements:
      name: {isModifier: false, short: Name (key) of the parameter, type: string, mustSupport: false, isSummary: false, index: 18}
      value: {isModifier: false, short: Value of the parameter to use or pass through, type: string, mustSupport: false, isSummary: false, index: 19}
    required: [name, value]
    isSummary: false
  channelType:
    isModifier: false
    short: Channel type for notifications
    type: Coding
    mustSupport: false
    binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/subscription-channel-type'}
    isSummary: true
    index: 15
package_version: 6.0.0-ballot3
class: resource
kind: resource
url: http://hl7.org/fhir/StructureDefinition/Subscription
base: http://hl7.org/fhir/StructureDefinition/DomainResource
version: 6.0.0-ballot3
required: [status, channelType, topic]