Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.5 - release NZ

Health New Zealand Te Whatu Ora Shared Care FHIR API - Local Development build (v0.4.5) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Table of Contents

.. 0 Table of Contents
... 1 Home
... 2 Business Context
... 3 Capability Statement
... 4 Careplan Workflow
... 5 Changelog
... 6 Collect Measurements
... 7 Common Messaging System
... 8 Complete Care Plan
... 9 Consent Based Access Control
... 10 Create Care Plan
... 11 Create Condition
... 12 Create Encounter
... 13 Developer Guide
... 14 Dunedin Hospital Outpatients
... 15 Extensions
... 16 Faq
... 17 Fhir Consent
... 18 Flat Data Views
... 19 Health Checks
... 20 History
... 21 In Home Observations
... 22 Initial Assesment
... 23 NDH Outpatients
... 24 Online GP
... 25 Outreach Referrals
... 26 Outreach Use Cases
... 27 Pharmacy Claiming
... 28 Remote Patient Monitoring
... 29 Roadmap
... 30 Artifacts Summary
.... 30.1 Care In The Community ActivityDefinition Apply Operation
.... 30.2 Care In The Community PlanDefinition Apply Operation
.... 30.3 Care In The Community QuestionnaireResponse Extract Operation
.... 30.4 CommunicationPerson
.... 30.5 ManaakiNgaTahiAllergyIntolerance
.... 30.6 ManaakiNgaTahiCarePlan
.... 30.7 ManaakiNgaTahiCondition
.... 30.8 ManaakiNgaTahiDocumentReference
.... 30.9 ManaakiNgaTahiEncounter
.... 30.10 ManaakiNgaTahiObservation
.... 30.11 ManaakiNgaTahiPlanDefinition
.... 30.12 ManaakiNgaTahiServiceRequest
.... 30.13 ServiceRequestActivityDefinition
.... 30.14 Template for COVID-19 Care in the Community CCCM MVP Careplans
.... 30.15 Vital Signs Observation Service Request
.... 30.16 AIR - Overseas, Historic, Not Done
.... 30.17 Antiviral medication eligibility questionnaire
.... 30.18 COVID-19 RAT Result Questionnaire
.... 30.19 COVID19 Initial Health Assessment Questionnaire
.... 30.20 COVID19 Public Health History Questionnaire
.... 30.21 COVID19 Vaccination Side Effects Questionnaire
.... 30.22 Early Warning Score
.... 30.23 Epworth Sleepiness Scale - Diagnostic Testing
.... 30.24 How does your cataract affect your life?
.... 30.25 How does your condition affect your life?
.... 30.26 Measles Daily Health Check
.... 30.27 Mental Health Assessment Survey
.... 30.28 MUSCULOSKELETAL HEALTH QUESTIONNAIRE (MSK-HQ)
.... 30.29 Patient Screening Tool IPC (District)
.... 30.30 Post Vaccine Symptom Check day 3 survey
.... 30.31 Post Vaccine Symptom Check day 42 survey
.... 30.32 Pregnancy Assessment Survey
.... 30.33 Preoperative Questionnaire Day Surgery Dunedin Hospital
.... 30.34 Private Colposcopy Did Not Attend Questionnaire
.... 30.35 Private Colposcopy Discharge Questionnaire
.... 30.36 Private Colposcopy Referral Summary Questionnaire
.... 30.37 Private Colposcopy Visit Summary Questionnaire
.... 30.38 Question Template for COVID-19 Regular Health Check
.... 30.39 Report a Rapid Antigen Test (RAT) result
.... 30.40 Respiratory Physiology Paediatric OSAS Screening Questionnaire
.... 30.41 Sleep Service Questionnaire
.... 30.42 ActiveMonitoringDay3SurveyQuestionnaireResponse
.... 30.43 ActiveMonitoringDay42SurveyQuestionnaireResponse
.... 30.44 AntiviralEligibilityNoQuestionnaireResponse
.... 30.45 AntiviralEligibilityYesQuestionnaireResponse
.... 30.46 ConsumerCOVIDRATResultQuestionnaireResponse
.... 30.47 COVIDInitialHealthAssessmentQuestionnaireResponse
.... 30.48 COVIDPublicHealthHistoryQuestionnaireResponseSherrylCarrion
.... 30.49 COVIDRATResultQuestionnaireResponse
.... 30.50 COVIDRegularHealthCheckQuestionnaireResponse
.... 30.51 COVIDVaccinationSurveyQuestionnaireResponse
.... 30.52 ImmsotVaccinationDataEntryQuestionnaireResponse
.... 30.53 MeaslesHealthCheckQuestionnaireResponse
.... 30.54 MentalHealthAssessmentSurveyQuestionnaireResponse
.... 30.55 PregnancyAssessmentSurveyQuestionnaireResponse
.... 30.56 CareyCarrington
.... 30.57 ConditionExample
.... 30.58 COVID-19 Omicron Response - Carey Carrington
.... 30.59 DocumentReferenceExample
.... 30.60 DrDottyMcStuffins
.... 30.61 EncounterExample
.... 30.62 ObservationExample
.... 30.63 ObservationsServiceRequestExample
.... 30.64 NIBSCommunicationPersonExample
.... 30.65 WhaihuaCommunicationPersonExample
.... 30.66 CMS Communication
.... 30.67 CMS Communication Request
.... 30.68 CMSTemplateDocumentReference
.... 30.69 Record Of all healthcare services
.... 30.70 EmailCommunicationRequestWithoutTemplateExample
.... 30.71 EmailCommunicationRequestWithTemplateExample
.... 30.72 SMSCommunicationRequestWithoutTemplateExample
.... 30.73 SMSCommunicationRequestWithTemplateExample
.... 30.74 EmailCommunicationExample
.... 30.75 OutreachCommunicationExample
.... 30.76 SMSCommunicationExample
.... 30.77 EmailCommunicationTemplateExample
.... 30.78 ActiveConsentExample
.... 30.79 ConsentByQuestionnaireExample
.... 30.80 ConsentByRelatedPersonExample
.... 30.81 ConsentExample
.... 30.82 ConsentQuestionnaireResponseExample
.... 30.83 ManaakiNgaTahiConsent
.... 30.84 ProvisionalConsentExample
.... 30.85 Question Template for COVID-19 Privacy Statement Question
.... 30.86 DHO Appointment Profile
.... 30.87 DHO Appointment Response Profile
.... 30.88 DHO Encounter profile
.... 30.89 DHO Encounter profile used to create an Encounter
.... 30.90 DHO Encounter profile used to update an Encounter
.... 30.91 DHO Location Profile
.... 30.92 DHO Patient Profile
.... 30.93 DHO Patient update profile
.... 30.94 An example Dunedin Hospital Outpatient Internal Clinic
.... 30.95 An example Dunedin Hospital Outpatient outreach
.... 30.96 An example Dunedin Hospital Outpatient patient home location
.... 30.97 DHOAppointmentClinicExample
.... 30.98 DHOAppointmentResponseExample
.... 30.99 DHOAppointmentTelehealthExample
.... 30.100 DHOAppointmentTelephoneExample
.... 30.101 DHOAppointmentUnstructuredExample
.... 30.102 DHODrDottyMcStuffins
.... 30.103 DHOEncounterCreateExample
.... 30.104 DHOEncounterExample
.... 30.105 DHOEncounterUpdateExample
.... 30.106 DHOPatientExampleGP
.... 30.107 DHOPatientExampleMultiplePractitioners
.... 30.108 DHOPatientExampleNP
.... 30.109 DHOPatientUpdateExample
.... 30.110 External Facility Example
.... 30.111 OutreachServiceRequest
.... 30.112 OutreachTask
.... 30.113 OutreachServiceRequestExample
.... 30.114 OutreachTaskExample
.... 30.115 RPM Educational Content Delivery Task
.... 30.116 Template for Remote Monitoring Cardiac Rehab Care Plan
.... 30.117 Template for Remote Monitoring Heart Failure Care Plan
.... 30.118 Vital Signs Observation Service Request
.... 30.119 Remote Monitoring COPD Survey
.... 30.120 Remote Patient Monitoring Educational Content Feedback Survey/Questionnaire
.... 30.121 Group/Unit Level Educational Content Delivery Task Example
.... 30.122 Module Level Educational Content Delivery Task Example
.... 30.123 RPMCardiacRehabCarePlanExample
.... 30.124 RPMCareTeamExample
.... 30.125 RPMConsentExample
.... 30.126 RPMObservationExample
.... 30.127 RPMObservationServiceRequestExample
.... 30.128 RPMPatientOnboardingCommunicationRequest
.... 30.129 Syllabus Level Educational Content Delivery Task
.... 30.130 New Zealand Pharmacy Claim Response
.... 30.131 NZ Medication Dispense
.... 30.132 NZ Medication Request
.... 30.133 NZ Pharmacy Claim
.... 30.134 HSAAPAdjudicatedClaimResponse
.... 30.135 New Zealand Pharmacy Claim Response Example
.... 30.136 PharmacySubmittedClaim
.... 30.137 NZ SharedCare Claim
.... 30.138 NZ SharedCare Claim Response
.... 30.139 Online GP Appointment
.... 30.140 Online GP Encounter
.... 30.141 Urgent Care Encounter
.... 30.142 NZ GP Online Encounter Example
.... 30.143 NZ Telehealth Claim Example
.... 30.144 NZ Telehealth Claim Response Example
.... 30.145 Online GP Appointment Example
.... 30.146 Shared Care FHIR Server Capability Statement
.... 30.147 Observation-flat-export
.... 30.148 RunOperation
.... 30.149 Search by appointment method
.... 30.150 Remote Monitoring Feedback Survey
.... 30.151 Remote Monitoring Heart Failure Symptom Survey Questionnaire
.... 30.152 DHOCondition
.... 30.153 Outpatient Communication Care Plan
.... 30.154 Outpatient Communication Task
.... 30.155 Attachment details
.... 30.156 Balance Owing
.... 30.157 Callback Url
.... 30.158 Campaign details
.... 30.159 CBS Pack Size
.... 30.160 CBS Subsidy
.... 30.161 Claimant Number
.... 30.162 CMS Payload Type Extension
.... 30.163 CMS Template Content Type Extension
.... 30.164 DHO Appointment method
.... 30.165 DHO Outreach vs Fixed site
.... 30.166 DHO Patient Contact Role
.... 30.167 DHO Telecom Notification Enabled
.... 30.168 Dose Flag
.... 30.169 For sms reply
.... 30.170 Group ID
.... 30.171 HNZ Person Telecom Count Shared
.... 30.172 HNZ Person Telecom Information Source
.... 30.173 HNZ Person Telecom Invalid Indicator
.... 30.174 HNZ Person Telecom Last Contacted
.... 30.175 HNZ Person Telecom Phone Type
.... 30.176 HNZ Person Telecom Score
.... 30.177 NZePS Endorsement
.... 30.178 NZePS Funding Category
.... 30.179 NZePS Script Number Local
.... 30.180 Originating Claimant Number
.... 30.181 Patient Cohort
.... 30.182 Patient Flag
.... 30.183 Prescriber Flag
.... 30.184 Prescription Flag
.... 30.185 Send to and from communication to contact points
.... 30.186 Shared Care Accident Related
.... 30.187 Shared Care Agreement Number
.... 30.188 Shared Care Claim Trace Number
.... 30.189 Shared Care CSC holder
.... 30.190 Shared Care Diagnosis Code
.... 30.191 Shared Care Patient Copayment
.... 30.192 Shared Care Product Or Service
.... 30.193 Shared Care Registration Code
.... 30.194 Shared Care Review Outcome
.... 30.195 Status DateTime
.... 30.196 Wastage Quantity
.... 30.197 Adjudication Reason Codes
.... 30.198 Adjudication Value Codes
.... 30.199 Allowed outreach types for DHOLocation
.... 30.200 Allowed physical types for DHOLocation
.... 30.201 Allowed relationship types for DHOLocation
.... 30.202 Australasian Triage Scale
.... 30.203 Claim Decision Codes
.... 30.204 Claim Decision Reason Codes
.... 30.205 CMS Payload Type ValueSet
.... 30.206 CMS Template Content Type ValueSet
.... 30.207 Codes for Task code
.... 30.208 COVID19 vaccines recognised by NZ public health
.... 30.209 DHO Appointment Modality ValueSet
.... 30.210 DHO Health Speciality ValueSet
.... 30.211 Diagnosis Use Codes
.... 30.212 Education Module ValueSet
.... 30.213 Information source when using the telecom information source extension
.... 30.214 NZ Appointment Reason Codes Code System
.... 30.215 NZ Claim Subtypes
.... 30.216 NZ Claim Types
.... 30.217 NZ purpose of use
.... 30.218 Online GP Discharge Disposition
.... 30.219 Online GP Participant Type
.... 30.220 Patient Cohort ValueSet
.... 30.221 Payment Type Codes
.... 30.222 Pharmacy Adjudication Category
.... 30.223 Provider Qualification Codes
.... 30.224 Shared Care Activity Status Reason
.... 30.225 Shared Care Encounter Type Value Set
.... 30.226 Status Reason for ServiceRequest
.... 30.227 System that last updated the record
.... 30.228 Telecom phone type indicator
.... 30.229 Telecom record score indicator
.... 30.230 Valueset for Communication Delivery Status
.... 30.231 Valueset for Participation Mode
.... 30.232 ValueSet for Patient Contact Role
.... 30.233 Valueset for Template Category
.... 30.234 Adjudication Reason Code System
.... 30.235 Adjudication Value Code System
.... 30.236 Australasian Triage Scale Code System
.... 30.237 Claim Decision Code System
.... 30.238 Claim Decision Reason Code System
.... 30.239 CMS Payload Type CodeSystem
.... 30.240 CMS Template Content Type CodeSystem
.... 30.241 Codes for CommunicationStatus
.... 30.242 Codes for ServiceRequest code
.... 30.243 Codes for Telecom Phone Types
.... 30.244 Codes for Telecom Score
.... 30.245 Codes for Telecom Source Systems
.... 30.246 Codes for Template category
.... 30.247 Codings for COVID-19 vaccination brands recognised in New Zealand public health
.... 30.248 DHO Appointment Modality CodeSystem
.... 30.249 DHO CodeSystem for Patient Contact Role
.... 30.250 DHO Health Speciality Codes
.... 30.251 DHO Location Physical Type
.... 30.252 DHO Location Relationship
.... 30.253 DHOLocation Outreach Type
.... 30.254 Education Module CodeSystem
.... 30.255 NZ Appointment Reason Codes Code System
.... 30.256 NZ Claim Subtype Code System
.... 30.257 NZ Purpose Of Use
.... 30.258 ParticipationMode
.... 30.259 Patient Cohort CodeSystem
.... 30.260 Pharmacy Adjudication Category Code System
.... 30.261 Provider Qualification Code System
.... 30.262 Shared Care Activity Status Reason
.... 30.263 Status Reason for ServiceRequest
.... 30.264 AllergyIntoleranceExample
.... 30.265 BSAService
.... 30.266 DHOConditionExample
.... 30.267 GOFSH-GENERATED-ID-0
.... 30.268 New Zealand Pharmacy Claim Example
.... 30.269 ObservationFlatExportRequest
.... 30.270 ObservationFlatExportResponse
.... 30.271 Outpatient Communication CarePlan Example
.... 30.272 Outpatient Communication Task Example
.... 30.273 RemoteMonitoringHeartFailureSymptomSurveyQuestionnaireResponse
.... 30.274 Te Whatu Ora - Southern (Example)
.... 30.275 Template for COVID-19 Care in the Community CCCM MVP Careplans
.... 30.276 Urgent Care Encounter Example