NZ Shared Digital Health Record API
0.5.0 - ballot
NZ Shared Digital Health Record API
0.5.0 - ballot
NZ Shared Digital Health Record API - Local Development build (v0.5.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Contents:
This page provides a list of the FHIR artifacts defined as part of this implementation guide.
The following artifacts define the specific capabilities that different types of systems are expected to have in order to comply with this implementation guide. Systems conforming to this implementation guide are expected to declare conformance to one or more of the following capability statements.
| NZ Shared Digital Health Record API |
NZ Shared Digital Health Record API |
These are custom operations that can be supported by and/or invoked by systems conforming to this implementation guide.
| SDHRParticipateOperation |
This operation allows a patient to choose to participate in the Shared Digital Health Record service. It can be used to indicate whether the patient wishes to participate, whether any resources are withheld, and the reason for participation. Examples where this operation might be used include:
|
These define constraints on FHIR resources for systems conforming to this implementation guide.
| SDHRAllergyIntolerance |
AllergyIntolerance FHIR resource for Shared Digital Health Record |
| SDHRCondition |
Condition resource to record problems and conditions affecting a person |
| SDHRConsent |
Consent resource created to reflect a patient has agreed to share their information with authorised health workers, originating from a practice management system For more detail on how this resource is used, see the consent based access control page. |
| SDHREncounter |
Encounter resource to record an instance of an interaction between patient and healthcare provider |
| SDHRObservation |
A Shared Digital Health Record Observation. |
These define constraints on FHIR data types for systems conforming to this implementation guide.
| Client Last Updated |
Extension to record the last time a resource was updated by the source system. When consuming applications are writing data to the SDHR API they can use this extension to record the |
| HNZ SDHR Highlighted |
Extension to indicate that a resource should be highlighted in the user interface. This is used to indicate that the resource is important and should be highlighted in a user interface. |
These define sets of codes used by systems conforming to this implementation guide.
| ValueSet for AllergyIntolerance Manifestation |
| ValueSet for AllergyIntolerance Severity |
| ValueSet for EncounterStatus |
| ValueSet for SDHR Participation Reason |
| ValueSet for SDHR Resource Tags |
These define new code systems used by systems conforming to this implementation guide.
| NZ-specific terminology for Shared Digital Health Records |
This system defines standard codes used throughout this Implementation Guide for New Zealand Shared Digital Health Records |
| SDHR Codes where the appropriate code is not known or can not be determined. | |
| SDHR Participation Reason Codes |
These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.
| APIError-Confidential |
Example OperationOutcome API response, returned when a resource has been flagged as confidential, and so cannot be accessed. |
| APIError-Unauthorised |
Access to Shared Digital Health Records is restricted.<br>
This API validates information that is provided by the API Consumer in their |
| AllergyIntoleranceExample |
An example payload for a Primary Care AllergyIntolerance resource indicating an allergy to Penicillin, with a confidentiality of restricted. |
| AllergyIntoleranceExample2 |
An example payload for a Primary Care AllergyIntolerance resource indicating an allergy to Cashew nuts |
| ConditionSearchResponseExample |
Example of a search response for a condition search. In this case the search response returns one result using the search parameters |
| ConfidentialRecordsSearchResponseExample |
Example of a searchset API response for an AllergyIntolerance resource search. In this case, the search response returns one entry item, with a total count of 2. This is because the API will not return the confidential record. The redacted security label is applied to the Bundle response, to indicate that confidential records have been removed from the result set. See the API documentation for more information. |
| DoNotParticipateParameters |
Example parameters content to POST to the Participate operation where a patient does not wish to participate in the Shared Digital Health Record service. |
| HypertensionConditionExample |
Example Hypertension Condition |
| ObservationVitalSignsExample |
An example SDHR Vital Signs Observation |
| RecordsWithheldParticipateParameters |
Example parameters content to POST to the Participate operation where a patient has individual records that are withheld - e.g. records marked as |
| RespiratoryConditionExample |
Example Respiratory Condition |
| SDHRConsentExample |
Consent example submitted to allow a patient to opt in to sharing their information, originating from a practice management system |
| SDHREncounterExample |
Example Encounter resource to record an instance of an interaction between patient and healthcare provider |