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 An example Dunedin Hospital Outpatient Internal Clinic
.... 30.97 An example Dunedin Hospital Outpatient outreach
.... 30.98 An example Dunedin Hospital Outpatient patient home location
.... 30.99 DHOAppointmentClinicExample
.... 30.100 DHOAppointmentResponseExample
.... 30.101 DHOAppointmentTelehealthExample
.... 30.102 DHOAppointmentTelephoneExample
.... 30.103 DHOAppointmentUnstructuredExample
.... 30.104 DHODrDottyMcStuffins
.... 30.105 DHOEncounterCreateExample
.... 30.106 DHOEncounterExample
.... 30.107 DHOEncounterUpdateExample
.... 30.108 DHOPatientExampleGP
.... 30.109 DHOPatientExampleMultiplePractitioners
.... 30.110 DHOPatientExampleNP
.... 30.111 DHOPatientUpdateExample
.... 30.112 External Facility Example
.... 30.113 Outpatient Communication CarePlan
.... 30.114 Outpatient Communication Task
.... 30.115 Outpatient Communication CarePlan Example
.... 30.116 Outpatient Communication Task Example
.... 30.117 OutreachServiceRequest
.... 30.118 OutreachTask
.... 30.119 OutreachServiceRequestExample
.... 30.120 OutreachTaskExample
.... 30.121 RPM Educational Content Delivery Task
.... 30.122 Template for Remote Monitoring Cardiac Rehab Care Plan
.... 30.123 Template for Remote Monitoring Heart Failure Care Plan
.... 30.124 Vital Signs Observation Service Request
.... 30.125 Remote Monitoring COPD Survey
.... 30.126 Remote Patient Monitoring Educational Content Feedback Survey/Questionnaire
.... 30.127 Group/Unit Level Educational Content Delivery Task Example
.... 30.128 Module Level Educational Content Delivery Task Example
.... 30.129 RPMCardiacRehabCarePlanExample
.... 30.130 RPMCareTeamExample
.... 30.131 RPMConsentExample
.... 30.132 RPMObservationExample
.... 30.133 RPMObservationServiceRequestExample
.... 30.134 RPMPatientOnboardingCommunicationRequest
.... 30.135 Syllabus Level Educational Content Delivery Task
.... 30.136 New Zealand Pharmacy Claim Response
.... 30.137 NZ Medication Dispense
.... 30.138 NZ Medication Request
.... 30.139 NZ Pharmacy Claim
.... 30.140 HSAAP Adjudicated Claim Response
.... 30.141 New Zealand Pharmacy Claim Response Example
.... 30.142 NZ Pharmacy Medication Dispense Example
.... 30.143 NZ Pharmacy Medication Request Example
.... 30.144 Pharmacy Submitted Claim
.... 30.145 NZ SharedCare Claim
.... 30.146 NZ SharedCare Claim Response
.... 30.147 Online GP Appointment
.... 30.148 Online GP Encounter
.... 30.149 Urgent Care Encounter
.... 30.150 NZ GP Online Encounter Example
.... 30.151 NZ Telehealth Claim Example
.... 30.152 NZ Telehealth Claim Response Example
.... 30.153 Online GP Appointment Example
.... 30.154 Shared Care FHIR Server Capability Statement
.... 30.155 Observation-flat-export
.... 30.156 RunOperation
.... 30.157 Search by appointment method
.... 30.158 Remote Monitoring Feedback Survey
.... 30.159 Remote Monitoring Heart Failure Symptom Survey Questionnaire
.... 30.160 DHOCondition
.... 30.161 Attachment details
.... 30.162 Balance Owing
.... 30.163 Callback Url
.... 30.164 Campaign details
.... 30.165 CBS Pack Size
.... 30.166 CBS Subsidy
.... 30.167 Claimant Number
.... 30.168 Classification Extension
.... 30.169 CMS Payload Type Extension
.... 30.170 CMS Template Content Type Extension
.... 30.171 DHO Appointment method
.... 30.172 DHO Initial Patient Class
.... 30.173 DHO Outreach vs Fixed site
.... 30.174 DHO Patient Contact Role
.... 30.175 DHO Telecom Notification Enabled
.... 30.176 DHO Telecom Validation Status
.... 30.177 Dose Flag
.... 30.178 Extended Supply Flag
.... 30.179 For sms reply
.... 30.180 Group ID
.... 30.181 HNZ Person Telecom Count Shared
.... 30.182 HNZ Person Telecom Information Source
.... 30.183 HNZ Person Telecom Invalid Indicator
.... 30.184 HNZ Person Telecom Last Contacted
.... 30.185 HNZ Person Telecom Phone Type
.... 30.186 HNZ Person Telecom Score
.... 30.187 Item Request
.... 30.188 NZePS Endorsement
.... 30.189 NZePS Funding Category
.... 30.190 NZePS Script Number Local
.... 30.191 Originating Claimant Number
.... 30.192 Patient Cohort
.... 30.193 Patient Flag
.... 30.194 Pharmacy Claim Item Detail Product Or Service
.... 30.195 Pharmacy Claim Item Detail Review Outcome
.... 30.196 Prescriber Flag
.... 30.197 Prescription Flag
.... 30.198 PSC Flag Extension
.... 30.199 Send to and from communication to contact points
.... 30.200 Shared Care Accident Related
.... 30.201 Shared Care Agreement Number
.... 30.202 Shared Care Claim Trace Number
.... 30.203 Shared Care CSC holder
.... 30.204 Shared Care Diagnosis Code
.... 30.205 Shared Care Patient Copayment
.... 30.206 Shared Care Product Or Service
.... 30.207 Shared Care Registration Code
.... 30.208 Shared Care Review Outcome
.... 30.209 Status DateTime
.... 30.210 Transaction Category
.... 30.211 Wastage Quantity
.... 30.212 Adjudication Reason Codes
.... 30.213 Adjudication Value Codes
.... 30.214 Allowed outreach types for DHOLocation
.... 30.215 Allowed physical types for DHOLocation
.... 30.216 Allowed relationship types for DHOLocation
.... 30.217 Allowed Telecom Validation Statuses
.... 30.218 Australasian Triage Scale
.... 30.219 Claim Decision Codes
.... 30.220 Claim Decision Reason Codes
.... 30.221 CMS Payload Type ValueSet
.... 30.222 CMS Template Content Type ValueSet
.... 30.223 Codes for Task code
.... 30.224 COVID19 vaccines recognised by NZ public health
.... 30.225 DHO Appointment Modality ValueSet
.... 30.226 DHO Health Speciality ValueSet
.... 30.227 Diagnosis Use Codes
.... 30.228 Education Module ValueSet
.... 30.229 Information source when using the telecom information source extension
.... 30.230 NZ Appointment Reason Codes Code System
.... 30.231 NZ Claim Subtypes
.... 30.232 NZ Claim Types
.... 30.233 NZ Pharmacy Claim Item Classification
.... 30.234 NZ Pharmacy Transaction Category
.... 30.235 NZ purpose of use
.... 30.236 Online GP Discharge Disposition
.... 30.237 Online GP Participant Type
.... 30.238 Outpatient Activity Status Reason
.... 30.239 Patient Cohort ValueSet
.... 30.240 Payment Type Codes
.... 30.241 Pharmacy Adjudication Category
.... 30.242 Provenance Reason Type
.... 30.243 Provider Qualification Codes
.... 30.244 Shared Care Encounter Type Value Set
.... 30.245 Status Reason for ServiceRequest
.... 30.246 System that last updated the record
.... 30.247 Telecom phone type indicator
.... 30.248 Telecom record score indicator
.... 30.249 Valueset for Communication Delivery Status
.... 30.250 Valueset for Participation Mode
.... 30.251 ValueSet for Patient Contact Role
.... 30.252 Valueset for Template Category
.... 30.253 Adjudication Reason Code System
.... 30.254 Adjudication Value Code System
.... 30.255 Australasian Triage Scale Code System
.... 30.256 Claim Decision Code System
.... 30.257 Claim Decision Reason Code System
.... 30.258 CMS Payload Type CodeSystem
.... 30.259 CMS Template Content Type CodeSystem
.... 30.260 Codes for CommunicationStatus
.... 30.261 Codes for ServiceRequest code
.... 30.262 Codes for Telecom Phone Types
.... 30.263 Codes for Telecom Score
.... 30.264 Codes for Telecom Source Systems
.... 30.265 Codes for Template category
.... 30.266 Codings for COVID-19 vaccination brands recognised in New Zealand public health
.... 30.267 DHO Appointment Modality CodeSystem
.... 30.268 DHO CodeSystem for Patient Contact Role
.... 30.269 DHO Health Speciality Codes
.... 30.270 DHO Location Physical Type
.... 30.271 DHO Location Relationship
.... 30.272 DHOLocation Outreach Type
.... 30.273 DHOPatient Telecom Validation Status
.... 30.274 Education Module CodeSystem
.... 30.275 NZ Appointment Reason Codes Code System
.... 30.276 NZ Claim Subtype Code System
.... 30.277 NZ Pharmacy Claim Item Classification CodeSystem
.... 30.278 NZ Pharmacy Transaction Category
.... 30.279 NZ Purpose Of Use
.... 30.280 Outpatient Activity Status Reason
.... 30.281 ParticipationMode
.... 30.282 Patient Cohort CodeSystem
.... 30.283 Pharmacy Adjudication Category Code System
.... 30.284 Provenance Reason Type
.... 30.285 Provider Qualification Code System
.... 30.286 Status Reason for ServiceRequest
.... 30.287 AllergyIntoleranceExample
.... 30.288 BSAService
.... 30.289 DHOConditionExample
.... 30.290 DHOPatientExampleGPDeceased
.... 30.291 DHOProvenanceNhiMergeExample
.... 30.292 GOFSH-GENERATED-ID-0
.... 30.293 New Zealand Pharmacy Claim Example
.... 30.294 ObservationFlatExportRequest
.... 30.295 ObservationFlatExportResponse
.... 30.296 OutpatientCommunicationRequestEmailExample
.... 30.297 RemoteMonitoringHeartFailureSymptomSurveyQuestionnaireResponse
.... 30.298 Te Whatu Ora - Southern (Example)
.... 30.299 Template for COVID-19 Care in the Community CCCM MVP Careplans
.... 30.300 Urgent Care Encounter Example