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 Complete Care Plan
... 7 Consent Based Access Control
... 8 Create Care Plan
... 9 Create Condition
... 10 Create Encounter
... 11 Developer Guide
... 12 Dunedin Hospital Outpatients
... 13 Extensions
... 14 Faq
... 15 Fhir Consent
... 16 Flat Data Views
... 17 Health Checks
... 18 History
... 19 In Home Observations
... 20 Initial Assesment
... 21 NDH Outpatients
... 22 Online GP
... 23 Outreach Referrals
... 24 Outreach Use Cases
... 25 Remote Patient Monitoring
... 26 Roadmap
... 27 Artifacts Summary
.... 27.1 Care In The Community ActivityDefinition Apply Operation
.... 27.2 Care In The Community PlanDefinition Apply Operation
.... 27.3 Care In The Community QuestionnaireResponse Extract Operation
.... 27.4 CommunicationPerson
.... 27.5 ManaakiNgaTahiAllergyIntolerance
.... 27.6 ManaakiNgaTahiCarePlan
.... 27.7 ManaakiNgaTahiCondition
.... 27.8 ManaakiNgaTahiDocumentReference
.... 27.9 ManaakiNgaTahiEncounter
.... 27.10 ManaakiNgaTahiObservation
.... 27.11 ManaakiNgaTahiPlanDefinition
.... 27.12 ManaakiNgaTahiServiceRequest
.... 27.13 ServiceRequestActivityDefinition
.... 27.14 Template for COVID-19 Care in the Community CCCM MVP Careplans
.... 27.15 Vital Signs Observation Service Request
.... 27.16 AIR - Overseas, Historic, Not Done
.... 27.17 Antiviral medication eligibility questionnaire
.... 27.18 COVID-19 RAT Result Questionnaire
.... 27.19 COVID19 Initial Health Assessment Questionnaire
.... 27.20 COVID19 Public Health History Questionnaire
.... 27.21 COVID19 Vaccination Side Effects Questionnaire
.... 27.22 Early Warning Score
.... 27.23 How does condition affect your life
.... 27.24 Measles Daily Health Check
.... 27.25 Mental Health Assessment Survey
.... 27.26 Post Vaccine Symptom Check day 3 survey
.... 27.27 Post Vaccine Symptom Check day 42 survey
.... 27.28 Pregnancy Assessment Survey
.... 27.29 Private Colposcopy Did Not Attend Questionnaire
.... 27.30 Private Colposcopy Discharge Questionnaire
.... 27.31 Private Colposcopy Referral Summary Questionnaire
.... 27.32 Private Colposcopy Visit Summary Questionnaire
.... 27.33 Question Template for COVID-19 Regular Health Check
.... 27.34 Report a Rapid Antigen Test (RAT) result
.... 27.35 ActiveMonitoringDay3SurveyQuestionnaireResponse
.... 27.36 ActiveMonitoringDay42SurveyQuestionnaireResponse
.... 27.37 AntiviralEligibilityNoQuestionnaireResponse
.... 27.38 AntiviralEligibilityYesQuestionnaireResponse
.... 27.39 ConsumerCOVIDRATResultQuestionnaireResponse
.... 27.40 COVIDInitialHealthAssessmentQuestionnaireResponse
.... 27.41 COVIDPublicHealthHistoryQuestionnaireResponseSherrylCarrion
.... 27.42 COVIDRATResultQuestionnaireResponse
.... 27.43 COVIDRegularHealthCheckQuestionnaireResponse
.... 27.44 COVIDVaccinationSurveyQuestionnaireResponse
.... 27.45 ImmsotVaccinationDataEntryQuestionnaireResponse
.... 27.46 MeaslesHealthCheckQuestionnaireResponse
.... 27.47 MentalHealthAssessmentSurveyQuestionnaireResponse
.... 27.48 PregnancyAssessmentSurveyQuestionnaireResponse
.... 27.49 CareyCarrington
.... 27.50 ConditionExample
.... 27.51 COVID-19 Omicron Response - Carey Carrington
.... 27.52 DocumentReferenceExample
.... 27.53 DrDottyMcStuffins
.... 27.54 EncounterExample
.... 27.55 ObservationExample
.... 27.56 ObservationsServiceRequestExample
.... 27.57 NIBSCommunicationPersonExample
.... 27.58 WhaihuaCommunicationPersonExample
.... 27.59 CMS Communication
.... 27.60 CMS Communication Request
.... 27.61 Record Of all healthcare services
.... 27.62 Record of Template for Email Communication from Any Healthcare System
.... 27.63 EmailCommunicationRequestWithoutTemplateExample
.... 27.64 EmailCommunicationRequestWithTemplateExample
.... 27.65 SMSCommunicationRequestWithoutTemplateExample
.... 27.66 SMSCommunicationRequestWithTemplateExample
.... 27.67 EmailCommunicationExample
.... 27.68 OutreachCommunicationExample
.... 27.69 SMSCommunicationExample
.... 27.70 EmailCommunicationTemplateExample
.... 27.71 ActiveConsentExample
.... 27.72 ConsentByQuestionnaireExample
.... 27.73 ConsentByRelatedPersonExample
.... 27.74 ConsentExample
.... 27.75 ConsentQuestionnaireResponseExample
.... 27.76 ManaakiNgaTahiConsent
.... 27.77 ProvisionalConsentExample
.... 27.78 Question Template for COVID-19 Privacy Statement Question
.... 27.79 DHO Appointment Profile
.... 27.80 DHO Appointment Response Profile
.... 27.81 DHO Encounter profile
.... 27.82 DHO Encounter profile used to create an Encounter
.... 27.83 DHO Encounter profile used to update an Encounter
.... 27.84 DHO Location Profile
.... 27.85 DHO Patient Profile
.... 27.86 DHO Patient update profile
.... 27.87 An example Dunedin Hospital Outpatient Internal Clinic
.... 27.88 An example Dunedin Hospital Outpatient outreach
.... 27.89 An example Dunedin Hospital Outpatient patient home location
.... 27.90 DHOAppointmentClinicExample
.... 27.91 DHOAppointmentResponseExample
.... 27.92 DHOAppointmentTelehealthExample
.... 27.93 DHOAppointmentTelephoneExample
.... 27.94 DHOAppointmentUnstructuredExample
.... 27.95 DHODrDottyMcStuffins
.... 27.96 DHOEncounterCreateExample
.... 27.97 DHOEncounterExample
.... 27.98 DHOEncounterUpdateExample
.... 27.99 DHOPatientExample
.... 27.100 DHOPatientUpdateExample
.... 27.101 External Facility Example
.... 27.102 OutreachServiceRequest
.... 27.103 OutreachTask
.... 27.104 OutreachServiceRequestExample
.... 27.105 OutreachTaskExample
.... 27.106 RPM Educational Content Delivery Task
.... 27.107 Template for Remote Monitoring Cardiac Rehab Care Plan
.... 27.108 Template for Remote Monitoring Heart Failure Care Plan
.... 27.109 Vital Signs Observation Service Request
.... 27.110 Remote Monitoring COPD Survey
.... 27.111 Remote Patient Monitoring Educational Content Feedback Survey/Questionnaire
.... 27.112 Group/Unit Level Educational Content Delivery Task Example
.... 27.113 Module Level Educational Content Delivery Task Example
.... 27.114 RPMCardiacRehabCarePlanExample
.... 27.115 RPMCareTeamExample
.... 27.116 RPMConsentExample
.... 27.117 RPMObservationExample
.... 27.118 RPMObservationServiceRequestExample
.... 27.119 RPMPatientOnboardingCommunicationRequest
.... 27.120 Syllabus Level Educational Content Delivery Task
.... 27.121 New Zealand Pharmacy Claim Response
.... 27.122 NZ Medication Dispense
.... 27.123 NZ Medication Request
.... 27.124 NZ Pharmacy Claim
.... 27.125 HSAAPAdjudicatedClaimResponse
.... 27.126 New Zealand Pharmacy Claim Response Example
.... 27.127 PharmacySubmittedClaim
.... 27.128 NZ SharedCare Claim
.... 27.129 NZ SharedCare Claim Response
.... 27.130 Online GP Appointment
.... 27.131 Online GP Encounter
.... 27.132 Urgent Care Encounter
.... 27.133 NZ GP Online Encounter Example
.... 27.134 NZ Telehealth Claim Example
.... 27.135 NZ Telehealth Claim Response Example
.... 27.136 Online GP Appointment Example
.... 27.137 Shared Care FHIR Server Capability Statement
.... 27.138 Observation-flat-export
.... 27.139 RunOperation
.... 27.140 Search by appointment method
.... 27.141 Remote Monitoring Feedback Survey
.... 27.142 Remote Monitoring Heart Failure Symptom Survey Questionnaire
.... 27.143 DHOCondition
.... 27.144 Attachment details
.... 27.145 Balance Owing
.... 27.146 Callback Url
.... 27.147 Campaign details
.... 27.148 CBS Pack Size
.... 27.149 CBS Subsidy
.... 27.150 Claimant Number
.... 27.151 DHO Appointment method
.... 27.152 DHO Outreach vs Fixed site
.... 27.153 DHO Patient Contact Role
.... 27.154 DHO Telecom Notification Enabled
.... 27.155 Dose Flag
.... 27.156 For sms reply
.... 27.157 Group ID
.... 27.158 HNZ Person Telecom Count Shared
.... 27.159 HNZ Person Telecom Information Source
.... 27.160 HNZ Person Telecom Invalid Indicator
.... 27.161 HNZ Person Telecom Last Contacted
.... 27.162 HNZ Person Telecom Phone Type
.... 27.163 HNZ Person Telecom Score
.... 27.164 NZePS Endorsement
.... 27.165 NZePS Funding Category
.... 27.166 NZePS Script Number Local
.... 27.167 Originating Claimant Number
.... 27.168 Patient Cohort
.... 27.169 Patient Flag
.... 27.170 Prescriber Flag
.... 27.171 Prescription Flag
.... 27.172 Send to and from communication to contact points
.... 27.173 Shared Care Accident Related
.... 27.174 Shared Care Agreement Number
.... 27.175 Shared Care Claim Trace Number
.... 27.176 Shared Care CSC holder
.... 27.177 Shared Care Diagnosis Code
.... 27.178 Shared Care Patient Copayment
.... 27.179 Shared Care Product Or Service
.... 27.180 Shared Care Registration Code
.... 27.181 Shared Care Review Outcome
.... 27.182 Status DateTime
.... 27.183 Wastage Quantity
.... 27.184 Adjudication Reason Codes
.... 27.185 Adjudication Value Codes
.... 27.186 Allowed outreach types for DHOLocation
.... 27.187 Allowed physical types for DHOLocation
.... 27.188 Allowed relationship types for DHOLocation
.... 27.189 Australasian Triage Scale
.... 27.190 Claim Decision Codes
.... 27.191 Claim Decision Reason Codes
.... 27.192 Codes for Task code
.... 27.193 COVID19 vaccines recognised by NZ public health
.... 27.194 DHO Appointment Modality ValueSet
.... 27.195 DHO Health Speciality ValueSet
.... 27.196 Diagnosis Use Codes
.... 27.197 Education Module ValueSet
.... 27.198 Information source when using the telecom information source extension
.... 27.199 NZ Appointment Reason Codes Code System
.... 27.200 NZ Claim Subtypes
.... 27.201 NZ Claim Types
.... 27.202 NZ purpose of use
.... 27.203 Online GP Discharge Disposition
.... 27.204 Online GP Participant Type
.... 27.205 Patient Cohort ValueSet
.... 27.206 Payment Type Codes
.... 27.207 Pharmacy Adjudication Category
.... 27.208 Provider Qualification Codes
.... 27.209 Shared Care Encounter Type Value Set
.... 27.210 Status Reason for ServiceRequest
.... 27.211 System that last updated the record
.... 27.212 Telecom phone type indicator
.... 27.213 Telecom record score indicator
.... 27.214 Valueset for Communication Delivery Status
.... 27.215 Valueset for Participation Mode
.... 27.216 ValueSet for Patient Contact Role
.... 27.217 Valueset for Template Category
.... 27.218 Adjudication Reason Code System
.... 27.219 Adjudication Value Code System
.... 27.220 Australasian Triage Scale Code System
.... 27.221 Claim Decision Code System
.... 27.222 Claim Decision Reason Code System
.... 27.223 Codes for CommunicationStatus
.... 27.224 Codes for ServiceRequest code
.... 27.225 Codes for Telecom Phone Types
.... 27.226 Codes for Telecom Score
.... 27.227 Codes for Telecom Source Systems
.... 27.228 Codes for Template category
.... 27.229 Codings for COVID-19 vaccination brands recognised in New Zealand public health
.... 27.230 DHO Appointment Modality CodeSystem
.... 27.231 DHO CodeSystem for Patient Contact Role
.... 27.232 DHO Health Speciality Codes
.... 27.233 DHO Location Physical Type
.... 27.234 DHO Location Relationship
.... 27.235 DHOLocation Outreach Type
.... 27.236 Education Module CodeSystem
.... 27.237 NZ Appointment Reason Codes Code System
.... 27.238 NZ Claim Subtype Code System
.... 27.239 NZ Purpose Of Use
.... 27.240 ParticipationMode
.... 27.241 Patient Cohort CodeSystem
.... 27.242 Pharmacy Adjudication Category Code System
.... 27.243 Provider Qualification Code System
.... 27.244 Status Reason for ServiceRequest
.... 27.245 AllergyIntoleranceExample
.... 27.246 BSAService
.... 27.247 DHOConditionExample
.... 27.248 GOFSH-GENERATED-ID-0
.... 27.249 New Zealand Pharmacy Claim Example
.... 27.250 ObservationFlatExportRequest
.... 27.251 ObservationFlatExportResponse
.... 27.252 RemoteMonitoringHeartFailureSymptomSurveyQuestionnaireResponse
.... 27.253 Te Whatu Ora - Southern (Example)
.... 27.254 Template for COVID-19 Care in the Community CCCM MVP Careplans
.... 27.255 Urgent Care Encounter Example