This page is part of the Release of AddCommunication IG (v2.2: Release) based on FHIR (HL7® FHIR® Standard) v5.0.0. . For a full list of available versions, see the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON
• TTL

Resource Profile: InvitationAppointment - Mappings

Draft as of 2025-02-04

Mappings for the InvitationAppointment resource profile.

Mappings for Workflow Pattern (http://hl7.org/fhir/workflow)

InvitationAppointment
Appointment	Request
identifier	Request.identifier
status	Request.status
serviceType	Request.code
reason	Request.reason
priority	Request.priority
replaces	Request.replaces
supportingInformation	Request.supportingInfo
start	Request.occurrence[x]
end	Request.occurrence[x]
minutesDuration	Request.occurrence[x]
requestedPeriod	Request.occurrence[x]
created	Request.authoredOn
note	Request.note
basedOn	Request.basedOn
participant	Request.performer, Request.subject
participant (healthcareservice)	Request.performer, Request.subject
participant (practitioner)	Request.performer, Request.subject

Mappings for FiveWs Pattern Mapping (http://hl7.org/fhir/fivews)

InvitationAppointment
Appointment	workflow.scheduling
identifier	FiveWs.identifier
status	FiveWs.status
class	FiveWs.class
specialty	FiveWs.class
priority	FiveWs.class
replaces	FiveWs.context
supportingInformation	FiveWs.context
previousAppointment	FiveWs.context
originatingAppointment	FiveWs.context
start	FiveWs.init
end	FiveWs.done[x]
subject	FiveWs.who
participant
actor	FiveWs.who
participant (healthcareservice)
actor	FiveWs.who
participant (practitioner)
actor	FiveWs.who

Mappings for RIM Mapping (http://hl7.org/v3)

InvitationAppointment
Appointment	Entity, Role, or Act,Act[@moodCode <= 'INT']
text	Act.text?
contained	N/A
extension
extension (CareServiceCode)
id	n/a
url	N/A
value[x]	N/A
value[x] (valueCodeableConcept)	N/A
id	n/a
extension	n/a
coding	union(., ./translation)
id	n/a
extension	n/a
system	./codeSystem
version	./codeSystemVersion
code	./code
display	CV.displayName
userSelected	CD.codingRationale
text	./originalText[mediaType/code="text/plain"]/data
extension (CareServiceArea)
id	n/a
url	N/A
value[x]	N/A
value[x] (valueCodeableConcept)	N/A
id	n/a
extension	n/a
coding	union(., ./translation)
id	n/a
extension	n/a
system	./codeSystem
version	./codeSystemVersion
code	./code
display	CV.displayName
userSelected	CD.codingRationale
text	./originalText[mediaType/code="text/plain"]/data
extension (IndividualChoice)
id	n/a
extension	n/a
extension (id)
id	n/a
url	N/A
value[x]	N/A
extension (body)
id	n/a
url	N/A
value[x]	N/A
extension (type)
id	n/a
url	N/A
value[x]	N/A
extension (Link)
id	n/a
extension	n/a
extension (name)
id	n/a
url	N/A
value[x]	N/A
extension (url)
id	n/a
url	N/A
value[x]	N/A
extension (readable_text)
id	n/a
url	N/A
value[x]	N/A
extension (type)
id	n/a
url	N/A
value[x]	N/A
url	N/A
extension (Placeholder)
url	N/A
extension (Prep)
id	n/a
extension	n/a
extension (type)
id	n/a
url	N/A
value[x]	N/A
extension (header)
id	n/a
url	N/A
value[x]	N/A
extension (printheader)
id	n/a
url	N/A
value[x]	N/A
extension (sortIndex)
id	n/a
url	N/A
value[x]	N/A
extension (PrepItem)
id	n/a
extension	n/a
extension (id)
id	n/a
url	N/A
value[x]	N/A
extension (body)
id	n/a
url	N/A
value[x]	N/A
extension (sortIndex)
id	n/a
url	N/A
value[x]	N/A
extension (Link)
id	n/a
extension	n/a
extension (name)
id	n/a
url	N/A
value[x]	N/A
extension (url)
id	n/a
url	N/A
value[x]	N/A
extension (readable_text)
id	n/a
url	N/A
value[x]	N/A
extension (type)
id	n/a
url	N/A
value[x]	N/A
url	N/A
url	N/A
url	N/A
extension (ReferralReference)
id	n/a
extension
extension (healthcareService)
id	n/a
url	N/A
value[x]	N/A
value[x] (valueReference)	N/A
extension (gapDays)
id	n/a
url	N/A
value[x]	N/A
value[x] (valueInteger)	N/A
extension (receiveCorrespondence)
id	n/a
url	N/A
value[x]	N/A
value[x] (valueBoolean)	N/A
url	N/A
modifierExtension	N/A
identifier	.id
status	.statusCode
cancellationReason	n/a
class	.inboundRelationship[typeCode=SUBJ].source[classCode=LIST].code
serviceCategory	n/a, might be inferred from the ServiceDeliveryLocation
serviceType	n/a, might be inferred from the ServiceDeliveryLocation
specialty	.performer.AssignedPerson.code
appointmentType	.code
reason	.reasonCode
priority	.priorityCode
description	.text
replaces	.inboundRelationship[@typeCode = 'SPRT'].observation
virtualService	N/A
supportingInformation	.inboundRelationship[@typeCode = 'SPRT'].observation
previousAppointment	N/A
originatingAppointment	N/A
start	.effectiveTime.low
end	.effectiveTime.high
minutesDuration	.activityTime[@xsi:type = ('SXPR_TS', 'PIVL_TS')].width
requestedPeriod	.activityTime[@xsi:type = ('SXPR_TS', 'PIVL_TS')]
slot	.outboundRelationship[@typeCode = 'REFR'].act[@classCode = 'ACT'][@moodCode = 'SLOT']
account	.pertains.A_Account
created	.author.time
note	.subjectOf.observation[@moodCode = 'EVN'][code = 'annotation'].value
patientInstruction	.subjectOf.observation[@moodCode = 'EVN'][code = 'annotation'].value
basedOn	.outboundRelationship[@typeCode = 'FLFS'].act[@classCode < 'ActCareProvisionRequestType'][@moodCode = 'RQO']
subject	subject.patient
participant	performer | reusableDevice | subject | location
id	n/a
extension	n/a
modifierExtension	N/A
type	(performer | reusableDevice | subject | location).@typeCode
period	n/a
actor	performer.person | reusableDevice.manufacturedDevice | subject.patient | location.serviceDeliveryLocation
required	(performer | reusableDevice | subject | location).@performInd
status	(performer | reusableDevice | subject | location).statusCode
participant (healthcareservice)	performer | reusableDevice | subject | location
id	n/a
extension	n/a
modifierExtension	N/A
type	(performer | reusableDevice | subject | location).@typeCode
period	n/a
actor	performer.person | reusableDevice.manufacturedDevice | subject.patient | location.serviceDeliveryLocation
required	(performer | reusableDevice | subject | location).@performInd
status	(performer | reusableDevice | subject | location).statusCode
participant (practitioner)	performer | reusableDevice | subject | location
id	n/a
extension	n/a
modifierExtension	N/A
type	(performer | reusableDevice | subject | location).@typeCode
period	n/a
actor	performer.person | reusableDevice.manufacturedDevice | subject.patient | location.serviceDeliveryLocation
required	(performer | reusableDevice | subject | location).@performInd
status	(performer | reusableDevice | subject | location).statusCode
recurrenceId	N/A
occurrenceChanged	N/A
recurrenceTemplate	N/A
id	n/a
extension	n/a
modifierExtension	N/A
timezone	N/A
weeklyTemplate
id	n/a
extension	n/a
modifierExtension	N/A
monthlyTemplate
id	n/a
extension	n/a
modifierExtension	N/A
yearlyTemplate
id	n/a
extension	n/a
modifierExtension	N/A

Mappings for iCalendar (http://ietf.org/rfc/2445)

InvitationAppointment
Appointment	VEVENT
identifier	UID
status	STATUS
serviceCategory	CATEGORIES
appointmentType	CLASSIFICATION
priority	PRIORITY
description	SUMMARY
replaces	ATTACH
supportingInformation	ATTACH
start	DTSTART
end	DTEND
minutesDuration	DURATION (e.g. PT15M)
created	CREATED
note	DESCRIPTION (for internal use)
patientInstruction	DESCRIPTION (for patient use)
participant	ATTENDEE component to be created
type	n/a
actor	ATTENDEE: (Need to provide the common name CN and also the MAILTO properties from the practitioner resource) where the participant type is not "information-only"
required	ROLE=REQ-PARTICIPANT (roleparam)
status	ATTENDEE;CN="John Doe";RSVP=TRUE:mailto:john@doe.com (rsvpparam | partstatparam)
participant (healthcareservice)	ATTENDEE component to be created
type	n/a
actor	ATTENDEE: (Need to provide the common name CN and also the MAILTO properties from the practitioner resource) where the participant type is not "information-only"
required	ROLE=REQ-PARTICIPANT (roleparam)
status	ATTENDEE;CN="John Doe";RSVP=TRUE:mailto:john@doe.com (rsvpparam | partstatparam)
participant (practitioner)	ATTENDEE component to be created
type	n/a
actor	ATTENDEE: (Need to provide the common name CN and also the MAILTO properties from the practitioner resource) where the participant type is not "information-only"
required	ROLE=REQ-PARTICIPANT (roleparam)
status	ATTENDEE;CN="John Doe";RSVP=TRUE:mailto:john@doe.com (rsvpparam | partstatparam)
recurrenceTemplate
timezone	TZID
recurrenceType	FREQ
lastOccurrenceDate	UNTIL
occurrenceCount	COUNT
occurrenceDate	RDATE
excludingDate	EXDATE

Mappings for HL7 V2 Mapping (http://hl7.org/v2)

InvitationAppointment
Appointment
extension
extension (CareServiceCode)
value[x]
value[x] (valueCodeableConcept)
coding	C*E.1-8, C*E.10-22
system	C*E.3
version	C*E.7
code	C*E.1
display	C*E.2 - but note this is not well followed
userSelected	Sometimes implied by being first
text	C*E.9. But note many systems use C*E.2 for this
extension (CareServiceArea)
value[x]
value[x] (valueCodeableConcept)
coding	C*E.1-8, C*E.10-22
system	C*E.3
version	C*E.7
code	C*E.1
display	C*E.2 - but note this is not well followed
userSelected	Sometimes implied by being first
text	C*E.9. But note many systems use C*E.2 for this
identifier	SCH-1, SCH-2, ARQ-1, ARQ-2
status	SCH-25
class	PV1-2
serviceType	ARQ-8, SCH-8
appointmentType	ARQ-7, SCH-7
reason	AIS-3
priority	ARQ-12, SCH-11.6 / TQ1-9
description	NTE-3
start	ARQ-11.1, SCH-11.4 / TQ1-7
end	SCH-11.5 / TQ1-8/ calculated based on the start and the duration which is in ARQ-9
requestedPeriod	ARQ-11
note	NTE-3
patientInstruction	NTE-3
subject	PID-3-Patient ID List
participant	PID, AIP, AIG, AIL
type	AIP-4, AIG-4
actor	PID-3-Patient ID List | AIL-3 | AIG-3 | AIP-3
status	AIP-12, AIG-14
participant (healthcareservice)	PID, AIP, AIG, AIL
type	AIP-4, AIG-4
actor	PID-3-Patient ID List | AIL-3 | AIG-3 | AIP-3
status	AIP-12, AIG-14
participant (practitioner)	PID, AIP, AIG, AIL
type	AIP-4, AIG-4
actor	PID-3-Patient ID List | AIL-3 | AIG-3 | AIP-3
status	AIP-12, AIG-14