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

Health New Zealand Te Whatu Ora Shared Care FHIR API - Local Development build (v0.4.1) 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 Extensions
... 13 Faq
... 14 Fhir Consent
... 15 Flat Data Views
... 16 Health Checks
... 17 History
... 18 In Home Observations
... 19 Initial Assesment
... 20 Outreach Referrals
... 21 Outreach Use Cases
... 22 Remote Patient Monitoring
... 23 Roadmap
... 24 Artifacts Summary
.... 24.1 Care In The Community ActivityDefinition Apply Operation
.... 24.2 Care In The Community PlanDefinition Apply Operation
.... 24.3 Care In The Community QuestionnaireResponse Extract Operation
.... 24.4 CommunicationPerson
.... 24.5 ManaakiNgaTahiAllergyIntolerance
.... 24.6 ManaakiNgaTahiCarePlan
.... 24.7 ManaakiNgaTahiCondition
.... 24.8 ManaakiNgaTahiDocumentReference
.... 24.9 ManaakiNgaTahiEncounter
.... 24.10 ManaakiNgaTahiObservation
.... 24.11 ManaakiNgaTahiPlanDefinition
.... 24.12 ManaakiNgaTahiServiceRequest
.... 24.13 ServiceRequestActivityDefinition
.... 24.14 Template for COVID-19 Care in the Community CCCM MVP Careplans
.... 24.15 Vital Signs Observation Service Request
.... 24.16 AIR - Overseas, Historic, Not Done
.... 24.17 Antiviral medication eligibility questionnaire
.... 24.18 COVID-19 RAT Result Questionnaire
.... 24.19 COVID19 Initial Health Assessment Questionnaire
.... 24.20 COVID19 Public Health History Questionnaire
.... 24.21 COVID19 Vaccination Side Effects Questionnaire
.... 24.22 Measles Daily Health Check
.... 24.23 Mental Health Assessment Survey
.... 24.24 Post Vaccine Symptom Check day 3 survey
.... 24.25 Post Vaccine Symptom Check day 42 survey
.... 24.26 Pregnancy Assessment Survey
.... 24.27 Private Colposcopy Did Not Attend Questionnaire
.... 24.28 Private Colposcopy Discharge Questionnaire
.... 24.29 Private Colposcopy Referral Summary Questionnaire
.... 24.30 Private Colposcopy Visit Summary Questionnaire
.... 24.31 Question Template for COVID-19 Regular Health Check
.... 24.32 Report a Rapid Antigen Test (RAT) result
.... 24.33 ActiveMonitoringDay3SurveyQuestionnaireResponse
.... 24.34 ActiveMonitoringDay42SurveyQuestionnaireResponse
.... 24.35 AntiviralEligibilityNoQuestionnaireResponse
.... 24.36 AntiviralEligibilityYesQuestionnaireResponse
.... 24.37 ConsumerCOVIDRATResultQuestionnaireResponse
.... 24.38 COVIDInitialHealthAssessmentQuestionnaireResponse
.... 24.39 COVIDPublicHealthHistoryQuestionnaireResponseSherrylCarrion
.... 24.40 COVIDRATResultQuestionnaireResponse
.... 24.41 COVIDRegularHealthCheckQuestionnaireResponse
.... 24.42 COVIDVaccinationSurveyQuestionnaireResponse
.... 24.43 ImmsotVaccinationDataEntryQuestionnaireResponse
.... 24.44 MeaslesHealthCheckQuestionnaireResponse
.... 24.45 MentalHealthAssessmentSurveyQuestionnaireResponse
.... 24.46 PregnancyAssessmentSurveyQuestionnaireResponse
.... 24.47 CareyCarrington
.... 24.48 ConditionExample
.... 24.49 COVID-19 Omicron Response - Carey Carrington
.... 24.50 DocumentReferenceExample
.... 24.51 DrDottyMcStuffins
.... 24.52 EncounterExample
.... 24.53 ObservationExample
.... 24.54 ObservationsServiceRequestExample
.... 24.55 NIBSCommunicationPersonExample
.... 24.56 WhaihuaCommunicationPersonExample
.... 24.57 CMS Communication
.... 24.58 CMS Communication Request
.... 24.59 Record Of all healthcare services
.... 24.60 Record of Template for Email Communication from Any Healthcare System
.... 24.61 EmailCommunicationRequestWithoutTemplateExample
.... 24.62 EmailCommunicationRequestWithTemplateExample
.... 24.63 SMSCommunicationRequestWithoutTemplateExample
.... 24.64 SMSCommunicationRequestWithTemplateExample
.... 24.65 EmailCommunicationExample
.... 24.66 OutreachCommunicationExample
.... 24.67 SMSCommunicationExample
.... 24.68 EmailCommunicationTemplateExample
.... 24.69 ActiveConsentExample
.... 24.70 ConsentByQuestionnaireExample
.... 24.71 ConsentByRelatedPersonExample
.... 24.72 ConsentExample
.... 24.73 ConsentQuestionnaireResponseExample
.... 24.74 ManaakiNgaTahiConsent
.... 24.75 ProvisionalConsentExample
.... 24.76 Question Template for COVID-19 Privacy Statement Question
.... 24.77 OutreachServiceRequest
.... 24.78 OutreachTask
.... 24.79 OutreachServiceRequestExample
.... 24.80 OutreachTaskExample
.... 24.81 Template for Remote Monitoring Cardiac Rehab Care Plan
.... 24.82 Template for Remote Monitoring Heart Failure Care Plan
.... 24.83 Vital Signs Observation Service Request
.... 24.84 Educational Content Delivery Task
.... 24.85 RPMCardiacRehabCarePlanExample
.... 24.86 RPMCareTeamExample
.... 24.87 RPMConsentExample
.... 24.88 RPMObservationExample
.... 24.89 RPMObservationServiceRequestExample
.... 24.90 RPMPatientOnboardingCommunicationRequest
.... 24.91 New Zealand Pharmacy Claim Response
.... 24.92 NZ Medication Dispense
.... 24.93 NZ Medication Request
.... 24.94 NZ Pharmacy Claim
.... 24.95 HSAAPAdjudicatedClaimResponse
.... 24.96 New Zealand Pharmacy Claim Response Example
.... 24.97 PharmacySubmittedClaim
.... 24.98 NZ SharedCare Appointment
.... 24.99 NZ SharedCare Encounter
.... 24.100 NZ Telehealth Claim
.... 24.101 NZ Telehealth Claim Response
.... 24.102 NZ Telehealth Appointment Example
.... 24.103 NZ Telehealth Claim Example
.... 24.104 NZ Telehealth Claim Response Example
.... 24.105 NZ Telehealth Encounter Example
.... 24.106 Shared Care FHIR Server Capability Statement
.... 24.107 RunOperation
.... 24.108 Remote Monitoring COPD Survey
.... 24.109 Remote Monitoring Feedback Survey
.... 24.110 Remote Monitoring Heart Failure Symptom Survey Questionnaire
.... 24.111 Record of Engagement with a Remote Patient Monitoring Education Module
.... 24.112 Accident Related
.... 24.113 Attachment details
.... 24.114 Balance Owing
.... 24.115 Callback Url
.... 24.116 Campaign details
.... 24.117 CBS Pack Size
.... 24.118 CBS Subsidy
.... 24.119 Claimant Number
.... 24.120 CSC Number
.... 24.121 Dose Flag
.... 24.122 For sms reply
.... 24.123 Group ID
.... 24.124 HNZ Person Telecom Count Shared
.... 24.125 HNZ Person Telecom Information Source
.... 24.126 HNZ Person Telecom Invalid Indicator
.... 24.127 HNZ Person Telecom Last Contacted
.... 24.128 HNZ Person Telecom Phone Type
.... 24.129 HNZ Person Telecom Score
.... 24.130 Item Tax
.... 24.131 NZePS Endorsement
.... 24.132 NZePS Funding Category
.... 24.133 NZePS Script Number Local
.... 24.134 Originating Claimant Number
.... 24.135 Patient Cohort
.... 24.136 Patient Flag
.... 24.137 Patient Paid Amount
.... 24.138 Prescriber Flag
.... 24.139 Prescription Flag
.... 24.140 Product Or Service
.... 24.141 Registration Code
.... 24.142 Remote Patient Monitoring Education Module Extension
.... 24.143 Review Outcome
.... 24.144 Send to and from communication to contact points
.... 24.145 Status DateTime
.... 24.146 Trace Number
.... 24.147 Triage Category
.... 24.148 Wastage Quantity
.... 24.149 Adjudication Reason Codes
.... 24.150 Adjudication Value Codes
.... 24.151 Australasian Triage Scale
.... 24.152 Claim Care Team Role Codes
.... 24.153 Claim Decision Codes
.... 24.154 Claim Decision Reason Codes
.... 24.155 Codes for Task code
.... 24.156 COVID19 vaccines recognised by NZ public health
.... 24.157 Diagnosis Use Codes
.... 24.158 Education Module ValueSet
.... 24.159 Information source when using the telecom information source extension
.... 24.160 NZ Claim Subtypes
.... 24.161 NZ Claim Types
.... 24.162 NZ purpose of use
.... 24.163 Patient Cohort ValueSet
.... 24.164 Payment Type Codes
.... 24.165 Pharmacy Adjudication Category
.... 24.166 Provider Qualification Codes
.... 24.167 Status Reason for ServiceRequest
.... 24.168 System that last updated the record
.... 24.169 Telecom phone type indicator
.... 24.170 Telecom record score indicator
.... 24.171 Valueset for Communication Delivery Status
.... 24.172 Valueset for Participation Mode
.... 24.173 Valueset for Template Category
.... 24.174 Australasian Triage Scale Code System
.... 24.175 Claim Care Team Role Code System
.... 24.176 Claim Decision Code System
.... 24.177 Claim Decision Reason Code System
.... 24.178 Codes for CommunicationStatus
.... 24.179 Codes for ServiceRequest code
.... 24.180 Codes for Telecom Phone Types
.... 24.181 Codes for Telecom Score
.... 24.182 Codes for Telecom Source Systems
.... 24.183 Codes for Template category
.... 24.184 Codings for COVID-19 vaccination brands recognised in New Zealand public health
.... 24.185 Education Module CodeSystem
.... 24.186 NZ Claim Subtype Code System
.... 24.187 NZ Claim Type Code System
.... 24.188 NZ Purpose Of Use
.... 24.189 ParticipationMode
.... 24.190 Patient Cohort CodeSystem
.... 24.191 Pharmacy Adjudication Category Code System
.... 24.192 Status Reason for ServiceRequest
.... 24.193 AllergyIntoleranceExample
.... 24.194 BSAService
.... 24.195 GOFSH-GENERATED-ID-0
.... 24.196 New Zealand Pharmacy Claim Example
.... 24.197 Remote Patient Monitoring Educational Content Feedback Survey/Questionnaire
.... 24.198 RemoteMonitoringHeartFailureSymptomSurveyQuestionnaireResponse
.... 24.199 RPMEducationCompletionExample
.... 24.200 Template for COVID-19 Care in the Community CCCM MVP Careplans