Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.7 - release New Zealand flag

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