Te Whatu Ora Shared Care FHIR API
0.4.0 - release
Te Whatu Ora Shared Care FHIR API
0.4.0 - release
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.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
Contents:
This page provides a list of the FHIR artifacts defined as part of this implementation guide.
Canonical FHIR Profiles and Definitions
| Care In The Community ActivityDefinition Apply Operation |
The apply operation applies an ActivityDefinition to a given context |
| Care In The Community PlanDefinition Apply Operation |
The apply operation applies a PlanDefinition to a given context |
| ManaakiNgaTahiAllergyIntolerance |
AllergyIntolerance FHIR resource for Manaaki Nga Tahi |
| ManaakiNgaTahiCarePlan |
CarePlan FHIR resource for Manaaki Nga Tahi |
| ManaakiNgaTahiCondition |
Condition FHIR resource for Manaaki Nga Tahi |
| ManaakiNgaTahiDocumentReference |
DocumentReference FHIR resource for Manaaki Nga Tahi |
| ManaakiNgaTahiEncounter |
Encounter FHIR resource for Manaaki Nga Tahi |
| ManaakiNgaTahiObservation |
Observation FHIR resource for Manaaki Nga Tahi |
| ManaakiNgaTahiPlanDefinition |
PlanDefinition template which creates Manaaki Nga Tahi (Care in the Community) CarePlans |
| ManaakiNgaTahiServiceRequest |
Service request FHIR resource for Manaaki Nga Tahi |
| ServiceRequestActivityDefinition |
ActivityDefinition resource which creates (templates) ServiceRequests |
| Template for COVID-19 Care in the Community CCCM MVP Careplans |
Creates a care plan suitable for a low to medium-risk COVID-19 case: patient activities include medication delivery, heath checks, RAT self-test and follow-up GP Check |
| Vital Signs Observation Service Request |
Template for care plan activities that capture of patient vital signs |
Standard questionnaire definitions shared by all applications
| AIR - Overseas, Historic, Not Done |
Submit an overseas, historic, or not-done vaccination to AIR |
| Antiviral medication eligibility questionnaire |
A questionnaire defining eligibility criteria for anti-viral medication |
| COVID-19 RAT Result Questionnaire |
Questionnaire for assisted channel or aged residential care facilities to report a COVID-19 rapid antigen test (RAT) result. |
| COVID19 Initial Health Assessment Questionnaire |
An initial assessment for a patient who has tested positive for COVID-19 |
| COVID19 Public Health History Questionnaire |
Questions about a patient’s recent COVID-19 history |
| COVID19 Vaccination Side Effects Questionnaire |
Te Whatu Ora post COVID-19 vaccination survey. |
| Measles Daily Health Check |
Te Whatu Ora survey of Symptoms, Context and Quarantine informations surrounding Measles Patients |
| Mental Health Assessment Survey |
Te Whatu Ora Mental Health Assessment Survey |
| Post Vaccine Symptom Check day 3 survey |
Te Whatu Ora 3-day post Influenza/Covid-19 booster vaccination survey. |
| Post Vaccine Symptom Check day 42 survey |
Te Whatu Ora 42-day post Influenza/Covid-19 booster vaccination survey. |
| Pregnancy Assessment Survey |
Te Whatu Ora pregnancy assessment survey. |
| Question Template for COVID-19 Regular Health Check |
Gather the status of a patient who is self isolating |
| Report a Rapid Antigen Test (RAT) result |
Consumer COVID RAT Result Questionnaire |
Demonstration QuestionnaireResponses for all Questionnaire resources
| ActiveMonitoringDay3SurveyQuestionnaireResponse |
Survey of side effects and overall experience of Influenza/COVID-19 Booster vaccination after 3 days. |
| ActiveMonitoringDay42SurveyQuestionnaireResponse |
Survey of side effects and overall experience of Influenza/COVID-19 Booster vaccination after 42 days. |
| AntiviralEligibilityNoQuestionnaireResponse |
Demonstrates payload for a pharmacy review where patient IS NOT eligible for antivirals |
| AntiviralEligibilityYesQuestionnaireResponse |
Demonstrates payload for a pharmacy review where patient IS eligible for antivirals |
| ConsumerCOVIDRATResultQuestionnaireResponse |
Example payload from an individual consumer reporting a COVID-19 rapid antigen test (RAT) result. |
| COVIDInitialHealthAssessmentQuestionnaireResponse |
Demonstrates responses collected for COVIDInitialHealthAssessmentQuestionnaire |
| COVIDPublicHealthHistoryQuestionnaireResponseSherrylCarrion |
Demonstrates responses collected for COVIDPublicHealthHistoryQuestionnaire in relation to example patient Sherryl Carrion |
| COVIDRATResultQuestionnaireResponse |
Example payload from an aged residential care facility reporting a COVID-19 rapid antigen test (RAT) result. |
| COVIDRegularHealthCheckQuestionnaireResponse |
Demonstrates responses collected for COVIDRegularHealthCheckQuestionnaire |
| COVIDVaccinationSurveyQuestionnaireResponse |
Example payload demonstrating data collected in a post COVID vaccination adverse reaction survey. |
| ImmsotVaccinationDataEntryQuestionnaireResponse |
Example payload of an overseas immunisation being added to ImmSoT. |
| MeaslesHealthCheckQuestionnaireResponse |
Example payload from an asymptomatic measles health check. |
| MentalHealthAssessmentSurveyQuestionnaireResponse |
Demonstrates responses collected for MentalHealthAssessmentSurveyQuestionnaire |
| PregnancyAssessmentSurveyQuestionnaireResponse |
Demonstrates responses collected for Pregnancy Assessment Survey Questionnaire |
| CareyCarrington |
An example patient resource |
| ConditionExample |
An example ManaakiNgaTahi Condition |
| COVID-19 Omicron Response - Carey Carrington |
An example ManaakiNgaTahi Care Plan |
| DocumentReferenceExample |
An example ManaakiNgaTahi DocumentReference |
| DrDottyMcStuffins |
Example of a practitioner who plans patient care |
| EncounterExample |
An example ManaakiNgaTahi Encounter |
| ObservationExample |
An example ManaakiNgaTahi Observation |
| ObservationsServiceRequestExample |
An example ManaakiNgaTahi ServiceRequest |
| ActiveConsentExample |
Example of an active patient consent lasting for 3 years as recorded by a Rheumatic Fever Secondary Prevention Service org. |
| ConsentByQuestionnaireExample |
An example ManaakiNgaTahi Consent by policy |
| ConsentByRelatedPersonExample |
Example of a data consent given on a subject patient’s behalf by a relative. |
| ConsentExample |
An example ManaakiNgaTahi Consent based on policies (but not involving a Questionnaire) |
| ConsentQuestionnaireResponseExample |
An example ManaakiNgaTahi QuestionnaireResponse |
| ManaakiNgaTahiConsent |
Consent FHIR resource for Manaaki Nga Tahi |
| ProvisionalConsentExample |
Example of a 3 month provisional data consent. Provisional consents are needed when an organisation creates FHIR data about a patient but has not yet officially received their consent. This can arise in real world health scenarios when the first opportunity for a patient to read and sign a consent form occurs some time after their registration with representations in FHIR. |
| Question Template for COVID-19 Privacy Statement Question |
A response to this questionnaire is used by Consent resources that enable access to other FHIR resources. |
The following artifacts define the specific capabilities that different types of systems are expected to have in order to comply with this implementation guide. Systems conforming to this implementation guide are expected to declare conformance to one or more of the following capability statements.
| Care In The Community FHIR Server Capability Statement |
The Manaaki Nga Tahi - Care In The Community FHIR API |
These define sets of codes used by systems conforming to this implementation guide.
| COVID19 vaccines recognised by NZ public health |
The COVID19 vaccine codes, as defined by NZ national immunisation register, for patient vaccination history recording purposes |
These define new code systems used by systems conforming to this implementation guide.
| Codings for COVID-19 vaccination brands recognised in New Zealand public health |
Each code represents a recognised COVID-19 vaccine |
These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.
| AllergyIntoleranceExample |
An example payload for the Manaaki Nga Tahi AllergyIntolerance resource indicating an allergy to Penicillin |
| Template for COVID-19 Care in the Community CCCM MVP Careplans |
An example ManaakiNgaTahi PlanDefinition |