Te Whatu Ora Shared Care FHIR API
0.3.9 - release New Zealand flag

Te Whatu Ora Shared Care FHIR API, published by Te Whatu Ora. This guide is not an authorized publication; it is the continuous build for version 0.3.9 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/tewhatuora/cinc-fhir-ig/ and changes regularly. See the Directory of published versions

CapabilityStatement: Care In The Community FHIR Server Capability Statement

Official URL: https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/CapabilityStatement/CareInTheCommunityCapabilityStatement Version: 0.3.9
Active as of 2023-10-19 Computable Name: CareInTheCommunityCapabilityStatement

The Manaaki Nga Tahi - Care In The Community FHIR API

Raw OpenAPI-Swagger Definition file | Download

Care In The Community FHIR Server Capability Statement

  • Implementation Guide Version: 0.3.9
  • FHIR Version: 4.0.1
  • Supported Formats: json
  • Supported Patch Formats:
  • Published on: Thu Oct 19 00:00:00 UTC 2023
  • Published by: Te Whatu Ora

Note to Implementers: FHIR Capabilities

Any FHIR capability may be 'allowed' by the system unless explicitly marked as "SHALL NOT". A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.

FHIR RESTful Capabilities

Mode: server

Security
Enable CORS: yes
Security services supported: OAuth
Summary of System-wide Interactions
  • Supports the transaction interaction.

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 TypeProfileRV-RSUCDSearches_include_revincludeOperations
Bundlehttp://hl7.org/fhir/StructureDefinition/Bundleyyyyyypatient, actor, status, date, clinical-status, _id, _lastUpdated*
CarePlanhttps://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/StructureDefinition/ManaakiNgaTahiCarePlan
Additional supported profiles:
  Rheumatic Fever CarePlan
yyyyyypatient, status, subject, _profile, _id, category*, CarePlan:encounter
CareTeamSupported profiles:
  Rheumatic Fever Care Team
yyyyyyidentifier, category, _profile, _id
Conditionhttps://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/StructureDefinition/ManaakiNgaTahiCondition
Additional supported profiles:
  Rheumatic Fever Condition
yyyyyypatient, subject, _profile, _id
Consenthttps://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/StructureDefinition/nz-sharedcare-consentyyyyyypatient, data, source-reference, status, _id*, Consent:source-reference
Encounterhttps://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/StructureDefinition/ManaakiNgaTahiEncounteryyyyyypatient, status, subject, _id*, Encounter:diagnosis
MedicationRequesthttp://hl7.org.nz/fhir/StructureDefinition/NzMedicationRequest
Additional supported profiles:
  Rheumatic Fever Medication Request
yyyyyypatient, status, medication*
MedicationStatementhttp://hl7.org.nz/fhir/StructureDefinition/NzMedicationStatement
Additional supported profiles:
  MedicationStatement
yyyyyypatient, status, medication*
Observationhttps://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/StructureDefinition/ManaakiNgaTahiObservationyyyyyycode, date, identifier, patient, based-on, encounter, category, derived-from, performer, status, subject, value-concept, value-date, value-quantity, value-string, _id, _lastUpdated*, Observation:patient, Observation:encounter, Observation:based-on, Observation:derived-from, Observation:device, Observation:focus, Observation:has-member, Observation:part-of, Observation:performer, Observation:specimen, Observation:subject
Patienthttps://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/StructureDefinition/nz-sharedcare-rheumaticfever-patientyyyyyyidentifier, _profile, _id
PlanDefinitionhttps://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/StructureDefinition/ManaakiNgaTahiPlanDefinitionyyyyyyidentifier, name, status, title, url, _id
Questionnaire yyyyyyidentifier, name, status, title, url, _id
QuestionnaireResponse yyyyyypatient, questionnaire, status, subject, _id*, QuestionnaireResponse:based-on, QuestionnaireResponse:encounter

