Health NZ | Te Whatu Ora FHIR Screening Implementation Guide
1.0.1 - normative+trial-use New Zealand flag

Health NZ | Te Whatu Ora FHIR Screening Implementation Guide - Local Development build (v1.0.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

This page provides a list of the FHIR artifacts defined as part of this implementation guide.

Behavior: Capability Statements

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

Structures: Resource Profiles

These define constraints on FHIR resources for systems conforming to this implementation guide.

ScreeningSummaryDocument

A FHIR DocumentReference representation of a screening summary report

Terminology: Value Sets

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)

Example: Example Instances

These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.

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