NZ Shared Digital Health Record API
1.1.3 - release

NZ Shared Digital Health Record API - Local Development build (v1.1.3) 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 SDHR Highlighted
.... 8.40 Immunization Diluent
.... 8.41 Immunization Facility Mobile Site
.... 8.42 NZePS Local Script Number
.... 8.43 NZePS Patient Instructions Modification Indicator
.... 8.44 NZePS Patient Medication Modification Indicator
.... 8.45 NZePS Status Type
.... 8.46 Planned Event Match
.... 8.47 Planned Event Match Quality
.... 8.48 ValueSet for AllergyIntolerance Code
.... 8.49 ValueSet for AllergyIntolerance Manifestation
.... 8.50 ValueSet for AllergyIntolerance Severity
.... 8.51 ValueSet for SDHR Participation Reason
.... 8.52 ValueSet for SDHR Resource Tags
.... 8.53 ValueSet for SDHR Verification Result
.... 8.54 NZ-specific terminology for Shared Digital Health Records
.... 8.55 SDHR Codes where the appropriate code is not known or can not be determined.
.... 8.56 SDHR Participation Reason Codes
.... 8.57 SDHR Specific Outcome Codes
.... 8.58 SDHR Verification Result Codes
.... 8.59 AllergyIntoleranceExample
.... 8.60 AllergyIntoleranceExample2
.... 8.61 APIError-Confidential
.... 8.62 APIError-Unauthorised
.... 8.63 AuditEventVerificationSampleOne
.... 8.64 AuditEventVerificationSampleTwo
.... 8.65 Batch-example
.... 8.66 BundleVerificationSamplesPageOneResponseExample
.... 8.67 BundleVerificationSamplesPageTwoResponseExample
.... 8.68 BundleVerificationSamplesResponseExample
.... 8.69 ConditionHypertensionExample
.... 8.70 ConditionRespiratoryExample
.... 8.71 ConsentExample
.... 8.72 ConsentExampleRecordsWithheld
.... 8.73 ConsentFacilityDenyExample
.... 8.74 ConsentHNZDenyExample
.... 8.75 ConsentMultiFacilityExample
.... 8.76 ObservationVitalSignsExample
.... 8.77 OperationOutcomeFacilityDenyExample
.... 8.78 OperationOutcomeFacilityLocked
.... 8.79 OperationOutcomeFacilityUnknown
.... 8.80 OperationOutcomeGlobalDenyExample
.... 8.81 OperationOutcomeParticipateInvalidPatient
.... 8.82 OperationOutcomeParticipateMissingReason
.... 8.83 OperationOutcomeParticipatePreferencesNotKnown
.... 8.84 OperationOutcomeParticipateSuccess
.... 8.85 OperationOutcomePatientLocked
.... 8.86 OperationOutcomeRateLimitExceeded
.... 8.87 OperationOutcomeRecordsWithheldAtSource
.... 8.88 ParametersDoNotParticipate
.... 8.89 ParametersHNZParticipateLinkedGroupOptIn
.... 8.90 ParametersHNZParticipateOptIn
.... 8.91 ParametersHNZParticipateOptOut
.... 8.92 ParametersParticipate
.... 8.93 ParametersParticipateRecordReleased
.... 8.94 ParametersParticipateRecordWithheld
.... 8.95 ParametersParticipationStatusActiveResponse
.... 8.96 ParametersParticipationStatusEnrolmentActiveResponse
.... 8.97 ParametersParticipationStatusEnrolmentResponse
.... 8.98 ParametersParticipationStatusNotParticipatingResponse
.... 8.99 ParametersParticipationStatusParticipatingResponse
.... 8.100 ParametersParticipationStatusResponse
.... 8.101 ParametersVerificationSubmissionRequestExample
.... 8.102 ParametersVerificationSubmissionResponseExample
.... 8.103 SearchConditionResponseExample
.... 8.104 SearchConfidentialRecordsResponseExample
.... 8.105 SearchExactMatchRecordWithheldExample
.... 8.106 SearchWithRecordsWithheldExample
... 9 Consent based access control
... 10 Test Data