Resource Conformance: supportedBundle

Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports create, read, update, delete, vread, search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference

Who the sensitivity is for Patient

SHALLactorreference

Any one of the individuals participating in the appointment (Practitioner, Device, Patient, HealthcareService, PractitionerRole, RelatedPerson, Location)

SHALLstatustoken

proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist

SHALLdatedate

Appointment date/time

SHALLclinical-statustoken

Must be one of

SHALL_idtoken

Logical id of this artifact

SHALL_lastUpdateddate

When the resource version last changed

 

Resource Conformance: supportedCarePlan

Interaction summary
  • Supports create, read, update, delete, vread, search-type.

Documentation

This server supports two subtypes of FHIR CarePlan - refer to Profiles

  1. ManaakiNgaTahiCarePlan - for care in the community health applications
  2. RheumaticFeverCarePlan - for rheumatic fever health applications
Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference

Who the care plan is for

SHALLstatustoken

draft | active | on-hold | revoked | completed | entered-in-error | unknown

SHALLsubjectreference

Who the care plan is for

SHALL_profilereference

Filter RheumaticFeverCarePlan instances using ?Resource-profile=https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/StructureDefinition/cinc-rheumaticfever-careplan

SHALL_idtoken

Logical id of this artifact

SHALLcategorytoken

Care plan search by category (SNOMED) code. Rheumatic fever secondary prevention care plans have category=http://snomed.sct/info|320721000210102

 

Resource Conformance: supportedCareTeam

Core FHIR Resource
CareTeam
Reference Policy
Interaction summary
  • Supports create, read, update, delete, vread, search-type.

Documentation

This server supports one subtype of FHIR CareTeam - refer to Profiles

  1. RheumaticFeverCareTeam - simply requires use of particular Condition.category codes in rheumatic fever health applications
Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken

The patient's official NHI identifier

SHALLcategorytoken

Rheumatic fever care teams will be found by the category code (NZ SNOMED Edition) category=http://snomed.sct/info|320741000210108

SHALL_profilereference

Filter RheumaticFeverCareTeam instances using ?Resource-profile=https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/StructureDefinition/cinc-rheumaticfever-careteam

SHALL_idtoken

Logical id of this artifact

 

Resource Conformance: supportedCondition

Interaction summary
  • Supports create, read, update, delete, vread, search-type.

Documentation

This server supports two subtypes of FHIR Condition - refer to Profiles

  1. ManaakiNgaTahiCondition - for care in the community health applications
  2. RheumaticFeverCondition - for rheumatic fever health applications
Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference

Who has the condition?

SHALLsubjectreference

Who has the condition?

SHALL_profilereference

Filter RheumaticFeverCondition instances using ?Resource-profile=https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/StructureDefinition/cinc-rheumaticfever-condition

SHALL_idtoken

Logical id of this artifact

 

Resource Conformance: supportedConsent

Interaction summary
  • Supports create, read, update, delete, vread, search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference

Who the consent applies to

SHALLdatareference

The actual data reference

SHALLsource-referencereference

Search by reference to a Consent, DocumentReference, Contract or QuestionnaireResponse

SHALLstatustoken

draft | proposed | active | rejected | inactive | entered-in-error

SHALL_idtoken

Logical id of this artifact

 

Resource Conformance: supportedEncounter

Interaction summary
  • Supports create, read, update, delete, vread, search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference

The patient or group present at the encounter

SHALLstatustoken

planned | arrived | triaged | in-progress | onleave | finished | cancelled +

SHALLsubjectreference

The patient or group present at the encounter

SHALL_idtoken

Logical id of this artifact

 

Resource Conformance: supportedMedicationRequest

Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports create, read, update, delete, vread, search-type.

Documentation

This server supports two profiles in addition to the base FHIR MedicationRequest resource.

  1. NzMedicationRequest - from the NZ Base Implementation Guide 2.0
  2. RheumaticFeverMedicationRequest - for rheumatic fever, captures the medication frequency which is the interval between appointments for benzathine injection.
Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference

