Health NZ | Te Whatu Ora FHIR Screening Implementation Guide
1.0.2 - normative+trial-use
Health NZ | Te Whatu Ora FHIR Screening Implementation Guide
1.0.2 - normative+trial-use
Health NZ | Te Whatu Ora FHIR Screening Implementation Guide - Local Development build (v1.0.2) 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.
| National Screening FHIR API Capability Statement |
National Screening FHIR API |
These define forms used by systems conforming to this implementation guide to capture or expose data to end users.
| Information Access and Use Agreement - End Users |
Captures acceptance of Terms Of Use by NZ health practitioners accessing screening information |
| Information Access and Use Agreement - Health and Disability Services Provider. |
Captures acceptance of Terms Of Use by an NZ health organisation (where practitioners will access screening information) |
These define constraints on FHIR resources for systems conforming to this implementation guide.
| ScreeningSummaryDocument |
A FHIR DocumentReference representation of a screening summary report |
These define sets of codes used by systems conforming to this implementation guide.
| Codes (mime types) for encoding of attachments in NZ screening summary documents |
This value set filters the supported document attachment/reference mime types used in an NZ screening summary report |
| Codes for categorization of NZ types of screening programme |
This value set draws on SNOMED preventive service terms to define the valid codes for NZ screening programme types (used in DocumentReference.category) |
These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.
| APIError-CompleteTermsOfUseForm |
Public API response when it has determined a Practitioner needs to accept Terms of Use |
| APIError-InvalidHPI |
Public API response when Request-Context set by PMS/API consumer contains a Practitioner that is not valid |
| APIError-InvalidHPIOrganisation |
Public API response when Request-Context set by PMS/API consumer contains an Organisation that is not valid |
| APIError-MissingOrgFacilityToU |
Public API response when no Terms of Use acceptance record was found for the health organisation |
| APIError-Unauthorised |
Access to cervical screening summary documents is restricted.<br>
This API uses informaton that is held in the Health Practitioner Index (HPI) in order to validate information that is provided by
the API Consumer in their |
| CervicalScreeningSummary |
Cervical screening summary as HTML doc with participant information including screening history |
| CervicalScreeningSummary-DeceasedWithScreeningHistory |
Sample cervical screening summary for deceased person with screening history |
| CervicalScreeningSummary-ParticipantOnly |
Cervical screening summary as HTML doc with participant information (no screening history) |
| CervicalScreeningSummaryPDF |
Cervical screening summary with PDF-encoded document sample content |
| DocumentReferenceExample1 |
Example DocumentReference content - contains pdf and html |
| DocumentReferenceWithSubjectExample |
Example DocumentReference search response using the '_include' parameter to return Patient demographics |
| HTMLSearchResponse |
Example DocumentReference search response returning HTML formatted screening summary. |
| HTMLSearchResponseWithSubject |
Example DocumentReference search response returning HTML formatted screening summary using the '_include' parameter to return Patient demographics. |
| KassandraTemahoe |
Example screening subject who is gender-diverse (female at birth), Māori ethnicity |
| MadeleineMeringue |
Example of a female screening participant who is NZ European ethnicity |
| SearchResponse-DeceasedFullReportNoOutcome |
Example of search response returning HTML screening summary document for a deceased person |
| SearchResponse-FullReportNoOutcome |
Example of response to search returning an HTML screening summary document |
| SearchResponse-NoMatchOneOutcome |
Example of search response Bundle with #match entries but an outcome that imagines a patient withdrawn from the programme |
| SearchResponse-ParticipantInfoOnlyWithOutcome |
Example of response to search for dormant NHI where there is participant info and an outcome message |