  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 SDHRHNZDomainParticipateOperation |
| 8.3 SDHRHNZParticipateOperation |
| 8.4 SDHRHNZParticipationStatusOperation |
| 8.5 SDHRParticipateOperation |
| 8.6 SDHRParticipationStatusOperation |
| 8.7 SDHRVerificationSamplesOperation |
| 8.8 SDHRVerificationSubmissionsOperation |
| 8.9 allergyintolerance-clientlastupdated |
| 8.10 condition-clientlastupdated |
| 8.11 condition-highlighted |
| 8.12 condition-long-term-condition |
| 8.13 observation-clientlastupdated |
| 8.14 AIR Immunization |
| 8.15 Batch Bundle with a Single Patient |
| 8.16 Medication Dispense resource for use in NZ e-Prescription Service MDR |
| 8.17 Medication Request resource for use in the NZ e-Prescription Service MDR |
| 8.18 SDHRAllergyIntolerance |
| 8.19 SDHRAuditEvent |
| 8.20 SDHRCondition |
| 8.21 SDHRConsent |
| 8.22 SDHRImmunization |
| 8.23 SDHRMedicationDispense |
| 8.24 SDHRMedicationRequest |
| 8.25 SDHRObservation |
| 8.26 SDHRVerificationSubmissionParameters |
| 8.27 SDHRVerificationSubmissionResponseParameters |
| 8.28 AIR Administered Product Extension |
| 8.29 AIR Age Given Extension |
| 8.30 AIR Created By User |
| 8.31 AIR Created Source System |
| 8.32 AIR Modified By User |
| 8.33 AIR Modified Source System |
| 8.34 AIR Related Person |
| 8.35 AIR Reschedule Date Extension |
| 8.36 AIR Serology Report Extension |
| 8.37 Client Last Updated |
| 8.38 Data Quality Assessment |
| 8.39 Domain Participation Last Updated |
| 8.40 Facility Participation |
| 8.41 HNZ Global Opt Out Reason |
| 8.42 HNZ SDHR Highlighted |
| 8.43 Immunization Diluent |
| 8.44 Immunization Facility Mobile Site |
| 8.45 NZePS Item Status |
| 8.46 NZePS Local Script Number |
| 8.47 NZePS Patient Instructions Modification Indicator |
| 8.48 NZePS Patient Medication Modification Indicator |
| 8.49 NZePS Status Type |
| 8.50 Planned Event Match |
| 8.51 Planned Event Match Quality |
| 8.52 SDHR Data Domains |
| 8.53 ValueSet for AllergyIntolerance Code |
| 8.54 ValueSet for AllergyIntolerance Manifestation |
| 8.55 ValueSet for AllergyIntolerance Severity |
| 8.56 ValueSet for HNZ Global Opt Out Reason |
| 8.57 ValueSet for SDHR Participation Reason |
| 8.58 ValueSet for SDHR Resource Tags |
| 8.59 ValueSet for SDHR Verification Result |
| 8.60 ValueSet for SDHR Verification Submission Status |
| 8.61 HNZ Global Opt Out Reason Codes |
| 8.62 NZ-specific terminology for Shared Digital Health Records |
| 8.63 SDHR Codes where the appropriate code is not known or can not be determined. |
| 8.64 SDHR Data Domains |
| 8.65 SDHR Participation Reason Codes |
| 8.66 SDHR Specific Outcome Codes |
| 8.67 SDHR Verification Result Codes |
| 8.68 SDHR Verification Submission Status Codes |
| 8.69 AllergyIntoleranceExample |
| 8.70 AllergyIntoleranceExample2 |
| 8.71 APIError-Confidential |
| 8.72 APIError-Unauthorised |
| 8.73 AuditEventVerificationSampleOne |
| 8.74 AuditEventVerificationSampleTwo |
| 8.75 Batch-example |
| 8.76 BundleVerificationSamplesEmptyResponseExample |
| 8.77 BundleVerificationSamplesPageOneResponseExample |
| 8.78 BundleVerificationSamplesPageTwoResponseExample |
| 8.79 BundleVerificationSamplesResponseExample |
| 8.80 ConditionHypertensionExample |
| 8.81 ConditionRespiratoryExample |
| 8.82 HIP external reference targets (technical stubs) |
| 8.83 ObservationVitalSignsExample |
| 8.84 OperationOutcomeDomainDeny |
| 8.85 OperationOutcomeFacilityDenyExample |
| 8.86 OperationOutcomeFacilityLocked |
| 8.87 OperationOutcomeFacilityUnknown |
| 8.88 OperationOutcomeGlobalDenyDeceasedExample |
| 8.89 OperationOutcomeGlobalDenyExample |
| 8.90 OperationOutcomeMedicationFacilityOptOut |
| 8.91 OperationOutcomeParticipateInvalidPatient |
| 8.92 OperationOutcomeParticipateLoadScheduled |
| 8.93 OperationOutcomeParticipateMissingReason |
| 8.94 OperationOutcomeParticipatePreferencesNotKnown |
| 8.95 OperationOutcomeParticipateSuccess |
| 8.96 OperationOutcomeParticipationStatusInvalidPatient |
| 8.97 OperationOutcomePatientLocked |
| 8.98 OperationOutcomeRateLimitExceeded |
| 8.99 OperationOutcomeRecordsWithheldAtSource |
| 8.100 ParametersDoNotParticipate |
| 8.101 ParametersHNZDomainChoices |
| 8.102 ParametersHNZDomainOptOff |
| 8.103 ParametersHNZParticipateLinkedGroupOptIn |
| 8.104 ParametersHNZParticipateOptIn |
| 8.105 ParametersHNZParticipateOptOut |
| 8.106 ParametersHNZParticipateOptOutDeceased |
| 8.107 ParametersHNZParticipateOptOutImportedExternalConsent |
| 8.108 ParametersParticipate |
| 8.109 ParametersParticipateRecordReleased |
| 8.110 ParametersParticipateRecordWithheld |
| 8.111 ParametersParticipationStatusActiveResponse |
| 8.112 ParametersParticipationStatusEnrolmentActiveResponse |
| 8.113 ParametersParticipationStatusEnrolmentResponse |
| 8.114 ParametersParticipationStatusNotParticipatingResponse |
| 8.115 ParametersParticipationStatusParticipatingResponse |
| 8.116 ParametersParticipationStatusRequest |
| 8.117 ParametersParticipationStatusResponse |
| 8.118 ParametersVerificationSubmissionRepeatedResponseExample |
| 8.119 ParametersVerificationSubmissionRequestExample |
| 8.120 ParametersVerificationSubmissionResponseExample |
| 8.121 SearchConditionResponseExample |
| 8.122 SearchConfidentialRecordsResponseExample |
| 8.123 SearchExactMatchRecordWithheldExample |
| 8.124 SearchWithRecordsWithheldExample |
| 9 Consent based access control |
| 10 Postman Onboarding |
| 11 Test Data |
