Te Whatu Ora Shared Care FHIR API
0.3.9 - release
Te Whatu Ora Shared Care FHIR API - Local Development build (v0.3.9) built by the FHIR (HL7® FHIR® Standard) Build Tools. 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 |
All Questionnaires used for Care in the Community
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 |
FHIR profiles, extensions and canonical Questionnaires
Certainty of rheumatic fever diagnosis |
Certainty of rheumatic fever diagnosis |
Codifies role taken by a whanau member of patient's care team |
Codifies role this whanau member plays in a patient’s care team |
Date of assessment of rheumatic heart disease severity |
This tracks the date of assessment of rheumatic heart disease severity because Condition.recordedDate is being used for date of diagnosis. |
Denotes if the member is to be used a primary contact |
Set to true if this whanau member acts as a primary contact for the patient |
Frequency of rheumatic fever medication |
Frequency of rheumatic fever medication to be set when medication is planned for an RF patient |
Medications and Follow-up Guidance Questionnaire |
Gathers information in secondary prophylaxis planning which guides subsequent medication appointments and follow-up |
Patient & whanau goals and preferences questionnaire |
Gathers patient and whanau preferences and goals for rheumatic fever care |
Reason a rheumatic fever care plan was closed (#revoked status) |
Captures why a rheumatic fever patient was removed from the register by completion of their care plan. |
Reason rheumatic fever care plan changed to on-hold status |
Captures why a rheumatic fever patient care has been placed on hold. |
Relationship of whanau member to patient in care team |
In patient care teams, codifies this whanau member’s relationship to the patient |
Rheumatic Fever Care Team |
Identifies parties involved in secondary prophylaxis (preventative treatment) for a patient. Members typically comprise rheumatic fever service Organizations and Practitioners especially nurses |
Rheumatic Fever CarePlan |
Profiles shared care plans used in NZ for management of rheumatic fever cases with suspected acute rheumatic fever |
Rheumatic Fever Condition |
This profile contains diagnosis code and adds rheumatic heart disease severity and diagnosis certainty extensions to the base NzCondition resource. |
Rheumatic Fever Medication Request |
Describes medication planned for a rheumatic fever patient over a period of time. Referenced as an activity in rheumatic fever care plans. Includes an extension defining the medication frequency which determines the scheduling intervals for Appointments. |
Rheumatic Fever Patient |
NzPatient-based FHIR resource for representing rheumatic fever patients |
Secondary Prophylaxis Health Assessment Questionnaire |
Gathers information about patient health at a secondary prophylaxis medication appointment |
Secondary prophylaxis medication allergy questionnaire |
Describes any known patient allergies to medications used in rheumatic fever secondary prophylaxis |
Severity of rheumatic heart disease |
Severity of rheumatic heart disease determines the severity of a patient’s rheumatic fever condition. |
All rheumatic fever example FHIR instances
Active care plan with medication planned and appointments booked for Madeleine Meringue |
Example of an RF care plan with secondary prophylaxis medication planned and two appointments booked. |
Basic care plan representing only the registration of Madeleine Meringue |
Example of the most basic RF care plan: not fully setup and indicates only that a patient registered with RF service. |
Care plan closed with only one appointment completed |
Example of an RF care plan that has gone on-hold, after the first secondary prophylaxis appointment has been attended. |
Care plan underway for Madeleine Meringue with one appointment completed |
Example of an RF care plan after the first secondary prophylaxis appointment has been attended. |
Care plan went on hold after first appointment completed |
Example of an RF care plan that has gone on-hold, after the first secondary prophylaxis appointment has been attended. |
Draft care plan for Madeleine Meringue (no secondary prevention planned) |
Example of an RF care plan where setup is complete but no secondary prevention activities yet planned. |
Encounter-SecondaryProphylaxisAppointment |
Example of a rheumatic fever patient/lead provider encounter for delivery of secondary prophylaxis meds |
LeadProvidersGroup |
Group which includes all the lead providers of rheumatic fever care in the national team |
MadeleineMeringue |
Example of a teenager patient who is NZ European ethnicity but speaks tagalog |
MadeleineMeringueAndWhanau |
Example of a teenager patient with whanau members defined as patient contacts |
MedicationsAndFollowUpGuidanceQuestionnaireResponse |
Example payload demonstrating guidance defined for secondary prophylaxis patient medication and follow-up. |
MedicationStatement-August |
Illustrates details of secondary prophylaxis medication given to a patient at an appointment |
PaniaPunga |
An example rheumatic fever patient who is Māori ethnicity and speaks Māori |
PatientMedicationAllergyQuestionnaireResponse |
Example payload demonstrating data collected about a patient’s allergies to RF medication. |
PatientWhanauGoalsPreferencesQuestionnaireResponse |
Example payload demonstrating patient/whanau expressed preferences and goals for rheumatic fever care. |
PlannedMedicationRequestExample |
Illustrates a request for active secondary prophylaxis medication that can appear in a rheumatic rever care plan |
RFPatientHealthAssessmentQuestionnaireResponse |
Example assessment of Madeleine’s health at her August secondary prophylaxis appointment. |
SecondaryProphylaxisAppointment-August-Booked |
Example of a booked patient appointment for rheumatic fever secondary prophylaxis treatment (injection) |
SecondaryProphylaxisAppointment-August-Fulfilled |
Example of a fulfilled (completed) patient appointment for rheumatic fever secondary prophylaxis treatment (injection) |
SecondaryProphylaxisAppointment-September-Booked |
Example of a booked patient appointment for rheumatic fever secondary prophylaxis treatment (injection) |
SecondaryProphylaxisAugustEncounterBundle |
Example of a Bundled POST which creates instances of Encounter, MedicationStatement and QuestionnaireResponse in one operation |
SecondaryProphylaxisCareTeam |
Example of secondary prophylaxis care team membership |
SecondaryProphylaxisMedicationExample |
Example of medication used in rheumatic fever secondary prophylaxis (prevention) as NZMT terminology |
SevereRfConditionExample |
An example of a rheumatic fever Condition |
TeTaiTokerauRFSecondaryPreventionService |
Identifies the Te Tai Tokerau rheumatic fever secondary prevention provider organization |
WaikatoRFSecondaryPreventionService |
Identifies the Waikato rheumatic fever secondary prevention provider organization |
All rheumatic fever ValueSets and CodeSystems
Codes for certainty of diagnosis of rheumatic fever condition |
This code system defines the codes that classify confidence level in diagnosis of a patient’s rheumatic fever condition |
Codes for certainty of rheumatic fever diagnosis |
This value set defines the codes that represent the certainty of a diagnosis of rheumatic fever in a patient. |
Codes for differentiating types of external identifiers held in FHIR resource Identifiers |
Identifier type codes for differentiating types of external identifiers held in FHIR resource Identifiers |
Codes for rheumatic fever condition as diagnosed at patient registration |
This value set defines the codes that represent the possible diagnoses of a patient with rheumatic fever condition at time of registration |
External identifier type codes |
This value set defines the codes that differentiate types of external identifiers held in FHIR resource Identifiers |
Generic QuestionnaireResponse yes/no question answer codes |
This value set defines valid answer codes for a yes/no-type questions where it’s important to be able to record an unknown or data not available response |
Rheumatic fever care plan category codes |
This value set defines a single code for use as a canonical category for NZ rheumatic fever FHIR care plans |
Rheumatic fever care team category codes |
This value set includes category codes for the type of care team assigned to care for a rheumatic fever patient |
Rheumatic fever medication allergy codes |
This value set includes codes for the RF secondary prophylaxis medications / substances a patient has an allergic reaction to |
Rheumatic fever patient care team participant role codes |
This value set includes codes for the roles participants can perform in a rheumatic fever patient care team |
Rheumatic fever planned medication frequency codes |
This value set defines codes for standard frequencies of secondary prophylaxis medication planning (that is, appointment intervals) |
Rheumatic heart disease severity codes |
This value set defines codes for the severity of rheumatic heart disease which determines the severity of a patient’s rheumatic fever condition |
FHIR resource profile and definitional resources relating to patient data consent
ManaakiNgaTahiConsent |
Consent FHIR resource for Manaaki Nga Tahi |
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. |
All example Consent FHIR instances
ConsentByQuestionnaireExample |
An example ManaakiNgaTahi Consent by policy |
ConsentByRelatedPersonExample |
Example of a patient consent given on a patient’s behalf by a relative, recorded by the Te Tai Tokerau Rheumatic Fever Service. On-behalf consent can arises in rheumatic fever scenarios where patients are commonly children/teenagers. This example shows how to identify the relative using a contained instance of
a |
ConsentExample |
An example ManaakiNgaTahi Consent based on policies (but not involving a Questionnaire) |
ConsentQuestionnaireResponseExample |
An example ManaakiNgaTahi QuestionnaireResponse |
ProposedConsentBaseExample |
Example of a provisional consent created for Te Tai Tokerau Rheumatic Fever Service. These types of Consent are a provisional arrangement by which a lead provider org. – Te Tai Tokerau in this case – can store and access patient data in FHIR before the patient’s consent has actually been obtained and recorded as a FHIR #active Consent instance. This base example is before any See ProposedConsentCoverageExample for an example with resources proected by data.references |
ProposedConsentCoverageExample |
Example of a provisional consent created for Te Tai Tokerau Rheumatic Fever Service. Provisional consents are an arrangement by which a lead provider org. – Te Tai Tokerau in this case – can store and access patient data in FHIR before the patient’s consent has actually been obtained and recorded as a FHIR #active Consent instance. This example includes sample |
RheumaticFeverActiveConsentExample |
Example of an active patient consent as recorded by the Te Tai Tokerau Rheumatic Fever Service. This example includes sample |
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 |