Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.2 - release
Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.2 - release
Health New Zealand Te Whatu Ora Shared Care FHIR API - Local Development build (v0.4.2) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: https://fhir-ig.digital.health.nz/shared-care/CapabilityStatement/SharedCareFHIRAPICapabilityStatement | Version: 0.4.2 | |||
| Active as of 2024-07-03 | Computable Name: SharedCareFHIRAPICapabilityStatement | |||
| Health NZ | Te Whatu Ora Shared Care FHIR API |
Raw OpenAPI-Swagger Definition file | Download
Profile: Capability Statement profile for use with the Health New Zealand Te Whatu Ora OpenAPI spec converter
jsonNote 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.
serverSMART-on-FHIRtransactioninteraction.| 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. |
The summary table lists the resources that are part of this configuration, and for each resource it lists:
_include_revinclude| 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 New Dunedin Hospital Outpatient Appointment Profile NZ SharedCare Appointment | y | y | y | y | y | y | patient, actor, status, date | * | ||
| AppointmentResponse | Supported Profiles New Dunedin Hospital Outpatient Appointment Response Profile | y | y | ||||||||
| Bundle | http://hl7.org/fhir/StructureDefinition/Bundle | y | y | y | y | y | y | ||||
| Communication | Supported Profiles CMS Communication | y | y | y | y | y | y | sender, identifier, based-on, patient, recipient, status, sent, received, medium, _profile | |||
| CommunicationRequest | Supported Profiles CMS Communication Request | y | y | y | y | y | y | identifier, medium, occurrence, patient, status, recipient, _profile | * | ||
| CarePlan | http://hl7.org/fhir/StructureDefinition/CarePlan Additional supported profiles: ManaakiNgaTahiCarePlan | y | y | y | y | y | y | patient, status, subject, _profile, _id, category | *, CarePlan:encounter | ||
| Condition | https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/ManaakiNgaTahiCondition | y | y | y | y | y | y | patient, subject, _profile, _id | |||
| Consent | https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/nz-sharedcare-consent | y | y | y | y | y | y | patient, data, source-reference, status, _id | *, Consent:source-reference | ||
| Encounter | Supported Profiles ManaakiNgaTahiEncounter NZ SharedCare Encounter | y | y | y | y | y | y | patient, status, subject, _id | *, Encounter:diagnosis | ||
| HealthcareService | Supported Profiles HealthcareService | y | y | y | y | y | y | identifier, active, name, service-type, program, _profile | |||
| Observation | https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/ManaakiNgaTahiObservation | y | y | y | y | y | y | code, 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 | $flat-export | |
| Patient | http://hl7.org.nz/fhir/StructureDefinition/NzPatient Additional supported profiles: New Dunedin Hospital Outpatient Update profile | y | y | y | y | identifier, _profile, _id, individual-family, individual-given, Patient-name, individual-phonetic, individual-email | * | ||||
| Person | Supported Profiles CommunicationPerson | y | y | y | y | y | y | phone, email, identifier, _profile, _source | |||
| PlanDefinition | https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/ManaakiNgaTahiPlanDefinition | y | y | y | identifier, name, status, title, url, _id | $apply | |||||
| Questionnaire | y | y | y | identifier, name, status, title, url, _id | |||||||
| QuestionnaireResponse | y | y | y | y | y | y | patient, questionnaire, status, subject, _id | *, QuestionnaireResponse:based-on, QuestionnaireResponse:encounter | $extract | ||
| ActivityDefinition | y | y | y | _id, identifier, name, status, title | * | $apply | |||||
| DocumentReference | Supported Profiles Record of Template for Email Communication from Any Healthcare System | y | y | y | y | y | y | identifier, status, category, date | |||
| Task | Supported Profiles OutreachTask | y | y | y | y | y | y | status, code, owner, subject, requester, based-on, patient, _id | |||
| ServiceRequest | Supported Profiles OutreachServiceRequest | y | y | y | y | y | y | identifier, status, priority, code, patient, subject, performer, requester, _id | * | ||
| Claim | Supported Profiles NZ SharedCare Claim | y | y | y | y | y | y | identifier, status, patient, provider, created, use, _id | |||
| ClaimResponse | Supported Profiles NZ SharedCare Claim Response | y | y | y | y | y | y | identifier, status, request, created, outcome, requestor, _id |
create, read, update, delete, vread, search-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | Who the sensitivity is for Patient |
| SHALL | recorder | reference | Who recorded the sensitivity AllergyIntolerance.recorder |
| SHALL | code | token | Code that identifies the allergy or intolerance AllergyIntolerance Code ValueSet |
| SHALL | category | token | Must be one of
|
| SHALL | clinical-status | token | Must be one of
|
| SHALL | _id | token | Logical id of this artifact |
| SHALL | _lastUpdated | date | When the resource version last changed |
create, read, update, delete, vread, search-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | Who the sensitivity is for Patient |
| SHALL | actor | reference | Any one of the individuals participating in the appointment (Practitioner, Device, Patient, HealthcareService, PractitionerRole, RelatedPerson, Location) |
| SHALL | status | token | proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist |
| SHALL | date | date | Appointment date/time |
New Dunedin Hospital Outpatient Appointment Response Profile
New Dunedin Hospital Outpatients - Used to confirm an appointment
create, read, update, delete, vread, search-type.create, read, update, delete, vread, search-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | sender | reference | Who shares the information |
| SHALL | identifier | token | clinical-identifier |
| SHALL | based-on | reference | Communication-based-on |
| SHALL | patient | reference | clinical-patient |
| SHALL | recipient | reference | Who the information is shared with |
| SHALL | status | token | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown |
| SHALL | sent | date | When sent |
| SHALL | received | date | Communication-received |
| SHALL | medium | token | Communication-medium |
| SHALL | _profile | reference |
create, read, update, delete, vread, search-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | identifier | token | Unique identifier |
| SHALL | medium | token | A channel of communication |
| SHALL | occurrence | date | CommunicationRequest.occurrence.ofType(dateTime) |
| SHALL | patient | reference | clinical-patient |
| SHALL | status | token | |
| SHALL | recipient | reference | Who the information is shared with |
| SHALL | _profile | reference |
create, read, update, delete, vread, search-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | Who the care plan is for |
| SHALL | status | token | draft | active | on-hold | revoked | completed | entered-in-error | unknown |
| SHALL | subject | reference | Who the care plan is for |
| SHALL | _profile | reference | Filter RheumaticFeverCarePlan instances using ?Resource-profile=https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/StructureDefinition/cinc-rheumaticfever-careplan |
| SHALL | _id | token | Logical id of this artifact |
| SHALL | category | token | Care plan search by category (SNOMED) code. Rheumatic fever secondary prevention care plans have category=http://snomed.sct/info|320721000210102 |
create, read, update, delete, vread, search-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | Who has the condition? |
| SHALL | subject | reference | Who has the condition? |
| SHALL | _profile | reference | Filter RheumaticFeverCondition instances using ?Resource-profile=https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/StructureDefinition/cinc-rheumaticfever-condition |
| SHALL | _id | token | Logical id of this artifact |
create, read, update, delete, vread, search-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | Who the consent applies to |
| SHALL | data | reference | The actual data reference |
| SHALL | source-reference | reference | Search by reference to a Consent, DocumentReference, Contract or QuestionnaireResponse |
| SHALL | status | token | draft | proposed | active | rejected | inactive | entered-in-error |
| SHALL | _id | token | Logical id of this artifact |
create, read, update, delete, vread, search-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | The patient or group present at the encounter |
| SHALL | status | token | planned | arrived | triaged | in-progress | onleave | finished | cancelled + |
| SHALL | subject | reference | The patient or group present at the encounter |
| SHALL | _id | token | Logical id of this artifact |
create, read, update, delete, vread, search-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | identifier | token | Unique identifier |
| SHALL | active | token | The Healthcare Service is currently marked as active |
| SHALL | name | string | A portion of the Healthcare service name |
| SHALL | service-type | token | The type of service provided by this healthcare service |
| SHALL | program | token | One of the Programs supported by this HealthcareService |
| SHALL | _profile | reference |
create, read, update, delete, vread, search-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | code | token | Describes what was observed. Sometimes this is called the observation 'name' |
| SHALL | date | date | Observation.effective Obtained date/time. If the obtained element is a period, a date that falls in the period |
| SHALL | identifier | token | A unique identifier assigned to this observation. |
| SHALL | patient | reference | Who the observation is for Patient |
| SHALL | based-on | reference | Reference to the service request. |
| SHALL | encounter | reference | The Encounter resource associated with the Observation. |
| SHALL | category | token | The classification of the type of observation |
| SHALL | derived-from | reference | Related measurements the observation is made from |
| SHALL | performer | reference | Who performed the observation |
| SHALL | status | token | The status of the observation |
| SHALL | subject | reference | The subject that the observation is about |
| SHALL | value-concept | token | The value of the observation, if the value is a CodeableConcept |
| SHALL | value-date | date | The value of the observation, if the value is a date or period of time |
| SHALL | value-quantity | quantity | 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) |
| SHALL | value-string | string | The value of the observation, if the value is a string, and also searches in CodeableConcept.text |
| SHALL | _id | token | Logical id of this artifact |
| SHALL | _lastUpdated | date | When the resource version last changed |
| Conformance | Operation | Documentation |
|---|---|---|
| SHALL | $flat-export |
read, update, vread, search-type.New Dunedin Hospital Outpatients - Patient Profile
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | identifier | token | The patient's official NHI identifier |
| SHALL | _profile | reference | Filter Patient instances using the applicable profile canonical Url from IG |
| SHALL | _id | token | Logical id of this artifact |
| SHALL | individual-family | string | A portion of the family name of the patient - Patient.name.family |
| SHALL | individual-given | string | A portion of the given name of the patient - Patient.name.given |
| SHALL | Patient-name | string | 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 |
| SHALL | individual-phonetic | string | A portion of either family or given name using some kind of phonetic matching algorithm - Patient.name |
| SHALL | individual-email | string | Patient's email contact record - Patient.telecom.where(system='email') | Person |
create, read, update, delete, vread, search-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | phone | token | A value in a phone contact. |
| SHALL | token | A value in an email contact | |
| SHALL | identifier | token | A person Identifier |
| SHALL | _profile | reference | Filter Person Instances using ?profile=https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/nz-sharedcare-communication-person |
| SHALL | _source | uri | Filter Person Instances using the meta.source field - e.g. ?_source=NIBS |
read, vread, search-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | identifier | token | External identifier for the plan definition |
| SHALL | name | string | Computationally friendly name of the plan definition |
| SHALL | status | token | The current status of the plan definition |
| SHALL | title | string | The human-friendly name of the plan definition |
| SHALL | url | uri | The uri that identifies the plan definition |
| SHALL | _id | token | Logical id of this artifact |
| Conformance | Operation | Documentation |
|---|---|---|
| SHALL | $apply |
read, vread, search-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | identifier | token | External identifier for the questionnaire |
| SHALL | name | string | Computationally friendly name of the questionnaire |
| SHALL | status | token | The current status of the questionnaire |
| SHALL | title | string | The human-friendly name of the questionnaire |
| SHALL | url | uri | The uri that identifies the questionnaire |
| SHALL | _id | token | Logical id of this artifact |
create, read, update, delete, vread, search-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | The patient that is the subject of the questionnaire response |
| SHALL | questionnaire | reference | The questionnaire the answers are provided for |
| SHALL | status | token | The status of the questionnaire response |
| SHALL | subject | reference | The subject of the questionnaire response |
| SHALL | _id | token | Logical id of this artifact |
| Conformance | Operation | Documentation |
|---|---|---|
| SHALL | $extract |
read, vread, search-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _id | token | Logical id of this artifact |
| SHALL | identifier | token | External identifier for the ActivityDefinition |
| SHALL | name | string | Computationally friendly name of the ActivityDefinition |
| SHALL | status | token | The current status of the ActivityDefinition |
| SHALL | title | string | The human-friendly name of the ActivityDefinition |
| Conformance | Operation | Documentation |
|---|---|---|
| SHALL | $apply |
create, read, update, delete, vread, search-type.Record of Template for Email Communication from Any Healthcare System
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | identifier | token | Identifier of the attachment binary |
| SHALL | status | token | current | superseded | entered-in-error |
| SHALL | category | token | Categorization of document |
| SHALL | date | date | When this document reference was createdr |
create, read, update, delete, vread, search-type.create, read, update, delete, vread, search-type.create, read, update, delete, vread, search-type.create, read, update, delete, vread, search-type.