description: A CapabilityStatement profile that constrains and documents the Capability Statement to the Health New Zealand Te Whatu Ora OpenAPI spec converter requirements
package_name: tewhatuora.digitaltooling
derivation: constraint
name: HnzToolingCapabilityStatement
type: CapabilityStatement
elements:
  extension:
    index: 0
    slicing:
      rules: open
      ordered: false
      discriminator:
      - {path: url, type: value}
      min: 1
      slices:
        HnzApiSpecBuilderExtension:
          match: {url: null}
          schema: {type: Extension, url: 'https://fhir-ig.digital.health.nz/hnz-digital-tooling/StructureDefinition/resource-metadata-extension', index: 1}
          min: 1
          max: 1
  version: {short: 'The version of API, displayed in the OpenAPI contact section', index: 2}
  contact:
    short: The contact details used in the OpenAPI info section
    index: 3
    elements:
      name: {short: The url for the contact, index: 4}
      telecom:
        elements:
          system:
            pattern: {type: Code, value: url}
            index: 5
    required: [name]
  format: {short: 'The media types supported by the API, e.g. application/json or application/fhir+json', index: 6}
  rest:
    elements:
      mode: {short: The mode of the RESTful interface. A mode of server MUST be provided to generate an OpenAPI spec, index: 7}
      security:
        elements:
          service: {short: 'The security service that the server supports, to annotate in the OpenAPI security section', index: 8}
      resource:
        index: 9
        elements:
          type: {short: The type of resource that the server supports. This MUST be provided to generate OpenAPI paths, index: 10}
          profile: {short: 'The base profile that the resource supports. If not provided, the base resource schema from the FHIR specification will be used', index: 11}
          supportedProfile: {short: 'The profiles that the resource supports. This MUST be provided to generate OpenAPI schemas based on the FHIR profiles, and examples on each resource', index: 12}
          interaction: {short: The interactions that the resource supports. This MUST be provided to generate OpenAPI operations, index: 13}
          searchParam: {short: The search parameters that the resource supports. This MUST be provided to generate OpenAPI parameters on each resource, index: 14}
          operation:
            short: Custom operations that the resource supports. This MUST be provided to generate a OpenAPI path/operation
            index: 15
            elements:
              name: {short: The name of the operation that the resource supports, index: 16}
              definition: {short: The canonical URL of the operation definition that the resource supports, index: 17}
      operation: {short: Custom operations that the server supports at at system level. This MUST be provided to generate a OpenAPI path/operation, index: 18}
    required: [resource]
package_version: 0.0.7
extensions:
  HnzApiSpecBuilderExtension: {url: 'https://fhir-ig.digital.health.nz/hnz-digital-tooling/StructureDefinition/resource-metadata-extension', min: 1, max: 1, type: Extension, index: 1}
class: profile
kind: resource
url: https://fhir-ig.digital.health.nz/hnz-digital-tooling/StructureDefinition/hnz-capability-statement
base: http://hl7.org/fhir/StructureDefinition/CapabilityStatement
version: 0.0.7
required: [extension, version, contact]