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