SDHRCapabilityStatement
type: CapabilityStatement
node role: treeRoot
id:
  v: SDHRCapabilityStatement
meta:
  profile:
    v: https://fhir-ig.digital.health.nz/hnz-digital-tooling/StructureDefinition/hnz-capability-statement
    l: hnz-capability-statement
text:
  status:
    v: extensions
  div:
    v: 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.0 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", "POPHLTH", "TREAT", "ETREAT", "PUBHLTH", "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 …
extension:
  extension:
    url:
      v: licenseURL
      l: licenseURL
    value: Uri
      v: https://www.tewhatuora.govt.nz/assets/Our-health-system/Digital-health/Digital-Service-Hub/API-Access-and-Use-Agreement.docx
      l: API-Access-and-Use-Agreement.docx
  extension:
    url:
      v: externalDocs
      l: externalDocs
    value: Uri
      v: https://fhir-ig.digital.health.nz/sdhr
      l: sdhr
  extension:
    url:
      v: licenseName
      l: licenseName
    value: String
      v: Health New Zealand Digital Services Hub API Access and Use Agreement
  extension:
    extension:
      extension:
        value: String
      extension:
        value: Uri
      extension:
        value: Boolean
      url:
        v: https://fhir-ig.digital.health.nz/hnz-digital-tooling/StructureDefinition/custom-headers-extension
        l: custom-headers-extension
    extension:
      extension:
        value: String
      extension:
        value: Uri
      extension:
        value: Boolean
      url:
        v: https://fhir-ig.digital.health.nz/hnz-digital-tooling/StructureDefinition/custom-headers-extension
        l: custom-headers-extension
    url:
      v: globalHeaders
      l: globalHeaders
  url:
    v: https://fhir-ig.digital.health.nz/hnz-digital-tooling/StructureDefinition/resource-metadata-extension
    l: resource-metadata-extension
url:
  v: https://fhir-ig.digital.health.nz/sdhr/CapabilityStatement/SDHRCapabilityStatement
  l: SDHRCapabilityStatement
version:
  v: 1.0.0
name:
  v: SDHRCapabilityStatement
title:
  v: NZ Shared Digital Health Record API
status:
  v: draft
experimental:
  v: false
date:
  v: 2024-04-15T01:15:23.3688326Z
publisher:
  v: Health New Zealand
contact:
  name:
    v: Health New Zealand
  telecom:
    system:
      v: url
    value:
      v: https://github.com/tewhatuora
contact:
  name:
    v: HNZ Integration Team
  telecom:
    system:
      v: email
    use:
      v: work
description:
  v: NZ Shared Digital Health Record API Capability Statement
kind:
  v: capability
software:
  name:
    v: NZ Shared Digital Health Record API
  version:
    v: 1.0.0
implementation:
  description:
    v: Health NZ | Te Whatu Ora NZ Shared Digital Health Record API
  url:
    v: https://api.sdhr.digital.health.nz/s2s
    l: s2s
fhir version:
  v: 4.0.1
format:
  v: application/fhir+json
