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 Dunedin Hospital Outpatient Appointment Profile
.... 26.79 Dunedin Hospital Outpatient Appointment Response Profile
.... 26.80 Dunedin Hospital Outpatient Encounter
.... 26.81 Dunedin Hospital Outpatient Encounter Create
.... 26.82 Dunedin Hospital Outpatient Encounter Update
.... 26.83 Dunedin Hospital Outpatient Get Patient Profile
.... 26.84 Dunedin Hospital Outpatient Update profile
.... 26.85 DHOAppointmentResponseExample
.... 26.86 DHOClinicAppointmentExample
.... 26.87 DHODrDottyMcStuffins
.... 26.88 DHOEncounterCreateExample
.... 26.89 DHOEncounterExample
.... 26.90 DHOEncounterUpdateExample
.... 26.91 DHOPatientExample
.... 26.92 DHOPatientUpdateExample
.... 26.93 DHOSIPICSAlexMorgan
.... 26.94 DHOSIPICSCuriousGeorge
.... 26.95 DHOSIPICSEmilyWhite
.... 26.96 DHOUnstructuredAppointmentExample
.... 26.97 OutreachServiceRequest
.... 26.98 OutreachTask
.... 26.99 OutreachServiceRequestExample
.... 26.100 OutreachTaskExample
.... 26.101 RPM Educational Content Delivery Task
.... 26.102 Template for Remote Monitoring Cardiac Rehab Care Plan
.... 26.103 Template for Remote Monitoring Heart Failure Care Plan
.... 26.104 Vital Signs Observation Service Request
.... 26.105 Remote Monitoring COPD Survey
.... 26.106 Remote Patient Monitoring Educational Content Feedback Survey/Questionnaire
.... 26.107 Group/Unit Level Educational Content Delivery Task Example
.... 26.108 Module Level Educational Content Delivery Task Example
.... 26.109 RPMCardiacRehabCarePlanExample
.... 26.110 RPMCareTeamExample
.... 26.111 RPMConsentExample
.... 26.112 RPMObservationExample
.... 26.113 RPMObservationServiceRequestExample
.... 26.114 RPMPatientOnboardingCommunicationRequest
.... 26.115 Syllabus Level Educational Content Delivery Task
.... 26.116 New Zealand Pharmacy Claim Response
.... 26.117 NZ Medication Dispense
.... 26.118 NZ Medication Request
.... 26.119 NZ Pharmacy Claim
.... 26.120 HSAAPAdjudicatedClaimResponse
.... 26.121 New Zealand Pharmacy Claim Response Example
.... 26.122 PharmacySubmittedClaim
.... 26.123 NZ SharedCare Appointment
.... 26.124 NZ SharedCare Claim
.... 26.125 NZ SharedCare Claim Response
.... 26.126 Online GP Encounter
.... 26.127 Urgent Care Encounter
.... 26.128 NZ GP Online Encounter Example
.... 26.129 NZ Telehealth Appointment Example
.... 26.130 NZ Telehealth Claim Example
.... 26.131 NZ Telehealth Claim Response Example
.... 26.132 Shared Care FHIR Server Capability Statement
.... 26.133 Observation-flat-export
.... 26.134 RunOperation
.... 26.135 Remote Monitoring Feedback Survey
.... 26.136 Remote Monitoring Heart Failure Symptom Survey Questionnaire
.... 26.137 DHOCondition
.... 26.138 Attachment details
.... 26.139 Balance Owing
.... 26.140 Callback Url
.... 26.141 Campaign details
.... 26.142 CBS Pack Size
.... 26.143 CBS Subsidy
.... 26.144 Claimant Number
.... 26.145 Dose Flag
.... 26.146 For sms reply
.... 26.147 Group ID
.... 26.148 HNZ Patient Contact Role
.... 26.149 HNZ Person Telecom Count Shared
.... 26.150 HNZ Person Telecom Information Source
.... 26.151 HNZ Person Telecom Invalid Indicator
.... 26.152 HNZ Person Telecom Last Contacted
.... 26.153 HNZ Person Telecom Phone Type
.... 26.154 HNZ Person Telecom Score
.... 26.155 NZePS Endorsement
.... 26.156 NZePS Funding Category
.... 26.157 NZePS Script Number Local
.... 26.158 Originating Claimant Number
.... 26.159 Patient Cohort
.... 26.160 Patient Flag
.... 26.161 Prescriber Flag
.... 26.162 Prescription Flag
.... 26.163 Send to and from communication to contact points
.... 26.164 Shared Care Accident Related
.... 26.165 Shared Care Agreement Number
.... 26.166 Shared Care Claim Trace Number
.... 26.167 Shared Care CSC holder
.... 26.168 Shared Care Diagnosis Code
.... 26.169 Shared Care Patient Copayment
.... 26.170 Shared Care Product Or Service
.... 26.171 Shared Care Registration Code
.... 26.172 Shared Care Review Outcome
.... 26.173 Status DateTime
.... 26.174 Wastage Quantity
.... 26.175 Adjudication Reason Codes
.... 26.176 Adjudication Value Codes
.... 26.177 Australasian Triage Scale
.... 26.178 Claim Decision Codes
.... 26.179 Claim Decision Reason Codes
.... 26.180 Codes for Task code
.... 26.181 COVID19 vaccines recognised by NZ public health
.... 26.182 Diagnosis Use Codes
.... 26.183 Education Module ValueSet
.... 26.184 Information source when using the telecom information source extension
.... 26.185 NZ Appointment Reason Codes Code System
.... 26.186 NZ Claim Subtypes
.... 26.187 NZ Claim Types
.... 26.188 NZ purpose of use
.... 26.189 Online GP Discharge Disposition
.... 26.190 Online GP Participant Type
.... 26.191 Patient Cohort ValueSet
.... 26.192 Payment Type Codes
.... 26.193 Pharmacy Adjudication Category
.... 26.194 Provider Qualification Codes
.... 26.195 Shared Care Encounter Type Value Set
.... 26.196 Status Reason for ServiceRequest
.... 26.197 System that last updated the record
.... 26.198 Telecom phone type indicator
.... 26.199 Telecom record score indicator
.... 26.200 Valueset for Communication Delivery Status
.... 26.201 Valueset for Participation Mode
.... 26.202 ValueSet for Patient Contact Role
.... 26.203 Valueset for Template Category
.... 26.204 Adjudication Reason Code System
.... 26.205 Adjudication Value Code System
.... 26.206 Australasian Triage Scale Code System
.... 26.207 Claim Decision Code System
.... 26.208 Claim Decision Reason Code System
.... 26.209 Codes for CommunicationStatus
.... 26.210 Codes for ServiceRequest code
.... 26.211 Codes for Telecom Phone Types
.... 26.212 Codes for Telecom Score
.... 26.213 Codes for Telecom Source Systems
.... 26.214 Codes for Template category
.... 26.215 CodeSystem for Patient Contact Role
.... 26.216 Codings for COVID-19 vaccination brands recognised in New Zealand public health
.... 26.217 Education Module CodeSystem
.... 26.218 NZ Appointment Reason Codes Code System
.... 26.219 NZ Claim Subtype Code System
.... 26.220 NZ Purpose Of Use
.... 26.221 ParticipationMode
.... 26.222 Patient Cohort CodeSystem
.... 26.223 Pharmacy Adjudication Category Code System
.... 26.224 Provider Qualification Code System
.... 26.225 Status Reason for ServiceRequest
.... 26.226 AllergyIntoleranceExample
.... 26.227 BSAService
.... 26.228 DHOConditionExample
.... 26.229 GOFSH-GENERATED-ID-0
.... 26.230 New Zealand Pharmacy Claim Example
.... 26.231 ObservationFlatExportRequest
.... 26.232 ObservationFlatExportResponse
.... 26.233 RemoteMonitoringHeartFailureSymptomSurveyQuestionnaireResponse
.... 26.234 Template for COVID-19 Care in the Community CCCM MVP Careplans
.... 26.235 Urgent Care Encounter Example