SDHRCapabilityStatement
type: CapabilityStatement
node role: treeRoot
resource.id:
  value: SDHRCapabilityStatement
resource.meta:
  meta.profile:
    value: https://fhir-ig.digital.health.nz/hnz-digital-tooling/StructureDefinition/hnz-capability-statement
    index: 0
    link: https://fhir-ig.digital.health.nz/hnz-digital-tooling/StructureDefinition/hnz-capability-statement
domain resource.text:
  narrative.status:
    value: extensions
  narrative.div: Generated Narrative: CapabilityStatement SDHRCapabilityStatement Profile: Capability Statement profile for use with the Health New Zealand Te Whatu Ora OpenAPI spec converter NZ Shared Digital Health Record API Implementation Guide Version: 1.0.2 FHIR Version: 4.0.1 Supported Formats: application/fhir+json Published on: 2024-04-15 01:15:23+0000 Published by: Health New Zealand 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 Request-Context custom header All FHIR API requests MUST include the HNZ request context custom header which supplies identifiers for the health user and organisation, or system behind the API request. This context is supplied using the 'Request-Context' custom HTTP header in the form of a base64-encoded JSON object. The value of the header has differing forms based on the type of request being made, namely whether it is in a user context (e.g. a clinical user searching for patient records), or a system context (e.g. a system submitting data to the API in a bulk load scenario). Requests with user context Context property Mandatory Value userIdentifier Yes The userid of the user as authenticated by the PMS/health application secondaryIdentifier Yes The secondary identifier for the user - this MUST be the end users Common Person Number (aka HPI Practitioner identifier) of the practitioner using the application where available. Otherwise, any secondary identifier that is held for the user purposeOfUse Yes One of [ "PATRQT", "TREAT", "ETREAT", "FAMRQT", "RECORDMGT" ]. For descriptions of the values, see Audit Events userFullName Yes Full name of the user of the PMS/health application. userRole Yes Role of the user of the PMS/health application. Set to "PROV" (Provider) or "PAT" (Patient) orgIdentifier Yes The HPI Orga…
domain resource.extension:
  index: 0
  element.extension:
    index: 0
    extension.url:
      value: licenseURL
    extension.value uri:
      value: https://www.tewhatuora.govt.nz/assets/Our-health-system/Digital-health/Digital-Service-Hub/API-Access-and-Use-Agreement.docx
  element.extension:
    index: 1
    extension.url:
      value: externalDocs
    extension.value uri:
      value: https://fhir-ig.digital.health.nz/sdhr
  element.extension:
    index: 2
    extension.url:
      value: licenseName
    extension.value string:
      value: Health New Zealand Digital Services Hub API Access and Use Agreement
  element.extension:
    index: 3
    element.extension:
      index: 0
      element.extension:
        index: 0
      element.extension:
        index: 1
      element.extension:
        index: 2
      extension.url:
        value: https://fhir-ig.digital.health.nz/hnz-digital-tooling/StructureDefinition/custom-headers-extension
    element.extension:
      index: 1
      element.extension:
        index: 0
      element.extension:
        index: 1
      element.extension:
        index: 2
      extension.url:
        value: https://fhir-ig.digital.health.nz/hnz-digital-tooling/StructureDefinition/custom-headers-extension
    extension.url:
      value: globalHeaders
  extension.url:
    value: https://fhir-ig.digital.health.nz/hnz-digital-tooling/StructureDefinition/resource-metadata-extension
capability statement.url:
  value: https://fhir-ig.digital.health.nz/sdhr/CapabilityStatement/SDHRCapabilityStatement
capability statement.version:
  value: 1.0.2
capability statement.name:
  value: SDHRCapabilityStatement
capability statement.title:
  value: NZ Shared Digital Health Record API
capability statement.status:
  value: draft
capability statement.experimental:
  value: false
capability statement.date:
  value: 2024-04-15T01:15:23.3688326Z
capability statement.publisher:
  value: Health New Zealand
capability statement.contact:
  index: 0
  contact detail.name:
    value: Health New Zealand
  contact detail.telecom:
    index: 0
    contact point.system:
      value: url
    contact point.value:
      value: https://github.com/tewhatuora
capability statement.contact:
  index: 1
  contact detail.name:
    value: HNZ Integration Team
  contact detail.telecom:
    index: 0
    contact point.system:
      value: email
    contact point.use:
      value: work
capability statement.description:
  value: NZ Shared Digital Health Record API Capability Statement
capability statement.kind:
  value: capability
capability statement.software:
  capability statement.software.name:
    value: NZ Shared Digital Health Record API
  capability statement.software.version:
    value: 1.0.0
capability statement.implementation:
  capability statement.implementation.description:
    value: Health NZ | Te Whatu Ora NZ Shared Digital Health Record API
  capability statement.implementation.url:
    value: https://api.sdhr.digital.health.nz/s2s
capability statement.fhir version:
  value: 4.0.1
capability statement.format:
  value: application/fhir+json
  index: 0
