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