SharedCareFHIRAPICapabilityStatement
type: CapabilityStatement
node role: treeRoot
id:
  v: SharedCareFHIRAPICapabilityStatement
meta:
  profile:
    v: https://fhir-ig.digital.health.nz/hnz-digital-tooling/StructureDefinition/hnz-capability-statement
    link: https://fhir-ig.digital.health.nz/hnz-digital-tooling/StructureDefinition/hnz-capability-statement
text:
  status:
    v: extensions
  div: Generated Narrative: CapabilityStatement SharedCareFHIRAPICapabilityStatement Profile: Capability Statement profile for use with the Health New Zealand Te Whatu Ora OpenAPI spec converter Shared Care FHIR Server Capability Statement Implementation Guide Version: 0.4.5 FHIR Version: 4.0.1 Supported Formats: json Published on: 2024-07-03 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: SMART-on-FHIR Summary of System-wide Interactions Supports the transactioninteraction. Summary of System-wide Operations Conformance Operation Documentation SHALL $run Run a flat data view operation to aggregate data for a specific patient using a defined ViewDefinition. See Flat Data Views for more information. 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 V-R S U C D Searches _include _revinclude Operations AllergyIntolerance https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/ManaakiNgaTahiAllergyIntolerance y y y y y y patient, recorder, code, category, clinical-status, _id, _lastUpdated * Appointment Supported Profiles Appointment NZ SharedCare Appointment Dunedin Hospital O…
extension:
  extension:
    url:
      v: licenseURL
    value: uri
      v: https://www.tewhatuora.govt.nz/assets/Our-health-system/Digital-health/Digital-Service-Hub/API-Access-and-Use-Agreement.docx
  extension:
    url:
      v: externalDocs
    value: uri
      v: https://fhir-ig.digital.health.nz/shared-care
  extension:
    url:
      v: 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
    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
    url:
      v: globalHeaders
  url:
    v: https://fhir-ig.digital.health.nz/hnz-digital-tooling/StructureDefinition/resource-metadata-extension
url:
  v: https://fhir-ig.digital.health.nz/shared-care/CapabilityStatement/SharedCareFHIRAPICapabilityStatement
version:
  v: 0.4.5
name:
  v: SharedCareFHIRAPICapabilityStatement
title:
  v: Shared Care FHIR Server Capability Statement
status:
  v: active
date:
  v: 2024-07-03
publisher:
  v: Te Whatu Ora
contact:
  name:
    v: Te Whatu Ora
  telecom:
    system:
      v: url
    value:
      v: https://www.tewhatuora.govt.nz/
contact:
  name:
    v: Te Whatu Ora Integration Team
  telecom:
    system:
      v: email
    use:
      v: work
description:
  v: Health NZ | Te Whatu Ora Shared Care FHIR API
jurisdiction:
  coding:
    system:
      v: urn:iso:std:iso:3166
    code:
      v: NZ
    display:
      v: New Zealand
kind:
  v: instance
implementation:
  description:
    v: Health NZ | Te Whatu Ora Shared Care FHIR API
  url:
    v: https://fhir.api.digital.health.nz/R4
fhir version:
  v: 4.0.1
format:
  v: json
