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.1.6 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
Mappings for the SDHRConsent resource profile.
| Name | Workflow Pattern | HL7 v2 Mapping | RIM Mapping | FiveWs Pattern Mapping |
|---|
  Consent |
Event |
CON |
FinancialConsent |
|
  Consent / id |
|
|
|
|
 Consent / meta |
|
|
|
|
| Consent / implicitRules |
|
|
|
|
| Consent / language |
|
|
|
|
| Consent / text |
|
|
Act.text? |
|
| Consent / contained |
|
|
N/A |
|
 Consent / extension |
|
|
N/A |
|
 Consent / modifierExtension |
|
|
N/A |
|
| Consent / identifier |
Event.identifier |
|
.id |
FiveWs.identifier |
| Consent / status |
Event.status |
HL7 Table 0498 - Consent Status |
.statusCode |
FiveWs.status |
| Consent / scope |
|
|
|
|
| Consent / category |
Event.code |
HL7 Table 0497 - Consent Type |
CNTRCT |
FiveWs.class |
  Consent / patient |
Event.subject |
|
Role |
FiveWs.subject |
 Consent / patient / id |
|
|
n/a |
|
| Consent / patient / extension |
|
|
n/a |
|
| Consent / patient / reference |
|
|
N/A |
|
| Consent / patient / type |
|
|
N/A |
|
| Consent / patient / identifier |
|
|
.identifier |
|
 Consent / patient / display |
|
|
N/A |
|
| Consent / dateTime |
Event.occurrence[x] |
Field 13/ Consent Decision Date |
FinancialConsent effectiveTime |
FiveWs.recorded |
| Consent / performer |
Event.performer |
Field 24/ ConsenterID |
|
FiveWs.actor |
| Consent / organization |
Event.performer |
|
|
FiveWs.witness |
 Consent / source[x] |
|
Field 19 Informational Material Supplied Indicator |
|
|
| Consent / policy |
|
|
|
|
| Consent / policy / id |
|
|
n/a |
|
| Consent / policy / extension |
|
|
n/a |
|
| Consent / policy / modifierExtension |
|
|
N/A |
|
| Consent / policy / authority |
|
|
|
|
| Consent / policy / uri |
|
|
|
|
| Consent / policyRule |
|
|
|
|
| Consent / verification |
|
|
|
|
| Consent / verification / id |
|
|
n/a |
|
| Consent / verification / extension |
|
|
n/a |
|
| Consent / verification / modifierExtension |
|
|
N/A |
|
| Consent / verification / verified |
|
|
|
|
| Consent / verification / verifiedWith |
|
|
|
|
| Consent / verification / verificationDate |
|
|
|
|
 Consent / provision |
|
|
|
|
 Consent / provision / id |
|
|
n/a |
|
| Consent / provision / Slices for extension |
|
|
|
|
  Consent / provision / Slices for extension / extension:HNZGlobalOptOutReasonExtension |
|
|
|
|
| Consent / provision / modifierExtension |
|
|
N/A |
|
| Consent / provision / type |
|
|
|
|
| Consent / provision / period |
|
|
|
|
| Consent / provision / period / id |
|
|
n/a |
|
| Consent / provision / period / extension |
|
|
n/a |
|
| Consent / provision / period / start |
|
DR.1 |
./low |
|
| Consent / provision / period / end |
|
DR.2 |
./high |
|
| Consent / provision / actor |
|
|
|
|
| Consent / provision / actor / id |
|
|
n/a |
|
| Consent / provision / actor / extension |
|
|
n/a |
|
| Consent / provision / actor / modifierExtension |
|
|
N/A |
|
| Consent / provision / actor / role |
|
|
|
|
| Consent / provision / actor / reference |
|
|
|
|
| Consent / provision / action |
|
|
|
|
| Consent / provision / securityLabel |
|
|
|
|
| Consent / provision / purpose |
|
|
|
|
| Consent / provision / class |
|
|
|
|
| Consent / provision / code |
|
|
|
|
| Consent / provision / dataPeriod |
|
|
|
|
| Consent / provision / data |
|
|
Role |
|
| Consent / provision / data / id |
|
|
n/a |
|
| Consent / provision / data / extension |
|
|
n/a |
|
| Consent / provision / data / modifierExtension |
|
|
N/A |
|
| Consent / provision / data / meaning |
|
|
|
|
| Consent / provision / data / reference |
|
|
|
|
 Consent / provision / Slices for provision |
|
|
|
|
  Consent / provision / Slices for provision / provision:All Slices |
|
|
|
|
  Consent / provision / Slices for provision / provision:All Slices / id |
