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

Health New Zealand Te Whatu Ora Shared Care FHIR API - Local Development build (v0.4.8) 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 Urgent Care
31 Artifacts Summary
31.1 Care In The Community ActivityDefinition Apply Operation
31.2 Care In The Community PlanDefinition Apply Operation
31.3 Care In The Community QuestionnaireResponse Extract Operation
31.4 CommunicationPerson
31.5 ManaakiNgaTahiAllergyIntolerance
31.6 ManaakiNgaTahiCarePlan
31.7 ManaakiNgaTahiCondition
31.8 ManaakiNgaTahiDocumentReference
31.9 ManaakiNgaTahiEncounter
31.10 ManaakiNgaTahiObservation
31.11 ManaakiNgaTahiPlanDefinition
31.12 ManaakiNgaTahiServiceRequest
31.13 ServiceRequestActivityDefinition
31.14 Template for COVID-19 Care in the Community CCCM MVP Careplans
31.15 Vital Signs Observation Service Request
31.16 Post-operative cataract assessment outcome
31.17 Post-operative cataract assessment outcome codes
31.18 Post-operative cataract assessment outcomes
31.19 Post-operative cataract pathway CarePlan
31.20 Adult Health Questionnaire for EBUS
31.21 AIR - Overseas, Historic, Not Done
31.22 Antiviral medication eligibility questionnaire
31.23 COVID-19 RAT Result Questionnaire
31.24 COVID19 Initial Health Assessment Questionnaire
31.25 COVID19 Public Health History Questionnaire
31.26 COVID19 Vaccination Side Effects Questionnaire
31.27 Early Warning Score
31.28 Enterics Inform Questionnaire
31.29 Epworth Sleepiness Scale
31.30 How does your cataract affect your life?
31.31 How does your condition affect your life?
31.32 Measles Daily Health Check
31.33 Mental Health Assessment Survey
31.34 MUSCULOSKELETAL HEALTH QUESTIONNAIRE (MSK-HQ)
31.35 Patient Screening Tool IPC (District)
31.36 Post Vaccine Symptom Check day 3 survey
31.37 Post Vaccine Symptom Check day 42 survey
31.38 Pregnancy Assessment Survey
31.39 Preoperative Questionnaire Day Surgery Dunedin Hospital
31.40 Private Colposcopy Did Not Attend Questionnaire
31.41 Private Colposcopy Discharge Questionnaire
31.42 Private Colposcopy Referral Summary Questionnaire
31.43 Private Colposcopy Visit Summary Questionnaire
31.44 Question Template for COVID-19 Regular Health Check
31.45 Report a Rapid Antigen Test (RAT) result
31.46 Respiratory Physiology Paediatric OSAS Screening Questionnaire
31.47 Sleep Service Questionnaire
31.48 ActiveMonitoringDay3SurveyQuestionnaireResponse
31.49 ActiveMonitoringDay42SurveyQuestionnaireResponse
31.50 AntiviralEligibilityNoQuestionnaireResponse
31.51 AntiviralEligibilityYesQuestionnaireResponse
31.52 ConsumerCOVIDRATResultQuestionnaireResponse
31.53 COVIDInitialHealthAssessmentQuestionnaireResponse
31.54 COVIDPublicHealthHistoryQuestionnaireResponseSherrylCarrion
31.55 COVIDRATResultQuestionnaireResponse
31.56 COVIDRegularHealthCheckQuestionnaireResponse
31.57 COVIDVaccinationSurveyQuestionnaireResponse
31.58 ImmsotVaccinationDataEntryQuestionnaireResponse
31.59 MeaslesHealthCheckQuestionnaireResponse
31.60 MentalHealthAssessmentSurveyQuestionnaireResponse
31.61 PregnancyAssessmentSurveyQuestionnaireResponse
31.62 CareyCarrington
31.63 ConditionExample
31.64 COVID-19 Omicron Response - Carey Carrington
31.65 DocumentReferenceExample
31.66 DrDottyMcStuffins
31.67 EncounterExample
31.68 ObservationExample
31.69 ObservationsServiceRequestExample
31.70 NIBSCommunicationPersonExample
31.71 WhaihuaCommunicationPersonExample
31.72 CMS Communication
31.73 CMS Communication Request
31.74 CMSTemplateDocumentReference
31.75 Record Of all healthcare services
31.76 EmailCommunicationRequestWithoutTemplateExample
31.77 EmailCommunicationRequestWithTemplateExample
31.78 SMSCommunicationRequestWithoutTemplateExample
31.79 SMSCommunicationRequestWithTemplateExample
31.80 EmailCommunicationExample
31.81 OutreachCommunicationExample
31.82 SMSCommunicationExample
31.83 EmailCommunicationTemplateExample
31.84 ActiveConsentExample
31.85 ConsentByQuestionnaireExample
31.86 ConsentByRelatedPersonExample
31.87 ConsentExample
31.88 ConsentQuestionnaireResponseExample
31.89 ManaakiNgaTahiConsent
31.90 ProvisionalConsentExample
31.91 Question Template for COVID-19 Privacy Statement Question
31.92 Cancel an Appointment backfill
31.93 DHO Appointment Profile
31.94 DHO Appointment Response Profile
31.95 DHO Encounter profile
31.96 DHO Encounter profile used to create an Encounter
31.97 DHO Encounter profile used to update an Encounter
31.98 DHO Location Profile
31.99 DHO Patient Profile
31.100 DHO Provenance Profile
31.101 DHO Service Request Profile
31.102 DHOCondition
31.103 Get an Appointment backfill's status
31.104 Start an Appointment backfill
31.105 An example Dunedin Hospital Outpatient Dunstan outreach clinic
31.106 An example Dunedin Hospital Outpatient Internal Clinic
31.107 An example Dunedin Hospital Outpatient outreach
31.108 An example Dunedin Hospital Outpatient patient home location
31.109 An example Dunedin Hospital Outpatient Service Request
31.110 An example Dunedin Hospital Outpatient telehealth-at-home location
31.111 An example Dunedin Hospital Outpatient telehealth-at-prison location
31.112 An example New Dunedin Hospital outpatient clinic
31.113 DHOAppointmentClinicExample
31.114 DHOAppointmentResponseExample
31.115 DHOAppointmentTelehealthDunstanExample
31.116 DHOAppointmentTelehealthExample
31.117 DHOAppointmentTelehealthPrisonExample
31.118 DHOAppointmentTelephoneExample
31.119 DHOAppointmentUnstructuredExample
31.120 DHOConditionExample
31.121 DHODrDottyMcStuffins
31.122 DHOEncounterCreateExample
31.123 DHOEncounterExample
31.124 DHOEncounterUpdateExample
31.125 DHOPatientExampleGP
31.126 DHOPatientExampleGPDeceased
31.127 DHOPatientExampleMultiplePractitioners
31.128 DHOPatientExampleNP
31.129 DHOProvenanceNhiMergeExample
31.130 External Facility Example
31.131 Outpatient Communication CarePlan
31.132 Outpatient Communication Task
31.133 Outpatient Communication CarePlan Example
31.134 Outpatient Communication Task Example
31.135 OutreachServiceRequest
31.136 OutreachTask
31.137 OutreachServiceRequestExample
31.138 OutreachTaskExample
31.139 RPM Educational Content Delivery Task
31.140 Template for Remote Monitoring Cardiac Rehab Care Plan
31.141 Template for Remote Monitoring Heart Failure Care Plan
31.142 Vital Signs Observation Service Request
31.143 Remote Monitoring COPD Survey
31.144 Remote Patient Monitoring Educational Content Feedback Survey/Questionnaire
31.145 Group/Unit Level Educational Content Delivery Task Example
31.146 Module Level Educational Content Delivery Task Example
31.147 RPMCardiacRehabCarePlanExample
31.148 RPMCareTeamExample
31.149 RPMConsentExample
31.150 RPMObservationExample
31.151 RPMObservationServiceRequestExample
31.152 RPMPatientOnboardingCommunicationRequest
31.153 Syllabus Level Educational Content Delivery Task
31.154 New Zealand Pharmacy Claim Response
31.155 NZ Medication Dispense
31.156 NZ Medication Request
31.157 NZ Pharmacy Claim
31.158 HSAAP Adjudicated Claim Response
31.159 New Zealand Pharmacy Claim Response Example
31.160 NZ Pharmacy Medication Dispense Example
31.161 NZ Pharmacy Medication Request Example
31.162 Pharmacy Submitted Claim
31.163 NZ SharedCare Claim
31.164 NZ SharedCare Claim Response
31.165 Online GP Appointment
31.166 Online GP Encounter
31.167 Urgent Care Encounter
31.168 NZ GP Online Encounter Example
31.169 NZ Telehealth Claim Example
31.170 NZ Telehealth Claim Response Example
31.171 Online GP Appointment Example
31.172 Shared Care FHIR Server Capability Statement
31.173 Observation-flat-export
31.174 RunOperation
31.175 Search by appointment method
31.176 Remote Monitoring Feedback Survey
31.177 Remote Monitoring Heart Failure Symptom Survey Questionnaire
31.178 Attachment details
31.179 Balance Owing
31.180 Callback Url
31.181 Campaign details
31.182 CBS Pack Size
31.183 CBS Subsidy
31.184 Claimant Number
31.185 Classification Extension
31.186 CMS Payload Type Extension
31.187 CMS Template Content Type Extension
31.188 DHO Appointment method
31.189 DHO Initial Patient Class
31.190 DHO Outreach vs Fixed site
31.191 DHO Patient Contact Role
31.192 DHO Telecom Notification Enabled
31.193 DHO Telecom Validation Status
31.194 Dose Flag
31.195 Extended Supply Flag
31.196 For sms reply
31.197 Group ID
31.198 HNZ Person Telecom Count Shared
31.199 HNZ Person Telecom Information Source
31.200 HNZ Person Telecom Invalid Indicator
31.201 HNZ Person Telecom Last Contacted
31.202 HNZ Person Telecom Phone Type
31.203 HNZ Person Telecom Score
31.204 Item Request
31.205 NZePS Endorsement
31.206 NZePS Funding Category
31.207 NZePS Script Number Local
31.208 Originating Claimant Number
31.209 Patient Cohort
31.210 Patient Flag
31.211 Pharmacy Claim Item Detail Product Or Service
31.212 Pharmacy Claim Item Detail Review Outcome
31.213 Prescriber Flag
31.214 Prescription Flag
31.215 PSC Flag Extension
31.216 Send to and from communication to contact points
31.217 Shared Care Accident Related
31.218 Shared Care Agreement Number
31.219 Shared Care Claim Trace Number
31.220 Shared Care CSC holder
31.221 Shared Care Diagnosis Code
31.222 Shared Care Patient Copayment
31.223 Shared Care Product Or Service
31.224 Shared Care Registration Code
31.225 Shared Care Review Outcome
31.226 Status DateTime
31.227 Transaction Category
31.228 Wastage Quantity
31.229 Adjudication Reason Codes
31.230 Adjudication Value Codes
31.231 Allowed outreach types for DHOLocation
31.232 Allowed physical types for DHOLocation
31.233 Allowed relationship types for DHOLocation
31.234 Allowed Telecom Validation Statuses
31.235 Australasian Triage Scale
31.236 Claim Decision Codes
31.237 Claim Decision Reason Codes
31.238 CMS Payload Type ValueSet
31.239 CMS Template Content Type ValueSet
31.240 Codes for Task code
31.241 COVID19 vaccines recognised by NZ public health
31.242 DHO Appointment Modality ValueSet
31.243 DHO Encounter Class
31.244 DHO Health Speciality ValueSet
31.245 Diagnosis Use Codes
31.246 Education Module ValueSet
31.247 Information source when using the telecom information source extension
31.248 NZ Appointment Reason Codes Code System
31.249 NZ Claim Subtypes
31.250 NZ Claim Types
31.251 NZ Pharmacy Claim Item Classification
31.252 NZ Pharmacy Transaction Category
31.253 NZ purpose of use
31.254 Online GP Consultation Service Type
31.255 Online GP Discharge Disposition
31.256 Online GP Participant Type
31.257 Online GP Referral Source
31.258 Outpatient Activity Status Reason
31.259 Patient Cohort ValueSet
31.260 Payment Type Codes
31.261 Pharmacy Adjudication Category
31.262 Provenance Reason Type
31.263 Provider Qualification Codes
31.264 Shared Care Encounter Type Value Set
31.265 Status Reason for ServiceRequest
31.266 System that last updated the record
31.267 Telecom phone type indicator
31.268 Telecom record score indicator
31.269 Valueset for Communication Delivery Status
31.270 Valueset for Participation Mode
31.271 ValueSet for Patient Contact Role
31.272 Valueset for Template Category
31.273 Adjudication Reason Code System
31.274 Adjudication Value Code System
31.275 Australasian Triage Scale Code System
31.276 Claim Decision Code System
31.277 Claim Decision Reason Code System
31.278 CMS Payload Type CodeSystem
31.279 CMS Template Content Type CodeSystem
31.280 Codes for CommunicationStatus
31.281 Codes for ServiceRequest code
31.282 Codes for Telecom Phone Types
31.283 Codes for Telecom Score
31.284 Codes for Telecom Source Systems
31.285 Codes for Template category
31.286 Codings for COVID-19 vaccination brands recognised in New Zealand public health
31.287 DHO Appointment Modality CodeSystem
31.288 DHO CodeSystem for Patient Contact Role
31.289 DHO Health Speciality Codes
31.290 DHO Location Physical Type
31.291 DHO Location Relationship
31.292 DHOLocation Outreach Type
31.293 DHOPatient Telecom Validation Status
31.294 Education Module CodeSystem
31.295 NZ Appointment Reason Codes Code System
31.296 NZ Claim Subtype Code System
31.297 NZ Pharmacy Claim Item Classification CodeSystem
31.298 NZ Pharmacy Transaction Category
31.299 NZ Purpose Of Use
31.300 Online GP Consultation Service Type Codes
31.301 Outpatient Activity Status Reason
31.302 ParticipationMode
31.303 Patient Cohort CodeSystem
31.304 Pharmacy Adjudication Category Code System
31.305 Provenance Reason Type
31.306 Provider Qualification Code System
31.307 Status Reason for ServiceRequest
31.308 AllergyIntoleranceExample
31.309 BSAService
31.310 GOFSH-GENERATED-ID-0
31.311 New Zealand Pharmacy Claim Example
31.312 ObservationFlatExportRequest
31.313 ObservationFlatExportResponse
31.314 OutpatientCommunicationRequestEmailExample
31.315 RemoteMonitoringHeartFailureSymptomSurveyQuestionnaireResponse
31.316 Te Whatu Ora - Southern (Example)
31.317 Template for COVID-19 Care in the Community CCCM MVP Careplans
31.318 Urgent Care Encounter Example