AIRCapabilityStatement
type: CapabilityStatement
node role: treeRoot
resource.id:
  value: AIRCapabilityStatement
domain resource.text:
  narrative.status:
    value: extensions
  narrative.div: Generated Narrative: CapabilityStatement AIRCapabilityStatement AIR FHIR Server Capability Statement Implementation Guide Version: 2.1.0 FHIR Version: 4.0.1 Supported Formats: json Published on: 2023-02-14 Published by: Te Whatu Ora Note to Implementers: FHIR Capabilities Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case. FHIR RESTful Capabilities Mode: server Security Enable CORS: yes Security services supported: OAuth Summary of System-wide Interactions Supports the transactioninteraction. Summary of System-wide Operations Conformance Operation Documentation SHALL $process-message POST| [base]/$process-message| http://hl7.org/fhir/OperationDefinition/MessageHeader-process-message| system/MessageHeader.u Capabilities by Resource/Profile Summary The summary table lists the resources that are part of this configuration, and for each resource it lists: The relevant profiles (if any) The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them. The required, recommended, and some optional search parameters (if any). The linked resources enabled for _include The other resources enabled for _revinclude The operations on the resource (if any) Resource Type Profile R S U C H-I Searches _include _revinclude Operations Immunization https://standards.digital.health.nz/fhir/air/StructureDefinition/air-immunization y y y y patient, protocolApplied.targetDisease, status-reason:not-in, status:not-in, data-quality *, Immunization.patient, Immunization.performer.actor, Immunization.location $upsert, $bulk-update Patient https://standards.digital.health.nz/fhir/air/StructureDefinition/air-patient y $update-state, $reassign-schedules, $patient-history Resource…
capability statement.url:
  value: https://standards.digital.health.nz/fhir/air/CapabilityStatement/AIRCapabilityStatement
capability statement.version:
  value: 2.1.0
capability statement.name:
  value: AIRCapabilityStatement
capability statement.title:
  value: AIR FHIR Server Capability Statement
capability statement.status:
  value: draft
capability statement.experimental:
  value: false
capability statement.date:
  value: 2023-02-14
capability statement.publisher:
  value: Te Whatu Ora
capability statement.contact:
  index: 0
  contact detail.name:
    value: Te Whatu Ora
  contact detail.telecom:
    index: 0
    contact point.system:
      value: url
    contact point.value:
      value: https://tewhatuora.govt.nz
capability statement.description:
  value: The Aotearoa Immunisation Register (AIR) FHIR v4.0.1 API
capability statement.jurisdiction:
  index: 0
  codeable concept.coding:
    index: 0
    coding.system:
      value: urn:iso:std:iso:3166
    coding.code:
      value: US
    coding.display:
      value: New Zealand
capability statement.kind:
  value: instance
capability statement.implementation:
  capability statement.implementation.description:
    value: PROD - ImmSoT Service endpoint
  capability statement.implementation.url:
    value: https://air.api.digital.health.nz/v2/fhir
capability statement.fhir version:
  value: 4.0.1
capability statement.format:
  value: json
  index: 0
