Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.7 - release New Zealand flag

Health New Zealand Te Whatu Ora Shared Care FHIR API - Local Development build (v0.4.7) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: OnlineGPAppointment - Mappings

Active as of 2026-10-13

Mappings for the OnlineGPAppointment resource profile.

Mappings to Structures in this Implementation Guide

No Mappings Found

Mappings to other Structures

No Mappings Found

Other Mappings

NameWorkflow PatternRIM MappingiCalendarFiveWs Pattern MappingHL7 v2 Mappingdoco
Appointment
Request
Act[@moodCode <= 'INT']
VEVENT
Appointment / id
Appointment / meta
Appointment / meta / id
n/a
Appointment / meta / extension
n/a
Appointment / meta / versionId
Appointment / meta / lastUpdated
Appointment / meta / source
Appointment / meta / profile
Appointment / meta / security
Appointment / meta / Slices for tag
Appointment / meta / Slices for tag / tag:correlationId
Appointment / meta / Slices for tag / tag:correlationId / id
n/a
Appointment / meta / Slices for tag / tag:correlationId / extension
n/a
Appointment / meta / Slices for tag / tag:correlationId / system
./codeSystem
C*E.3
Appointment / meta / Slices for tag / tag:correlationId / version
./codeSystemVersion
C*E.7
Appointment / meta / Slices for tag / tag:correlationId / code
./code
C*E.1
Appointment / meta / Slices for tag / tag:correlationId / display
CV.displayName
C*E.2 - but note this is not well followed
Appointment / meta / Slices for tag / tag:correlationId / userSelected
CD.codingRationale
Sometimes implied by being first
Appointment / implicitRules
Appointment / language
Appointment / text
Act.text?
Appointment / contained
N/A
Appointment / extension
N/A
Appointment / modifierExtension
N/A
Appointment / identifier
Request.identifier
.id
UID
FiveWs.identifier
  • SCH-1
  • SCH-2
  • ARQ-1
  • ARQ-2
Appointment / identifier / id
n/a
Appointment / identifier / extension
n/a
Appointment / identifier / use
Role.code or implied by context
N/A
Appointment / identifier / type
Role.code or implied by context
CX.5
Appointment / identifier / system
II.root or Role.id.root
CX.4 / EI-2-4
Appointment / identifier / value
II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
CX.1 / EI.1
Appointment / identifier / period
Role.effectiveTime or implied by context
CX.7 + CX.8
Appointment / identifier / assigner
II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
  • CX.4 / (CX.4
  • CX.9
  • CX.10)
Appointment / status
Request.status
.statusCode
STATUS
FiveWs.status
SCH-25
Appointment / cancelationReason
n/a
Appointment / serviceCategory
  • n/a
  • might be inferred from the ServiceDeliveryLocation
CATEGORIES
Appointment / serviceType
Request.code
  • n/a
  • might be inferred from the ServiceDeliveryLocation
Appointment / specialty
.performer.AssignedPerson.code
FiveWs.class
Appointment / appointmentType
.code
CLASSIFICATION
ARQ-7
Appointment / reasonCode
Request.reasonCode
.reasonCode
  • AIS-3
  • SCH-7
Appointment / reasonReference
Request.reasonReference
.inboundRelationship[@typeCode = 'RSON'].observation
Appointment / priority
Request.priority
.priorityCode
PRIORITY
FiveWs.class
  • ARQ-12
  • SCH-11.6 / TQ1-9
Appointment / description
.text
SUMMARY
NTE-3
Appointment / supportingInformation
Request.supportingInfo
.inboundRelationship[@typeCode = 'SPRT'].observation
ATTACH
FiveWs.context
Appointment / supportingInformation / id
n/a
Appointment / supportingInformation / extension
n/a
Appointment / supportingInformation / reference
N/A
Appointment / supportingInformation / type
N/A
Appointment / supportingInformation / identifier
.identifier
Appointment / supportingInformation / identifier / id
n/a
Appointment / supportingInformation / identifier / extension
n/a
Appointment / supportingInformation / identifier / use
Role.code or implied by context
N/A
Appointment / supportingInformation / identifier / type
Role.code or implied by context
CX.5
Appointment / supportingInformation / identifier / system
II.root or Role.id.root
CX.4 / EI-2-4
Appointment / supportingInformation / identifier / value
II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
CX.1 / EI.1
Appointment / supportingInformation / identifier / period
Role.effectiveTime or implied by context
CX.7 + CX.8
Appointment / supportingInformation / identifier / assigner
II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
  • CX.4 / (CX.4
  • CX.9
  • CX.10)
Appointment / supportingInformation / display
N/A
Appointment / start
Request.occurrence[x]
.effectiveTime.low
DTSTART
FiveWs.init
  • ARQ-11.1
  • SCH-11.4 / TQ1-7
Appointment / end
Request.occurrence[x]
.effectiveTime.high
DTEND
FiveWs.done[x]
SCH-11.5 / TQ1-8/ calculated based on the start and the duration which is in ARQ-9
Appointment / minutesDuration
Request.occurrence[x]
  • type = ('SXPR_TS'
  • 'PIVL_TS')].width