capability statement.rest:
  index: 0
  capability statement.rest.mode:
    value: server
  capability statement.rest.documentation:
    value: ### Request-Context custom header All FHIR API requests MUST include the HNZ request context *custom header* which supplies identifiers for the health user and organisation, or system behind the API request. This context is supplied using the 'Request-Context' custom HTTP header in the form of a base64-encoded JSON object. The value of the header has differing forms based on the type of request being made, namely whether it is in a user context (e.g. a clinical user searching for patient records), or a system context (e.g. a system submitting data to the API in a bulk load scenario). #### Requests with user context | **Context property** | **Mandatory** | **Value** | |:-------------------------|:------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------| | `userIdentifier` | Yes | The userid of the user as authenticated by the PMS/health application | | `secondaryIdentifier` | Yes | The secondary identifier for the user - this **MUST** be the end users Common Person Number (aka HPI Practitioner identifier) of the practitioner using the application where available. Otherwise, any secondary identifier that is held for the user | | `purposeOfUse` | Yes | One of [ "PATRQT", "TREAT", "ETREAT", "FAMRQT", "RECORDMGT" ]. For descriptions of the values, see [Audit Events](https://fhir-ig.digital.health.nz/auditevents/ValueSet-purposeofuse.html) | | `userFullName` | Yes | Full name of the user of the PMS/health application. | | `userRole` | Yes | Role of the user of the PMS/health application. Set to `"PROV"` (Provider) or `"PAT"` (Patient) | | `orgIdentifier` | Yes | The HPI Organisation Number (aka HPI Organisation identifier) for the organisation in which the API consumer application is deployed | | `facilityIdentifier` | Yes | The HPI Facility identifier for the facility where the record is being sourced / accessed. | #### Requests with system context | **Context pr…
  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
    element.extension:
      index: 1
      extension.url:
        value: http://fhir-registry.smarthealthit.org/StructureDefinition/capabilities
      extension.value code:
        value: client-confidential-symmetric
    capability statement.rest.security.cors:
      value: true
    capability statement.rest.security.service:
      index: 0
      codeable concept.coding:
        index: 0
    capability statement.rest.security.description:
      value: OAuth 2.0 - Client Credential flow.
  capability statement.rest.resource:
    index: 0
    element.extension:
      index: 0
      element.extension:
        index: 0
      element.extension:
        index: 1
      extension.url:
        value: http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination
    capability statement.rest.resource.type:
      value: AllergyIntolerance
    capability statement.rest.resource.profile:
      value: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/SDHRAllergyIntolerance
      link: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/SDHRAllergyIntolerance
    capability statement.rest.resource.documentation:
      value: Note that the supported interactions of the API will vary per API Consumer, depending on the consuming system's role.
    capability statement.rest.resource.interaction:
      index: 0
      capability statement.rest.resource.interaction.code:
        value: read
    capability statement.rest.resource.interaction:
      index: 1
      capability statement.rest.resource.interaction.code:
        value: create
    capability statement.rest.resource.interaction:
      index: 2
      capability statement.rest.resource.interaction.code:
        value: update
    capability statement.rest.resource.interaction:
      index: 3
      capability statement.rest.resource.interaction.code:
        value: search-type
    capability statement.rest.resource.interaction:
      index: 4
      capability statement.rest.resource.interaction.code:
        value: delete
    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/clinical-patient
        link: http://hl7.org/fhir/SearchParameter/clinical-patient
      capability statement.rest.resource.search param.type:
        value: reference
      capability statement.rest.resource.search param.documentation:
        value: MANDATORY Who the sensitivity is for [Patient](http://hl7.org/fhir/R4/patient.html)
    capability statement.rest.resource.search param:
      index: 1
      capability statement.rest.resource.search param.name:
        value: category
      capability statement.rest.resource.search param.definition:
        value: http://hl7.org/fhir/SearchParameter/AllergyIntolerance-category
        link: http://hl7.org/fhir/SearchParameter/AllergyIntolerance-category
      capability statement.rest.resource.search param.type:
        value: token
      capability statement.rest.resource.search param.documentation:
        value: Must be one of * food * medication * environment * biologic [AllergyIntolerance Category ValueSet](http://hl7.org/fhir/ValueSet/allergy-intolerance-category)

value: key

value: X-Correlation-Id

value: value

value: required

value: false

value: key

value: Request-Context

value: value

value: required

value: true

value: token

value: authorize

value: SMART-on-FHIR

value: SHALL

value: required

value: patient

index: 2
capability statement.rest.resource.search param.name:
  value: clinical-status
capability statement.rest.resource.search param.definition:
  value: http://hl7.org/fhir/SearchParameter/AllergyIntolerance-clinical-status
  link: http://hl7.org/fhir/SearchParameter/AllergyIntolerance-clinical-status
capability statement.rest.resource.search param.type:
  value: token
capability statement.rest.resource.search param.documentation:
  value: Must be one of * active * inactive * resolved [AllergyIntolerance Clinical Status ValueSet](http://hl7.org/fhir/R4/valueset-allergyintolerance-clinical.html)

index: 3
capability statement.rest.resource.search param.name:
  value: code
capability statement.rest.resource.search param.definition:
  value: http://hl7.org/fhir/SearchParameter/clinical-code
  link: http://hl7.org/fhir/SearchParameter/clinical-code
capability statement.rest.resource.search param.type:
  value: token
capability statement.rest.resource.search param.documentation:
  value: Code that identifies the allergy or intolerance [AllergyIntolerance Code ValueSet](http://hl7.org/fhir/ValueSet/allergyintolerance-code)

index: 4
capability statement.rest.resource.search param.name:
  value: identifier
capability statement.rest.resource.search param.definition:
  value: http://hl7.org/fhir/SearchParameter/clinical-identifier
  link: http://hl7.org/fhir/SearchParameter/clinical-identifier
capability statement.rest.resource.search param.type:
  value: token
capability statement.rest.resource.search param.documentation:
  value: A unique identifier assigned to this resource.

index: 5
capability statement.rest.resource.search param.name:
  value: recorder
capability statement.rest.resource.search param.definition:
  value: http://hl7.org/fhir/SearchParameter/AllergyIntolerance-recorder
  link: http://hl7.org/fhir/SearchParameter/AllergyIntolerance-recorder
capability statement.rest.resource.search param.type:
  value: reference
capability statement.rest.resource.search param.documentation:
  value: Who recorded the sensitivity [AllergyIntolerance.recorder](http://hl7.org/fhir/R4/allergyintolerance-definitions.html#AllergyIntolerance.recorder)

index: 6
capability statement.rest.resource.search param.name:
  value: severity
capability statement.rest.resource.search param.definition:
  value: http://hl7.org/fhir/SearchParameter/severity
  link: http://hl7.org/fhir/SearchParameter/severity
capability statement.rest.resource.search param.type:
  value: token
capability statement.rest.resource.search param.documentation:
  value: mild | moderate | severe (of event as a whole).

index: 7
capability statement.rest.resource.search param.name:
  value: clientlastupdated
capability statement.rest.resource.search param.definition:
  value: https://fhir-ig.digital.health.nz/sdhr/SearchParameter/allergyintolerance-clientlastupdated
  link: https://fhir-ig.digital.health.nz/sdhr/SearchParameter/allergyintolerance-clientlastupdated
capability statement.rest.resource.search param.type:
  value: date
capability statement.rest.resource.search param.documentation:
  value: The ClientLastUpdated extension value. This date parameter can also be used with `_sort=clientlastupdated` or `_sort=-clientlastupdated`.

index: 8
capability statement.rest.resource.search param.name:
  value: _lastUpdated
capability statement.rest.resource.search param.definition:
  value: http://hl7.org/fhir/SearchParameter/Resource-lastUpdated
  link: http://hl7.org/fhir/SearchParameter/Resource-lastUpdated
capability statement.rest.resource.search param.type:
  value: date
capability statement.rest.resource.search param.documentation:
  value: When the resource version last changed

index: 1
element.extension:
  index: 0
  element.extension:
    index: 0
    extension.url:
      value: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    extension.value code:
      value: SHALL
  element.extension:
    index: 1
    extension.url:
      value: required
    extension.value string:
      value: patient
  extension.url:
    value: http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination
capability statement.rest.resource.type:
  value: Condition
capability statement.rest.resource.profile:
  value: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/SDHRCondition
  link: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/SDHRCondition
capability statement.rest.resource.documentation:
  value: Note that the supported interactions of the API will vary per API Consumer, depending on the consuming system's role.
capability statement.rest.resource.interaction:
  index: 0
  capability statement.rest.resource.interaction.code:
    value: read
capability statement.rest.resource.interaction:
  index: 1
  capability statement.rest.resource.interaction.code:
    value: create
capability statement.rest.resource.interaction:
  index: 2
  capability statement.rest.resource.interaction.code:
    value: update
capability statement.rest.resource.interaction:
  index: 3
  capability statement.rest.resource.interaction.code:
    value: search-type
capability statement.rest.resource.interaction:
  index: 4
  capability statement.rest.resource.interaction.code:
    value: delete
capability statement.rest.resource.search include:
  value: Condition:encounter
  index: 0
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/clinical-patient
    link: http://hl7.org/fhir/SearchParameter/clinical-patient
  capability statement.rest.resource.search param.type:
    value: reference
  capability statement.rest.resource.search param.documentation:
    value: **MANDATORY** Who has the condition?
capability statement.rest.resource.search param:
  index: 1
  capability statement.rest.resource.search param.name:
    value: category
  capability statement.rest.resource.search param.definition:
    value: http://hl7.org/fhir/SearchParameter/Condition-category
    link: http://hl7.org/fhir/SearchParameter/Condition-category
  capability statement.rest.resource.search param.type:
    value: token
  capability statement.rest.resource.search param.documentation:
    value: The category of the condition
capability statement.rest.resource.search param:
  index: 2
  capability statement.rest.resource.search param.name:
    value: code
  capability statement.rest.resource.search param.definition:
    value: http://hl7.org/fhir/SearchParameter/clinical-code
    link: http://hl7.org/fhir/SearchParameter/clinical-code
  capability statement.rest.resource.search param.type:
    value: token
  capability statement.rest.resource.search param.documentation:
    value: The code for the condition
capability statement.rest.resource.search param:
  index: 3
  capability statement.rest.resource.search param.name:
    value: encounter
  capability statement.rest.resource.search param.definition:
    value: http://hl7.org/fhir/SearchParameter/Condition-encounter
    link: http://hl7.org/fhir/SearchParameter/Condition-encounter
  capability statement.rest.resource.search param.type:
    value: reference
  capability statement.rest.resource.search param.documentation:
    value: Encounter associated with the condition
capability statement.rest.resource.search param:
  index: 4
  capability statement.rest.resource.search param.name:
    value: identifier
  capability statement.rest.resource.search param.definition:
    value: http://hl7.org/fhir/SearchParameter/clinical-identifier
    link: http://hl7.org/fhir/SearchParameter/clinical-identifier
  capability statement.rest.resource.search param.type:
    value: token
  capability statement.rest.resource.search param.documentation:
    value: A unique identifier assigned to this resource.
capability statement.rest.resource.search param:
  index: 5
  capability statement.rest.resource.search param.name:
    value: onset-date
  capability statement.rest.resource.search param.definition:
    value: http://hl7.org/fhir/SearchParameter/Condition-onset-date
    link: http://hl7.org/fhir/SearchParameter/Condition-onset-date
  capability statement.rest.resource.search param.type:
    value: date
  capability statement.rest.resource.search param.documentation:
    value: Date the condition started
capability statement.rest.resource.search param:
  index: 6
  capability statement.rest.resource.search param.name:
    value: severity
  capability statement.rest.resource.search param.definition:
    value: http://hl7.org/fhir/SearchParameter/Condition-severity
    link: http://hl7.org/fhir/SearchParameter/Condition-severity
  capability statement.rest.resource.search param.type:
    value: token
  capability statement.rest.resource.search param.documentation:
    value: The severity of the condition
capability statement.rest.resource.search param:
  index: 7
  capability statement.rest.resource.search param.name:
    value: subject
  capability statement.rest.resource.search param.definition:
    value: http://hl7.org/fhir/SearchParameter/Condition-subject
    link: http://hl7.org/fhir/SearchParameter/Condition-subject
  capability statement.rest.resource.search param.type:
    value: reference
  capability statement.rest.resource.search param.documentation:
    value: Who has the condition?
capability statement.rest.resource.search param:
  index: 8
  capability statement.rest.resource.search param.name:
    value: highlighted
  capability statement.rest.resource.search param.definition:
    value: https://fhir-ig.digital.health.nz/sdhr/SearchParameter/condition-highlighted
    link: https://fhir-ig.digital.health.nz/sdhr/SearchParameter/condition-highlighted
  capability statement.rest.resource.search param.type:
    value: token
  capability statement.rest.resource.search param.documentation:
    value: Search for conditions flagged as highlighted in the SDHRCondition profile
capability statement.rest.resource.search param:
  index: 9
  capability statement.rest.resource.search param.name:
    value: long-term-condition
  capability statement.rest.resource.search param.definition:
    value: https://fhir-ig.digital.health.nz/sdhr/SearchParameter/condition-long-term-condition
    link: https://fhir-ig.digital.health.nz/sdhr/SearchParameter/condition-long-term-condition
  capability statement.rest.resource.search param.type:
    value: token
  capability statement.rest.resource.search param.documentation:
    value: Search for conditions flagged as long term in the SDHRCondition profile
capability statement.rest.resource.search param:
  index: 10
  capability statement.rest.resource.search param.name:
    value: clientlastupdated
  capability statement.rest.resource.search param.definition:
    value: https://fhir-ig.digital.health.nz/sdhr/SearchParameter/condition-clientlastupdated
    link: https://fhir-ig.digital.health.nz/sdhr/SearchParameter/condition-clientlastupdated
  capability statement.rest.resource.search param.type:
    value: date
  capability statement.rest.resource.search param.documentation:
    value: The ClientLastUpdated extension value. This date parameter can also be used with `_sort=clientlastupdated` or `_sort=-clientlastupdated`.
capability statement.rest.resource.search param:
  index: 11
  capability statement.rest.resource.search param.name:
    value: _lastUpdated
  capability statement.rest.resource.search param.definition:
    value: http://hl7.org/fhir/SearchParameter/Resource-lastUpdated
    link: http://hl7.org/fhir/SearchParameter/Resource-lastUpdated
  capability statement.rest.resource.search param.type:
    value: date
  capability statement.rest.resource.search param.documentation:
    value: When the resource version last changed.

index: 2
element.extension:
  index: 0
  element.extension:
    index: 0
    extension.url:
      value: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    extension.value code:
      value: SHALL
  element.extension:
    index: 1
    extension.url:
      value: required
    extension.value string:
      value: patient
  extension.url:
    value: http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination
capability statement.rest.resource.type:
  value: Observation
capability statement.rest.resource.profile:
  value: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/SDHRObservation
  link: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/SDHRObservation
capability statement.rest.resource.documentation:
  value: Note that the supported interactions of the API will vary per API Consumer, depending on the consuming system's role.
capability statement.rest.resource.interaction:
  index: 0
  capability statement.rest.resource.interaction.code:
    value: read
capability statement.rest.resource.interaction:
  index: 1
  capability statement.rest.resource.interaction.code:
    value: create
capability statement.rest.resource.interaction:
  index: 2
  capability statement.rest.resource.interaction.code:
    value: update
capability statement.rest.resource.interaction:
  index: 3
  capability statement.rest.resource.interaction.code:
    value: search-type
capability statement.rest.resource.interaction:
  index: 4
  capability statement.rest.resource.interaction.code:
    value: delete
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/clinical-patient
    link: http://hl7.org/fhir/SearchParameter/clinical-patient
  capability statement.rest.resource.search param.type:
    value: reference
  capability statement.rest.resource.search param.documentation:
    value: **MANDATORY** Who the observation is for [Patient](http://hl7.org/fhir/R4/patient.html)
capability statement.rest.resource.search param:
  index: 1
  capability statement.rest.resource.search param.name:
    value: category
  capability statement.rest.resource.search param.definition:
    value: http://hl7.org/fhir/SearchParameter/Observation-category
    link: http://hl7.org/fhir/SearchParameter/Observation-category
  capability statement.rest.resource.search param.type:
    value: token
  capability statement.rest.resource.search param.documentation:
    value: The classification of the type of observation
capability statement.rest.resource.search param:
  index: 2
  capability statement.rest.resource.search param.name:
    value: code
  capability statement.rest.resource.search param.definition:
    value: http://hl7.org/fhir/SearchParameter/clinical-code
    link: http://hl7.org/fhir/SearchParameter/clinical-code
  capability statement.rest.resource.search param.type:
    value: token
  capability statement.rest.resource.search param.documentation:
    value: Describes what was observed. Sometimes this is called the observation 'name'
capability statement.rest.resource.search param:
  index: 3
  capability statement.rest.resource.search param.name:
    value: date
  capability statement.rest.resource.search param.definition:
    value: http://hl7.org/fhir/SearchParameter/clinical-date
    link: http://hl7.org/fhir/SearchParameter/clinical-date
  capability statement.rest.resource.search param.type:
    value: date
  capability statement.rest.resource.search param.documentation:
    value: Observation.effective Obtained date/time. If the obtained element is a period, a date that falls in the period
capability statement.rest.resource.search param:
  index: 4
  capability statement.rest.resource.search param.name:
    value: encounter
  capability statement.rest.resource.search param.definition:
    value: http://hl7.org/fhir/SearchParameter/clinical-encounter
    link: http://hl7.org/fhir/SearchParameter/clinical-encounter
  capability statement.rest.resource.search param.type:
    value: reference
  capability statement.rest.resource.search param.documentation:
    value: The Encounter resource associated with the Observation.
capability statement.rest.resource.search param:
  index: 5
  capability statement.rest.resource.search param.name:
    value: identifier
  capability statement.rest.resource.search param.definition:
    value: http://hl7.org/fhir/SearchParameter/clinical-identifier
    link: http://hl7.org/fhir/SearchParameter/clinical-identifier
  capability statement.rest.resource.search param.type:
    value: token
  capability statement.rest.resource.search param.documentation:
    value: A unique identifier assigned to this resource.
capability statement.rest.resource.search param:
  index: 6
  capability statement.rest.resource.search param.name:
    value: performer
  capability statement.rest.resource.search param.definition:
    value: http://hl7.org/fhir/SearchParameter/Observation-performer
    link: http://hl7.org/fhir/SearchParameter/Observation-performer
  capability statement.rest.resource.search param.type:
    value: reference
  capability statement.rest.resource.search param.documentation:
    value: Who performed the observation
capability statement.rest.resource.search param:
  index: 7
  capability statement.rest.resource.search param.name:
    value: status
  capability statement.rest.resource.search param.definition:
    value: http://hl7.org/fhir/SearchParameter/Observation-status
    link: http://hl7.org/fhir/SearchParameter/Observation-status
  capability statement.rest.resource.search param.type:
    value: token
  capability statement.rest.resource.search param.documentation:
    value: The status of the observation
capability statement.rest.resource.search param:
  index: 8
  capability statement.rest.resource.search param.name:
    value: subject
  capability statement.rest.resource.search param.definition:
    value: http://hl7.org/fhir/SearchParameter/Observation-subject
    link: http://hl7.org/fhir/SearchParameter/Observation-subject
  capability statement.rest.resource.search param.type:
    value: reference
  capability statement.rest.resource.search param.documentation:
    value: The subject that the observation is about
capability statement.rest.resource.search param:
  index: 9
  capability statement.rest.resource.search param.name:
    value: value-concept
  capability statement.rest.resource.search param.definition:
    value: http://hl7.org/fhir/SearchParameter/Observation-value-concept
    link: http://hl7.org/fhir/SearchParameter/Observation-value-concept
  capability statement.rest.resource.search param.type:
    value: token
  capability statement.rest.resource.search param.documentation:
    value: The value of the observation, if the value is a CodeableConcept
capability statement.rest.resource.search param:
  index: 10
  capability statement.rest.resource.search param.name:
    value: value-date
  capability statement.rest.resource.search param.definition:
    value: http://hl7.org/fhir/SearchParameter/Observation-value-date
    link: http://hl7.org/fhir/SearchParameter/Observation-value-date
  capability statement.rest.resource.search param.type:
    value: date
  capability statement.rest.resource.search param.documentation:
    value: The value of the observation, if the value is a date or period of time
capability statement.rest.resource.search param:
  index: 11
  capability statement.rest.resource.search param.name:
    value: value-quantity
  capability statement.rest.resource.search param.definition:
    value: http://hl7.org/fhir/SearchParameter/Observation-value-quantity
    link: http://hl7.org/fhir/SearchParameter/Observation-value-quantity
  capability statement.rest.resource.search param.type:
    value: quantity
  capability statement.rest.resource.search param.documentation:
    value: The value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)
capability statement.rest.resource.search param:
  index: 12
  capability statement.rest.resource.search param.name:
    value: value-string
  capability statement.rest.resource.search param.definition:
    value: http://hl7.org/fhir/SearchParameter/Observation-value-string
    link: http://hl7.org/fhir/SearchParameter/Observation-value-string
  capability statement.rest.resource.search param.type:
    value: string
  capability statement.rest.resource.search param.documentation:
    value: The value of the observation, if the value is a string, and also searches in CodeableConcept.text
capability statement.rest.resource.search param:
  index: 13
  capability statement.rest.resource.search param.name:
    value: clientlastupdated
  capability statement.rest.resource.search param.definition:
    value: https://fhir-ig.digital.health.nz/sdhr/SearchParameter/observation-clientlastupdated
    link: https://fhir-ig.digital.health.nz/sdhr/SearchParameter/observation-clientlastupdated
  capability statement.rest.resource.search param.type:
    value: date
  capability statement.rest.resource.search param.documentation:
    value: The ClientLastUpdated extension value. This date parameter can also be used with `_sort=clientlastupdated` or `_sort=-clientlastupdated`.
capability statement.rest.resource.search param:
  index: 14
  capability statement.rest.resource.search param.name:
    value: _lastUpdated

value: date

value: When the resource version last changed.

index: 3
element.extension:
  index: 0
  element.extension:
    index: 0
    extension.url:
      value: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    extension.value code:
      value: SHALL
  element.extension:
    index: 1
    extension.url:
      value: required
    extension.value string:
      value: patient
  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://fhir-ig.digital.health.nz/sdhr/StructureDefinition/SDHRImmunization
  link: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/SDHRImmunization
capability statement.rest.resource.documentation:
  value: Note that the supported interactions of the API will vary per API Consumer, depending on the consuming system's role.
capability statement.rest.resource.interaction:
  index: 0
  capability statement.rest.resource.interaction.code:
    value: read
capability statement.rest.resource.interaction:
  index: 1
  capability statement.rest.resource.interaction.code:
    value: vread
capability statement.rest.resource.interaction:
  index: 2
  capability statement.rest.resource.interaction.code:
    value: search-type
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/clinical-patient
    link: http://hl7.org/fhir/SearchParameter/clinical-patient
  capability statement.rest.resource.search param.type:
    value: reference
  capability statement.rest.resource.search param.documentation:
    value: **MANDATORY** Who the immunization is for [Patient](http://hl7.org/fhir/R4/patient.html)
capability statement.rest.resource.search param:
  index: 1
  capability statement.rest.resource.search param.name:
    value: date
  capability statement.rest.resource.search param.definition:
    value: http://hl7.org/fhir/SearchParameter/Immunization-date
    link: http://hl7.org/fhir/SearchParameter/Immunization-date
  capability statement.rest.resource.search param.type:
    value: date
  capability statement.rest.resource.search param.documentation:
    value: Vaccination (occurrence) date. Comparators eq, ge, gt, le, lt are supported; two `date` parameters may be combined for a range. Applied by SDHR.
capability statement.rest.resource.search param:
  index: 2
  capability statement.rest.resource.search param.name:
    value: location
  capability statement.rest.resource.search param.definition:
    value: http://hl7.org/fhir/SearchParameter/Immunization-location
    link: http://hl7.org/fhir/SearchParameter/Immunization-location
  capability statement.rest.resource.search param.type:
    value: reference
  capability statement.rest.resource.search param.documentation:
    value: Facility (HPI) where the vaccination was administered. Applied by SDHR.
capability statement.rest.resource.search param:
  index: 3
  capability statement.rest.resource.search param.name:
    value: vaccine-code
  capability statement.rest.resource.search param.definition:
    value: http://hl7.org/fhir/SearchParameter/Immunization-vaccine-code
    link: http://hl7.org/fhir/SearchParameter/Immunization-vaccine-code
  capability statement.rest.resource.search param.type:
    value: token
  capability statement.rest.resource.search param.documentation:
    value: Vaccine product administered. Supports `system|code` or bare `code`, and the `:text` modifier for name search. Applied by SDHR.
capability statement.rest.resource.search param:
  index: 4
  capability statement.rest.resource.search param.name:
    value: target-disease
  capability statement.rest.resource.search param.definition:
    value: http://hl7.org/fhir/SearchParameter/Immunization-target-disease
    link: http://hl7.org/fhir/SearchParameter/Immunization-target-disease
  capability statement.rest.resource.search param.type:
    value: token
  capability statement.rest.resource.search param.documentation:
    value: Disease targeted by the vaccination (protocolApplied.targetDisease, SNOMED). Applied by AIR.
capability statement.rest.resource.search param:
  index: 5
  capability statement.rest.resource.search param.name:
    value: status
  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: Immunisation event status. Applied by AIR. Records with status `entered-in-error` are never returned.
capability statement.rest.resource.search param:
  index: 6
  capability statement.rest.resource.search param.name:
    value: status-reason
  capability statement.rest.resource.search param.definition:
    value: http://hl7.org/fhir/SearchParameter/Immunization-status-reason
    link: http://hl7.org/fhir/SearchParameter/Immunization-status-reason
  capability statement.rest.resource.search param.type:
    value: token
  capability statement.rest.resource.search param.documentation:
    value: Reason a vaccination was not administered. Applied by AIR.

index: 4
element.extension:
  index: 0
  element.extension:
    index: 0
    extension.url:
      value: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    extension.value code:
      value: SHALL
  element.extension:
    index: 1
    extension.url:
      value: required
    extension.value string:
      value: patient
  extension.url:
    value: http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination
capability statement.rest.resource.type:
  value: MedicationRequest
capability statement.rest.resource.profile:
  value: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/SDHRMedicationRequest
  link: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/SDHRMedicationRequest
capability statement.rest.resource.documentation:
  value: Note that the supported interactions of the API will vary per API Consumer, depending on the consuming system's role.
capability statement.rest.resource.interaction:
  index: 0
  capability statement.rest.resource.interaction.code:
    value: read
capability statement.rest.resource.interaction:
  index: 1
  capability statement.rest.resource.interaction.code:
    value: search-type
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/clinical-patient
    link: http://hl7.org/fhir/SearchParameter/clinical-patient
  capability statement.rest.resource.search param.type:
    value: reference
  capability statement.rest.resource.search param.documentation:
    value: **MANDATORY** Who the prescription is for [Patient](http://hl7.org/fhir/R4/patient.html)
capability statement.rest.resource.search param:
  index: 1
  capability statement.rest.resource.search param.name:
    value: identifier
  capability statement.rest.resource.search param.definition:
    value: http://hl7.org/fhir/SearchParameter/clinical-identifier
    link: http://hl7.org/fhir/SearchParameter/clinical-identifier
  capability statement.rest.resource.search param.type:
    value: token
  capability statement.rest.resource.search param.documentation:
    value: A unique identifier assigned to this resource.
capability statement.rest.resource.search param:
  index: 2
  capability statement.rest.resource.search param.name:
    value: status
  capability statement.rest.resource.search param.definition:
    value: http://hl7.org/fhir/SearchParameter/medications-status
    link: http://hl7.org/fhir/SearchParameter/medications-status
  capability statement.rest.resource.search param.type:
    value: token
  capability statement.rest.resource.search param.documentation:
    value: Status of the prescription.
capability statement.rest.resource.search param:
  index: 3
  capability statement.rest.resource.search param.name:
    value: _lastUpdated
  capability statement.rest.resource.search param.definition:
    value: http://hl7.org/fhir/SearchParameter/Resource-lastUpdated
    link: http://hl7.org/fhir/SearchParameter/Resource-lastUpdated
  capability statement.rest.resource.search param.type:
    value: date
  capability statement.rest.resource.search param.documentation:
    value: When the resource version last changed.

index: 5
element.extension:
  index: 0
  element.extension:
    index: 0
    extension.url:
      value: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    extension.value code:
      value: SHALL
  element.extension:
    index: 1
    extension.url:
      value: required
    extension.value string:
      value: patient
  extension.url:
    value: http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination
capability statement.rest.resource.type:
  value: MedicationDispense
capability statement.rest.resource.profile:
  value: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/SDHRMedicationDispense
  link: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/SDHRMedicationDispense
capability statement.rest.resource.documentation:
  value: Note that the supported interactions of the API will vary per API Consumer, depending on the consuming system's role.
capability statement.rest.resource.interaction:
  index: 0
  capability statement.rest.resource.interaction.code:
    value: read
capability statement.rest.resource.interaction:
  index: 1
  capability statement.rest.resource.interaction.code:
    value: search-type
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/clinical-patient
    link: http://hl7.org/fhir/SearchParameter/clinical-patient
  capability statement.rest.resource.search param.type:
    value: reference
  capability statement.rest.resource.search param.documentation:
    value: **MANDATORY** Who the dispense is for [Patient](http://hl7.org/fhir/R4/patient.html)
capability statement.rest.resource.search param:
  index: 1
  capability statement.rest.resource.search param.name:
    value: identifier
  capability statement.rest.resource.search param.definition:
    value: http://hl7.org/fhir/SearchParameter/clinical-identifier
    link: http://hl7.org/fhir/SearchParameter/clinical-identifier
  capability statement.rest.resource.search param.type:
    value: token
  capability statement.rest.resource.search param.documentation:
    value: A unique identifier assigned to this resource.
capability statement.rest.resource.search param:
  index: 2
  capability statement.rest.resource.search param.name:
    value: status
  capability statement.rest.resource.search param.definition:
    value: http://hl7.org/fhir/SearchParameter/medications-status
    link: http://hl7.org/fhir/SearchParameter/medications-status
  capability statement.rest.resource.search param.type:
    value: token
  capability statement.rest.resource.search param.documentation:
    value: Status of the dispense.
capability statement.rest.resource.search param:
  index: 3
  capability statement.rest.resource.search param.name:
    value: _lastUpdated
  capability statement.rest.resource.search param.definition:
    value: http://hl7.org/fhir/SearchParameter/Resource-lastUpdated
    link: http://hl7.org/fhir/SearchParameter/Resource-lastUpdated
  capability statement.rest.resource.search param.type:
    value: date
  capability statement.rest.resource.search param.documentation:
    value: When the resource version last changed.

index: 0
capability statement.rest.interaction.code:
  value: search-system

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

index: 2
capability statement.rest.interaction.code:
  value: batch

index: 0
capability statement.rest.resource.operation.name:
  value: participate
capability statement.rest.resource.operation.definition:
  value: https://fhir-ig.digital.health.nz/sdhr/OperationDefinition/SDHRParticipateOperation
  link: https://fhir-ig.digital.health.nz/sdhr/OperationDefinition/SDHRParticipateOperation
capability statement.rest.resource.operation.documentation:
  value: This operation allows a patient to choose to participate in the Shared Digital Health Record service. This operation should be used by data providers in the Shared Digital Health Record ecosystem such as Patient Management Systems (PMS) or Electronic Health Record (EHR) systems. It can be used to indicate whether the patient wishes to participate, whether any resources are withheld, and the reason for participation. The scope of this operation is the API consumer - e.g. an HPI Facility where patient data is held. Scenarios where this operation might be used include: - A patient has opted in to the Shared Digital Health Record service and appropriate data will be shared from the data holder to the service. - A patient chooses not to participate in the Shared Digital Health Record service and informs their healthcare provider of this choice. - A patient has one or more confidential records, held at their healthcare provider, that are withheld from the service. - A patient has previously withheld records but has now released them to the Shared Digital Health Record service. For example payloads that might be used with this operation see: - [Parameters resource for total non-participation](./Parameters-ParametersDoNotParticipate.html) : This example shows how to indicate that a patient does not wish to participate in the Shared Digital Health Record service (has opted out). - [Parameters resource for participation](./Parameters-ParametersParticipate.html) : This example shows how to indicate that a patient wishes to participate in the Shared Digital Health Record service, where previously opted out (opt-in). - [Parameters resource for partial participation with withheld records](./Parameters-ParametersParticipateRecordWithheld.html) : This example shows how to indicate that a patient has some confidential records that are withheld from the Shared Digital Health Record service. - [Parameters resource for releasing withheld records](./Parameters-ParametersParticipateRecor…

index: 1
capability statement.rest.resource.operation.name:
  value: hnz-participate
capability statement.rest.resource.operation.definition:
  value: https://fhir-ig.digital.health.nz/sdhr/OperationDefinition/SDHRHNZParticipateOperation
  link: https://fhir-ig.digital.health.nz/sdhr/OperationDefinition/SDHRHNZParticipateOperation
capability statement.rest.resource.operation.documentation:
  value: This operation allows a patient to choose to participate in the Shared Digital Health Record service via HNZ assisted channels. This operation should only be used by HNZ channels. Scenarios where this operation might be used include: - A patient has opted in to the Shared Digital Health Record service by contacting Health NZ via appropriate digital or assisted channels. - A linked group of patients has opted in to the Shared Digital Health Record service by contacting Health NZ via appropriate digital or assisted channels. - A patient chooses not to participate in the Shared Digital Health Record service and informs Health NZ of this choice via appropriate digital or assisted channels. For example payloads that might be used with this operation see: - [Parameters resource for total non-participation](./Parameters-ParametersHNZParticipateOptOut.html) : This example shows how to indicate that a patient does not wish to participate in the Shared Digital Health Record service (has opted out). - [Parameters resource for participation](./Parameters-ParametersHNZParticipateOptIn.html) : This example shows how to indicate that a patient wishes to participate in the Shared Digital Health Record service. - [Parameters resource for linked group participation](./Parameters-ParametersHNZParticipateLinkedGroupOptIn.html) : This example shows how to indicate that all patients in a linked NHI group wish to participate in the Shared Digital Health Record service. To make a request to this operation the API Consumer must POST a `Parameters` payload to the operation URL (e.g. `POST https://api.sdhr.digital.health.nz/s2s/$hnz-participate`). The operation is idempotent, meaning that multiple requests with the same parameters will have the same effect as a single request. The operation is expected to be called by a Health NZ channel system on behalf of the patient, and the patient must be identified by their NHI. For a global opt-in request, one or more `patient` parameters may be suppli…