rest:
  mode:
    v: server
  security:
    extension:
      extension:
        value: uri
      url:
        v: http://fhir-registry.smarthealthit.org/StructureDefinition/oauth-uris
    extension:
      url:
        v: http://fhir-registry.smarthealthit.org/StructureDefinition/capabilities
      value: code
        v: client-confidential-symmetric
    cors:
      v: true
  resource:
    type:
      v: AllergyIntolerance
    profile:
      v: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/ManaakiNgaTahiAllergyIntolerance
      link: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/ManaakiNgaTahiAllergyIntolerance
    interaction:
      code:
        v: create
    interaction:
      code:
        v: read
    interaction:
      code:
        v: update
    interaction:
      code:
        v: delete
    interaction:
      code:
        v: vread
    interaction:
      code:
        v: search-type
    versioning:
      v: versioned
    read history:
      v: false
    update create:
      v: false
    conditional create:
      v: false
    conditional read:
      v: not-supported
    conditional update:
      v: false
    conditional delete:
      v: not-supported
    search include:
      v: *
    search param:
      name:
        v: patient
      definition:
        v: http://hl7.org/fhir/SearchParameter/clinical-patient
        link: http://hl7.org/fhir/SearchParameter/clinical-patient
      type:
        v: reference
      documentation:
        v: Who the sensitivity is for [Patient](http://hl7.org/fhir/R4/patient.html)
    search param:
      name:
        v: recorder
      definition:
        v: http://hl7.org/fhir/SearchParameter/AllergyIntolerance-recorder
        link: http://hl7.org/fhir/SearchParameter/AllergyIntolerance-recorder
      type:
        v: reference
      documentation:
        v: Who recorded the sensitivity [AllergyIntolerance.recorder](http://hl7.org/fhir/R4/allergyintolerance-definitions.html#AllergyIntolerance.recorder)
    search param:
      name:
        v: code
      definition:
        v: http://hl7.org/fhir/SearchParameter/clinical-code
        link: http://hl7.org/fhir/SearchParameter/clinical-code
      type:
        v: token
      documentation:
        v: Code that identifies the allergy or intolerance [AllergyIntolerance Code ValueSet](http://hl7.org/fhir/ValueSet/allergyintolerance-code)
    search param:
      name:
        v: category
      definition:
        v: http://hl7.org/fhir/SearchParameter/AllergyIntolerance-category
        link: http://hl7.org/fhir/SearchParameter/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
        link: http://hl7.org/fhir/SearchParameter/AllergyIntolerance-clinical-status

v: key

string
v: X-Correlation-Id

v: value

v: required

boolean
v: true

v: key

string
v: Request-Context

v: value

v: required

boolean
v: true

v: token

v: SMART-on-FHIR

v: token

v: Must be one of * active * inactive * resolved [AllergyIntolerance Clinical Status ValueSet](http://hl7.org/fhir/R4/valueset-allergyintolerance-clinical.html)

name:
  v: _id
definition:
  v: https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/StructureDefinition-ManaakiNgaTahiAllergyIntolerance-definitions.html#AllergyIntolerance.id
  link: https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/StructureDefinition-ManaakiNgaTahiAllergyIntolerance-definitions.html#AllergyIntolerance.id
type:
  v: token
documentation:
  v: Logical id of this artifact

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

type:
  v: Appointment
supported profile:
  v: http://hl7.org/fhir/StructureDefinition/Appointment
  link: http://hl7.org/fhir/StructureDefinition/Appointment
supported profile:
  v: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/SharedCareAppointment
  link: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/SharedCareAppointment
supported profile:
  v: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/DHOAppointment
  link: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/DHOAppointment
interaction:
  code:
    v: create
interaction:
  code:
    v: read
interaction:
  code:
    v: update
interaction:
  code:
    v: delete
interaction:
  code:
    v: vread
interaction:
  code:
    v: search-type
versioning:
  v: versioned
read history:
  v: false
update create:
  v: false
conditional create:
  v: false
conditional read:
  v: not-supported
conditional update:
  v: false
conditional delete:
  v: not-supported
search include:
  v: *
search rev include:
  v: *
search param:
  name:
    v: patient
  definition:
    v: http://hl7.org/fhir/SearchParameter/clinical-patient
    link: http://hl7.org/fhir/SearchParameter/clinical-patient
  type:
    v: reference
  documentation:
    v: Who the sensitivity is for [Patient](http://hl7.org/fhir/R4/patient.html)
search param:
  name:
    v: actor
  definition:
    v: http://hl7.org/fhir/SearchParameter/Appointment-actor
    link: http://hl7.org/fhir/SearchParameter/Appointment-actor
  type:
    v: reference
  documentation:
    v: Any one of the individuals participating in the appointment (Practitioner, Device, Patient, HealthcareService, PractitionerRole, RelatedPerson, Location)
search param:
  name:
    v: status
  definition:
    v: http://hl7.org/fhir/SearchParameter/Appointment-status
    link: http://hl7.org/fhir/SearchParameter/Appointment-status
  type:
    v: token
  documentation:
    v: proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist
search param:
  name:
    v: date
  definition:
    v: http://hl7.org/fhir/SearchParameter/clinical-date
    link: http://hl7.org/fhir/SearchParameter/clinical-date
  type:
    v: date
  documentation:
    v: Appointment date/time

type:
  v: AppointmentResponse
supported profile:
  v: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/DHOAppointmentResponse
  link: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/DHOAppointmentResponse
documentation:
  v: Dunedin Hospital Outpatients - Used to confirm an appointment
interaction:
  code:
    v: create
interaction:
  code:
    v: update
versioning:
  v: versioned
read history:
  v: false
update create:
  v: true
conditional create:
  v: false
conditional read:
  v: not-supported
conditional update:
  v: false
conditional delete:
  v: not-supported
search include:
  v: *
search param:
  name:
    v: identifier
  definition:
    v: https://hl7.org/fhir/searchparameter-registry.html#clinical-identifier
    link: https://hl7.org/fhir/searchparameter-registry.html#clinical-identifier
  type:
    v: token
  documentation:
    v: The AppointmentResponse clinical identifier
search param:
  name:
    v: _id
  definition:
    v: http://hl7.org/fhir/SearchParameter/Resource-id
    link: http://hl7.org/fhir/SearchParameter/Resource-id
  type:
    v: token
  documentation:
    v: Logical id of this artifact

type:
  v: Bundle
profile:
  v: http://hl7.org/fhir/StructureDefinition/Bundle
  link: http://hl7.org/fhir/StructureDefinition/Bundle
interaction:
  code:
    v: create
interaction:
  code:
    v: read
interaction:
  code:
    v: update
interaction:
  code:
    v: delete
interaction:
  code:
    v: vread
interaction:
  code:
    v: search-type
versioning:
  v: versioned
read history:
  v: false
update create:
  v: false
conditional create:
  v: false
conditional read:
  v: not-supported
conditional update:
  v: false
conditional delete:
  v: not-supported

type:
  v: Communication
supported profile:
  v: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/CMSCommunication
  link: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/CMSCommunication
interaction:
  code:
    v: create
interaction:
  code:
    v: read
interaction:
  code:
    v: update
interaction:
  code:
    v: delete
interaction:
  code:
    v: vread
interaction:
  code:
    v: search-type
versioning:
  v: versioned
read history:
  v: false
update create:
  v: false
conditional create:
  v: false
conditional read:
  v: not-supported
conditional update:
  v: false
conditional delete:
  v: not-supported
search param:
  name:
    v: sender
  definition:
    v: http://hl7.org/fhir/SearchParameter/Communication-sender
    link: http://hl7.org/fhir/SearchParameter/Communication-sender
  type:
    v: reference
  documentation:
    v: Who shares the information
search param:
  name:
    v: identifier
  definition:
    v: http://hl7.org/fhir/SearchParameter/Communication-identifier
    link: http://hl7.org/fhir/SearchParameter/Communication-identifier
  type:
    v: token
  documentation:
    v: clinical-identifier
search param:
  name:
    v: based-on
  definition:
    v: http://hl7.org/fhir/SearchParameter/Communication-based-on
    link: http://hl7.org/fhir/SearchParameter/Communication-based-on
  type:
    v: reference
  documentation:
    v: Communication-based-on
search param:
  name:
    v: patient
  definition:
    v: http://hl7.org/fhir/SearchParameter/clinical-patient
    link: http://hl7.org/fhir/SearchParameter/clinical-patient
  type:
    v: reference
  documentation:
    v: clinical-patient
search param:
  name:
    v: recipient
  definition:
    v: http://hl7.org/fhir/SearchParameter/Communication-recipient
    link: http://hl7.org/fhir/SearchParameter/Communication-recipient
  type:
    v: reference
  documentation:
    v: Who the information is shared with
search param:
  name:
    v: status
  definition:
    v: http://hl7.org/fhir/SearchParameter/Communication-status
    link: http://hl7.org/fhir/SearchParameter/Communication-status
  type:
    v: token
  documentation:
    v: preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
search param:
  name:
    v: sent
  definition:
    v: http://hl7.org/fhir/SearchParameter/Communication-sent
    link: http://hl7.org/fhir/SearchParameter/Communication-sent
  type:
    v: date
  documentation:
    v: When sent
search param:
  name:
    v: received
  definition:
    v: http://hl7.org/fhir/SearchParameter/Communication-received
    link: http://hl7.org/fhir/SearchParameter/Communication-received
  type:
    v: date
  documentation:
    v: Communication-received
search param:
  name:
    v: medium
  definition:
    v: http://hl7.org/fhir/SearchParameter/Communication-medium
    link: http://hl7.org/fhir/SearchParameter/Communication-medium
  type:
    v: token
  documentation:
    v: Communication-medium
search param:
  name:
    v: _profile
  definition:
    v: https://hl7.org/fhir/searchparameter-registry.html#Resource-profile
    link: https://hl7.org/fhir/searchparameter-registry.html#Resource-profile
  type:
    v: reference

type:
  v: CommunicationRequest
supported profile:
  v: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/CMSCommunicationRequest
  link: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/CMSCommunicationRequest
interaction:
  code:
    v: create
interaction:
  code:
    v: read
interaction:
  code:
    v: update
interaction:
  code:
    v: delete
interaction:
  code:
    v: vread
interaction:
  code:
    v: search-type
versioning:
  v: versioned
read history:
  v: false
update create:
  v: false
conditional create:
  v: false
conditional read:
  v: not-supported
conditional update:
  v: false
conditional delete:
  v: not-supported
search rev include:
  v: *
search param:
  name:
    v: identifier
  definition:
    v: http://hl7.org/fhir/SearchParameter/CommunicationRequest-identifier
    link: http://hl7.org/fhir/SearchParameter/CommunicationRequest-identifier
  type:
    v: token
  documentation:
    v: Unique identifier
search param:
  name:
    v: medium
  definition:
    v: http://hl7.org/fhir/SearchParameter/CommunicationRequest-medium
    link: http://hl7.org/fhir/SearchParameter/CommunicationRequest-medium
  type:
    v: token
  documentation:
    v: A channel of communication
search param:
  name:
    v: occurrence
  definition:
    v: http://hl7.org/fhir/SearchParameter/CommunicationRequest-occurrence
    link: http://hl7.org/fhir/SearchParameter/CommunicationRequest-occurrence
  type:
    v: date
  documentation:
    v: CommunicationRequest.occurrence.ofType(dateTime)
search param:
  name:
    v: patient
  definition:
    v: http://hl7.org/fhir/SearchParameter/clinical-patient
    link: http://hl7.org/fhir/SearchParameter/clinical-patient
  type:
    v: reference
  documentation:
    v: clinical-patient
search param:
  name:
    v: status
  definition:
    v: http://hl7.org/fhir/SearchParameter/CommunicationRequest-status
    link: http://hl7.org/fhir/SearchParameter/CommunicationRequest-status
  type:
    v: token
search param:
  name:
    v: recipient
  definition:
    v: http://hl7.org/fhir/SearchParameter/CommunicationRequest-recipient
    link: http://hl7.org/fhir/SearchParameter/CommunicationRequest-recipient
  type:
    v: reference
  documentation:
    v: Who the information is shared with
search param:
  name:
    v: _profile
  definition:
    v: https://hl7.org/fhir/searchparameter-registry.html#Resource-profile
    link: https://hl7.org/fhir/searchparameter-registry.html#Resource-profile
  type:
    v: reference

type:
  v: CarePlan
profile:
  v: http://hl7.org/fhir/StructureDefinition/CarePlan
  link: http://hl7.org/fhir/StructureDefinition/CarePlan
supported profile:
  v: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/ManaakiNgaTahiCarePlan
  link: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/ManaakiNgaTahiCarePlan
interaction:
  code:
    v: create
interaction:
  code:
    v: read
interaction:
  code:
    v: update
interaction:
  code:
    v: delete
interaction:
  code:
    v: vread
interaction:
  code:
    v: search-type
versioning:
  v: versioned
read history:
  v: false
update create:
  v: false
conditional create:
  v: false
conditional read:
  v: not-supported
conditional update:
  v: false
conditional delete:
  v: not-supported
search include:
  v: *
search include:
  v: CarePlan:encounter
search param:
  name:
    v: patient
  definition:
    v: http://hl7.org/fhir/SearchParameter/clinical-patient
    link: http://hl7.org/fhir/SearchParameter/clinical-patient
  type:
    v: reference
  documentation:
    v: Who the care plan is for
search param:
  name:
    v: status
  definition:
    v: http://hl7.org/fhir/SearchParameter/CarePlan-status
    link: http://hl7.org/fhir/SearchParameter/CarePlan-status
  type:
    v: token
  documentation:
    v: draft | active | on-hold | revoked | completed | entered-in-error | unknown
search param:
  name:
    v: subject
  definition:
    v: http://hl7.org/fhir/SearchParameter/CarePlan-subject
    link: http://hl7.org/fhir/SearchParameter/CarePlan-subject
  type:
    v: reference
  documentation:
    v: Who the care plan is for
search param:
  name:
    v: _profile
  definition:
    v: https://hl7.org/fhir/searchparameter-registry.html#Resource-profile
    link: https://hl7.org/fhir/searchparameter-registry.html#Resource-profile
  type:
    v: reference
  documentation:
    v: Filter **RheumaticFeverCarePlan instances** using ?Resource-profile=https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/StructureDefinition/cinc-rheumaticfever-careplan
search param:
  name:
    v: _id
  definition:
    v: http://hl7.org/fhir/SearchParameter/Resource-id
    link: http://hl7.org/fhir/SearchParameter/Resource-id
  type:
    v: token
  documentation:
    v: Logical id of this artifact
search param:
  name:
    v: category
  definition:
    v: https://hl7.org/fhir/searchparameter-registry.html#CarePlan-category
    link: https://hl7.org/fhir/searchparameter-registry.html#CarePlan-category
  type:
    v: token
  documentation:
    v: Care plan search by category (SNOMED) code. Rheumatic fever secondary prevention care plans have category=http://snomed.sct/info|320721000210102

type:
  v: Condition
profile:
  v: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/ManaakiNgaTahiCondition
  link: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/ManaakiNgaTahiCondition
interaction:
  code:
    v: create
interaction:
  code:
    v: read
interaction:
  code:
    v: update
interaction:
  code:
    v: delete
interaction:
  code:
    v: vread
interaction:
  code:
    v: search-type
versioning:
  v: versioned
read history:
  v: false
update create:
  v: false
conditional create:
  v: false
conditional read:
  v: not-supported
conditional update:
  v: false
conditional delete:
  v: not-supported
search param:
  name:
    v: patient
  definition:
    v: http://hl7.org/fhir/SearchParameter/clinical-patient
    link: http://hl7.org/fhir/SearchParameter/clinical-patient
  type:
    v: reference
  documentation:
    v: Who has the condition?
search param:
  name:
    v: subject
  definition:
    v: http://hl7.org/fhir/SearchParameter/Condition-subject
    link: http://hl7.org/fhir/SearchParameter/Condition-subject
  type:
    v: reference
  documentation:
    v: Who has the condition?
search param:
  name:
    v: _profile
  definition:
    v: https://hl7.org/fhir/searchparameter-registry.html#Resource-profile
    link: https://hl7.org/fhir/searchparameter-registry.html#Resource-profile
  type:
    v: reference
  documentation:
    v: Filter **RheumaticFeverCondition instances** using ?Resource-profile=https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/StructureDefinition/cinc-rheumaticfever-condition
search param:
  name:
    v: _id
  definition:
    v: http://hl7.org/fhir/SearchParameter/Resource-id
    link: http://hl7.org/fhir/SearchParameter/Resource-id
  type:
    v: token
  documentation:
    v: Logical id of this artifact

type:
  v: Consent
profile:
  v: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/nz-sharedcare-consent
  link: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/nz-sharedcare-consent
interaction:
  code:
    v: create
interaction:
  code:
    v: read
interaction:
  code:
    v: update
interaction:
  code:
    v: delete
interaction:
  code:
    v: vread
interaction:
  code:
    v: search-type
versioning:
  v: versioned
read history:
  v: false
update create:
  v: false
conditional create:
  v: false
conditional read:
  v: not-supported
conditional update:
  v: false
conditional delete:
  v: not-supported
search include:
  v: *
search include:
  v: Consent:source-reference
search param:
  name:
    v: patient
  definition:
    v: http://hl7.org/fhir/SearchParameter/clinical-patient
    link: http://hl7.org/fhir/SearchParameter/clinical-patient
  type:
    v: reference
  documentation:
    v: Who the consent applies to
search param:
  name:
    v: data
  definition:
    v: http://hl7.org/fhir/SearchParameter/Consent-data
    link: http://hl7.org/fhir/SearchParameter/Consent-data
  type:
    v: reference
  documentation:
    v: The actual data reference
search param:
  name:
    v: source-reference
  definition:
    v: http://hl7.org/fhir/SearchParameter/Consent-source-reference
    link: http://hl7.org/fhir/SearchParameter/Consent-source-reference
  type:
    v: reference
  documentation:
    v: Search by reference to a Consent, DocumentReference, Contract or QuestionnaireResponse
search param:
  name:
    v: status
  definition:
    v: http://hl7.org/fhir/SearchParameter/Consent-status
    link: http://hl7.org/fhir/SearchParameter/Consent-status
  type:
    v: token
  documentation:
    v: draft | proposed | active | rejected | inactive | entered-in-error
search param:
  name:
    v: _id
  definition:
    v: http://hl7.org/fhir/SearchParameter/Resource-id
    link: http://hl7.org/fhir/SearchParameter/Resource-id
  type:
    v: token
  documentation:
    v: Logical id of this artifact

type:
  v: Encounter
supported profile:
  v: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/ManaakiNgaTahiEncounter
  link: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/ManaakiNgaTahiEncounter
supported profile:
  v: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/OnlineGPEncounter
  link: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/OnlineGPEncounter
supported profile:
  v: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/UrgentCareEncounter
  link: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/UrgentCareEncounter
supported profile:
  v: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/DHOEncounter
  link: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/DHOEncounter
supported profile:
  v: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/DHOEncounterCreate
  link: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/DHOEncounterCreate
supported profile:
  v: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/DHOEncounterUpdate
  link: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/DHOEncounterUpdate
interaction:
  code:
    v: create
interaction:
  code:
    v: read
interaction:
  code:
    v: update
interaction:
  code:
    v: delete
interaction:
  code:
    v: vread
interaction:
  code:
    v: search-type
versioning:
  v: versioned
read history:
  v: false
update create:
  v: false
conditional create:
  v: false
conditional read:
  v: not-supported
conditional update:
  v: false
conditional delete:
  v: not-supported
search include:
  v: *
search include:
  v: Encounter:diagnosis
search include:
  v: Encounter:appointment
search param:
  name:
    v: patient
  definition:
    v: http://hl7.org/fhir/SearchParameter/clinical-patient
    link: http://hl7.org/fhir/SearchParameter/clinical-patient
  type:
    v: reference
  documentation:
    v: The patient or group present at the encounter
search param:
  name:
    v: appointment
  definition:
    v: http://hl7.org/fhir/SearchParameter/clinical-identifer
    link: http://hl7.org/fhir/SearchParameter/clinical-identifer
  type:
    v: reference
  documentation:
    v: The appointment associated with the encounter
search param:
  name:
    v: status
  definition:
    v: http://hl7.org/fhir/SearchParameter/Encounter-status
    link: http://hl7.org/fhir/SearchParameter/Encounter-status
  type:
    v: token
  documentation:
    v: planned | arrived | triaged | in-progress | onleave | finished | cancelled +
search param:
  name:
    v: subject
  definition:
    v: http://hl7.org/fhir/SearchParameter/Encounter-subject
    link: http://hl7.org/fhir/SearchParameter/Encounter-subject
  type:
    v: reference
  documentation:
    v: The patient or group present at the encounter
search param:
  name:
    v: _id
  definition:
    v: http://hl7.org/fhir/SearchParameter/Resource-id
    link: http://hl7.org/fhir/SearchParameter/Resource-id
  type:
    v: token
  documentation:
    v: Logical id of this artifact

type:
  v: HealthcareService
supported profile:
  v: http://hl7.org/fhir/StructureDefinition/HealthcareService
  link: http://hl7.org/fhir/StructureDefinition/HealthcareService
interaction:
  code:
    v: create
interaction:
  code:
    v: read
interaction:
  code:
    v: update
interaction:
  code:
    v: delete
interaction:
  code:
    v: vread
interaction:
  code:
    v: search-type
versioning:
  v: versioned
read history:
  v: false
update create:
  v: false
conditional create:
  v: false
conditional read:
  v: not-supported
conditional update:
  v: false
conditional delete:
  v: not-supported
search param:
  name:
    v: identifier
  definition:
    v: http://hl7.org/fhir/SearchParameter/HealthcareService-identifier
    link: http://hl7.org/fhir/SearchParameter/HealthcareService-identifier
  type:
    v: token
  documentation:
    v: Unique identifier
search param:
  name:
    v: active
  definition:
    v: http://hl7.org/fhir/SearchParameter/HealthcareService-active
    link: http://hl7.org/fhir/SearchParameter/HealthcareService-active
  type:
    v: token
  documentation:
    v: The Healthcare Service is currently marked as active
search param:
  name:
    v: name
  definition:
    v: http://hl7.org/fhir/SearchParameter/HealthcareService-name
    link: http://hl7.org/fhir/SearchParameter/HealthcareService-name
  type:
    v: string
  documentation:
    v: A portion of the Healthcare service name
search param:
  name:
    v: service-type
  definition:
    v: http://hl7.org/fhir/SearchParameter/HealthcareService-service-type
    link: http://hl7.org/fhir/SearchParameter/HealthcareService-service-type
  type:
    v: token
  documentation:
    v: The type of service provided by this healthcare service
search param:
  name:
    v: program
  definition:
    v: http://hl7.org/fhir/SearchParameter/HealthcareService-program
    link: http://hl7.org/fhir/SearchParameter/HealthcareService-program
  type:
    v: token
  documentation:
    v: One of the Programs supported by this HealthcareService
search param:
  name:
    v: _profile
  definition:
    v: https://hl7.org/fhir/searchparameter-registry.html#Resource-profile
    link: https://hl7.org/fhir/searchparameter-registry.html#Resource-profile
  type:
    v: reference

type:
  v: Observation
profile:
  v: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/ManaakiNgaTahiObservation
  link: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/ManaakiNgaTahiObservation
interaction:
  code:
    v: create
interaction:
  code:
    v: read
interaction:
  code:
    v: update
interaction:
  code:
    v: delete
interaction:
  code:
    v: vread
interaction:
  code:
    v: search-type
versioning:
  v: versioned
read history:
  v: false
update create:
  v: false
conditional create:
  v: false
conditional read:
  v: not-supported
conditional update:
  v: false
conditional delete:
  v: not-supported
search include:
  v: *
search include:
  v: Observation:patient
search include:
  v: Observation:encounter
search include:
  v: Observation:based-on
search include:
  v: Observation:derived-from
search include:
  v: Observation:device
search include:
  v: Observation:focus
search include:
  v: Observation:has-member
search include:
  v: Observation:part-of
search include:
  v: Observation:performer
search include:
  v: Observation:specimen
search include:
  v: Observation:subject
search param:
  name:
    v: code
  definition:
    v: http://hl7.org/fhir/SearchParameter/clinical-code
    link: http://hl7.org/fhir/SearchParameter/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
    link: http://hl7.org/fhir/SearchParameter/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: identifier
  definition:
    v: http://hl7.org/fhir/SearchParameter/clinical-identifier
    link: http://hl7.org/fhir/SearchParameter/clinical-identifier
  type:
    v: token
  documentation:
    v: A unique identifier assigned to this observation.
search param:
  name:
    v: patient
  definition:
    v: http://hl7.org/fhir/SearchParameter/clinical-patient
    link: http://hl7.org/fhir/SearchParameter/clinical-patient
  type:
    v: reference
  documentation:
    v: Who the observation is for [Patient](http://hl7.org/fhir/R4/patient.html)
search param:
  name:
    v: based-on
  definition:
    v: http://hl7.org/fhir/SearchParameter/Observation-based-on
    link: http://hl7.org/fhir/SearchParameter/Observation-based-on
  type:
    v: reference
  documentation:
    v: Reference to the service request.
search param:
  name:
    v: encounter
  definition:
    v: http://hl7.org/fhir/SearchParameter/clinical-encounter
    link: http://hl7.org/fhir/SearchParameter/clinical-encounter
  type:
    v: reference
  documentation:
    v: The Encounter resource associated with the Observation.
search param:
  name:
    v: category
  definition:
    v: http://hl7.org/fhir/SearchParameter/Observation-category
    link: http://hl7.org/fhir/SearchParameter/Observation-category
  type:
    v: token
  documentation:
    v: The classification of the type of observation
search param:
  name:
    v: derived-from
  definition:
    v: http://hl7.org/fhir/SearchParameter/Observation-derived-from
    link: http://hl7.org/fhir/SearchParameter/Observation-derived-from
  type:
    v: reference
  documentation:
    v: Related measurements the observation is made from
search param:
  name:
    v: performer
  definition:
    v: http://hl7.org/fhir/SearchParameter/Observation-performer
    link: http://hl7.org/fhir/SearchParameter/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
    link: http://hl7.org/fhir/SearchParameter/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
    link: http://hl7.org/fhir/SearchParameter/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
    link: http://hl7.org/fhir/SearchParameter/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
    link: http://hl7.org/fhir/SearchParameter/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
    link: http://hl7.org/fhir/SearchParameter/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)

name:
  v: value-string
definition:
  v: http://hl7.org/fhir/SearchParameter/Observation-value-string
  link: http://hl7.org/fhir/SearchParameter/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

name:
  v: _id
definition:
  v: http://hl7.org/fhir/SearchParameter/Resource-id
  link: http://hl7.org/fhir/SearchParameter/Resource-id
type:
  v: token
documentation:
  v: Logical id of this artifact

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

name:
  v: flat-export
definition:
  v: https://fhir-ig.digital.health.nz/shared-care/OperationDefinition/Observation-flat-export
  link: https://fhir-ig.digital.health.nz/shared-care/OperationDefinition/Observation-flat-export

type:
  v: Patient
profile:
  v: http://hl7.org.nz/fhir/StructureDefinition/NzPatient
  link: http://hl7.org.nz/fhir/StructureDefinition/NzPatient
supported profile:
  v: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/DHOPatientUpdate
  link: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/DHOPatientUpdate
documentation:
  v: Dunedin Hospital Outpatients - Patient Profile
interaction:
  code:
    v: read
interaction:
  code:
    v: update
interaction:
  code:
    v: vread
interaction:
  code:
    v: search-type
versioning:
  v: versioned
read history:
  v: false
update create:
  v: false
conditional create:
  v: false
conditional read:
  v: not-supported
conditional update:
  v: false
conditional delete:
  v: not-supported
search include:
  v: *
search param:
  name:
    v: identifier
  definition:
    v: https://hl7.org/fhir/searchparameter-registry.html#Patient-identifier
    link: https://hl7.org/fhir/searchparameter-registry.html#Patient-identifier
  type:
    v: token
  documentation:
    v: The patient's official NHI identifier
search param:
  name:
    v: _profile
  definition:
    v: https://hl7.org/fhir/searchparameter-registry.html#Resource-profile
    link: https://hl7.org/fhir/searchparameter-registry.html#Resource-profile
  type:
    v: reference
  documentation:
    v: Filter **Patient instances** using the applicable profile canonical Url from IG
search param:
  name:
    v: _id
  definition:
    v: http://hl7.org/fhir/SearchParameter/Resource-id
    link: http://hl7.org/fhir/SearchParameter/Resource-id
  type:
    v: token
  documentation:
    v: Logical id of this artifact
search param:
  name:
    v: individual-family
  definition:
    v: https://www.hl7.org/fhir/R4/searchparameter-registry.html
    link: https://www.hl7.org/fhir/R4/searchparameter-registry.html
  type:
    v: string
  documentation:
    v: A portion of the family name of the patient - Patient.name.family
search param:
  name:
    v: individual-given
  definition:
    v: https://www.hl7.org/fhir/R4/searchparameter-registry.html
    link: https://www.hl7.org/fhir/R4/searchparameter-registry.html
  type:
    v: string
  documentation:
    v: A portion of the given name of the patient - Patient.name.given
search param:
  name:
    v: Patient-name
  definition:
    v: https://www.hl7.org/fhir/R4/searchparameter-registry.html
    link: https://www.hl7.org/fhir/R4/searchparameter-registry.html
  type:
    v: string
  documentation:
    v: A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text - Patient.name
search param:
  name:
    v: individual-phonetic
  definition:
    v: https://www.hl7.org/fhir/R4/searchparameter-registry.html
    link: https://www.hl7.org/fhir/R4/searchparameter-registry.html
  type:
    v: string
  documentation:
    v: A portion of either family or given name using some kind of phonetic matching algorithm - Patient.name
search param:
  name:
    v: individual-email
  definition:
    v: https://www.hl7.org/fhir/R4/searchparameter-registry.html
    link: https://www.hl7.org/fhir/R4/searchparameter-registry.html
  type:
    v: string
  documentation:
    v: Patient's email contact record - Patient.telecom.where(system='email') | Person

type:
  v: Person
supported profile:
  v: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/nz-sharedcare-communication-person
  link: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/nz-sharedcare-communication-person
interaction:
  code:
    v: create
interaction:
  code:
    v: read
interaction:
  code:
    v: update
interaction:
  code:
    v: delete
interaction:
  code:
    v: vread
interaction:
  code:
    v: search-type
versioning:
  v: versioned
read history:
  v: false
update create:
  v: false
conditional create:
  v: false
conditional read:
  v: not-supported
conditional update:
  v: false
conditional delete:
  v: not-supported
search param:
  name:
    v: phone
  definition:
    v: https://hl7.org/fhir/searchparameter-registry.html#individual-phone
    link: https://hl7.org/fhir/searchparameter-registry.html#individual-phone
  type:
    v: token
  documentation:
    v: A value in a phone contact.
search param:
  name:
    v: email
  definition:
    v: http://hl7.org/fhir/SearchParameter/individual-email
    link: http://hl7.org/fhir/SearchParameter/individual-email
  type:
    v: token
  documentation:
    v: A value in an email contact
search param:
  name:
    v: identifier
  definition:
    v: http://hl7.org/fhir/SearchParameter/clinical-identifier
    link: http://hl7.org/fhir/SearchParameter/clinical-identifier
  type:
    v: token
  documentation:
    v: A person Identifier
search param:
  name:
    v: _profile
  definition:
    v: https://hl7.org/fhir/searchparameter-registry.html#Resource-profile
    link: https://hl7.org/fhir/searchparameter-registry.html#Resource-profile
  type:
    v: reference
  documentation:
    v: Filter **Person Instances** using ?profile=https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/nz-sharedcare-communication-person
search param:
  name:
    v: _source
  definition:
    v: https://hl7.org/fhir/searchparameter-registry.html#Resource-source
    link: https://hl7.org/fhir/searchparameter-registry.html#Resource-source
  type:
    v: uri
  documentation:
    v: Filter **Person Instances** using the meta.source field - e.g. ?_source=NIBS

type:
  v: PlanDefinition
profile:
  v: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/ManaakiNgaTahiPlanDefinition
  link: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/ManaakiNgaTahiPlanDefinition
interaction:
  code:
    v: read
interaction:
  code:
    v: vread
interaction:
  code:
    v: search-type
versioning:
  v: versioned
read history:
  v: false
update create:
  v: false
conditional create:
  v: false
conditional read:
  v: not-supported
conditional update:
  v: false
conditional delete:
  v: not-supported
search param:
  name:
    v: identifier
  definition:
    v: http://hl7.org/fhir/SearchParameter/PlanDefinition-identifier
    link: http://hl7.org/fhir/SearchParameter/PlanDefinition-identifier
  type:
    v: token
  documentation:
    v: External identifier for the plan definition
search param:
  name:
    v: name
  definition:
    v: http://hl7.org/fhir/SearchParameter/PlanDefinition-name
    link: http://hl7.org/fhir/SearchParameter/PlanDefinition-name
  type:
    v: string
  documentation:
    v: Computationally friendly name of the plan definition
search param:
  name:
    v: status
  definition:
    v: http://hl7.org/fhir/SearchParameter/PlanDefinition-status
    link: http://hl7.org/fhir/SearchParameter/PlanDefinition-status
  type:
    v: token
  documentation:
    v: The current status of the plan definition
search param:
  name:
    v: title
  definition:
    v: http://hl7.org/fhir/SearchParameter/PlanDefinition-title
    link: http://hl7.org/fhir/SearchParameter/PlanDefinition-title
  type:
    v: string
  documentation:
    v: The human-friendly name of the plan definition
search param:
  name:
    v: url
  definition:
    v: http://hl7.org/fhir/SearchParameter/PlanDefinition-url
    link: http://hl7.org/fhir/SearchParameter/PlanDefinition-url
  type:
    v: uri
  documentation:
    v: The uri that identifies the plan definition
search param:
  name:
    v: _id
  definition:
    v: http://hl7.org/fhir/SearchParameter/Resource-id
    link: http://hl7.org/fhir/SearchParameter/Resource-id
  type:
    v: token
  documentation:
    v: Logical id of this artifact
operation:
  name:
    v: apply
  definition:
    v: https://fhir-ig.digital.health.nz/shared-care/OperationDefinition/PlanDefinition-apply
    link: https://fhir-ig.digital.health.nz/shared-care/OperationDefinition/PlanDefinition-apply

type:
  v: Questionnaire
interaction:
  code:
    v: read
interaction:
  code:
    v: vread
interaction:
  code:
    v: search-type
versioning:
  v: versioned
read history:
  v: false
update create:
  v: false
conditional create:
  v: false
conditional read:
  v: not-supported
conditional update:
  v: false
conditional delete:
  v: not-supported
search param:
  name:
    v: identifier
  definition:
    v: http://hl7.org/fhir/SearchParameter/Questionnaire-identifier
    link: http://hl7.org/fhir/SearchParameter/Questionnaire-identifier
  type:
    v: token
  documentation:
    v: External identifier for the questionnaire
search param:
  name:
    v: name
  definition:
    v: http://hl7.org/fhir/SearchParameter/Questionnaire-name
    link: http://hl7.org/fhir/SearchParameter/Questionnaire-name
  type:
    v: string
  documentation:
    v: Computationally friendly name of the questionnaire
search param:
  name:
    v: status
  definition:
    v: http://hl7.org/fhir/SearchParameter/Questionnaire-status
    link: http://hl7.org/fhir/SearchParameter/Questionnaire-status
  type:
    v: token
  documentation:
    v: The current status of the questionnaire
search param:
  name:
    v: title
  definition:
    v: http://hl7.org/fhir/SearchParameter/Questionnaire-title
    link: http://hl7.org/fhir/SearchParameter/Questionnaire-title
  type:
    v: string
  documentation:
    v: The human-friendly name of the questionnaire
search param:
  name:
    v: url
  definition:
    v: http://hl7.org/fhir/SearchParameter/Questionnaire-url
    link: http://hl7.org/fhir/SearchParameter/Questionnaire-url
  type:
    v: uri
  documentation:
    v: The uri that identifies the questionnaire
search param:
  name:
    v: _id
  definition:
    v: http://hl7.org/fhir/SearchParameter/Resource-id
    link: http://hl7.org/fhir/SearchParameter/Resource-id
  type:
    v: token
  documentation:
    v: Logical id of this artifact

type:
  v: QuestionnaireResponse
interaction:
  code:
    v: create
interaction:
  code:
    v: read
interaction:
  code:
    v: update
interaction:
  code:
    v: delete
interaction:
  code:
    v: vread
interaction:
  code:
    v: search-type
versioning:
  v: versioned
read history:
  v: false
update create:
  v: false
conditional create:
  v: false
conditional read:
  v: not-supported
conditional update:
  v: false
conditional delete:
  v: not-supported
search include:
  v: *
search include:
  v: QuestionnaireResponse:based-on
search include:
  v: QuestionnaireResponse:encounter
search param:
  name:
    v: patient
  definition:
    v: http://hl7.org/fhir/SearchParameter/QuestionnaireResponse-patient
    link: http://hl7.org/fhir/SearchParameter/QuestionnaireResponse-patient
  type:
    v: reference
  documentation:
    v: The patient that is the subject of the questionnaire response
search param:
  name:
    v: questionnaire
  definition:
    v: http://hl7.org/fhir/SearchParameter/QuestionnaireResponse-questionnaire
    link: http://hl7.org/fhir/SearchParameter/QuestionnaireResponse-questionnaire
  type:
    v: reference
  documentation:
    v: The questionnaire the answers are provided for
search param:
  name:
    v: status
  definition:
    v: http://hl7.org/fhir/SearchParameter/QuestionnaireResponse-status
    link: http://hl7.org/fhir/SearchParameter/QuestionnaireResponse-status
  type:
    v: token
  documentation:
    v: The status of the questionnaire response
search param:
  name:
    v: subject
  definition:
    v: http://hl7.org/fhir/SearchParameter/QuestionnaireResponse-subject
    link: http://hl7.org/fhir/SearchParameter/QuestionnaireResponse-subject
  type:
    v: reference
  documentation:
    v: The subject of the questionnaire response
search param:
  name:
    v: _id
  definition:
    v: http://hl7.org/fhir/SearchParameter/Resource-id
    link: http://hl7.org/fhir/SearchParameter/Resource-id
  type:
    v: token
  documentation:
    v: Logical id of this artifact
operation:
  name:
    v: extract
  definition:
    v: https://fhir-ig.digital.health.nz/shared-care/OperationDefinition/QuestionnaireResponse-extract
    link: https://fhir-ig.digital.health.nz/shared-care/OperationDefinition/QuestionnaireResponse-extract

type:
  v: ActivityDefinition
interaction:
  code:
    v: read
interaction:
  code:
    v: vread
interaction:
  code:
    v: search-type
versioning:
  v: versioned
read history:
  v: false
update create:
  v: false
conditional create:
  v: false
conditional read:
  v: not-supported
conditional update:
  v: false
conditional delete:
  v: not-supported
search include:
  v: *
search param:
  name:
    v: _id
  definition:
    v: http://hl7.org/fhir/SearchParameter/Resource-id
    link: http://hl7.org/fhir/SearchParameter/Resource-id
  type:
    v: token
  documentation:
    v: Logical id of this artifact
search param:
  name:
    v: identifier
  definition:
    v: http://hl7.org/fhir/SearchParameter/ActivityDefinition-identifier
    link: http://hl7.org/fhir/SearchParameter/ActivityDefinition-identifier
  type:
    v: token
  documentation:
    v: External identifier for the ActivityDefinition
search param:
  name:
    v: name
  definition:
    v: http://hl7.org/fhir/SearchParameter/ActivityDefinition-name
    link: http://hl7.org/fhir/SearchParameter/ActivityDefinition-name
  type:
    v: string
  documentation:
    v: Computationally friendly name of the ActivityDefinition
search param:
  name:
    v: status
  definition:
    v: http://hl7.org/fhir/SearchParameter/ActivityDefinition-status
    link: http://hl7.org/fhir/SearchParameter/ActivityDefinition-status
  type:
    v: token
  documentation:
    v: The current status of the ActivityDefinition
search param:
  name:
    v: title
  definition:
    v: http://hl7.org/fhir/SearchParameter/ActivityDefinition-title
    link: http://hl7.org/fhir/SearchParameter/ActivityDefinition-title
  type:
    v: string
  documentation:
    v: The human-friendly name of the ActivityDefinition
operation:
  name:
    v: apply
  definition:
    v: https://fhir-ig.digital.health.nz/shared-care/OperationDefinition/ActivityDefinition-apply
    link: https://fhir-ig.digital.health.nz/shared-care/OperationDefinition/ActivityDefinition-apply

type:
  v: DocumentReference
supported profile:
  v: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/TemplateDocumentReference
  link: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/TemplateDocumentReference
interaction:
  code:
    v: create
interaction:
  code:
    v: read
interaction:
  code:
    v: update
interaction:
  code:
    v: delete
interaction:
  code:
    v: vread
interaction:
  code:
    v: search-type
versioning:
  v: versioned
read history:
  v: false
update create:
  v: false
conditional create:
  v: false
conditional read:
  v: not-supported
conditional update:
  v: false
conditional delete:
  v: not-supported
search param:
  name:
    v: identifier
  definition:
    v: http://hl7.org/fhir/SearchParameter/clinical-identifier
    link: http://hl7.org/fhir/SearchParameter/clinical-identifier
  type:
    v: token
  documentation:
    v: Identifier of the attachment binary
search param:
  name:
    v: status
  definition:
    v: http://hl7.org/fhir/SearchParameter/DocumentReference-status
    link: http://hl7.org/fhir/SearchParameter/DocumentReference-status
  type:
    v: token
  documentation:
    v: current | superseded | entered-in-error
search param:
  name:
    v: category
  definition:
    v: http://hl7.org/fhir/SearchParameter/DocumentReference-category
    link: http://hl7.org/fhir/SearchParameter/DocumentReference-category
  type:
    v: token
  documentation:
    v: Categorization of document
search param:
  name:
    v: date
  definition:
    v: http://hl7.org/fhir/SearchParameter/DocumentReference-date
    link: http://hl7.org/fhir/SearchParameter/DocumentReference-date
  type:
    v: date
  documentation:
    v: When this document reference was createdr

type:
  v: Task
supported profile:
  v: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/OutreachTask
  link: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/OutreachTask
interaction:
  code:
    v: create
interaction:
  code:
    v: read
interaction:
  code:
    v: update
interaction:
  code:
    v: delete
interaction:
  code:
    v: vread
interaction:
  code:
    v: search-type
versioning:
  v: versioned
read history:
  v: false
update create:
  v: false
conditional create:
  v: false
conditional read:
  v: not-supported
conditional update:
  v: false
conditional delete:
  v: not-supported
search param:
  name:
    v: status
  definition:
    v: http://hl7.org/fhir/SearchParameter/Task-status
    link: http://hl7.org/fhir/SearchParameter/Task-status
  type:
    v: token
search param:
  name:
    v: code
  definition:
    v: http://hl7.org/fhir/SearchParameter/Task-code
    link: http://hl7.org/fhir/SearchParameter/Task-code
  type:
    v: token
  documentation:
    v: The type of outreach task
search param:
  name:
    v: owner
  definition:
    v: http://hl7.org/fhir/SearchParameter/Task-owner
    link: http://hl7.org/fhir/SearchParameter/Task-owner
  type:
    v: reference
search param:
  name:
    v: subject
  definition:
    v: http://hl7.org/fhir/SearchParameter/Task-subject
    link: http://hl7.org/fhir/SearchParameter/Task-subject
  type:
    v: reference
search param:
  name:
    v: requester
  definition:
    v: http://hl7.org/fhir/SearchParameter/Task-requester
    link: http://hl7.org/fhir/SearchParameter/Task-requester
  type:
    v: reference
search param:
  name:
    v: based-on
  definition:
    v: http://hl7.org/fhir/SearchParameter/Task-based-on
    link: http://hl7.org/fhir/SearchParameter/Task-based-on
  type:
    v: reference
search param:
  name:
    v: patient
  definition:
    v: http://hl7.org/fhir/SearchParameter/clinical-patient
    link: http://hl7.org/fhir/SearchParameter/clinical-patient
  type:
    v: reference
search param:
  name:
    v: _id
  definition:
    v: http://hl7.org/fhir/SearchParameter/Resource-id
    link: http://hl7.org/fhir/SearchParameter/Resource-id
  type:
    v: token
  documentation:
    v: Logical id of this artifact

type:
  v: ServiceRequest
supported profile:
  v: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/OutreachServiceRequest
  link: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/OutreachServiceRequest
interaction:
  code:
    v: create
interaction:
  code:
    v: read
interaction:
  code:
    v: update
interaction:
  code:
    v: delete
interaction:
  code:
    v: vread
interaction:
  code:
    v: search-type
versioning:
  v: versioned
read history:
  v: false
update create:
  v: false
conditional create:
  v: false
conditional read:
  v: not-supported
conditional update:
  v: false
conditional delete:
  v: not-supported
search rev include:
  v: *
search param:
  name:
    v: identifier
  definition:
    v: http://hl7.org/fhir/SearchParameter/clinical-identifier
    link: http://hl7.org/fhir/SearchParameter/clinical-identifier
  type:
    v: token
search param:
  name:
    v: status
  definition:
    v: http://hl7.org/fhir/SearchParameter/ServiceRequest-status
    link: http://hl7.org/fhir/SearchParameter/ServiceRequest-status
  type:
    v: token
search param:
  name:
    v: priority
  definition:
    v: http://hl7.org/fhir/SearchParameter/ServiceRequest-priority
    link: http://hl7.org/fhir/SearchParameter/ServiceRequest-priority
  type:
    v: token
search param:
  name:
    v: code
  definition:
    v: http://hl7.org/fhir/SearchParameter/clinical-code
    link: http://hl7.org/fhir/SearchParameter/clinical-code
  type:
    v: token
search param:
  name:
    v: patient
  definition:
    v: http://hl7.org/fhir/SearchParameter/clinical-patient
    link: http://hl7.org/fhir/SearchParameter/clinical-patient
  type:
    v: reference
search param:
  name:
    v: subject
  definition:
    v: http://hl7.org/fhir/SearchParameter/ServiceRequest-subject
    link: http://hl7.org/fhir/SearchParameter/ServiceRequest-subject
  type:
    v: reference
search param:
  name:
    v: performer
  definition:
    v: http://hl7.org/fhir/SearchParameter/ServiceRequest-performer
    link: http://hl7.org/fhir/SearchParameter/ServiceRequest-performer
  type:
    v: reference
search param:
  name:
    v: requester
  definition:
    v: http://hl7.org/fhir/SearchParameter/ServiceRequest-requester
    link: http://hl7.org/fhir/SearchParameter/ServiceRequest-requester
  type:
    v: reference
search param:
  name:
    v: _id
  definition:
    v: http://hl7.org/fhir/SearchParameter/Resource-id
    link: http://hl7.org/fhir/SearchParameter/Resource-id
  type:
    v: token
  documentation:
    v: Logical id of this artifact

type:
  v: MedicationDispense
supported profile:
  v: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/NzPharmacyMedicationDispense
  link: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/NzPharmacyMedicationDispense
interaction:
  code:
    v: create
interaction:
  code:
    v: read
interaction:
  code:
    v: update
interaction:
  code:
    v: delete
interaction:
  code:
    v: vread
interaction:
  code:
    v: search-type
versioning:
  v: versioned
read history:
  v: false
update create:
  v: false
conditional create:
  v: false
conditional read:
  v: not-supported
conditional update:
  v: false
conditional delete:
  v: not-supported
search param:
  name:
    v: identifier
  definition:
    v: http://hl7.org/fhir/SearchParameter/clinical-identifier
    link: http://hl7.org/fhir/SearchParameter/clinical-identifier
  type:
    v: token
search param:
  name:
    v: status
  definition:
    v: http://hl7.org/fhir/SearchParameter/medications-status
    link: http://hl7.org/fhir/SearchParameter/medications-status
  type:
    v: token
search param:
  name:
    v: patient
  definition:
    v: http://hl7.org/fhir/SearchParameter/clinical-patient
    link: http://hl7.org/fhir/SearchParameter/clinical-patient
  type:
    v: reference
search param:
  name:
    v: prescription
  definition:
    v: http://hl7.org/fhir/SearchParameter/MedicationDispense-prescription
    link: http://hl7.org/fhir/SearchParameter/MedicationDispense-prescription
  type:
    v: reference
search param:
  name:
    v: whenhandedover
  definition:
    v: http://hl7.org/fhir/SearchParameter/MedicationDispense-whenhandedover
    link: http://hl7.org/fhir/SearchParameter/MedicationDispense-whenhandedover
  type:
    v: date
search param:
  name:
    v: whenprepared
  definition:
    v: http://hl7.org/fhir/SearchParameter/MedicationDispense-whenprepared
    link: http://hl7.org/fhir/SearchParameter/MedicationDispense-whenprepared
  type:
    v: date
search param:
  name:
    v: _id
  definition:
    v: http://hl7.org/fhir/SearchParameter/Resource-id
    link: http://hl7.org/fhir/SearchParameter/Resource-id
  type:
    v: token

type:
  v: MedicationRequest
supported profile:
  v: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/NzPharmacyMedicationRequest
  link: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/NzPharmacyMedicationRequest
interaction:
  code:
    v: create
interaction:
  code:
    v: read
interaction:
  code:
    v: update
interaction:
  code:
    v: delete
interaction:
  code:
    v: vread
interaction:
  code:
    v: search-type
versioning:
  v: versioned
read history:
  v: false
update create:
  v: false
conditional create:
  v: false
conditional read:
  v: not-supported
conditional update:
  v: false
conditional delete:
  v: not-supported
search param:
  name:
    v: identifier
  definition:
    v: http://hl7.org/fhir/SearchParameter/clinical-identifier
    link: http://hl7.org/fhir/SearchParameter/clinical-identifier
  type:
    v: token
search param:
  name:
    v: status
  definition:
    v: http://hl7.org/fhir/SearchParameter/medications-status
    link: http://hl7.org/fhir/SearchParameter/medications-status
  type:
    v: token
search param:
  name:
    v: patient
  definition:
    v: http://hl7.org/fhir/SearchParameter/clinical-patient
    link: http://hl7.org/fhir/SearchParameter/clinical-patient
  type:
    v: reference
search param:
  name:
    v: subject
  definition:
    v: http://hl7.org/fhir/SearchParameter/MedicationRequest-subject
    link: http://hl7.org/fhir/SearchParameter/MedicationRequest-subject
  type:
    v: reference
search param:
  name:
    v: requester
  definition:
    v: http://hl7.org/fhir/SearchParameter/MedicationRequest-requester
    link: http://hl7.org/fhir/SearchParameter/MedicationRequest-requester
  type:
    v: reference
search param:
  name:
    v: authoredon
  definition:
    v: http://hl7.org/fhir/SearchParameter/MedicationRequest-authoredon
    link: http://hl7.org/fhir/SearchParameter/MedicationRequest-authoredon
  type:
    v: date
search param:
  name:
    v: _id
  definition:
    v: http://hl7.org/fhir/SearchParameter/Resource-id
    link: http://hl7.org/fhir/SearchParameter/Resource-id
  type:
    v: token

type:
  v: Claim
supported profile:
  v: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/SharedCareClaim
  link: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/SharedCareClaim
supported profile:
  v: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/NzPharmacyClaim
  link: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/NzPharmacyClaim
interaction:
  code:
    v: create
interaction:
  code:
    v: read
interaction:
  code:
    v: update
interaction:
  code:
    v: delete
interaction:
  code:
    v: vread
interaction:
  code:
    v: search-type
versioning:
  v: versioned
read history:
  v: false
update create:
  v: false
conditional create:
  v: false
conditional read:
  v: not-supported
conditional update:
  v: false
conditional delete:
  v: not-supported
search param:
  name:
    v: identifier
  definition:
    v: http://hl7.org/fhir/SearchParameter/clinical-identifier
    link: http://hl7.org/fhir/SearchParameter/clinical-identifier
  type:
    v: token
search param:
  name:
    v: status
  definition:
    v: http://hl7.org/fhir/SearchParameter/Claim-status
    link: http://hl7.org/fhir/SearchParameter/Claim-status
  type:
    v: token
search param:
  name:
    v: patient
  definition:
    v: http://hl7.org/fhir/SearchParameter/clinical-patient
    link: http://hl7.org/fhir/SearchParameter/clinical-patient
  type:
    v: reference
search param:
  name:
    v: provider
  definition:
    v: http://hl7.org/fhir/SearchParameter/Claim-provider
    link: http://hl7.org/fhir/SearchParameter/Claim-provider
  type:
    v: reference
search param:
  name:
    v: created
  definition:
    v: http://hl7.org/fhir/SearchParameter/Claim-created
    link: http://hl7.org/fhir/SearchParameter/Claim-created
  type:
    v: date
search param:
  name:
    v: use
  definition:
    v: http://hl7.org/fhir/SearchParameter/Claim-use
    link: http://hl7.org/fhir/SearchParameter/Claim-use
  type:
    v: token
search param:
  name:
    v: _id
  definition:
    v: http://hl7.org/fhir/SearchParameter/Resource-id
    link: http://hl7.org/fhir/SearchParameter/Resource-id
  type:
    v: token

type:
  v: ClaimResponse
supported profile:
  v: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/SharedCareClaimResponse
  link: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/SharedCareClaimResponse
supported profile:
  v: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/NzPharmacyClaimResponse
  link: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/NzPharmacyClaimResponse
interaction:
  code:
    v: create
interaction:
  code:
    v: read
interaction:
  code:
    v: update
interaction:
  code:
    v: delete
interaction:
  code:
    v: vread
interaction:
  code:
    v: search-type
versioning:
  v: versioned
read history:
  v: false
update create:
  v: false
conditional create:
  v: false
conditional read:
  v: not-supported
conditional update:
  v: false
conditional delete:
  v: not-supported
search param:
  name:
    v: identifier
  definition:
    v: http://hl7.org/fhir/SearchParameter/ClaimResponse-identifier
    link: http://hl7.org/fhir/SearchParameter/ClaimResponse-identifier
  type:
    v: token
search param:
  name:
    v: status
  definition:
    v: http://hl7.org/fhir/SearchParameter/ClaimResponse-status
    link: http://hl7.org/fhir/SearchParameter/ClaimResponse-status
  type:
    v: token
search param:
  name:
    v: request
  definition:
    v: http://hl7.org/fhir/SearchParameter/ClaimResponse-request
    link: http://hl7.org/fhir/SearchParameter/ClaimResponse-request
  type:
    v: reference
search param:
  name:
    v: created
  definition:
    v: http://hl7.org/fhir/SearchParameter/ClaimResponse-created
    link: http://hl7.org/fhir/SearchParameter/ClaimResponse-created
  type:
    v: date
search param:
  name:
    v: outcome
  definition:
    v: http://hl7.org/fhir/SearchParameter/ClaimResponse-outcome
    link: http://hl7.org/fhir/SearchParameter/ClaimResponse-outcome
  type:
    v: token
search param:
  name:
    v: requestor
  definition:
    v: http://hl7.org/fhir/SearchParameter/ClaimResponse-requestor
    link: http://hl7.org/fhir/SearchParameter/ClaimResponse-requestor
  type:
    v: reference
search param:
  name:
    v: _id
  definition:
    v: http://hl7.org/fhir/SearchParameter/Resource-id
    link: http://hl7.org/fhir/SearchParameter/Resource-id
  type:
    v: token

code:
  v: transaction

name:
  v: run
definition:
  v: https://fhir-ig.digital.health.nz/shared-care/OperationDefinition/RunOperation
  link: https://fhir-ig.digital.health.nz/shared-care/OperationDefinition/RunOperation
documentation:
  v: Run a flat data view operation to aggregate data for a specific patient using a defined ViewDefinition. See [Flat Data Views](./flatDataViews.md) for more information.