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

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 Changelog
... 5 Collect Measurements
... 6 Common Messaging System
... 7 Complete Care Plan
... 8 Consent Based Access Control
... 9 Create Care Plan
... 10 Create Condition
... 11 Create Encounter
... 12 Developer Guide
... 13 Dunedin Hospital Outpatients
... 14 Extensions
... 15 Faq
... 16 Fhir Consent
... 17 Flat Data Views
... 18 Health Checks
... 19 History
... 20 In Home Observations
... 21 Initial Assesment
... 22 NDH Outpatients
... 23 Online GP
... 24 Outpatient Communication Workflow
... 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 Outpatient Communication CarePlan
.... 30.112 Outpatient Communication Task
.... 30.113 Outpatient Communication CarePlan Example
.... 30.114 Outpatient Communication Task Example
.... 30.115 OutreachServiceRequest
.... 30.116 OutreachTask
.... 30.117 OutreachServiceRequestExample
.... 30.118 OutreachTaskExample
.... 30.119 RPM Educational Content Delivery Task
.... 30.120 Template for Remote Monitoring Cardiac Rehab Care Plan
.... 30.121 Template for Remote Monitoring Heart Failure Care Plan
.... 30.122 Vital Signs Observation Service Request
.... 30.123 Remote Monitoring COPD Survey
.... 30.124 Remote Patient Monitoring Educational Content Feedback Survey/Questionnaire
.... 30.125 Group/Unit Level Educational Content Delivery Task Example
.... 30.126 Module Level Educational Content Delivery Task Example
.... 30.127 RPMCardiacRehabCarePlanExample
.... 30.128 RPMCareTeamExample
.... 30.129 RPMConsentExample
.... 30.130 RPMObservationExample
.... 30.131 RPMObservationServiceRequestExample
.... 30.132 RPMPatientOnboardingCommunicationRequest
.... 30.133 Syllabus Level Educational Content Delivery Task
.... 30.134 New Zealand Pharmacy Claim Response
.... 30.135 NZ Medication Dispense
.... 30.136 NZ Medication Request
.... 30.137 NZ Pharmacy Claim
.... 30.138 HSAAPAdjudicatedClaimResponse
.... 30.139 New Zealand Pharmacy Claim Response Example
.... 30.140 PharmacySubmittedClaim
.... 30.141 NZ SharedCare Claim
.... 30.142 NZ SharedCare Claim Response
.... 30.143 Online GP Appointment
.... 30.144 Online GP Encounter
.... 30.145 Urgent Care Encounter
.... 30.146 NZ GP Online Encounter Example
.... 30.147 NZ Telehealth Claim Example
.... 30.148 NZ Telehealth Claim Response Example
.... 30.149 Online GP Appointment Example
.... 30.150 Shared Care FHIR Server Capability Statement
.... 30.151 Observation-flat-export
.... 30.152 RunOperation
.... 30.153 Search by appointment method
.... 30.154 Remote Monitoring Feedback Survey
.... 30.155 Remote Monitoring Heart Failure Symptom Survey Questionnaire
.... 30.156 DHOCondition
.... 30.157 Attachment details
.... 30.158 Balance Owing
.... 30.159 Callback Url
.... 30.160 Campaign details
.... 30.161 CBS Pack Size
.... 30.162 CBS Subsidy
.... 30.163 Claimant Number
.... 30.164 CMS Payload Type Extension
.... 30.165 CMS Template Content Type Extension
.... 30.166 DHO Appointment method
.... 30.167 DHO Outreach vs Fixed site
.... 30.168 DHO Patient Contact Role
.... 30.169 DHO Telecom Notification Enabled
.... 30.170 DHO Telecom Validation Status
.... 30.171 Dose Flag
.... 30.172 Extended Supply Flag
.... 30.173 For sms reply
.... 30.174 Group ID
.... 30.175 HNZ Person Telecom Count Shared
.... 30.176 HNZ Person Telecom Information Source
.... 30.177 HNZ Person Telecom Invalid Indicator
.... 30.178 HNZ Person Telecom Last Contacted
.... 30.179 HNZ Person Telecom Phone Type
.... 30.180 HNZ Person Telecom Score
.... 30.181 Item Request
.... 30.182 NZePS Endorsement
.... 30.183 NZePS Funding Category
.... 30.184 NZePS Script Number Local
.... 30.185 Originating Claimant Number
.... 30.186 Patient Cohort
.... 30.187 Patient Flag
.... 30.188 Prescriber Flag
.... 30.189 Prescription Flag
.... 30.190 Send to and from communication to contact points
.... 30.191 Shared Care Accident Related
.... 30.192 Shared Care Agreement Number
.... 30.193 Shared Care Claim Trace Number
.... 30.194 Shared Care CSC holder
.... 30.195 Shared Care Diagnosis Code
.... 30.196 Shared Care Patient Copayment
.... 30.197 Shared Care Product Or Service
.... 30.198 Shared Care Registration Code
.... 30.199 Shared Care Review Outcome
.... 30.200 Status DateTime
.... 30.201 Transaction Category
.... 30.202 Wastage Quantity
.... 30.203 Adjudication Reason Codes
.... 30.204 Adjudication Value Codes
.... 30.205 Allowed outreach types for DHOLocation
.... 30.206 Allowed physical types for DHOLocation
.... 30.207 Allowed relationship types for DHOLocation
.... 30.208 Allowed Telecom Validation Statuses
.... 30.209 Australasian Triage Scale
.... 30.210 Claim Decision Codes
.... 30.211 Claim Decision Reason Codes
.... 30.212 CMS Payload Type ValueSet
.... 30.213 CMS Template Content Type ValueSet
.... 30.214 Codes for Task code
.... 30.215 COVID19 vaccines recognised by NZ public health
.... 30.216 DHO Appointment Modality ValueSet
.... 30.217 DHO Health Speciality ValueSet
.... 30.218 Diagnosis Use Codes
.... 30.219 Education Module ValueSet
.... 30.220 Information source when using the telecom information source extension
.... 30.221 NZ Appointment Reason Codes Code System
.... 30.222 NZ Claim Subtypes
.... 30.223 NZ Claim Types
.... 30.224 NZ Pharmacy Transaction Category
.... 30.225 NZ purpose of use
.... 30.226 Online GP Discharge Disposition
.... 30.227 Online GP Participant Type
.... 30.228 Outpatient Activity Status Reason
.... 30.229 Outpatient Service Codes
.... 30.230 Patient Cohort ValueSet
.... 30.231 Payment Type Codes
.... 30.232 Pharmacy Adjudication Category
.... 30.233 Provider Qualification Codes
.... 30.234 Shared Care Encounter Type Value Set
.... 30.235 Status Reason for ServiceRequest
.... 30.236 System that last updated the record
.... 30.237 Telecom phone type indicator
.... 30.238 Telecom record score indicator
.... 30.239 Valueset for Communication Delivery Status
.... 30.240 Valueset for Participation Mode
.... 30.241 ValueSet for Patient Contact Role
.... 30.242 Valueset for Template Category
.... 30.243 Adjudication Reason Code System
.... 30.244 Adjudication Value Code System
.... 30.245 Australasian Triage Scale Code System
.... 30.246 Claim Decision Code System
.... 30.247 Claim Decision Reason Code System
.... 30.248 CMS Payload Type CodeSystem
.... 30.249 CMS Template Content Type CodeSystem
.... 30.250 Codes for CommunicationStatus
.... 30.251 Codes for ServiceRequest code
.... 30.252 Codes for Telecom Phone Types
.... 30.253 Codes for Telecom Score
.... 30.254 Codes for Telecom Source Systems
.... 30.255 Codes for Template category
.... 30.256 Codings for COVID-19 vaccination brands recognised in New Zealand public health
.... 30.257 DHO Appointment Modality CodeSystem
.... 30.258 DHO CodeSystem for Patient Contact Role
.... 30.259 DHO Health Speciality Codes
.... 30.260 DHO Location Physical Type
.... 30.261 DHO Location Relationship
.... 30.262 DHOLocation Outreach Type
.... 30.263 DHOPatient Telecom Validation Status
.... 30.264 Education Module CodeSystem
.... 30.265 NZ Appointment Reason Codes Code System
.... 30.266 NZ Claim Subtype Code System
.... 30.267 NZ Pharmacy Transaction Category
.... 30.268 NZ Purpose Of Use
.... 30.269 Outpatient Activity Status Reason
.... 30.270 Outpatient Service Codes
.... 30.271 ParticipationMode
.... 30.272 Patient Cohort CodeSystem
.... 30.273 Pharmacy Adjudication Category Code System
.... 30.274 Provider Qualification Code System
.... 30.275 Status Reason for ServiceRequest
.... 30.276 AllergyIntoleranceExample
.... 30.277 BSAService
.... 30.278 Campylobacter Enterics Disease Questionnaire
.... 30.279 DHOConditionExample
.... 30.280 DHOPatientExampleGPDeceased
.... 30.281 GOFSH-GENERATED-ID-0
.... 30.282 New Zealand Pharmacy Claim Example
.... 30.283 ObservationFlatExportRequest
.... 30.284 ObservationFlatExportResponse
.... 30.285 OutpatientCommunicationRequestEmailExample
.... 30.286 RemoteMonitoringHeartFailureSymptomSurveyQuestionnaireResponse
.... 30.287 Te Whatu Ora - Southern (Example)
.... 30.288 Template for COVID-19 Care in the Community CCCM MVP Careplans
.... 30.289 Urgent Care Encounter Example