description: An extension to hold additional metadata for resources such as global headers and license URL.
package_name: tewhatuora.digitaltooling
derivation: constraint
name: HnzApiSpecBuilderExtension
type: Extension
elements:
  extension:
    array: true
    min: 3
    index: 0
    slicing:
      slices:
        globalHeaders:
          match: {}
          schema:
            short: Global HTTP headers to be added to all operations as request parameters within the OpenAPI specification
            array: true
            index: 1
            extensions: {}
            elements:
              extension: {type: Extension, url: 'https://fhir-ig.digital.health.nz/hnz-digital-tooling/StructureDefinition/custom-headers-extension', index: 2}
              url:
                pattern: {type: Uri, value: globalHeaders}
                index: 3
              value:
                choices: []
                index: 5
        licenseURL:
          match: {}
          schema:
            short: A URL to the license under which the FHIR API is provided.
            _required: true
            index: 6
            extensions: {}
            elements:
              extension: {index: 7}
              url:
                pattern: {type: Uri, value: licenseURL}
                index: 8
              value:
                choices: [valueUri]
                index: 10
              valueUri: {type: uri, choiceOf: value, index: 11}
        externalDocs:
          match: {}
          schema:
            short: A URL to the external documentation for this FHIR API.
            _required: true
            index: 12
            extensions: {}
            elements:
              extension: {index: 13}
              url:
                pattern: {type: Uri, value: externalDocs}
                index: 14
              value:
                choices: [valueUri]
                index: 16
              valueUri: {type: uri, choiceOf: value, index: 17}
        licenseName:
          match: {}
          schema:
            short: A name for the license under which the FHIR API is provided.
            _required: true
            index: 18
            extensions: {}
            elements:
              extension: {index: 19}
              url:
                pattern: {type: Uri, value: licenseName}
                index: 20
              value:
                choices: [valueString]
                index: 22
              valueString: {type: string, choiceOf: value, index: 23}
  url:
    pattern: {type: Uri, value: 'https://fhir-ig.digital.health.nz/hnz-digital-tooling/StructureDefinition/resource-metadata-extension'}
    index: 24
  value:
    choices: []
    index: 26
package_version: 0.0.7
extensions:
  globalHeaders:
    url: null
    short: Global HTTP headers to be added to all operations as request parameters within the OpenAPI specification
    array: true
    index: 1
    extensions: {}
    elements:
      extension: {type: Extension, url: 'https://fhir-ig.digital.health.nz/hnz-digital-tooling/StructureDefinition/custom-headers-extension', index: 2}
      url:
        pattern: {type: Uri, value: globalHeaders}
        index: 3
      value:
        choices: []
        index: 5
  licenseURL:
    url: null
    short: A URL to the license under which the FHIR API is provided.
    _required: true
    index: 6
    extensions: {}
    elements:
      extension: {index: 7}
      url:
        pattern: {type: Uri, value: licenseURL}
        index: 8
      value:
        choices: [valueUri]
        index: 10
      valueUri: {type: uri, choiceOf: value, index: 11}
  externalDocs:
    url: null
    short: A URL to the external documentation for this FHIR API.
    _required: true
    index: 12
    extensions: {}
    elements:
      extension: {index: 13}
      url:
        pattern: {type: Uri, value: externalDocs}
        index: 14
      value:
        choices: [valueUri]
        index: 16
      valueUri: {type: uri, choiceOf: value, index: 17}
  licenseName:
    url: null
    short: A name for the license under which the FHIR API is provided.
    _required: true
    index: 18
    extensions: {}
    elements:
      extension: {index: 19}
      url:
        pattern: {type: Uri, value: licenseName}
        index: 20
      value:
        choices: [valueString]
        index: 22
      valueString: {type: string, choiceOf: value, index: 23}
class: extension
kind: complex-type
url: https://fhir-ig.digital.health.nz/hnz-digital-tooling/StructureDefinition/resource-metadata-extension
base: http://hl7.org/fhir/StructureDefinition/Extension
version: 0.0.7