The rheumatic fever patient for whom this medication is prescribed

SHALLstatustoken

active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown +

SHALLmedicationreference

Return all MedicationRequests that relate to this type of medication

 

Resource Conformance: supportedMedicationStatement

Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports create, read, update, delete, vread, search-type.

Documentation

This server supports the NZ Base IG profiles NzMedicationStatement in addition to the base MedicationStatement FHIR resource.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference

The rheumatic fever patient to whom medication was administered

SHALLstatustoken

active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken +

SHALLmedicationreference

Return all instances of administration of this medication

 

Resource Conformance: supportedObservation

Interaction summary
  • Supports create, read, update, delete, vread, search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLcodetoken

Describes what was observed. Sometimes this is called the observation 'name'

SHALLdatedate

Observation.effective Obtained date/time. If the obtained element is a period, a date that falls in the period

SHALLidentifiertoken

A unique identifier assigned to this observation.

SHALLpatientreference

Who the observation is for Patient

SHALLbased-onreference

Reference to the service request.

SHALLencounterreference

The Encounter resource associated with the Observation.

SHALLcategorytoken

The classification of the type of observation

SHALLderived-fromreference

Related measurements the observation is made from

SHALLperformerreference

Who performed the observation

SHALLstatustoken

The status of the observation

SHALLsubjectreference

The subject that the observation is about

SHALLvalue-concepttoken

The value of the observation, if the value is a CodeableConcept

SHALLvalue-datedate

The value of the observation, if the value is a date or period of time

SHALLvalue-quantityquantity

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)

SHALLvalue-stringstring

The value of the observation, if the value is a string, and also searches in CodeableConcept.text

SHALL_idtoken

Logical id of this artifact

SHALL_lastUpdateddate

When the resource version last changed

 

Resource Conformance: supportedPatient

Interaction summary
  • Supports create, read, update, delete, vread, search-type.

Documentation

This server supports one subsubtype of FHIR Patient (subtype of NzPatient) - refer to Profiles

  1. RheumaticFeverPatient - for rheumatic fever health applications
Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken

The patient's official NHI identifier

SHALL_profilereference

Filter RheumaticFeverPatient instances using ?Resource-profile=https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/StructureDefinition/cinc-rheumaticfever-patient

SHALL_idtoken

Logical id of this artifact

 

Resource Conformance: supportedPlanDefinition

Interaction summary
  • Supports create, read, update, delete, vread, search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken

External identifier for the plan definition

SHALLnamestring

Computationally friendly name of the plan definition

SHALLstatustoken

The current status of the plan definition

SHALLtitlestring

The human-friendly name of the plan definition

SHALLurluri

The uri that identifies the plan definition

SHALL_idtoken

Logical id of this artifact

 
Extended Operations
ConformanceOperationDocumentation
SHALL$apply

Resource Conformance: supportedQuestionnaire

Core FHIR Resource
Questionnaire
Reference Policy
Interaction summary
  • Supports create, read, update, delete, vread, search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken

External identifier for the questionnaire

SHALLnamestring

Computationally friendly name of the questionnaire

SHALLstatustoken

The current status of the questionnaire

SHALLtitlestring

The human-friendly name of the questionnaire

SHALLurluri

The uri that identifies the questionnaire

SHALL_idtoken

Logical id of this artifact

 

Resource Conformance: supportedQuestionnaireResponse

Core FHIR Resource
QuestionnaireResponse
Reference Policy
Interaction summary
  • Supports create, read, update, delete, vread, search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference

The patient that is the subject of the questionnaire response

SHALLquestionnairereference

The questionnaire the answers are provided for

SHALLstatustoken

The status of the questionnaire response

SHALLsubjectreference

The subject of the questionnaire response

SHALL_idtoken

Logical id of this artifact