rest:
  mode:
    v: server
  documentation:
    v: ### 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", "POPHLTH", "TREAT", "ETREAT", "PUBHLTH", "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 | …
  security:
    extension:
      extension:
        value: Uri
      extension:
        value: Uri
      url:
        v: http://fhir-registry.smarthealthit.org/StructureDefinition/oauth-uris
        l: oauth-uris
    extension:
      url:
        v: http://fhir-registry.smarthealthit.org/StructureDefinition/capabilities
        l: capabilities
      value: Code
        v: client-confidential-symmetric
    cors:
      v: true
    description:
      v: OAuth 2.0 - Client Credential flow.
  resource:
    extension:
      extension:
        value: Code
      extension:
        value: String
      url:
        v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination
        l: capabilitystatement-search-parameter-combination
    type:
      v: AllergyIntolerance
    profile:
      v: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/SDHRAllergyIntolerance
      l: SDHRAllergyIntolerance
    documentation:
      v: Note that the supported interactions of the API will vary per API Consumer, depending on the consuming system's role.
    interaction:
      code:
        v: read
    interaction:
      code:
        v: create
    interaction:
      code:
        v: update
    interaction:
      code:
        v: search-type
    interaction:
      code:
        v: delete
    search param:
      name:
        v: patient
      definition:
        v: http://hl7.org/fhir/SearchParameter/clinical-patient
        l: clinical-patient
      type:
        v: reference
      documentation:
        v: MANDATORY Who the sensitivity is for [Patient](http://hl7.org/fhir/R4/patient.html)
    search param:
      name:
        v: category
      definition:
        v: http://hl7.org/fhir/SearchParameter/AllergyIntolerance-category
        l: AllergyIntolerance-category
      type:
        v: token
      documentation:
        v: Must be one of * food * medication * environment * biologic [AllergyIntolerance Category ValueSet](http://hl7.org/fhir/ValueSet/allergy-intolerance-category)
    search param:
      name:
        v: clinical-status
      definition:
        v: http://hl7.org/fhir/SearchParameter/AllergyIntolerance-clinical-status
        l: AllergyIntolerance-clinical-status
      type:
        v: token
      documentation:
        v: Must be one of * active * inactive * resolved [AllergyIntolerance Clinical Status ValueSet](http://hl7.org/fhir/R4/valueset-allergyintolerance-clinical.html)
    search param:
      name:
        v: code
      definition:
        v: http://hl7.org/fhir/SearchParameter/clinical-code
        l: clinical-code

v: key
l: key

String
v: X-Correlation-Id

v: value
l: value

v: required
l: required

Boolean
v: false

v: key
l: key

String
v: Request-Context

v: value
l: value

v: required
l: required

Boolean
v: true

v: token
l: token

v: authorize
l: authorize

v: SMART-on-FHIR

Code
v: SHALL

v: required
l: required

String
v: patient

v: token

v: Code that identifies the allergy or intolerance [AllergyIntolerance Code ValueSet](http://hl7.org/fhir/ValueSet/allergyintolerance-code)

name:
  v: identifier
definition:
  v: http://hl7.org/fhir/SearchParameter/clinical-identifier
  l: clinical-identifier
type:
  v: token
documentation:
  v: A unique identifier assigned to this resource.

name:
  v: recorder
definition:
  v: http://hl7.org/fhir/SearchParameter/AllergyIntolerance-recorder
  l: AllergyIntolerance-recorder
type:
  v: reference
documentation:
  v: Who recorded the sensitivity [AllergyIntolerance.recorder](http://hl7.org/fhir/R4/allergyintolerance-definitions.html#AllergyIntolerance.recorder)

name:
  v: severity
definition:
  v: http://hl7.org/fhir/SearchParameter/severity
  l: severity
type:
  v: token
documentation:
  v: mild | moderate | severe (of event as a whole).

name:
  v: _lastUpdated
definition:
  v: http://hl7.org/fhir/SearchParameter/Resource-lastUpdated
  l: Resource-lastUpdated
type:
  v: date
documentation:
  v: When the resource version last changed

extension:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
      l: capabilitystatement-expectation
    value: Code
      v: SHALL
  extension:
    url:
      v: required
      l: required
    value: String
      v: patient
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination
    l: capabilitystatement-search-parameter-combination
type:
  v: Condition
profile:
  v: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/SDHRCondition
  l: SDHRCondition
documentation:
  v: Note that the supported interactions of the API will vary per API Consumer, depending on the consuming system's role.
interaction:
  code:
    v: read
interaction:
  code:
    v: create
interaction:
  code:
    v: update
interaction:
  code:
    v: search-type
interaction:
  code:
    v: delete
search include:
  v: Condition:encounter
search param:
  name:
    v: patient
  definition:
    v: http://hl7.org/fhir/SearchParameter/clinical-patient
    l: clinical-patient
  type:
    v: reference
  documentation:
    v: **MANDATORY** Who has the condition?
search param:
  name:
    v: category
  definition:
    v: http://hl7.org/fhir/SearchParameter/Condition-category
    l: Condition-category
  type:
    v: token
  documentation:
    v: The category of the condition
search param:
  name:
    v: code
  definition:
    v: http://hl7.org/fhir/SearchParameter/clinical-code
    l: clinical-code
  type:
    v: token
  documentation:
    v: The code for the condition
search param:
  name:
    v: encounter
  definition:
    v: http://hl7.org/fhir/SearchParameter/Condition-encounter
    l: Condition-encounter
  type:
    v: reference
  documentation:
    v: Encounter associated with the condition
search param:
  name:
    v: identifier
  definition:
    v: http://hl7.org/fhir/SearchParameter/clinical-identifier
    l: clinical-identifier
  type:
    v: token
  documentation:
    v: A unique identifier assigned to this resource.
search param:
  name:
    v: onset-date
  definition:
    v: http://hl7.org/fhir/SearchParameter/Condition-onset-date
    l: Condition-onset-date
  type:
    v: date
  documentation:
    v: Date the condition started
search param:
  name:
    v: severity
  definition:
    v: http://hl7.org/fhir/SearchParameter/Condition-severity
    l: Condition-severity
  type:
    v: token
  documentation:
    v: The severity of the condition
search param:
  name:
    v: subject
  definition:
    v: http://hl7.org/fhir/SearchParameter/Condition-subject
    l: Condition-subject
  type:
    v: reference
  documentation:
    v: Who has the condition?
search param:
  name:
    v: highlighted
  definition:
    v: https://fhir-ig.digital.health.nz/sdhr/SearchParameter/condition-highlighted
    l: condition-highlighted
  type:
    v: token
  documentation:
    v: Search for conditions flagged as highlighted in the SDHRCondition profile
search param:
  name:
    v: long-term-condition
  definition:
    v: https://fhir-ig.digital.health.nz/sdhr/SearchParameter/condition-long-term-condition
    l: condition-long-term-condition
  type:
    v: token
  documentation:
    v: Search for conditions flagged as long term in the SDHRCondition profile
search param:
  name:
    v: _lastUpdated
  definition:
    v: http://hl7.org/fhir/SearchParameter/Resource-lastUpdated
    l: Resource-lastUpdated
  type:
    v: date
  documentation:
    v: When the resource version last changed.

extension:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
      l: capabilitystatement-expectation
    value: Code
      v: SHALL
  extension:
    url:
      v: required
      l: required
    value: String
      v: patient
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination
    l: capabilitystatement-search-parameter-combination
type:
  v: Observation
profile:
  v: https://fhir-ig.digital.health.nz/sdhr/StructureDefinition/SDHRObservation
  l: SDHRObservation
documentation:
  v: Note that the supported interactions of the API will vary per API Consumer, depending on the consuming system's role.
interaction:
  code:
    v: read
interaction:
  code:
    v: create
interaction:
  code:
    v: update
interaction:
  code:
    v: search-type
interaction:
  code:
    v: delete
search param:
  name:
    v: patient
  definition:
    v: http://hl7.org/fhir/SearchParameter/clinical-patient
    l: clinical-patient
  type:
    v: reference
  documentation:
    v: **MANDATORY** Who the observation is for [Patient](http://hl7.org/fhir/R4/patient.html)
search param:
  name:
    v: category
  definition:
    v: http://hl7.org/fhir/SearchParameter/Observation-category
    l: Observation-category
  type:
    v: token
  documentation:
    v: The classification of the type of observation
search param:
  name:
    v: code
  definition:
    v: http://hl7.org/fhir/SearchParameter/clinical-code
    l: clinical-code
  type:
    v: token
  documentation:
    v: Describes what was observed. Sometimes this is called the observation 'name'
search param:
  name:
    v: date
  definition:
    v: http://hl7.org/fhir/SearchParameter/clinical-date
    l: clinical-date
  type:
    v: date
  documentation:
    v: Observation.effective Obtained date/time. If the obtained element is a period, a date that falls in the period
search param:
  name:
    v: encounter
  definition:
    v: http://hl7.org/fhir/SearchParameter/clinical-encounter
    l: clinical-encounter
  type:
    v: reference
  documentation:
    v: The Encounter resource associated with the Observation.
search param:
  name:
    v: identifier
  definition:
    v: http://hl7.org/fhir/SearchParameter/clinical-identifier
    l: clinical-identifier
  type:
    v: token
  documentation:
    v: A unique identifier assigned to this resource.
search param:
  name:
    v: performer
  definition:
    v: http://hl7.org/fhir/SearchParameter/Observation-performer
    l: Observation-performer
  type:
    v: reference
  documentation:
    v: Who performed the observation
search param:
  name:
    v: status
  definition:
    v: http://hl7.org/fhir/SearchParameter/Observation-status
    l: Observation-status
  type:
    v: token
  documentation:
    v: The status of the observation
search param:
  name:
    v: subject
  definition:
    v: http://hl7.org/fhir/SearchParameter/Observation-subject
    l: Observation-subject
  type:
    v: reference
  documentation:
    v: The subject that the observation is about
search param:
  name:
    v: value-concept
  definition:
    v: http://hl7.org/fhir/SearchParameter/Observation-value-concept
    l: Observation-value-concept
  type:
    v: token
  documentation:
    v: The value of the observation, if the value is a CodeableConcept
search param:
  name:
    v: value-date
  definition:
    v: http://hl7.org/fhir/SearchParameter/Observation-value-date
    l: Observation-value-date
  type:
    v: date
  documentation:
    v: The value of the observation, if the value is a date or period of time
search param:
  name:
    v: value-quantity
  definition:
    v: http://hl7.org/fhir/SearchParameter/Observation-value-quantity
    l: Observation-value-quantity
  type:
    v: quantity
  documentation:
    v: 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)
search param:
  name:
    v: value-string
  definition:
    v: http://hl7.org/fhir/SearchParameter/Observation-value-string
    l: Observation-value-string
  type:
    v: string
  documentation:
    v: The value of the observation, if the value is a string, and also searches in CodeableConcept.text
search param:
  name:
    v: _lastUpdated
  definition:
    v: http://hl7.org/fhir/SearchParameter/Resource-lastUpdated
    l: Resource-lastUpdated
  type:
    v: date
  documentation:
    v: When the resource version last changed.

code:
  v: search-system

code:
  v: transaction

code:
  v: batch

name:
  v: participate
definition:
  v: https://fhir-ig.digital.health.nz/sdhr/OperationDefinition/SDHRParticipateOperation
  l: SDHRParticipateOperation
documentation:
  v: 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…

name:
  v: hnz-participate
definition:
  v: https://fhir-ig.digital.health.nz/sdhr/OperationDefinition/SDHRHNZParticipateOperation
  l: SDHRHNZParticipateOperation
documentation:
  v: 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 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. 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. The operation will return an OperationOutcome resource indicating the result of the operation.