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

Health New Zealand Te Whatu Ora Shared Care FHIR API - Local Development build (v0.4.7) 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 Post-operative cataract assessment outcome
.... 30.17 Post-operative cataract assessment outcome codes
.... 30.18 Post-operative cataract assessment outcomes
.... 30.19 Post-operative cataract pathway CarePlan
.... 30.20 AIR - Overseas, Historic, Not Done
.... 30.21 Antiviral medication eligibility questionnaire
.... 30.22 COVID-19 RAT Result Questionnaire
.... 30.23 COVID19 Initial Health Assessment Questionnaire
.... 30.24 COVID19 Public Health History Questionnaire
.... 30.25 COVID19 Vaccination Side Effects Questionnaire
.... 30.26 Early Warning Score
.... 30.27 Enterics Inform Questionnaire
.... 30.28 Epworth Sleepiness Scale
.... 30.29 How does your cataract affect your life?
.... 30.30 How does your condition affect your life?
.... 30.31 Measles Daily Health Check
.... 30.32 Mental Health Assessment Survey
.... 30.33 MUSCULOSKELETAL HEALTH QUESTIONNAIRE (MSK-HQ)
.... 30.34 Patient Screening Tool IPC (District)
.... 30.35 Post Vaccine Symptom Check day 3 survey
.... 30.36 Post Vaccine Symptom Check day 42 survey
.... 30.37 Pregnancy Assessment Survey
.... 30.38 Preoperative Questionnaire Day Surgery Dunedin Hospital
.... 30.39 Private Colposcopy Did Not Attend Questionnaire
.... 30.40 Private Colposcopy Discharge Questionnaire
.... 30.41 Private Colposcopy Referral Summary Questionnaire
.... 30.42 Private Colposcopy Visit Summary Questionnaire
.... 30.43 Question Template for COVID-19 Regular Health Check
.... 30.44 Report a Rapid Antigen Test (RAT) result
.... 30.45 Respiratory Physiology Paediatric OSAS Screening Questionnaire
.... 30.46 Sleep Service Questionnaire
.... 30.47 ActiveMonitoringDay3SurveyQuestionnaireResponse
.... 30.48 ActiveMonitoringDay42SurveyQuestionnaireResponse
.... 30.49 AntiviralEligibilityNoQuestionnaireResponse
.... 30.50 AntiviralEligibilityYesQuestionnaireResponse
.... 30.51 ConsumerCOVIDRATResultQuestionnaireResponse
.... 30.52 COVIDInitialHealthAssessmentQuestionnaireResponse
.... 30.53 COVIDPublicHealthHistoryQuestionnaireResponseSherrylCarrion
.... 30.54 COVIDRATResultQuestionnaireResponse
.... 30.55 COVIDRegularHealthCheckQuestionnaireResponse
.... 30.56 COVIDVaccinationSurveyQuestionnaireResponse
.... 30.57 ImmsotVaccinationDataEntryQuestionnaireResponse
.... 30.58 MeaslesHealthCheckQuestionnaireResponse
.... 30.59 MentalHealthAssessmentSurveyQuestionnaireResponse
.... 30.60 PregnancyAssessmentSurveyQuestionnaireResponse
.... 30.61 CareyCarrington
.... 30.62 ConditionExample
.... 30.63 COVID-19 Omicron Response - Carey Carrington
.... 30.64 DocumentReferenceExample
.... 30.65 DrDottyMcStuffins
.... 30.66 EncounterExample
.... 30.67 ObservationExample
.... 30.68 ObservationsServiceRequestExample
.... 30.69 NIBSCommunicationPersonExample
.... 30.70 WhaihuaCommunicationPersonExample
.... 30.71 CMS Communication
.... 30.72 CMS Communication Request
.... 30.73 CMSTemplateDocumentReference
.... 30.74 Record Of all healthcare services
.... 30.75 EmailCommunicationRequestWithoutTemplateExample
.... 30.76 EmailCommunicationRequestWithTemplateExample
.... 30.77 SMSCommunicationRequestWithoutTemplateExample
.... 30.78 SMSCommunicationRequestWithTemplateExample
.... 30.79 EmailCommunicationExample
.... 30.80 OutreachCommunicationExample
.... 30.81 SMSCommunicationExample
.... 30.82 EmailCommunicationTemplateExample
.... 30.83 ActiveConsentExample
.... 30.84 ConsentByQuestionnaireExample
.... 30.85 ConsentByRelatedPersonExample
.... 30.86 ConsentExample
.... 30.87 ConsentQuestionnaireResponseExample
.... 30.88 ManaakiNgaTahiConsent
.... 30.89 ProvisionalConsentExample
.... 30.90 Question Template for COVID-19 Privacy Statement Question
.... 30.91 DHO Appointment Profile
.... 30.92 DHO Appointment Response Profile
.... 30.93 DHO Encounter profile
.... 30.94 DHO Encounter profile used to create an Encounter
.... 30.95 DHO Encounter profile used to update an Encounter
.... 30.96 DHO Location Profile
.... 30.97 DHO Patient Profile
.... 30.98 DHO Patient update profile
.... 30.99 DHO Provenance Profile
.... 30.100 DHO Service Request Profile
.... 30.101 An example Dunedin Hospital Outpatient Dunstan outreach clinic
.... 30.102 An example Dunedin Hospital Outpatient Internal Clinic
.... 30.103 An example Dunedin Hospital Outpatient outreach
.... 30.104 An example Dunedin Hospital Outpatient patient home location
.... 30.105 An example Dunedin Hospital Outpatient Service Request
.... 30.106 An example Dunedin Hospital Outpatient telehealth-at-home location
.... 30.107 An example Dunedin Hospital Outpatient telehealth-at-prison location
.... 30.108 An example New Dunedin Hospital outpatient clinic
.... 30.109 DHOAppointmentClinicExample
.... 30.110 DHOAppointmentResponseExample
.... 30.111 DHOAppointmentTelehealthDunstanExample
.... 30.112 DHOAppointmentTelehealthExample
.... 30.113 DHOAppointmentTelehealthPrisonExample
.... 30.114 DHOAppointmentTelephoneExample
.... 30.115 DHOAppointmentUnstructuredExample
.... 30.116 DHODrDottyMcStuffins
.... 30.117 DHOEncounterCreateExample
.... 30.118 DHOEncounterExample
.... 30.119 DHOEncounterUpdateExample
.... 30.120 DHOPatientExampleGP
.... 30.121 DHOPatientExampleMultiplePractitioners
.... 30.122 DHOPatientExampleNP
.... 30.123 DHOPatientUpdateExample
.... 30.124 External Facility Example
.... 30.125 Outpatient Communication CarePlan
.... 30.126 Outpatient Communication Task
.... 30.127 Outpatient Communication CarePlan Example
.... 30.128 Outpatient Communication Task Example
.... 30.129 OutreachServiceRequest
.... 30.130 OutreachTask
.... 30.131 OutreachServiceRequestExample
.... 30.132 OutreachTaskExample
.... 30.133 RPM Educational Content Delivery Task
.... 30.134 Template for Remote Monitoring Cardiac Rehab Care Plan
.... 30.135 Template for Remote Monitoring Heart Failure Care Plan
.... 30.136 Vital Signs Observation Service Request
.... 30.137 Remote Monitoring COPD Survey
.... 30.138 Remote Patient Monitoring Educational Content Feedback Survey/Questionnaire
.... 30.139 Group/Unit Level Educational Content Delivery Task Example
.... 30.140 Module Level Educational Content Delivery Task Example
.... 30.141 RPMCardiacRehabCarePlanExample
.... 30.142 RPMCareTeamExample
.... 30.143 RPMConsentExample
.... 30.144 RPMObservationExample
.... 30.145 RPMObservationServiceRequestExample
.... 30.146 RPMPatientOnboardingCommunicationRequest
.... 30.147 Syllabus Level Educational Content Delivery Task
.... 30.148 New Zealand Pharmacy Claim Response
.... 30.149 NZ Medication Dispense
.... 30.150 NZ Medication Request
.... 30.151 NZ Pharmacy Claim
.... 30.152 HSAAP Adjudicated Claim Response
.... 30.153 New Zealand Pharmacy Claim Response Example
.... 30.154 NZ Pharmacy Medication Dispense Example
.... 30.155 NZ Pharmacy Medication Request Example
.... 30.156 Pharmacy Submitted Claim
.... 30.157 NZ SharedCare Claim
.... 30.158 NZ SharedCare Claim Response
.... 30.159 Online GP Appointment
.... 30.160 Online GP Encounter
.... 30.161 Urgent Care Encounter
.... 30.162 NZ GP Online Encounter Example
.... 30.163 NZ Telehealth Claim Example
.... 30.164 NZ Telehealth Claim Response Example
.... 30.165 Online GP Appointment Example
.... 30.166 Shared Care FHIR Server Capability Statement
.... 30.167 Observation-flat-export
.... 30.168 RunOperation
.... 30.169 Search by appointment method
.... 30.170 Remote Monitoring Feedback Survey
.... 30.171 Remote Monitoring Heart Failure Symptom Survey Questionnaire
.... 30.172 DHOCondition
.... 30.173 Attachment details
.... 30.174 Balance Owing
.... 30.175 Callback Url
.... 30.176 Campaign details
.... 30.177 CBS Pack Size
.... 30.178 CBS Subsidy
.... 30.179 Claimant Number
.... 30.180 Classification Extension
.... 30.181 CMS Payload Type Extension
.... 30.182 CMS Template Content Type Extension
.... 30.183 DHO Appointment method
.... 30.184 DHO Initial Patient Class
.... 30.185 DHO Outreach vs Fixed site
.... 30.186 DHO Patient Contact Role
.... 30.187 DHO Telecom Notification Enabled
.... 30.188 DHO Telecom Validation Status
.... 30.189 Dose Flag
.... 30.190 Extended Supply Flag
.... 30.191 For sms reply
.... 30.192 Group ID
.... 30.193 HNZ Person Telecom Count Shared
.... 30.194 HNZ Person Telecom Information Source
.... 30.195 HNZ Person Telecom Invalid Indicator
.... 30.196 HNZ Person Telecom Last Contacted
.... 30.197 HNZ Person Telecom Phone Type
.... 30.198 HNZ Person Telecom Score
.... 30.199 Item Request
.... 30.200 NZePS Endorsement
.... 30.201 NZePS Funding Category
.... 30.202 NZePS Script Number Local
.... 30.203 Originating Claimant Number
.... 30.204 Patient Cohort
.... 30.205 Patient Flag
.... 30.206 Pharmacy Claim Item Detail Product Or Service
.... 30.207 Pharmacy Claim Item Detail Review Outcome
.... 30.208 Prescriber Flag
.... 30.209 Prescription Flag
.... 30.210 PSC Flag Extension
.... 30.211 Send to and from communication to contact points
.... 30.212 Shared Care Accident Related
.... 30.213 Shared Care Agreement Number
.... 30.214 Shared Care Claim Trace Number
.... 30.215 Shared Care CSC holder
.... 30.216 Shared Care Diagnosis Code
.... 30.217 Shared Care Patient Copayment
.... 30.218 Shared Care Product Or Service
.... 30.219 Shared Care Registration Code
.... 30.220 Shared Care Review Outcome
.... 30.221 Status DateTime
.... 30.222 Transaction Category
.... 30.223 Wastage Quantity
.... 30.224 Adjudication Reason Codes
.... 30.225 Adjudication Value Codes
.... 30.226 Allowed outreach types for DHOLocation
.... 30.227 Allowed physical types for DHOLocation
.... 30.228 Allowed relationship types for DHOLocation
.... 30.229 Allowed Telecom Validation Statuses
.... 30.230 Australasian Triage Scale
.... 30.231 Claim Decision Codes
.... 30.232 Claim Decision Reason Codes
.... 30.233 CMS Payload Type ValueSet
.... 30.234 CMS Template Content Type ValueSet
.... 30.235 Codes for Task code
.... 30.236 COVID19 vaccines recognised by NZ public health
.... 30.237 DHO Appointment Modality ValueSet
.... 30.238 DHO Encounter Class
.... 30.239 DHO Health Speciality ValueSet
.... 30.240 Diagnosis Use Codes
.... 30.241 Education Module ValueSet
.... 30.242 Information source when using the telecom information source extension
.... 30.243 NZ Appointment Reason Codes Code System
.... 30.244 NZ Claim Subtypes
.... 30.245 NZ Claim Types
.... 30.246 NZ Pharmacy Claim Item Classification
.... 30.247 NZ Pharmacy Transaction Category
.... 30.248 NZ purpose of use
.... 30.249 Online GP Consultation Service Type
.... 30.250 Online GP Discharge Disposition
.... 30.251 Online GP Participant Type
.... 30.252 Online GP Referral Source
.... 30.253 Outpatient Activity Status Reason
.... 30.254 Patient Cohort ValueSet
.... 30.255 Payment Type Codes
.... 30.256 Pharmacy Adjudication Category
.... 30.257 Provenance Reason Type
.... 30.258 Provider Qualification Codes
.... 30.259 Shared Care Encounter Type Value Set
.... 30.260 Status Reason for ServiceRequest
.... 30.261 System that last updated the record
.... 30.262 Telecom phone type indicator
.... 30.263 Telecom record score indicator
.... 30.264 Valueset for Communication Delivery Status
.... 30.265 Valueset for Participation Mode
.... 30.266 ValueSet for Patient Contact Role
.... 30.267 Valueset for Template Category
.... 30.268 Adjudication Reason Code System
.... 30.269 Adjudication Value Code System
.... 30.270 Australasian Triage Scale Code System
.... 30.271 Claim Decision Code System
.... 30.272 Claim Decision Reason Code System
.... 30.273 CMS Payload Type CodeSystem
.... 30.274 CMS Template Content Type CodeSystem
.... 30.275 Codes for CommunicationStatus
.... 30.276 Codes for ServiceRequest code
.... 30.277 Codes for Telecom Phone Types
.... 30.278 Codes for Telecom Score
.... 30.279 Codes for Telecom Source Systems
.... 30.280 Codes for Template category
.... 30.281 Codings for COVID-19 vaccination brands recognised in New Zealand public health
.... 30.282 DHO Appointment Modality CodeSystem
.... 30.283 DHO CodeSystem for Patient Contact Role
.... 30.284 DHO Health Speciality Codes
.... 30.285 DHO Location Physical Type
.... 30.286 DHO Location Relationship
.... 30.287 DHOLocation Outreach Type
.... 30.288 DHOPatient Telecom Validation Status
.... 30.289 Education Module CodeSystem
.... 30.290 NZ Appointment Reason Codes Code System
.... 30.291 NZ Claim Subtype Code System
.... 30.292 NZ Pharmacy Claim Item Classification CodeSystem
.... 30.293 NZ Pharmacy Transaction Category
.... 30.294 NZ Purpose Of Use
.... 30.295 Online GP Consultation Service Type Codes
.... 30.296 Outpatient Activity Status Reason
.... 30.297 ParticipationMode
.... 30.298 Patient Cohort CodeSystem
.... 30.299 Pharmacy Adjudication Category Code System
.... 30.300 Provenance Reason Type
.... 30.301 Provider Qualification Code System
.... 30.302 Status Reason for ServiceRequest
.... 30.303 AllergyIntoleranceExample
.... 30.304 BSAService
.... 30.305 DHOConditionExample
.... 30.306 DHOPatientExampleGPDeceased
.... 30.307 DHOProvenanceNhiMergeExample
.... 30.308 GOFSH-GENERATED-ID-0
.... 30.309 New Zealand Pharmacy Claim Example
.... 30.310 ObservationFlatExportRequest
.... 30.311 ObservationFlatExportResponse
.... 30.312 OutpatientCommunicationRequestEmailExample
.... 30.313 RemoteMonitoringHeartFailureSymptomSurveyQuestionnaireResponse
.... 30.314 Te Whatu Ora - Southern (Example)
.... 30.315 Template for COVID-19 Care in the Community CCCM MVP Careplans
.... 30.316 Urgent Care Encounter Example