New Zealand Rheumatic Fever FHIR Implementation Guide
1.0.0 - draft

New Zealand Rheumatic Fever FHIR Implementation Guide, published by Te Whatu Ora. 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-rheumatic-fever/ and changes regularly. See the Directory of published versions

Fhir Consent

This page describes how FHIR API-integrated applications can represent the two common forms of patient consent commonly sought in NZ health scenarios:

  1. Consent to collect patient information and share with other health NZ providers/practitioners through the FHIR API, and
  2. Consent to receive NZ health treatment or services.

Organisations providing health services, or collecting health information for the purpose of providing/coordinating health services, are required to obtain patient consent by NZ law and health policies. How those organisations actually obtain consent from the patient varies according to the processes each organisation uses, and these processes are external to Health New Zealand's FHIR API capability at present.

In the current period of adoption of FHIR APIs for health information interchange, it is assumed that official records of consent continue to be held in repositories of documentation specific to the organisations and the processes they operate. That is, FHIR consent representation, while necessary to share consent status easily through the sector as well as allow access control, is not the official record of patient consent.

The FHIR Consent representation described here allows for practical consideration that a patient's information may need to be appear in FHIR before their consent has been obtained. In rheumatic fever coordination, for example, patients are registered but sometimes not seen until a treatment appointment which is the first opportunity for them to sign a consent form.

To handle these scenarios, the FHIR API supports Consent instances created in a #proposed status, representing a provisional assumption of consent. Custodians can later convert such instances to #active status when consent is officially obtained.

When a patient declines to give their consent this may mean they have opted out of information collection/sharing or receiving treatment. FHIR supports both forms of consent using the two Consent scopes data-privacy and treatment.

Custodianship of patient health data

The organisation that collects patient information is the custodian of that data and organises creation of the corresponding FHIR Consents. The custodian org may or may not provide treatment but for FHIR representation, the key thing is that the party responsible for the patient data must be identified in the organisation element of the Consent instance. Organisation references should be formed using HPI organisation identifiers.

If management of a patient's information transfers to another organisation, the custodian organisation must be updated in Consent instances for that patient.


FHIR Consent instances for confirmed patient consentRepresentation of consent when confirmed by patient's signed formPatient data covered by data access provision3Consent to treatment:CONSENTstatus:#ACTIVEscope:#treatmentpolicy: reference to regs/leg.treatment provisiontype:#PERMITperiod:2023-01-21to2026-01-20Consent to collect/share data:CONSENTstatus:#ACTIVEscope:#patient-privacypolicy: reference to regs/leg.data access provisiontype:#PERMITperiod:2023-01-21to2026-01-20«logical reference»NHI patient:PATIENTlogical id: NHI«logical reference»Data custodian org:ORGANIZATIONHPI Org Id:GnXnnnplanned appointments, etc.:CAREPLAN meta.tag:#rf-nzcondition severity and specifics:CONDITION meta.tag:#rf-nzappointments:ENCOUNTER                                meta.tag:#rf-nzpreferences, health assessments:QUESTIONNAIRERESPONSE meta.tag:#rf-nzdiagnosis detail:OBSERVATION                          meta.tag:#rf-nz.provision.data.reference.patient2.organizationHPI org. ref1.patient.provision.organizationHPI org. ref1Notes1.Consent.organizationidentifies which org is custodian of the patient data.2. Consent instances identify the data subject in.patientreferences.3. FHIR resource instances with patient data tagged for access scoping eg. #rf-nz for rheumatic feverHealth NZ/Te Whatu Ora. FHIR data model generated on 26/09/2024



