DEPRECATED Te Whatu Ora Shared Care FHIR API - see https://fhir-ig.digital.health.nz/shared-care
0.4.0 - release
DEPRECATED Te Whatu Ora Shared Care FHIR API - see https://fhir-ig.digital.health.nz/shared-care
0.4.0 - release
DEPRECATED Te Whatu Ora Shared Care FHIR API - see https://fhir-ig.digital.health.nz/shared-care, published by Te Whatu Ora. This guide is not an authorized publication; it is the continuous build for version 0.4.0 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
| Official URL: https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/CapabilityStatement/SharedCareFHIRAPICapabilityStatement | Version: 0.4.0 | |||
| Active as of 2023-10-19 | Computable Name: SharedCareFHIRAPICapabilityStatement | |||
| Health NZ | Te Whatu Ora Shared Care FHIR API |
Raw OpenAPI-Swagger Definition file | Download
Generated Narrative: CapabilityStatement SharedCareFHIRAPICapabilityStatement
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.
serverOAuthtransactioninteraction.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 |
|---|---|---|---|---|---|---|---|---|---|---|---|
| Bundle | http://hl7.org/fhir/StructureDefinition/Bundle | y | y | y | y | y | y | patient, actor, status, date, clinical-status, _id, _lastUpdated | * | ||
| CarePlan | https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/StructureDefinition/ManaakiNgaTahiCarePlan | y | y | y | patient, status, subject, _profile, _id, category | *, CarePlan:encounter | |||||
| Condition | https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/StructureDefinition/ManaakiNgaTahiCondition | y | y | y | y | y | y | patient, subject, _profile, _id | |||
| Consent | https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/StructureDefinition/nz-sharedcare-consent | y | y | y | y | y | y | patient, data, source-reference, status, _id | *, Consent:source-reference | ||
| Encounter | https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/StructureDefinition/ManaakiNgaTahiEncounter | y | y | y | y | y | y | patient, status, subject, _id | *, Encounter:diagnosis | ||
| Observation | https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/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 | ||
| Person | y | y | y | y | y | y | phone, email, identifier, profile | ||||
| PlanDefinition | https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/StructureDefinition/ManaakiNgaTahiPlanDefinition | y | y | y | identifier, name, status, title, url, _id | ||||||
| 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 |
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 |
| 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 |
read, 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 | 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 |
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://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/StructureDefinition/nz-sharedcare-communication-person |
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 |