|
|
n/a |
|
| Consent / provision / Slices for provision / provision:All Slices / Slices for extension |
|
|
|
|
| Consent / provision / Slices for provision / provision:All Slices / Slices for extension / extension:FacilityParticipationExtension |
|
|
|
|
| Consent / provision / Slices for provision / provision:All Slices / modifierExtension |
|
|
N/A |
|
| Consent / provision / Slices for provision / provision:All Slices / type |
|
|
|
|
| Consent / provision / Slices for provision / provision:All Slices / period |
|
|
|
|
| Consent / provision / Slices for provision / provision:All Slices / actor |
|
|
|
|
| Consent / provision / Slices for provision / provision:All Slices / actor / id |
|
|
n/a |
|
| Consent / provision / Slices for provision / provision:All Slices / actor / extension |
|
|
n/a |
|
| Consent / provision / Slices for provision / provision:All Slices / actor / modifierExtension |
|
|
N/A |
|
| Consent / provision / Slices for provision / provision:All Slices / actor / role |
|
|
|
|
| Consent / provision / Slices for provision / provision:All Slices / actor / reference |
|
|
|
|
| Consent / provision / Slices for provision / provision:All Slices / action |
|
|
|
|
| Consent / provision / Slices for provision / provision:All Slices / securityLabel |
|
|
|
|
| Consent / provision / Slices for provision / provision:All Slices / purpose |
|
|
|
|
| Consent / provision / Slices for provision / provision:All Slices / class |
|
|
|
|
| Consent / provision / Slices for provision / provision:All Slices / code |
|
|
|
|
| Consent / provision / Slices for provision / provision:All Slices / dataPeriod |
|
|
|
|
| Consent / provision / Slices for provision / provision:All Slices / data |
|
|
Role |
|
| Consent / provision / Slices for provision / provision:All Slices / data / id |
|
|
n/a |
|
| Consent / provision / Slices for provision / provision:All Slices / data / extension |
|
|
n/a |
|
| Consent / provision / Slices for provision / provision:All Slices / data / modifierExtension |
|
|
N/A |
|
| Consent / provision / Slices for provision / provision:All Slices / data / meaning |
|
|
|
|
| Consent / provision / Slices for provision / provision:All Slices / data / reference |
|
|
|
|
| Consent / provision / Slices for provision / provision:All Slices / provision |
|
|
|
|
 Consent / provision / Slices for provision / provision:domainParticipation |
|
|
|
|
 Consent / provision / Slices for provision / provision:domainParticipation / id |
|
|
n/a |
|
| Consent / provision / Slices for provision / provision:domainParticipation / Slices for extension |
|
|
|
|
 Consent / provision / Slices for provision / provision:domainParticipation / Slices for extension |
|
|
|
|
 Consent / provision / Slices for provision / provision:domainParticipation / Slices for extension / extension:FacilityParticipationExtension |
|
|
|
|
| Consent / provision / Slices for provision / provision:domainParticipation / Slices for extension / extension:lastUpdated |
|
|
|
|
| Consent / provision / Slices for provision / provision:domainParticipation / modifierExtension |
|
|
N/A |
|
| Consent / provision / Slices for provision / provision:domainParticipation / type |
|
|
|
|
| Consent / provision / Slices for provision / provision:domainParticipation / period |
|
|
|
|
| Consent / provision / Slices for provision / provision:domainParticipation / actor |
|
|
|
|
| Consent / provision / Slices for provision / provision:domainParticipation / action |
|
|
|
|
| Consent / provision / Slices for provision / provision:domainParticipation / securityLabel |
|
|
|
|
| Consent / provision / Slices for provision / provision:domainParticipation / purpose |
|
|
|
|
| Consent / provision / Slices for provision / provision:domainParticipation / class |
|
|
|
|
| Consent / provision / Slices for provision / provision:domainParticipation / class / id |
|
|
n/a |
|
| Consent / provision / Slices for provision / provision:domainParticipation / class / extension |
|
|
n/a |
|
| Consent / provision / Slices for provision / provision:domainParticipation / class / system |
|
C*E.3 |
./codeSystem |
|
| Consent / provision / Slices for provision / provision:domainParticipation / class / version |
|
C*E.7 |
./codeSystemVersion |
|
| Consent / provision / Slices for provision / provision:domainParticipation / class / code |
|
C*E.1 |
./code |
|
| Consent / provision / Slices for provision / provision:domainParticipation / class / display |
|
C*E.2 - but note this is not well followed |
CV.displayName |
|
| Consent / provision / Slices for provision / provision:domainParticipation / class / userSelected |
|
Sometimes implied by being first |
CD.codingRationale |
|
| Consent / provision / Slices for provision / provision:domainParticipation / code |
|
|
|
|
| Consent / provision / Slices for provision / provision:domainParticipation / dataPeriod |
|
|
|
|
| Consent / provision / Slices for provision / provision:domainParticipation / data |
|
|
Role |
|
 Consent / provision / Slices for provision / provision:domainParticipation / provision |
|
|
|
|
Documentation for this format |
