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 Outreach Referrals
... 23 Outreach Use Cases
... 24 Remote Patient Monitoring
... 25 Roadmap
... 26 Artifacts Summary
.... 26.1 Care In The Community ActivityDefinition Apply Operation
.... 26.2 Care In The Community PlanDefinition Apply Operation
.... 26.3 Care In The Community QuestionnaireResponse Extract Operation
.... 26.4 CommunicationPerson
.... 26.5 ManaakiNgaTahiAllergyIntolerance
.... 26.6 ManaakiNgaTahiCarePlan
.... 26.7 ManaakiNgaTahiCondition
.... 26.8 ManaakiNgaTahiDocumentReference
.... 26.9 ManaakiNgaTahiEncounter
.... 26.10 ManaakiNgaTahiObservation
.... 26.11 ManaakiNgaTahiPlanDefinition
.... 26.12 ManaakiNgaTahiServiceRequest
.... 26.13 ServiceRequestActivityDefinition
.... 26.14 Template for COVID-19 Care in the Community CCCM MVP Careplans
.... 26.15 Vital Signs Observation Service Request
.... 26.16 AIR - Overseas, Historic, Not Done
.... 26.17 Antiviral medication eligibility questionnaire
.... 26.18 COVID-19 RAT Result Questionnaire
.... 26.19 COVID19 Initial Health Assessment Questionnaire
.... 26.20 COVID19 Public Health History Questionnaire
.... 26.21 COVID19 Vaccination Side Effects Questionnaire
.... 26.22 Early Warning Score
.... 26.23 Measles Daily Health Check
.... 26.24 Mental Health Assessment Survey
.... 26.25 Post Vaccine Symptom Check day 3 survey
.... 26.26 Post Vaccine Symptom Check day 42 survey
.... 26.27 Pregnancy Assessment Survey
.... 26.28 Private Colposcopy Did Not Attend Questionnaire
.... 26.29 Private Colposcopy Discharge Questionnaire
.... 26.30 Private Colposcopy Referral Summary Questionnaire
.... 26.31 Private Colposcopy Visit Summary Questionnaire
.... 26.32 Question Template for COVID-19 Regular Health Check
.... 26.33 Report a Rapid Antigen Test (RAT) result
.... 26.34 ActiveMonitoringDay3SurveyQuestionnaireResponse
.... 26.35 ActiveMonitoringDay42SurveyQuestionnaireResponse
.... 26.36 AntiviralEligibilityNoQuestionnaireResponse
.... 26.37 AntiviralEligibilityYesQuestionnaireResponse
.... 26.38 ConsumerCOVIDRATResultQuestionnaireResponse
.... 26.39 COVIDInitialHealthAssessmentQuestionnaireResponse
.... 26.40 COVIDPublicHealthHistoryQuestionnaireResponseSherrylCarrion
.... 26.41 COVIDRATResultQuestionnaireResponse
.... 26.42 COVIDRegularHealthCheckQuestionnaireResponse
.... 26.43 COVIDVaccinationSurveyQuestionnaireResponse
.... 26.44 ImmsotVaccinationDataEntryQuestionnaireResponse
.... 26.45 MeaslesHealthCheckQuestionnaireResponse
.... 26.46 MentalHealthAssessmentSurveyQuestionnaireResponse
.... 26.47 PregnancyAssessmentSurveyQuestionnaireResponse
.... 26.48 CareyCarrington
.... 26.49 ConditionExample
.... 26.50 COVID-19 Omicron Response - Carey Carrington
.... 26.51 DocumentReferenceExample
.... 26.52 DrDottyMcStuffins
.... 26.53 EncounterExample
.... 26.54 ObservationExample
.... 26.55 ObservationsServiceRequestExample
.... 26.56 NIBSCommunicationPersonExample
.... 26.57 WhaihuaCommunicationPersonExample
.... 26.58 CMS Communication
.... 26.59 CMS Communication Request
.... 26.60 Record Of all healthcare services
.... 26.61 Record of Template for Email Communication from Any Healthcare System
.... 26.62 EmailCommunicationRequestWithoutTemplateExample
.... 26.63 EmailCommunicationRequestWithTemplateExample
.... 26.64 SMSCommunicationRequestWithoutTemplateExample
.... 26.65 SMSCommunicationRequestWithTemplateExample
.... 26.66 EmailCommunicationExample
.... 26.67 OutreachCommunicationExample
.... 26.68 SMSCommunicationExample
.... 26.69 EmailCommunicationTemplateExample
.... 26.70 ActiveConsentExample
.... 26.71 ConsentByQuestionnaireExample
.... 26.72 ConsentByRelatedPersonExample
.... 26.73 ConsentExample
.... 26.74 ConsentQuestionnaireResponseExample
.... 26.75 ManaakiNgaTahiConsent
.... 26.76 ProvisionalConsentExample
.... 26.77 Question Template for COVID-19 Privacy Statement Question
.... 26.78 DHO Appointment Profile
.... 26.79 DHO Appointment Response Profile
.... 26.80 DHO Encounter profile
.... 26.81 DHO Encounter profile used to create an Encounter
.... 26.82 DHO Encounter profile used to update an Encounter
.... 26.83 DHO Location Profile
.... 26.84 DHO Patient Profile
.... 26.85 DHO Patient update profile
.... 26.86 An example Dunedin Hospital Outpatient Internal Clinic
.... 26.87 An example Dunedin Hospital Outpatient outreach
.... 26.88 An example Dunedin Hospital Outpatient patient home location
.... 26.89 DHOAppointmentClinicExample
.... 26.90 DHOAppointmentResponseExample
.... 26.91 DHOAppointmentTelehealthExample
.... 26.92 DHOAppointmentTelephoneExample
.... 26.93 DHOAppointmentUnstructuredExample
.... 26.94 DHODrDottyMcStuffins
.... 26.95 DHOEncounterCreateExample
.... 26.96 DHOEncounterExample
.... 26.97 DHOEncounterUpdateExample
.... 26.98 DHOPatientExample
.... 26.99 DHOPatientUpdateExample
.... 26.100 External Facility Example
.... 26.101 OutreachServiceRequest
.... 26.102 OutreachTask
.... 26.103 OutreachServiceRequestExample
.... 26.104 OutreachTaskExample
.... 26.105 RPM Educational Content Delivery Task
.... 26.106 Template for Remote Monitoring Cardiac Rehab Care Plan
.... 26.107 Template for Remote Monitoring Heart Failure Care Plan
.... 26.108 Vital Signs Observation Service Request
.... 26.109 Remote Monitoring COPD Survey
.... 26.110 Remote Patient Monitoring Educational Content Feedback Survey/Questionnaire
.... 26.111 Group/Unit Level Educational Content Delivery Task Example
.... 26.112 Module Level Educational Content Delivery Task Example
.... 26.113 RPMCardiacRehabCarePlanExample
.... 26.114 RPMCareTeamExample
.... 26.115 RPMConsentExample
.... 26.116 RPMObservationExample
.... 26.117 RPMObservationServiceRequestExample
.... 26.118 RPMPatientOnboardingCommunicationRequest
.... 26.119 Syllabus Level Educational Content Delivery Task
.... 26.120 New Zealand Pharmacy Claim Response
.... 26.121 NZ Medication Dispense
.... 26.122 NZ Medication Request
.... 26.123 NZ Pharmacy Claim
.... 26.124 HSAAPAdjudicatedClaimResponse
.... 26.125 New Zealand Pharmacy Claim Response Example
.... 26.126 PharmacySubmittedClaim
.... 26.127 NZ SharedCare Claim
.... 26.128 NZ SharedCare Claim Response
.... 26.129 Online GP Appointment
.... 26.130 Online GP Encounter
.... 26.131 Urgent Care Encounter
.... 26.132 NZ GP Online Encounter Example
.... 26.133 NZ Telehealth Claim Example
.... 26.134 NZ Telehealth Claim Response Example
.... 26.135 Online GP Appointment Example
.... 26.136 Shared Care FHIR Server Capability Statement
.... 26.137 Observation-flat-export
.... 26.138 RunOperation
.... 26.139 Search by appointment method
.... 26.140 Remote Monitoring Feedback Survey
.... 26.141 Remote Monitoring Heart Failure Symptom Survey Questionnaire
.... 26.142 DHOCondition
.... 26.143 Attachment details
.... 26.144 Balance Owing
.... 26.145 Callback Url
.... 26.146 Campaign details
.... 26.147 CBS Pack Size
.... 26.148 CBS Subsidy
.... 26.149 Claimant Number
.... 26.150 DHO Appointment method
.... 26.151 DHO Outreach vs Fixed site
.... 26.152 DHO Patient Contact Role
.... 26.153 DHO Telecom Notification Enabled
.... 26.154 Dose Flag
.... 26.155 For sms reply
.... 26.156 Group ID
.... 26.157 HNZ Person Telecom Count Shared
.... 26.158 HNZ Person Telecom Information Source
.... 26.159 HNZ Person Telecom Invalid Indicator
.... 26.160 HNZ Person Telecom Last Contacted
.... 26.161 HNZ Person Telecom Phone Type
.... 26.162 HNZ Person Telecom Score
.... 26.163 NZePS Endorsement
.... 26.164 NZePS Funding Category
.... 26.165 NZePS Script Number Local
.... 26.166 Originating Claimant Number
.... 26.167 Patient Cohort
.... 26.168 Patient Flag
.... 26.169 Prescriber Flag
.... 26.170 Prescription Flag
.... 26.171 Send to and from communication to contact points
.... 26.172 Shared Care Accident Related
.... 26.173 Shared Care Agreement Number
.... 26.174 Shared Care Claim Trace Number
.... 26.175 Shared Care CSC holder
.... 26.176 Shared Care Diagnosis Code
.... 26.177 Shared Care Patient Copayment
.... 26.178 Shared Care Product Or Service
.... 26.179 Shared Care Registration Code
.... 26.180 Shared Care Review Outcome
.... 26.181 Status DateTime
.... 26.182 Wastage Quantity
.... 26.183 Adjudication Reason Codes
.... 26.184 Adjudication Value Codes
.... 26.185 Allowed outreach types for DHOLocation
.... 26.186 Allowed physical types for DHOLocation
.... 26.187 Allowed relationship types for DHOLocation
.... 26.188 Australasian Triage Scale
.... 26.189 Claim Decision Codes
.... 26.190 Claim Decision Reason Codes
.... 26.191 Codes for Task code
.... 26.192 COVID19 vaccines recognised by NZ public health
.... 26.193 DHO Appointment Modality ValueSet
.... 26.194 DHO Health Speciality ValueSet
.... 26.195 Diagnosis Use Codes
.... 26.196 Education Module ValueSet
.... 26.197 Information source when using the telecom information source extension
.... 26.198 NZ Appointment Reason Codes Code System
.... 26.199 NZ Claim Subtypes
.... 26.200 NZ Claim Types
.... 26.201 NZ purpose of use
.... 26.202 Online GP Discharge Disposition
.... 26.203 Online GP Participant Type
.... 26.204 Patient Cohort ValueSet
.... 26.205 Payment Type Codes
.... 26.206 Pharmacy Adjudication Category
.... 26.207 Provider Qualification Codes
.... 26.208 Shared Care Encounter Type Value Set
.... 26.209 Status Reason for ServiceRequest
.... 26.210 System that last updated the record
.... 26.211 Telecom phone type indicator
.... 26.212 Telecom record score indicator
.... 26.213 Valueset for Communication Delivery Status
.... 26.214 Valueset for Participation Mode
.... 26.215 ValueSet for Patient Contact Role
.... 26.216 Valueset for Template Category
.... 26.217 Adjudication Reason Code System
.... 26.218 Adjudication Value Code System
.... 26.219 Australasian Triage Scale Code System
.... 26.220 Claim Decision Code System
.... 26.221 Claim Decision Reason Code System
.... 26.222 Codes for CommunicationStatus
.... 26.223 Codes for ServiceRequest code
.... 26.224 Codes for Telecom Phone Types
.... 26.225 Codes for Telecom Score
.... 26.226 Codes for Telecom Source Systems
.... 26.227 Codes for Template category
.... 26.228 Codings for COVID-19 vaccination brands recognised in New Zealand public health
.... 26.229 DHO Appointment Modality CodeSystem
.... 26.230 DHO CodeSystem for Patient Contact Role
.... 26.231 DHO Health Speciality Codes
.... 26.232 DHO Location Physical Type
.... 26.233 DHO Location Relationship
.... 26.234 DHOLocation Outreach Type
.... 26.235 Education Module CodeSystem
.... 26.236 NZ Appointment Reason Codes Code System
.... 26.237 NZ Claim Subtype Code System
.... 26.238 NZ Purpose Of Use
.... 26.239 ParticipationMode
.... 26.240 Patient Cohort CodeSystem
.... 26.241 Pharmacy Adjudication Category Code System
.... 26.242 Provider Qualification Code System
.... 26.243 Status Reason for ServiceRequest
.... 26.244 AllergyIntoleranceExample
.... 26.245 BSAService
.... 26.246 DHOConditionExample
.... 26.247 GOFSH-GENERATED-ID-0
.... 26.248 New Zealand Pharmacy Claim Example
.... 26.249 ObservationFlatExportRequest
.... 26.250 ObservationFlatExportResponse
.... 26.251 RemoteMonitoringHeartFailureSymptomSurveyQuestionnaireResponse
.... 26.252 Te Whatu Ora - Southern (Example)
.... 26.253 Template for COVID-19 Care in the Community CCCM MVP Careplans
.... 26.254 Urgent Care Encounter Example