FHIR Release 3 (STU) CI-Build

This page is part of the FHIR Specification (v3.0.2: STU 3). The current version which supercedes this version is 5.0.0 . For a full list Continuous Integration Build of available versions, see FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon . Page versions: R5 R4B R4 R3 R2

12.10.9 12.13.10 Resource Appointment - Mappings

Maturity Level : N/A
Responsible Owner: Patient Administration icon Work Group Ballot Standards Status : Informative Security Category : Patient Compartments : Device , Group , Patient , Practitioner , RelatedPerson

Mappings:

RIM FiveWs Pattern Mapping

Workflow Pattern

HL7 v2 V2 Mapping

RIM Mapping

iCalendar

Mappings for the appointment resource. Appointment resource (see Mappings to Other Standards for further information & status).

12.10.9.1 12.13.10.1 Mappings for RIM FiveWs Pattern Mapping (http://hl7.org/v3) ( http://hl7.org/fhir/fivews icon )

.id .statusCode .performer.AssignedPerson.code .code .reasonCode .inboundRelationship[@typeCode = 'RSON'].observation .priorityCode .text .inboundRelationship[@typeCode = 'SPRT'].observation .effectiveTime.low .effectiveTime.high
Appointment Act[@moodCode <= 'INT'] workflow.scheduling
    identifier FiveWs.identifier
    status FiveWs.status
    serviceCategory     class n/a, might be inferred from the ServiceDeliveryLocation FiveWs.class
    serviceType     specialty n/a, might be inferred from the ServiceDeliveryLocation FiveWs.class
    specialty     priority FiveWs.class
    appointmentType     replaces FiveWs.context
    reason     supportingInformation FiveWs.context
    indication     previousAppointment FiveWs.context
    priority     originatingAppointment FiveWs.context
    description     start FiveWs.init
    supportingInformation     end FiveWs.done[x]
    start     subject FiveWs.who
    end         actor FiveWs.who

12.13.10.2 Workflow Pattern ( http://hl7.org/fhir/workflow icon )

.outboundRelationship[@typeCode = 'REFR'].act[@classCode = 'ACT'][@moodCode = 'SLOT'] .author.time .subjectOf.observation[@moodCode = 'EVN'][code = 'annotation'].value .outboundRelationship[@typeCode = 'FLFS'].act[@classCode < 'ActCareProvisionRequestType'][@moodCode = 'RQO'] .activityTime[@xsi:type = ('SXPR_TS', 'PIVL_TS')]
    minutesDuration .activityTime[@xsi:type = ('SXPR_TS', 'PIVL_TS')].width Appointment Request
    slot     identifier Request.identifier
    created     status Request.status
    comment     serviceType Request.code
    incomingReferral     reason Request.reason
    participant     priority performer | reusableDevice | subject | location Request.priority
        type     replaces Request.replaces
(performer | reusableDevice | subject | location).@typeCode     supportingInformation Request.supportingInfo
        actor     start Request.occurrence[x]
performer.person | reusableDevice.manufacturedDevice | subject.patient | location.serviceDeliveryLocation     end Request.occurrence[x]
        required     minutesDuration Request.occurrence[x]
(performer | reusableDevice | subject | location).@performInd     requestedPeriod Request.occurrence[x]
        status     created Request.authoredOn
(performer | reusableDevice | subject | location).statusCode     note Request.note
    requestedPeriod     basedOn Request.basedOn
    participant Request.performer, Request.subject

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

The mappings provided in this tab are indicative of how HL7 v2 fields relate to HL7 FHIR attributes in this resource, but is not complete and without critical HL7 v2 context. The HL7 v2-FHIR Implementation guide, located here icon , provides additional guidance on transforming an HL7 v2 message to FHIR resources for FHIR R4 and FHIR R6.
Appointment
    identifier SCH-1, SCH-2, ARQ-1, ARQ-2
    status SCH-25
    serviceCategory     cancellationReason
    serviceType     class PV1-2
    specialty     serviceCategory
    appointmentType     serviceType ARQ-7 ARQ-8, SCH-8 or ARQ-7, SCH-7 - note these are all user tables - review with trading partners which v2 field is used for serviceType concepts is recommended.
    reason     specialty AIS-3, SCH-7
    indication     appointmentType
    priority     reason AIS-3
    priority ARQ-12, SCH-11.6 / TQ1-9
    description NTE-3
    replaces
    virtualService
    supportingInformation
    start     previousAppointment
    originatingAppointment
    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
    minutesDuration
    requestedPeriod ARQ-11
    slot
    account
    created
    comment     cancellationDate
    note NTE-3
    patientInstruction NTE-3
    incomingReferral     basedOn
    participant     subject PID-3-Patient ID List
    participant PID, AIP, AIG, AIL
        type AIP-4, AIG-4
        actor         period
        actor PID-3-Patient ID List | AIL-3 | AIG-3 | AIP-3
        required
        status AIP-12, AIG-14
    recurrenceId
    occurrenceChanged
    recurrenceTemplate
        timezone
        recurrenceType
        lastOccurrenceDate
        occurrenceCount
        occurrenceDate
        weeklyTemplate
            monday
            tuesday
            wednesday
            thursday
            friday
            saturday
            sunday
            weekInterval
        monthlyTemplate
            dayOfMonth
            nthWeekOfMonth
            dayOfWeek
            monthInterval
        yearlyTemplate
            yearInterval
        excludingDate
        excludingRecurrenceId

12.13.10.4 RIM Mapping ( http://hl7.org/v3 icon )

Appointment Act[@moodCode <= 'INT']
    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')]
ARQ-11     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
        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
        timezone N/A

12.10.9.3 12.13.10.5 Mappings for iCalendar (http://www.ietf.org/rfc/rfc2445.txt) ( http://ietf.org/rfc/2445 icon )

Appointment VEVENT
    identifier UID
    status STATUS
    cancellationReason
    serviceCategory     class
    serviceCategory CATEGORIES
    serviceType
    specialty
    appointmentType CLASSIFICATION
    reason
    indication     priority PRIORITY
    description SUMMARY
    priority     replaces ATTACH
PRIORITY     virtualService
    description     supportingInformation ATTACH
DESCRIPTION     previousAppointment
    supportingInformation     originatingAppointment
    start DTSTART
    end DTEND
    minutesDuration DURATION (e.g. PT15M)
    requestedPeriod
    slot
    account
    created CREATED
    cancellationDate
    comment     note DESCRIPTION (for internal use)
COMMENT     patientInstruction DESCRIPTION (for patient use)
    incomingReferral     basedOn
    participant     subject
    participant ATTENDEE component to be created
        type n/a
        actor         period
        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" "information-only"
        required ROLE=REQ-PARTICIPANT (roleparam)
        status ATTENDEE;CN="Brian Postlethwaite";RSVP=TRUE:mailto:BPostlethwaite@data.com ATTENDEE;CN="John Doe";RSVP=TRUE:mailto:john@doe.com (rsvpparam | partstatparam)
    requestedPeriod     recurrenceId
    occurrenceChanged
    recurrenceTemplate
        timezone TZID
        recurrenceType FREQ
        lastOccurrenceDate UNTIL
        occurrenceCount COUNT
        occurrenceDate RDATE
        weeklyTemplate
            monday
            tuesday
            wednesday
            thursday
            friday
            saturday
            sunday
            weekInterval
        monthlyTemplate
            dayOfMonth
            nthWeekOfMonth
            dayOfWeek
            monthInterval
        yearlyTemplate
            yearInterval
        excludingDate EXDATE
        excludingRecurrenceId