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 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 Outreach Referrals
... 25 Outreach Use Cases
... 26 Remote Patient Monitoring
... 27 Roadmap
... 28 Artifacts Summary
.... 28.1 Care In The Community ActivityDefinition Apply Operation
.... 28.2 Care In The Community PlanDefinition Apply Operation
.... 28.3 Care In The Community QuestionnaireResponse Extract Operation
.... 28.4 CommunicationPerson
.... 28.5 ManaakiNgaTahiAllergyIntolerance
.... 28.6 ManaakiNgaTahiCarePlan
.... 28.7 ManaakiNgaTahiCondition
.... 28.8 ManaakiNgaTahiDocumentReference
.... 28.9 ManaakiNgaTahiEncounter
.... 28.10 ManaakiNgaTahiObservation
.... 28.11 ManaakiNgaTahiPlanDefinition
.... 28.12 ManaakiNgaTahiServiceRequest
.... 28.13 ServiceRequestActivityDefinition
.... 28.14 Template for COVID-19 Care in the Community CCCM MVP Careplans
.... 28.15 Vital Signs Observation Service Request
.... 28.16 AIR - Overseas, Historic, Not Done
.... 28.17 Antiviral medication eligibility questionnaire
.... 28.18 COVID-19 RAT Result Questionnaire
.... 28.19 COVID19 Initial Health Assessment Questionnaire
.... 28.20 COVID19 Public Health History Questionnaire
.... 28.21 COVID19 Vaccination Side Effects Questionnaire
.... 28.22 Early Warning Score
.... 28.23 Epworth Sleepiness Scale - Diagnostic Testing
.... 28.24 How does your cataract affect your life?
.... 28.25 How does your condition affect your life?
.... 28.26 Measles Daily Health Check
.... 28.27 Mental Health Assessment Survey
.... 28.28 Patient Screening Tool IPC (District)
.... 28.29 Post Vaccine Symptom Check day 3 survey
.... 28.30 Post Vaccine Symptom Check day 42 survey
.... 28.31 Pregnancy Assessment Survey
.... 28.32 Preoperative Questionnaire Day Surgery Dunedin Hospital
.... 28.33 Private Colposcopy Did Not Attend Questionnaire
.... 28.34 Private Colposcopy Discharge Questionnaire
.... 28.35 Private Colposcopy Referral Summary Questionnaire
.... 28.36 Private Colposcopy Visit Summary Questionnaire
.... 28.37 Question Template for COVID-19 Regular Health Check
.... 28.38 Report a Rapid Antigen Test (RAT) result
.... 28.39 Respiratory Physiology Paediatric OSAS Screening Questionnaire
.... 28.40 Sleep Questionnaire
.... 28.41 ActiveMonitoringDay3SurveyQuestionnaireResponse
.... 28.42 ActiveMonitoringDay42SurveyQuestionnaireResponse
.... 28.43 AntiviralEligibilityNoQuestionnaireResponse
.... 28.44 AntiviralEligibilityYesQuestionnaireResponse
.... 28.45 ConsumerCOVIDRATResultQuestionnaireResponse
.... 28.46 COVIDInitialHealthAssessmentQuestionnaireResponse
.... 28.47 COVIDPublicHealthHistoryQuestionnaireResponseSherrylCarrion
.... 28.48 COVIDRATResultQuestionnaireResponse
.... 28.49 COVIDRegularHealthCheckQuestionnaireResponse
.... 28.50 COVIDVaccinationSurveyQuestionnaireResponse
.... 28.51 ImmsotVaccinationDataEntryQuestionnaireResponse
.... 28.52 MeaslesHealthCheckQuestionnaireResponse
.... 28.53 MentalHealthAssessmentSurveyQuestionnaireResponse
.... 28.54 PregnancyAssessmentSurveyQuestionnaireResponse
.... 28.55 CareyCarrington
.... 28.56 ConditionExample
.... 28.57 COVID-19 Omicron Response - Carey Carrington
.... 28.58 DocumentReferenceExample
.... 28.59 DrDottyMcStuffins
.... 28.60 EncounterExample
.... 28.61 ObservationExample
.... 28.62 ObservationsServiceRequestExample
.... 28.63 NIBSCommunicationPersonExample
.... 28.64 WhaihuaCommunicationPersonExample
.... 28.65 CMS Communication
.... 28.66 CMS Communication Request
.... 28.67 CMSTemplateDocumentReference
.... 28.68 Record Of all healthcare services
.... 28.69 EmailCommunicationRequestWithoutTemplateExample
.... 28.70 EmailCommunicationRequestWithTemplateExample
.... 28.71 SMSCommunicationRequestWithoutTemplateExample
.... 28.72 SMSCommunicationRequestWithTemplateExample
.... 28.73 EmailCommunicationExample
.... 28.74 OutreachCommunicationExample
.... 28.75 SMSCommunicationExample
.... 28.76 EmailCommunicationTemplateExample
.... 28.77 ActiveConsentExample
.... 28.78 ConsentByQuestionnaireExample
.... 28.79 ConsentByRelatedPersonExample
.... 28.80 ConsentExample
.... 28.81 ConsentQuestionnaireResponseExample
.... 28.82 ManaakiNgaTahiConsent
.... 28.83 ProvisionalConsentExample
.... 28.84 Question Template for COVID-19 Privacy Statement Question
.... 28.85 DHO Appointment Profile
.... 28.86 DHO Appointment Response Profile
.... 28.87 DHO Encounter profile
.... 28.88 DHO Encounter profile used to create an Encounter
.... 28.89 DHO Encounter profile used to update an Encounter
.... 28.90 DHO Location Profile
.... 28.91 DHO Patient Profile
.... 28.92 DHO Patient update profile
.... 28.93 An example Dunedin Hospital Outpatient Internal Clinic
.... 28.94 An example Dunedin Hospital Outpatient outreach
.... 28.95 An example Dunedin Hospital Outpatient patient home location
.... 28.96 DHOAppointmentClinicExample
.... 28.97 DHOAppointmentResponseExample
.... 28.98 DHOAppointmentTelehealthExample
.... 28.99 DHOAppointmentTelephoneExample
.... 28.100 DHOAppointmentUnstructuredExample
.... 28.101 DHODrDottyMcStuffins
.... 28.102 DHOEncounterCreateExample
.... 28.103 DHOEncounterExample
.... 28.104 DHOEncounterUpdateExample
.... 28.105 DHOPatientExampleGP
.... 28.106 DHOPatientExampleMultiplePractitioners
.... 28.107 DHOPatientExampleNP
.... 28.108 DHOPatientUpdateExample
.... 28.109 External Facility Example
.... 28.110 OutreachServiceRequest
.... 28.111 OutreachTask
.... 28.112 OutreachServiceRequestExample
.... 28.113 OutreachTaskExample
.... 28.114 RPM Educational Content Delivery Task
.... 28.115 Template for Remote Monitoring Cardiac Rehab Care Plan
.... 28.116 Template for Remote Monitoring Heart Failure Care Plan
.... 28.117 Vital Signs Observation Service Request
.... 28.118 Remote Monitoring COPD Survey
.... 28.119 Remote Patient Monitoring Educational Content Feedback Survey/Questionnaire
.... 28.120 Group/Unit Level Educational Content Delivery Task Example
.... 28.121 Module Level Educational Content Delivery Task Example
.... 28.122 RPMCardiacRehabCarePlanExample
.... 28.123 RPMCareTeamExample
.... 28.124 RPMConsentExample
.... 28.125 RPMObservationExample
.... 28.126 RPMObservationServiceRequestExample
.... 28.127 RPMPatientOnboardingCommunicationRequest
.... 28.128 Syllabus Level Educational Content Delivery Task
.... 28.129 New Zealand Pharmacy Claim Response
.... 28.130 NZ Medication Dispense
.... 28.131 NZ Medication Request
.... 28.132 NZ Pharmacy Claim
.... 28.133 HSAAPAdjudicatedClaimResponse
.... 28.134 New Zealand Pharmacy Claim Response Example
.... 28.135 PharmacySubmittedClaim
.... 28.136 NZ SharedCare Claim
.... 28.137 NZ SharedCare Claim Response
.... 28.138 Online GP Appointment
.... 28.139 Online GP Encounter
.... 28.140 Urgent Care Encounter
.... 28.141 NZ GP Online Encounter Example
.... 28.142 NZ Telehealth Claim Example
.... 28.143 NZ Telehealth Claim Response Example
.... 28.144 Online GP Appointment Example
.... 28.145 Shared Care FHIR Server Capability Statement
.... 28.146 Observation-flat-export
.... 28.147 RunOperation
.... 28.148 Search by appointment method
.... 28.149 Remote Monitoring Feedback Survey
.... 28.150 Remote Monitoring Heart Failure Symptom Survey Questionnaire
.... 28.151 DHOCondition
.... 28.152 Attachment details
.... 28.153 Balance Owing
.... 28.154 Callback Url
.... 28.155 Campaign details
.... 28.156 CBS Pack Size
.... 28.157 CBS Subsidy
.... 28.158 Claimant Number
.... 28.159 CMS Payload Type Extension
.... 28.160 CMS Template Content Type Extension
.... 28.161 DHO Appointment method
.... 28.162 DHO Outreach vs Fixed site
.... 28.163 DHO Patient Contact Role
.... 28.164 DHO Telecom Notification Enabled
.... 28.165 Dose Flag
.... 28.166 For sms reply
.... 28.167 Group ID
.... 28.168 HNZ Person Telecom Count Shared
.... 28.169 HNZ Person Telecom Information Source
.... 28.170 HNZ Person Telecom Invalid Indicator
.... 28.171 HNZ Person Telecom Last Contacted
.... 28.172 HNZ Person Telecom Phone Type
.... 28.173 HNZ Person Telecom Score
.... 28.174 NZePS Endorsement
.... 28.175 NZePS Funding Category
.... 28.176 NZePS Script Number Local
.... 28.177 Originating Claimant Number
.... 28.178 Patient Cohort
.... 28.179 Patient Flag
.... 28.180 Prescriber Flag
.... 28.181 Prescription Flag
.... 28.182 Send to and from communication to contact points
.... 28.183 Shared Care Accident Related
.... 28.184 Shared Care Agreement Number
.... 28.185 Shared Care Claim Trace Number
.... 28.186 Shared Care CSC holder
.... 28.187 Shared Care Diagnosis Code
.... 28.188 Shared Care Patient Copayment
.... 28.189 Shared Care Product Or Service
.... 28.190 Shared Care Registration Code
.... 28.191 Shared Care Review Outcome
.... 28.192 Status DateTime
.... 28.193 Wastage Quantity
.... 28.194 Adjudication Reason Codes
.... 28.195 Adjudication Value Codes
.... 28.196 Allowed outreach types for DHOLocation
.... 28.197 Allowed physical types for DHOLocation
.... 28.198 Allowed relationship types for DHOLocation
.... 28.199 Australasian Triage Scale
.... 28.200 Claim Decision Codes
.... 28.201 Claim Decision Reason Codes
.... 28.202 CMS Payload Type ValueSet
.... 28.203 CMS Template Content Type ValueSet
.... 28.204 Codes for Task code
.... 28.205 COVID19 vaccines recognised by NZ public health
.... 28.206 DHO Appointment Modality ValueSet
.... 28.207 DHO Health Speciality ValueSet
.... 28.208 Diagnosis Use Codes
.... 28.209 Education Module ValueSet
.... 28.210 Information source when using the telecom information source extension
.... 28.211 NZ Appointment Reason Codes Code System
.... 28.212 NZ Claim Subtypes
.... 28.213 NZ Claim Types
.... 28.214 NZ purpose of use
.... 28.215 Online GP Discharge Disposition
.... 28.216 Online GP Participant Type
.... 28.217 Patient Cohort ValueSet
.... 28.218 Payment Type Codes
.... 28.219 Pharmacy Adjudication Category
.... 28.220 Provider Qualification Codes
.... 28.221 Shared Care Encounter Type Value Set
.... 28.222 Status Reason for ServiceRequest
.... 28.223 System that last updated the record
.... 28.224 Telecom phone type indicator
.... 28.225 Telecom record score indicator
.... 28.226 Valueset for Communication Delivery Status
.... 28.227 Valueset for Participation Mode
.... 28.228 ValueSet for Patient Contact Role
.... 28.229 Valueset for Template Category
.... 28.230 Adjudication Reason Code System
.... 28.231 Adjudication Value Code System
.... 28.232 Australasian Triage Scale Code System
.... 28.233 Claim Decision Code System
.... 28.234 Claim Decision Reason Code System
.... 28.235 CMS Payload Type CodeSystem
.... 28.236 CMS Template Content Type CodeSystem
.... 28.237 Codes for CommunicationStatus
.... 28.238 Codes for ServiceRequest code
.... 28.239 Codes for Telecom Phone Types
.... 28.240 Codes for Telecom Score
.... 28.241 Codes for Telecom Source Systems
.... 28.242 Codes for Template category
.... 28.243 Codings for COVID-19 vaccination brands recognised in New Zealand public health
.... 28.244 DHO Appointment Modality CodeSystem
.... 28.245 DHO CodeSystem for Patient Contact Role
.... 28.246 DHO Health Speciality Codes
.... 28.247 DHO Location Physical Type
.... 28.248 DHO Location Relationship
.... 28.249 DHOLocation Outreach Type
.... 28.250 Education Module CodeSystem
.... 28.251 NZ Appointment Reason Codes Code System
.... 28.252 NZ Claim Subtype Code System
.... 28.253 NZ Purpose Of Use
.... 28.254 ParticipationMode
.... 28.255 Patient Cohort CodeSystem
.... 28.256 Pharmacy Adjudication Category Code System
.... 28.257 Provider Qualification Code System
.... 28.258 Status Reason for ServiceRequest
.... 28.259 AllergyIntoleranceExample
.... 28.260 BSAService
.... 28.261 DHOConditionExample
.... 28.262 GOFSH-GENERATED-ID-0
.... 28.263 New Zealand Pharmacy Claim Example
.... 28.264 ObservationFlatExportRequest
.... 28.265 ObservationFlatExportResponse
.... 28.266 RemoteMonitoringHeartFailureSymptomSurveyQuestionnaireResponse
.... 28.267 Te Whatu Ora - Southern (Example)
.... 28.268 Template for COVID-19 Care in the Community CCCM MVP Careplans
.... 28.269 Urgent Care Encounter Example