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 NZ SharedCare Encounter
.... 26.127 NZ Telehealth Appointment Example
.... 26.128 NZ Telehealth Claim Example
.... 26.129 NZ Telehealth Claim Response Example
.... 26.130 NZ Telehealth Encounter Example
.... 26.131 Shared Care FHIR Server Capability Statement
.... 26.132 Observation-flat-export
.... 26.133 RunOperation
.... 26.134 Remote Monitoring Feedback Survey
.... 26.135 Remote Monitoring Heart Failure Symptom Survey Questionnaire
.... 26.136 DHOCondition
.... 26.137 Attachment details
.... 26.138 Balance Owing
.... 26.139 Callback Url
.... 26.140 Campaign details
.... 26.141 CBS Pack Size
.... 26.142 CBS Subsidy
.... 26.143 Claimant Number
.... 26.144 Dose Flag
.... 26.145 For sms reply
.... 26.146 Group ID
.... 26.147 HNZ Patient Contact Role
.... 26.148 HNZ Person Telecom Count Shared
.... 26.149 HNZ Person Telecom Information Source
.... 26.150 HNZ Person Telecom Invalid Indicator
.... 26.151 HNZ Person Telecom Last Contacted
.... 26.152 HNZ Person Telecom Phone Type
.... 26.153 HNZ Person Telecom Score
.... 26.154 NZePS Endorsement
.... 26.155 NZePS Funding Category
.... 26.156 NZePS Script Number Local
.... 26.157 Originating Claimant Number
.... 26.158 Patient Cohort
.... 26.159 Patient Flag
.... 26.160 Prescriber Flag
.... 26.161 Prescription Flag
.... 26.162 Send to and from communication to contact points
.... 26.163 Shared Care Accident Related
.... 26.164 Shared Care Agreement Number
.... 26.165 Shared Care Claim Trace Number
.... 26.166 Shared Care CSC holder
.... 26.167 Shared Care Patient Copayment
.... 26.168 Shared Care Product Or Service
.... 26.169 Shared Care Registration Code
.... 26.170 Shared Care Review Outcome
.... 26.171 Status DateTime
.... 26.172 Wastage Quantity
.... 26.173 Adjudication Reason Codes
.... 26.174 Adjudication Value Codes
.... 26.175 Australasian Triage Scale
.... 26.176 Claim Decision Codes
.... 26.177 Claim Decision Reason Codes
.... 26.178 Codes for Task code
.... 26.179 COVID19 vaccines recognised by NZ public health
.... 26.180 Diagnosis Use Codes
.... 26.181 Education Module ValueSet
.... 26.182 Information source when using the telecom information source extension
.... 26.183 NZ Appointment Reason Codes Code System
.... 26.184 NZ Claim Subtypes
.... 26.185 NZ Claim Types
.... 26.186 NZ purpose of use
.... 26.187 Patient Cohort ValueSet
.... 26.188 Payment Type Codes
.... 26.189 Pharmacy Adjudication Category
.... 26.190 Provider Qualification Codes
.... 26.191 Shared Care Encounter Type Value Set
.... 26.192 Status Reason for ServiceRequest
.... 26.193 System that last updated the record
.... 26.194 Telecom phone type indicator
.... 26.195 Telecom record score indicator
.... 26.196 Valueset for Communication Delivery Status
.... 26.197 Valueset for Participation Mode
.... 26.198 ValueSet for Patient Contact Role
.... 26.199 Valueset for Template Category
.... 26.200 Adjudication Reason Code System
.... 26.201 Adjudication Value Code System
.... 26.202 Australasian Triage Scale Code System
.... 26.203 Claim Decision Code System
.... 26.204 Claim Decision Reason Code System
.... 26.205 Codes for CommunicationStatus
.... 26.206 Codes for ServiceRequest code
.... 26.207 Codes for Telecom Phone Types
.... 26.208 Codes for Telecom Score
.... 26.209 Codes for Telecom Source Systems
.... 26.210 Codes for Template category
.... 26.211 CodeSystem for Patient Contact Role
.... 26.212 Codings for COVID-19 vaccination brands recognised in New Zealand public health
.... 26.213 Education Module CodeSystem
.... 26.214 NZ Appointment Reason Codes Code System
.... 26.215 NZ Claim Subtype Code System
.... 26.216 NZ Purpose Of Use
.... 26.217 ParticipationMode
.... 26.218 Patient Cohort CodeSystem
.... 26.219 Pharmacy Adjudication Category Code System
.... 26.220 Provider Qualification Code System
.... 26.221 Status Reason for ServiceRequest
.... 26.222 AllergyIntoleranceExample
.... 26.223 BSAService
.... 26.224 DHOConditionExample
.... 26.225 GOFSH-GENERATED-ID-0
.... 26.226 New Zealand Pharmacy Claim Example
.... 26.227 ObservationFlatExportRequest
.... 26.228 ObservationFlatExportResponse
.... 26.229 RemoteMonitoringHeartFailureSymptomSurveyQuestionnaireResponse
.... 26.230 Template for COVID-19 Care in the Community CCCM MVP Careplans