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