capability statement.rest:
  index: 0
  capability statement.rest.mode:
    value: server
  capability statement.rest.security:
    element.extension:
      index: 0
      element.extension:
        index: 0
      element.extension:
        index: 1
      extension.url:
        value: http://fhir-registry.smarthealthit.org/StructureDefinition/oauth-uris
    capability statement.rest.security.cors:
      value: true
    capability statement.rest.security.service:
      index: 0
      codeable concept.coding:
        index: 0
  capability statement.rest.resource:
    index: 0
    element.extension:
      index: 0
      element.extension:
        index: 0
      extension.url:
        value: http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination
    element.extension:
      index: 1
      element.extension:
        index: 0
      element.extension:
        index: 1
      element.extension:
        index: 2
      element.extension:
        index: 3
      extension.url:
        value: http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination
    capability statement.rest.resource.type:
      value: Immunization
    capability statement.rest.resource.profile:
      value: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-immunization
      link: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-immunization
    capability statement.rest.resource.interaction:
      index: 0
      capability statement.rest.resource.interaction.code:
        value: create
      capability statement.rest.resource.interaction.documentation:
        value: POST|[base]/Immunization/|The "create" operation is used to create a new immunisation event. This method performs validation checks to ensure that the event is valid before it is created. Returns either the created Immunization record or if there were any issues with the create, the response will contain an OperationOutcome resource array. The OperationOutcome resource has an informational issue indicating that the create operation failed. The issue array of the OperationOutcome resource would contain additional issues with appropriate severity and code values.|system/Immunization.c
    capability statement.rest.resource.interaction:
      index: 1
      capability statement.rest.resource.interaction.code:
        value: read
      capability statement.rest.resource.interaction.documentation:
        value: GET|[base]/Immunization/[id]|The "read" operation is used to read an immunisation event. This method takes an immunisation event id and returns back the FHIR resource for the immunization event.|system/Immunization.r
    capability statement.rest.resource.interaction:
      index: 2
      capability statement.rest.resource.interaction.code:
        value: update
      capability statement.rest.resource.interaction.documentation:
        value: PUT|[base]/Immunization/[id]| The "update" operation is used to update an existing immunisation event. This method checks if the immunisation event with the given ID exists, and if it does, it updates the event with the new details provided. The method also performs validation checks to ensure that the updated event is valid before it is saved. Returns either the the updated immunisation record or an OperationOutcome if there were any issues with the update. On success - returns the updated immunisation record. data quality issues will be identified and sent as part of the response in the meta section of the resource. On Fail - if there were any issues with the update, the response will contain an OperationOutcome resource array. The OperationOutcome resource has an informational issue indicating that the update operation failed. The issue array of the OperationOutcome resource would contain additional issues with appropriate severity and code values.|system/Immunization.u
    capability statement.rest.resource.interaction:
      index: 3
      capability statement.rest.resource.interaction.code:
        value: history-instance
      capability statement.rest.resource.interaction.documentation:
        value: GET|[base]/Immunization/[id]_history|The _history interaction is used to return all the versions of an immunization event including the data quality. This method takes an immsot_id and returns back the FHIR bundle, which is a collection of immunization event resources where each resource in the bundle represents a version.|system/Immunization.r, air-admin/Immunization.r
    capability statement.rest.resource.versioning:
      value: versioned
    capability statement.rest.resource.read history:
      value: false
    capability statement.rest.resource.update create:
      value: false
    capability statement.rest.resource.conditional create:
      value: false
    capability statement.rest.resource.conditional read:
      value: not-supported
    capability statement.rest.resource.conditional update:
      value: false
    capability statement.rest.resource.conditional delete:
      value: not-supported
    capability statement.rest.resource.search include:
      value: *
      index: 0
    capability statement.rest.resource.search include:
      value: Immunization.patient
      index: 1
    capability statement.rest.resource.search include:
      value: Immunization.performer.actor
      index: 2
    capability statement.rest.resource.search include:
      value: Immunization.location
      index: 3
    capability statement.rest.resource.search param:
      index: 0
      capability statement.rest.resource.search param.name:
        value: patient
      capability statement.rest.resource.search param.definition:
        value: http://hl7.org/fhir/SearchParameter/patient
        link: http://hl7.org/fhir/SearchParameter/patient
      capability statement.rest.resource.search param.type:
        value: reference
      capability statement.rest.resource.search param.documentation:
        value: NHI number of the patient
    capability statement.rest.resource.search param:
      index: 1
      capability statement.rest.resource.search param.name:
        value: protocolApplied.targetDisease
      capability statement.rest.resource.search param.definition:
        value: http://hl7.org/fhir/SearchParameter/target-disease
        link: http://hl7.org/fhir/SearchParameter/target-disease
      capability statement.rest.resource.search param.type:
        value: token
      capability statement.rest.resource.search param.documentation:
        value: Vaccine-preventable disease being targeted by an immunisation.
    capability statement.rest.resource.search param:
      index: 2
      capability statement.rest.resource.search param.name:
        value: status-reason:not-in
      capability statement.rest.resource.search param.definition:
        value: http://hl7.org/fhir/SearchParameter/Immunization-StatusReason
        link: http://hl7.org/fhir/SearchParameter/Immunization-StatusReason
      capability statement.rest.resource.search param.type:
        value: token
      capability statement.rest.resource.search param.documentation:
        value: Exclude immunisation events with specified status reason codes
    capability statement.rest.resource.search param:
      index: 3
      capability statement.rest.resource.search param.name:
        value: status:not-in
      capability statement.rest.resource.search param.definition:
        value: http://hl7.org/fhir/SearchParameter/Immunization-Status
        link: http://hl7.org/fhir/SearchParameter/Immunization-Status
      capability statement.rest.resource.search param.type:
        value: token
      capability statement.rest.resource.search param.documentation:
        value: Exclude immunisation events with specified statuses
    capability statement.rest.resource.search param:
      index: 4
      capability statement.rest.resource.search param.name:
        value: data-quality
      capability statement.rest.resource.search param.definition:
        value: https://standards.digital.health.nz/fhir/air/StructureDefinition/immunization-data-quality
        link: https://standards.digital.health.nz/fhir/air/StructureDefinition/immunization-data-quality

value: token

value: authorize

value: OAuth

value: required

value: patient

value: required

value: patient

value: optional

value: protocolApplied.targetDisease

value: optional

value: status-reason:not-in

value: optional

value: status:not-in

value: special

value: Query search for immunisation events with data quality issues. Restricted to admin users.

index: 0
capability statement.rest.resource.operation.name:
  value: upsert
