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