Release 4 FHIR CI-Build

This page is part of the Continuous Integration Build of FHIR Specification (v4.0.1: R4 - Mixed Normative and STU ) in it's permanent home (it will always (will be available incorrect/inconsistent at this URL). The current version which supercedes this version is 5.0.0 . For a full list of available versions, see 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 Standards Status : Informative Security Category : Patient Compartments : Device , Group , Patient , Practitioner , RelatedPerson

Mappings:

FiveWs Pattern Mapping

Workflow Pattern

HL7 v2 V2 Mapping

RIM Mapping

iCalendar

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

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

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

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

    requestedPeriod Request.occurrence[x]
Appointment Request
    identifier Request.identifier
    status Request.status
    serviceType Request.code
    reasonCode     reason Request.reasonCode Request.reason
    reasonReference     priority Request.reasonReference Request.priority
    priority     replaces Request.priority Request.replaces
    supportingInformation Request.supportingInfo
    start Request.occurrence[x]
    end Request.occurrence[x]
    minutesDuration Request.occurrence[x]
    requestedPeriod Request.occurrence[x]
    created Request.authoredOn
    comment     note Request.note
    basedOn Request.basedOn
    participant Request.performer, Request.subject

12.10.9.3 12.13.10.3 HL7 v2 V2 Mapping ( 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
    cancelationReason     cancellationReason
    serviceCategory     class PV1-2
    serviceType     serviceCategory
    specialty     serviceType 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.
    appointmentType     specialty ARQ-7
    reasonCode     appointmentType AIS-3, SCH-7
    reasonReference     reason AIS-3
    priority ARQ-12, SCH-11.6 / TQ1-9
    description NTE-3
    replaces
    virtualService
    supportingInformation
    previousAppointment
    start     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
    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
        period     recurrenceId
    occurrenceChanged
    requestedPeriod     recurrenceTemplate
        timezone
        recurrenceType
ARQ-11         lastOccurrenceDate
        occurrenceCount
        occurrenceDate
        weeklyTemplate
            monday
            tuesday
            wednesday
            thursday
            friday
            saturday
            sunday
            weekInterval
        monthlyTemplate
            dayOfMonth
            nthWeekOfMonth
            dayOfWeek
            monthInterval
        yearlyTemplate
            yearInterval
        excludingDate
        excludingRecurrenceId

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

.inboundRelationship[@typeCode = 'RSON'].observation .priorityCode .text .activityTime[@xsi:type = ('SXPR_TS', 'PIVL_TS')]
Appointment Act[@moodCode <= 'INT']
    identifier .id
    status .statusCode
    cancelationReason     cancellationReason n/a
    serviceCategory     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
    reasonCode     reason .reasonCode
    reasonReference     priority .priorityCode
    priority     description .text
    description     replaces .inboundRelationship[@typeCode = 'SPRT'].observation
    virtualService N/A
    supportingInformation .inboundRelationship[@typeCode = 'SPRT'].observation
    start     previousAppointment N/A
    originatingAppointment N/A
    start .effectiveTime.low
    end .effectiveTime.high
    minutesDuration .activityTime[@xsi:type = ('SXPR_TS', 'PIVL_TS')].width
    slot     requestedPeriod .activityTime[@xsi:type = ('SXPR_TS', 'PIVL_TS')]
    slot .outboundRelationship[@typeCode = 'REFR'].act[@classCode = 'ACT'][@moodCode = 'SLOT']
    created     account .pertains.A_Account
    created .author.time
    comment     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']
    participant     subject subject.patient
    participant performer | reusableDevice | subject | location
        type (performer | reusableDevice | subject | location).@typeCode
        actor         period n/a
        actor performer.person | reusableDevice.manufacturedDevice | subject.patient | location.serviceDeliveryLocation
        required (performer | reusableDevice | subject | location).@performInd
        status (performer | reusableDevice | subject | location).statusCode
        period     recurrenceId N/A
n/a     occurrenceChanged N/A
    requestedPeriod     recurrenceTemplate N/A
        timezone N/A

12.10.9.5 12.13.10.5 iCalendar ( http://ietf.org/rfc/2445 icon )

Appointment VEVENT
    identifier UID
    status STATUS
    cancelationReason     cancellationReason
    class
    serviceCategory CATEGORIES
    serviceType
    specialty
    appointmentType CLASSIFICATION
    reasonCode     reason
    reasonReference     priority PRIORITY
    priority     description PRIORITY SUMMARY
    description     replaces ATTACH
SUMMARY     virtualService
    supportingInformation ATTACH
    start     previousAppointment
    originatingAppointment
    start DTSTART
    end DTEND
    minutesDuration DURATION (e.g. PT15M)
    requestedPeriod
    slot
    account
    created CREATED
    comment     cancellationDate
    note DESCRIPTION (for internal use)
    patientInstruction DESCRIPTION (for patient use)
    basedOn
    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"
        required ROLE=REQ-PARTICIPANT (roleparam)
        status ATTENDEE;CN="John Doe";RSVP=TRUE:mailto:john@doe.com (rsvpparam | partstatparam)
        period     recurrenceId
    occurrenceChanged
    requestedPeriod     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