FHIR Consent instance data - on-behalf consentRepresentation of patient consent when given on behalf by a related personPatient data covered by data access provision3Consent to treatment:CONSENTstatus:#ACTIVEscope:#treatmentpolicy: reference to regs/leg.treatment provisiontype:#PERMITperiod:2023-01-21to2026-01-20Consent to collect/share data:CONSENTstatus:#ACTIVEscope:#patient-privacypolicy: reference to regs/leg.data access provisiontype:#PERMITperiod:2023-01-21to2026-01-20«contained»person giving consent:RELATEDPERSON4name.given:Berylname.family:Hackettrelationship:#PRN«contained»person giving consent:RELATEDPERSON4name.given:Berylname.family:Hackettrelationship:#PRN«logical reference»NHI patient:PATIENTlogical id: NHI«logical reference»Data custodian org:ORGANIZATIONHPI Org Id:GnXnnnplanned appointments, etc.:CAREPLAN meta.tag:#rf-nzcondition severity and specifics:CONDITION meta.tag:#rf-nzappointments:ENCOUNTER                                meta.tag:#rf-nzpreferences, health assessments:QUESTIONNAIRERESPONSE meta.tag:#rf-nzdiagnosis detail:OBSERVATION                          meta.tag:#rf-nz.provision.data.reference.patient2.organizationHPI org. ref1.performer4.patient.provision.organizationHPI org. ref1.performer4Notes1.Consent.organizationidentifies which org is custodian of the patient data.2. Consent instances identify the data subject in.patientreferences.3. FHIR resource instances with patient data tagged for access scoping eg. #rf-nz for rheumatic fever4. Note thatRelatedPersoninstance is contained by AND linked from (via .performer) the Consent instance.Health NZ/Te Whatu Ora. FHIR data model generated on 26/09/2024



Patient opted out from data sharing

FHIR Consent instances for patient opted-out (of treatment / data sharing)Representation of consent denied (or withdrawn) by patientPatient data covered by data access provision3Consent to treatment:CONSENTstatus:#ACTIVEscope:#treatmentpolicy: reference to regs/leg.treatment provisiontype:#PERMITperiod:2023-01-21to2026-01-20Consent to collect/share data:CONSENTstatus:#ACTIVEscope:#patient-privacypolicy: reference to regs/leg.data access permit provisiontype:#DENYperiod:2023-06-23to..«logical reference»NHI patient:PATIENTlogical id: NHI«logical reference»Data custodian org:ORGANIZATIONHPI Org Id:GnXnnnplanned appointments, etc.:CAREPLAN meta.tag:#rf-nzcondition severity and specifics:CONDITION meta.tag:#rf-nzappointments:ENCOUNTER                                meta.tag:#rf-nzpreferences, health assessments:QUESTIONNAIRERESPONSE meta.tag:#rf-nzdiagnosis detail:OBSERVATION                          meta.tag:#rf-nz.provision.data.reference.patient2.organizationHPI org. ref1.patient.provision.organizationHPI org. ref1Notes1.Consent.organizationidentifies which org is custodian of the patient data.2. Consent instances identify the data subject in.patientreferences.3. FHIR resource instances with patient data tagged for access scoping eg. #rf-nz for rheumatic fever4. FHIR API access rules for instances covered by anopt-outconsents will becontrolled by OAUTH scopes TBDHealth NZ/Te Whatu Ora. FHIR data model generated on 26/09/2024



FHIR Consent instances when patient consent is pendingRepresentation of limited provisional consent when patient's signed form pending but not receivedPatient data covered by temporary data access provision3consent to treatment:CONSENTstatus:#PROPOSEDscope:#treatmentpolicy: reference to regs/leg.treatment provisiontype:#PERMITperiod:2023-01-21to2026-01-20Consent to collect/share data:CONSENTstatus:#PROPOSEDscope:#patient-privacypolicy: reference to regs/leg.data access provisiontype:#PERMITperiod:2023-01-21to2026-01-20«logical reference»NHI patient:PATIENTlogical id: NHI«logical reference»Data custodian org:ORGANIZATIONHPI Org Id:GnXnnnplanned appointments, etc.:CAREPLAN meta.tag:#rf-nzcondition severity and specifics:CONDITION meta.tag:#rf-nzappointments:ENCOUNTER                                meta.tag:#rf-nzpreferences, health assessments:QUESTIONNAIRERESPONSE meta.tag:#rf-nzdiagnosis detail:OBSERVATION                          meta.tag:#rf-nz.provision.data.reference.patient2.organizationHPI org. ref1.patient.provision.organizationHPI org. ref1Notes1.Consent.organizationidentifies which org is custodian of the patient data.2. Consent instances identify the data subject in.patientreferences.3. FHIR resource instances with patient data tagged for access scoping eg. #rf-nz for rheumatic fever4. Start date is when the custodian provisionally-assumes consent to start;End date is empty (provision doesn't expire).Health NZ/Te Whatu Ora. FHIR data model generated on 26/09/2024