description: This is an extension to support the ITK handling specification. This provides the ability to control the sending of acknowledgements and other values such as profile ID and interaction ID.
package_name: NHSD.Assets.STU3
derivation: constraint
name: Extension-ITK-MessageHandling-2
type: Extension
elements:
  extension:
    index: 0
    slicing:
      rules: open
      discriminator:
      - {path: url, type: value}
      min: null
      slices:
        BusAckRequested:
          match: {url: BusAckRequested}
          schema:
            short: Populated when sender requires a business level response to be returned.
            _required: true
            index: 1
            elements:
              url:
                pattern: {type: Uri, value: BusAckRequested}
                index: 2
              valueBoolean:
                type: boolean
                index: 3
                slicing:
                  slices:
                    valueBoolean:
                      match: {}
                      schema: {type: boolean, _required: true, index: 3}
                      min: 1
            required: [valueBoolean]
        InfAckRequested:
          match: {url: InfAckRequested}
          schema:
            short: Populated when sender requires an infrastructure level response to be returned.
            _required: true
            index: 4
            elements:
              url:
                pattern: {type: Uri, value: InfAckRequested}
                index: 5
              valueBoolean:
                type: boolean
                index: 6
                slicing:
                  slices:
                    valueBoolean:
                      match: {}
                      schema: {type: boolean, _required: true, index: 6}
                      min: 1
            required: [valueBoolean]
        RecipientType:
          match: {url: RecipientType}
          schema:
            short: Indicates the type of recipient.
            _required: true
            index: 7
            elements:
              url:
                pattern: {type: Uri, value: RecipientType}
                index: 8
              valueCoding:
                type: Coding
                index: 9
                slicing:
                  slices:
                    valueCoding:
                      match: {}
                      schema:
                        type: Coding
                        _required: true
                        index: 9
                        elements:
                          system:
                            pattern: {type: Uri, value: 'https://fhir.nhs.uk/STU3/CodeSystem/ITK-RecipientType-1'}
                            index: 10
                          version: {index: 11}
                          code: {index: 12}
                          display: {index: 13}
                          userSelected: {index: 14}
                        required: [display, system, code]
            required: [valueCoding]
        MessageDefinition:
          match: {url: MessageDefinition}
          schema:
            short: A reference to a URL for the MessageDefinition for the payload, which can be any message definition instance which conforms to the ITK message definition profile.   This MessageDefinition will detail the information to allow correct processing of the payload, such as profiles used, message event type, profiles used, responses allowed/ required etc..
            _required: true
            index: 15
            elements:
              url:
                pattern: {type: Uri, value: MessageDefinition}
                index: 16
              valueReference:
                type: Reference
                index: 17
                slicing:
                  slices:
                    valueReference:
                      match: {}
                      schema:
                        type: Reference
                        _required: true
                        index: 17
                        elements:
                          reference: {index: 18}
                          identifier: {index: 19}
                          display: {index: 20}
                        required: [reference]
            required: [valueReference]
        SenderReference:
          match: {url: SenderReference}
          schema:
            short: A reference that the sender includes and wants returned in any response.
            _required: true
            index: 21
            elements:
              url:
                pattern: {type: Uri, value: SenderReference}
                index: 22
              valueString:
                type: string
                maxLength: 255
                index: 23
                slicing:
                  slices:
                    valueString:
                      match: {}
                      schema: {type: string, maxLength: 255, _required: true, index: 23}
                      min: 1
            required: [valueString]
        LocalExtension:
          match: {url: LocalExtension}
          schema:
            _required: true
            index: 24
            elements:
              url:
                pattern: {type: Uri, value: LocalExtension}
                index: 25
              value:
                choices: []
                index: 27
            required: [value]
  url:
    pattern: {type: Uri, value: 'https://fhir.nhs.uk/STU3/StructureDefinition/Extension-ITK-MessageHandling-2'}
    index: 28
  value:
    choices: []
    index: 30
package_version: 1.0.0
extensions:
  BusAckRequested:
    url: BusAckRequested
    short: Populated when sender requires a business level response to be returned.
    _required: true
    index: 1
    elements:
      url:
        pattern: {type: Uri, value: BusAckRequested}
        index: 2
      valueBoolean:
        type: boolean
        index: 3
        slicing:
          slices:
            valueBoolean:
              match: {}
              schema: {type: boolean, _required: true, index: 3}
              min: 1
    required: [valueBoolean]
  InfAckRequested:
    url: InfAckRequested
    short: Populated when sender requires an infrastructure level response to be returned.
    _required: true
    index: 4
    elements:
      url:
        pattern: {type: Uri, value: InfAckRequested}
        index: 5
      valueBoolean:
        type: boolean
        index: 6
        slicing:
          slices:
            valueBoolean:
              match: {}
              schema: {type: boolean, _required: true, index: 6}
              min: 1
    required: [valueBoolean]
  RecipientType:
    url: RecipientType
    short: Indicates the type of recipient.
    _required: true
    index: 7
    elements:
      url:
        pattern: {type: Uri, value: RecipientType}
        index: 8
      valueCoding:
        type: Coding
        index: 9
        slicing:
          slices:
            valueCoding:
              match: {}
              schema:
                type: Coding
                _required: true
                index: 9
                elements:
                  system:
                    pattern: {type: Uri, value: 'https://fhir.nhs.uk/STU3/CodeSystem/ITK-RecipientType-1'}
                    index: 10
                  version: {index: 11}
                  code: {index: 12}
                  display: {index: 13}
                  userSelected: {index: 14}
                required: [display, system, code]
    required: [valueCoding]
  MessageDefinition:
    url: MessageDefinition
    short: A reference to a URL for the MessageDefinition for the payload, which can be any message definition instance which conforms to the ITK message definition profile.   This MessageDefinition will detail the information to allow correct processing of the payload, such as profiles used, message event type, profiles used, responses allowed/ required etc..
    _required: true
    index: 15
    elements:
      url:
        pattern: {type: Uri, value: MessageDefinition}
        index: 16
      valueReference:
        type: Reference
        index: 17
        slicing:
          slices:
            valueReference:
              match: {}
              schema:
                type: Reference
                _required: true
                index: 17
                elements:
                  reference: {index: 18}
                  identifier: {index: 19}
                  display: {index: 20}
                required: [reference]
    required: [valueReference]
  SenderReference:
    url: SenderReference
    short: A reference that the sender includes and wants returned in any response.
    _required: true
    index: 21
    elements:
      url:
        pattern: {type: Uri, value: SenderReference}
        index: 22
      valueString:
        type: string
        maxLength: 255
        index: 23
        slicing:
          slices:
            valueString:
              match: {}
              schema: {type: string, maxLength: 255, _required: true, index: 23}
              min: 1
    required: [valueString]
  LocalExtension:
    url: LocalExtension
    _required: true
    index: 24
    elements:
      url:
        pattern: {type: Uri, value: LocalExtension}
        index: 25
      value:
        choices: []
        index: 27
    required: [value]
class: extension
kind: complex-type
url: https://fhir.nhs.uk/STU3/StructureDefinition/Extension-ITK-MessageHandling-2
base: http://hl7.org/fhir/StructureDefinition/Extension
version: 2.1.0