capability statement.rest.resource.operation.definition:
  value: https://standards.digital.health.nz/fhir/air/OperationDefinition/immunization-upsert
  link: https://standards.digital.health.nz/fhir/air/OperationDefinition/immunization-upsert
capability statement.rest.resource.operation.documentation:
  value: Update or add an immunisation event

index: 1
capability statement.rest.resource.operation.name:
  value: bulk-update
capability statement.rest.resource.operation.definition:
  value: https://standards.digital.health.nz/fhir/air/OperationDefinition/immunization-bulk-update
  link: https://standards.digital.health.nz/fhir/air/OperationDefinition/immunization-bulk-update
capability statement.rest.resource.operation.documentation:
  value: Update or add immunisation events in bulk.

index: 1
capability statement.rest.resource.type:
  value: Patient
capability statement.rest.resource.profile:
  value: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-patient
  link: https://standards.digital.health.nz/fhir/air/StructureDefinition/air-patient
capability statement.rest.resource.interaction:
  index: 0
  capability statement.rest.resource.interaction.code:
    value: read
  capability statement.rest.resource.interaction.documentation:
    value: GET|[base]/Patient/[id]|Read the current state of an ImmSOT Consumer. Consumer state held in ImmSOT is returned as a FHIR AIR Patient. When an optional header "origin-nhi-version" is included which contains the NHI version, the API will check if it is the same NHI version we have stored in ImmSoT database for the Consumer. If it is the same, we return the current data we have in ImmSoT database. If it is not the same, we do a Consumer sync with NHI and update the data we have in ImmSoT database and then return this updated data in the response.|system/Patient.r, air-test/Patient.r
capability statement.rest.resource.operation:
  index: 0
  capability statement.rest.resource.operation.name:
    value: update-state
  capability statement.rest.resource.operation.definition:
    value: https://standards.digital.health.nz/fhir/air/OperationDefinition/update-patient-state
    link: https://standards.digital.health.nz/fhir/air/OperationDefinition/update-patient-state
  capability statement.rest.resource.operation.documentation:
    value: Update the current state of an ImmSOT Consumer. Updates the Consumer state and/or sub status only. Input is the Consumer version previously read (used for operation optimistic locking) and the desired Consumer state. At least one of state and subStatus must be specified. If state or subStatus is not specified, then these attributes will not be updated. Setting subStatus to null will clear the current sub status. A 412 Preconditioned Failed will be returned if the version received in the payload does not match the server version.
capability statement.rest.resource.operation:
  index: 1
  capability statement.rest.resource.operation.name:
    value: reassign-schedules
  capability statement.rest.resource.operation.definition:
    value: https://standards.digital.health.nz/fhir/air/OperationDefinition/reassign-patient-schedules
    link: https://standards.digital.health.nz/fhir/air/OperationDefinition/reassign-patient-schedules
  capability statement.rest.resource.operation.documentation:
    value: Reassign immunisation schedules for a patient. Cancels the existing schedules and then creates a new set of schedules based on the new onboarding date. Input is the new onboarding date.
capability statement.rest.resource.operation:
  index: 2
  capability statement.rest.resource.operation.name:
    value: patient-history
  capability statement.rest.resource.operation.definition:
    value: https://standards.digital.health.nz/fhir/air/OperationDefinition/patient-history
    link: https://standards.digital.health.nz/fhir/air/OperationDefinition/patient-history
  capability statement.rest.resource.operation.documentation:
    value: Fetch all the versions of an ImmSOT Patient/Consumer.

index: 0
capability statement.rest.interaction.code:
  value: transaction

index: 0
capability statement.rest.resource.operation.name:
  value: process-message
capability statement.rest.resource.operation.definition:
  value: http://hl7.org/fhir/OperationDefinition/MessageHeader-process-message
  link: http://hl7.org/fhir/OperationDefinition/MessageHeader-process-message
capability statement.rest.resource.operation.documentation:
  value: POST| [base]/$process-message| http://hl7.org/fhir/OperationDefinition/MessageHeader-process-message| system/MessageHeader.u

index: 0
capability statement.messaging.supported message:
  index: 0
  capability statement.messaging.supported message.mode:
    value: sender
  capability statement.messaging.supported message.definition:
    value: http://hl7.org.nz/fhir/MessageDefinition/UpdateImmunisationRequestMessageDefinition
    link: http://hl7.org.nz/fhir/MessageDefinition/UpdateImmunisationRequestMessageDefinition
capability statement.messaging.supported message:
  index: 1
  capability statement.messaging.supported message.mode:
    value: sender
  capability statement.messaging.supported message.definition:
    value: http://hl7.org.nz/fhir/MessageDefinition/UpdateImmunisationResponsetMessageDefinition
    link: http://hl7.org.nz/fhir/MessageDefinition/UpdateImmunisationResponsetMessageDefinition