description: An extension to represent custom headers to be applied globally in an OpenAPI specification.
package_name: tewhatuora.digitaltooling
derivation: constraint
name: HnzCustomHeadersExtension
type: Extension
elements:
  extension:
    array: true
    min: 3
    index: 0
    slicing:
      slices:
        key:
          match: {}
          schema:
            short: The header name. E.g. Request-Context
            _required: true
            index: 1
            extensions: {}
            elements:
              extension: {index: 2}
              url:
                pattern: {type: Uri, value: key}
                index: 3
              value:
                choices: [valueString]
                index: 5
              valueString: {type: string, choiceOf: value, index: 6}
        value:
          match: {}
          schema:
            short: The uri to an OAS schema to apply for the header value
            _required: true
            index: 7
            extensions: {}
            elements:
              extension: {index: 8}
              url:
                pattern: {type: Uri, value: value}
                index: 9
              value:
                choices: [valueUri]
                index: 11
              valueUri: {type: uri, choiceOf: value, index: 12}
        required:
          match: {}
          schema:
            short: Whether the header is required or optional.
            _required: true
            index: 13
            extensions: {}
            elements:
              extension: {index: 14}
              url:
                pattern: {type: Uri, value: required}
                index: 15
              value:
                choices: [valueBoolean]
                index: 17
              valueBoolean: {type: boolean, choiceOf: value, index: 18}
  url:
    pattern: {type: Uri, value: 'https://fhir-ig.digital.health.nz/hnz-digital-tooling/StructureDefinition/custom-headers-extension'}
    index: 19
  value:
    choices: []
    index: 21
package_version: 0.0.7
extensions:
  key:
    url: null
    short: The header name. E.g. Request-Context
    _required: true
    index: 1
    extensions: {}
    elements:
      extension: {index: 2}
      url:
        pattern: {type: Uri, value: key}
        index: 3
      value:
        choices: [valueString]
        index: 5
      valueString: {type: string, choiceOf: value, index: 6}
  value:
    url: null
    short: The uri to an OAS schema to apply for the header value
    _required: true
    index: 7
    extensions: {}
    elements:
      extension: {index: 8}
      url:
        pattern: {type: Uri, value: value}
        index: 9
      value:
        choices: [valueUri]
        index: 11
      valueUri: {type: uri, choiceOf: value, index: 12}
  required:
    url: null
    short: Whether the header is required or optional.
    _required: true
    index: 13
    extensions: {}
    elements:
      extension: {index: 14}
      url:
        pattern: {type: Uri, value: required}
        index: 15
      value:
        choices: [valueBoolean]
        index: 17
      valueBoolean: {type: boolean, choiceOf: value, index: 18}
class: extension
kind: complex-type
url: https://fhir-ig.digital.health.nz/hnz-digital-tooling/StructureDefinition/custom-headers-extension
base: http://hl7.org/fhir/StructureDefinition/Extension
version: 0.0.7