NZ Shared Digital Health Record API
1.1.4 - release

NZ Shared Digital Health Record API - Local Development build (v1.1.4) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Table of Contents

.. 0 Table of Contents
... 1 NZ Shared Digital Health Record API
... 2 Contribute Information to SDHR
... 3 Access Information from SDHR
... 4 Data Overview
.... 4.1 Conditions
.... 4.2 Allergies & Intolerances
.... 4.3 Observations
.... 4.4 Medications
.... 4.5 Immunisations
.... 4.6 Data Models
... 5 API Documentation
... 6 Compliance Requirements - for Systems Sharing Data
... 7 Compliance Requirements - for Systems Reading Data
... 8 FHIR Artifacts
.... 8.1 NZ Shared Digital Health Record API
.... 8.2 SDHRHNZParticipateOperation
.... 8.3 SDHRHNZParticipationStatusOperation
.... 8.4 SDHRParticipateOperation
.... 8.5 SDHRParticipationStatusOperation
.... 8.6 SDHRVerificationSamplesOperation
.... 8.7 SDHRVerificationSubmissionsOperation
.... 8.8 allergyintolerance-clientlastupdated
.... 8.9 condition-clientlastupdated
.... 8.10 condition-highlighted
.... 8.11 condition-long-term-condition
.... 8.12 observation-clientlastupdated
.... 8.13 AIR Immunization
.... 8.14 Batch Bundle with a Single Patient
.... 8.15 Medication Dispense resource for use in NZ e-Prescription Service MDR
.... 8.16 Medication Request resource for use in the NZ e-Prescription Service MDR
.... 8.17 SDHRAllergyIntolerance
.... 8.18 SDHRAuditEvent
.... 8.19 SDHRCondition
.... 8.20 SDHRConsent
.... 8.21 SDHRImmunization
.... 8.22 SDHRMedicationDispense
.... 8.23 SDHRMedicationRequest
.... 8.24 SDHRObservation
.... 8.25 SDHRVerificationSubmissionParameters
.... 8.26 SDHRVerificationSubmissionResponseParameters
.... 8.27 AIR Administered Product Extension
.... 8.28 AIR Age Given Extension
.... 8.29 AIR Created By User
.... 8.30 AIR Created Source System
.... 8.31 AIR Modified By User
.... 8.32 AIR Modified Source System
.... 8.33 AIR Related Person
.... 8.34 AIR Reschedule Date Extension
.... 8.35 AIR Serology Report Extension
.... 8.36 Client Last Updated
.... 8.37 Data Quality Assessment
.... 8.38 Facility Participation
.... 8.39 HNZ Global Opt Out Reason
.... 8.40 HNZ SDHR Highlighted
.... 8.41 Immunization Diluent
.... 8.42 Immunization Facility Mobile Site
.... 8.43 NZePS Local Script Number
.... 8.44 NZePS Patient Instructions Modification Indicator
.... 8.45 NZePS Patient Medication Modification Indicator
.... 8.46 NZePS Status Type
.... 8.47 Planned Event Match
.... 8.48 Planned Event Match Quality
.... 8.49 ValueSet for AllergyIntolerance Code
.... 8.50 ValueSet for AllergyIntolerance Manifestation
.... 8.51 ValueSet for AllergyIntolerance Severity
.... 8.52 ValueSet for HNZ Global Opt Out Reason
.... 8.53 ValueSet for SDHR Participation Reason
.... 8.54 ValueSet for SDHR Resource Tags
.... 8.55 ValueSet for SDHR Verification Result
.... 8.56 HNZ Global Opt Out Reason Codes
.... 8.57 NZ-specific terminology for Shared Digital Health Records
.... 8.58 SDHR Codes where the appropriate code is not known or can not be determined.
.... 8.59 SDHR Participation Reason Codes
.... 8.60 SDHR Specific Outcome Codes
.... 8.61 SDHR Verification Result Codes
.... 8.62 AllergyIntoleranceExample
.... 8.63 AllergyIntoleranceExample2
.... 8.64 APIError-Confidential
.... 8.65 APIError-Unauthorised
.... 8.66 AuditEventVerificationSampleOne
.... 8.67 AuditEventVerificationSampleTwo
.... 8.68 Batch-example
.... 8.69 BundleVerificationSamplesPageOneResponseExample
.... 8.70 BundleVerificationSamplesPageTwoResponseExample
.... 8.71 BundleVerificationSamplesResponseExample
.... 8.72 ConditionHypertensionExample
.... 8.73 ConditionRespiratoryExample
.... 8.74 ConsentExample
.... 8.75 ConsentExampleRecordsWithheld
.... 8.76 ConsentFacilityDenyExample
.... 8.77 ConsentHNZDenyExample
.... 8.78 ConsentMultiFacilityExample
.... 8.79 HIP external reference targets (technical stubs)
.... 8.80 ObservationVitalSignsExample
.... 8.81 OperationOutcomeFacilityDenyExample
.... 8.82 OperationOutcomeFacilityLocked
.... 8.83 OperationOutcomeFacilityUnknown
.... 8.84 OperationOutcomeGlobalDenyExample
.... 8.85 OperationOutcomeParticipateInvalidPatient
.... 8.86 OperationOutcomeParticipateMissingReason
.... 8.87 OperationOutcomeParticipatePreferencesNotKnown
.... 8.88 OperationOutcomeParticipateSuccess
.... 8.89 OperationOutcomeParticipationStatusInvalidPatient
.... 8.90 OperationOutcomePatientLocked
.... 8.91 OperationOutcomeRateLimitExceeded
.... 8.92 OperationOutcomeRecordsWithheldAtSource
.... 8.93 ParametersDoNotParticipate
.... 8.94 ParametersHNZParticipateLinkedGroupOptIn
.... 8.95 ParametersHNZParticipateOptIn
.... 8.96 ParametersHNZParticipateOptOut
.... 8.97 ParametersHNZParticipateOptOutDeceased
.... 8.98 ParametersHNZParticipateOptOutImportedExternalConsent
.... 8.99 ParametersParticipate
.... 8.100 ParametersParticipateRecordReleased
.... 8.101 ParametersParticipateRecordWithheld
.... 8.102 ParametersParticipationStatusActiveResponse
.... 8.103 ParametersParticipationStatusEnrolmentActiveResponse
.... 8.104 ParametersParticipationStatusEnrolmentResponse
.... 8.105 ParametersParticipationStatusNotParticipatingResponse
.... 8.106 ParametersParticipationStatusParticipatingResponse
.... 8.107 ParametersParticipationStatusRequest
.... 8.108 ParametersParticipationStatusResponse
.... 8.109 ParametersVerificationSubmissionRequestExample
.... 8.110 ParametersVerificationSubmissionResponseExample
.... 8.111 SearchConditionResponseExample
.... 8.112 SearchConfidentialRecordsResponseExample
.... 8.113 SearchExactMatchRecordWithheldExample
.... 8.114 SearchWithRecordsWithheldExample
... 9 Consent based access control
... 10 Test Data