NZ Shared Digital Health Record API
1.0.0 - release

NZ Shared Digital Health Record API, published by Health New Zealand. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/tewhatuora/fhir-sdhr/ and changes regularly. See the Directory of published versions

Table of Contents

.. 0 Table of Contents
... 1 NZ Shared Digital Health Record API
... 2 Use cases
... 3 Consent based access control
... 4 FHIR Artifacts
.... 4.1 NZ Shared Digital Health Record API
.... 4.2 SDHRHNZParticipateOperation
.... 4.3 SDHRParticipateOperation
.... 4.4 condition-highlighted
.... 4.5 condition-long-term-condition
.... 4.6 Batch Bundle with a Single Patient
.... 4.7 SDHRAllergyIntolerance
.... 4.8 SDHRCondition
.... 4.9 SDHRConsent
.... 4.10 SDHRObservation
.... 4.11 Client Last Updated
.... 4.12 Facility Participation
.... 4.13 HNZ SDHR Highlighted
.... 4.14 ValueSet for AllergyIntolerance Code
.... 4.15 ValueSet for AllergyIntolerance Manifestation
.... 4.16 ValueSet for AllergyIntolerance Severity
.... 4.17 ValueSet for SDHR Participation Reason
.... 4.18 ValueSet for SDHR Resource Tags
.... 4.19 NZ-specific terminology for Shared Digital Health Records
.... 4.20 SDHR Codes where the appropriate code is not known or can not be determined.
.... 4.21 SDHR Participation Reason Codes
.... 4.22 SDHR Specific Outcome Codes
.... 4.23 AllergyIntoleranceExample
.... 4.24 AllergyIntoleranceExample2
.... 4.25 APIError-Confidential
.... 4.26 APIError-Unauthorised
.... 4.27 Batch-example
.... 4.28 ConditionHypertensionExample
.... 4.29 ConditionRespiratoryExample
.... 4.30 ConsentExample
.... 4.31 ConsentExampleRecordsWithheld
.... 4.32 ConsentFacilityDenyExample
.... 4.33 ConsentHNZDenyExample
.... 4.34 ConsentMultiFacilityExample
.... 4.35 ObservationVitalSignsExample
.... 4.36 OperationOutcomeFacilityDenyExample
.... 4.37 OperationOutcomeFacilityLocked
.... 4.38 OperationOutcomeFacilityUnknown
.... 4.39 OperationOutcomeGlobalDenyExample
.... 4.40 OperationOutcomeParticipateInvalidPatient
.... 4.41 OperationOutcomeParticipateMissingReason
.... 4.42 OperationOutcomeParticipatePreferencesNotKnown
.... 4.43 OperationOutcomeParticipateSuccess
.... 4.44 OperationOutcomePatientLocked
.... 4.45 OperationOutcomeRateLimitExceeded
.... 4.46 OperationOutcomeRecordsWithheldAtSource
.... 4.47 ParametersDoNotParticipate
.... 4.48 ParametersHNZParticipateOptIn
.... 4.49 ParametersHNZParticipateOptOut
.... 4.50 ParametersParticipate
.... 4.51 ParametersParticipateRecordReleased
.... 4.52 ParametersParticipateRecordWithheld
.... 4.53 SearchConditionResponseExample
.... 4.54 SearchConfidentialRecordsResponseExample
.... 4.55 SearchExactMatchRecordWithheldExample
.... 4.56 SearchWithRecordsWithheldExample
... 5 Compliance Requirements - for Systems Sharing Data
... 6 Data Models
... 7 API Docs
... 8 Test Data