DURATION (e.g. PT15M)
Appointment / slot
.outboundRelationship[@typeCode = 'REFR'].act[@classCode = 'ACT'][@moodCode = 'SLOT']
Appointment / created
Request.authoredOn
.author.time
CREATED
Appointment / comment
Request.note
.subjectOf.observation[@moodCode = 'EVN'][code = 'annotation'].value
DESCRIPTION (for internal use)
NTE-3
Appointment / patientInstruction
.subjectOf.observation[@moodCode = 'EVN'][code = 'annotation'].value
DESCRIPTION (for patient use)
NTE-3
Appointment / basedOn
Request.basedOn
.outboundRelationship[@typeCode = 'FLFS'].act[@classCode < 'ActCareProvisionRequestType'][@moodCode = 'RQO']
Appointment / Slices for participant
  • Request.performer
  • Request.subject
performer | reusableDevice | subject | location
ATTENDEE component to be created
  • PID
  • AIP
  • AIG
  • AIL
Appointment / Slices for participant / participant:All Slices
Appointment / Slices for participant / participant:All Slices / id
n/a
Appointment / Slices for participant / participant:All Slices / extension
n/a
Appointment / Slices for participant / participant:All Slices / modifierExtension
N/A
Appointment / Slices for participant / participant:All Slices / type
(performer | reusableDevice | subject | location).@typeCode
n/a
  • AIP-4
  • AIG-4
Appointment / Slices for participant / participant:All Slices / actor
performer.person | reusableDevice.manufacturedDevice | subject.patient | location.serviceDeliveryLocation
(Need to provide the common name CN and also the MAILTO properties from the practitioner resource) where the participant type is not "information-only"
FiveWs.who
PID-3-Patient ID List | AIL-3 | AIG-3 | AIP-3
Appointment / Slices for participant / participant:All Slices / required
(performer | reusableDevice | subject | location).@performInd
ROLE=REQ-PARTICIPANT (roleparam)
Appointment / Slices for participant / participant:All Slices / status
(performer | reusableDevice | subject | location).statusCode
mailto:john@doe.com (rsvpparam | partstatparam)
  • AIP-12
  • AIG-14
Appointment / Slices for participant / participant:All Slices / period
n/a
Appointment / Slices for participant / participant:patient
  • Request.performer
  • Request.subject
performer | reusableDevice | subject | location
ATTENDEE component to be created
  • PID
  • AIP
  • AIG
  • AIL
Appointment / Slices for participant / participant:patient / id
n/a
Appointment / Slices for participant / participant:patient / extension
n/a
Appointment / Slices for participant / participant:patient / modifierExtension
N/A
Appointment / Slices for participant / participant:patient / type
(performer | reusableDevice | subject | location).@typeCode
n/a
  • AIP-4
  • AIG-4
Appointment / Slices for participant / participant:patient / actor
performer.person | reusableDevice.manufacturedDevice | subject.patient | location.serviceDeliveryLocation
(Need to provide the common name CN and also the MAILTO properties from the practitioner resource) where the participant type is not "information-only"
FiveWs.who
PID-3-Patient ID List | AIL-3 | AIG-3 | AIP-3
Appointment / Slices for participant / participant:patient / actor / id
n/a
Appointment / Slices for participant / participant:patient / actor / extension
n/a
Appointment / Slices for participant / participant:patient / actor / reference
N/A
Appointment / Slices for participant / participant:patient / actor / type
N/A
Appointment / Slices for participant / participant:patient / actor / identifier
.identifier
Appointment / Slices for participant / participant:patient / actor / identifier / id
n/a
Appointment / Slices for participant / participant:patient / actor / identifier / extension
n/a
Appointment / Slices for participant / participant:patient / actor / identifier / use
Role.code or implied by context
N/A
Appointment / Slices for participant / participant:patient / actor / identifier / type
Role.code or implied by context
CX.5
Appointment / Slices for participant / participant:patient / actor / identifier / system
II.root or Role.id.root
CX.4 / EI-2-4
Appointment / Slices for participant / participant:patient / actor / identifier / value
II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
CX.1 / EI.1
Appointment / Slices for participant / participant:patient / actor / identifier / period
Role.effectiveTime or implied by context
CX.7 + CX.8
Appointment / Slices for participant / participant:patient / actor / identifier / assigner
II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
  • CX.4 / (CX.4
  • CX.9
  • CX.10)
Appointment / Slices for participant / participant:patient / actor / display
N/A
Appointment / Slices for participant / participant:patient / required
(performer | reusableDevice | subject | location).@performInd
ROLE=REQ-PARTICIPANT (roleparam)
Appointment / Slices for participant / participant:patient / status
(performer | reusableDevice | subject | location).statusCode
mailto:john@doe.com (rsvpparam | partstatparam)
  • AIP-12
  • AIG-14
Appointment / Slices for participant / participant:patient / period
n/a
Appointment / requestedPeriod
Request.occurrence[x]
  • type = ('SXPR_TS'
  • 'PIVL_TS')]
ARQ-11

doco Documentation for this format