Release 5 R6 Ballot (2nd Draft)

This page is part of the FHIR Specification (v5.0.0: R5 - STU v6.0.0-ballot2: Release 6 Ballot (2nd Draft) (see Ballot Notes ). This is the The current published version in it's permanent home (it will always be available at this URL). is 5.0.0 . For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2

12.14.10 Resource Appointment - Mappings

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

Mappings:

FiveWs Pattern Mapping

Workflow Pattern

HL7 V2 Mapping

RIM Mapping

iCalendar

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

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

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
        actor FiveWs.who

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

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

12.14.10.3 HL7 V2 Mapping ( http://hl7.org/v2 icon )

Appointment
    identifier SCH-1, SCH-2, ARQ-1, ARQ-2
    status SCH-25
    cancellationReason
    class PV1-2
    serviceCategory
    serviceType ARQ-8, SCH-8
    specialty
    appointmentType ARQ-7, SCH-7
    reason AIS-3
    priority ARQ-12, SCH-11.6 / TQ1-9
    description NTE-3
    replaces
    virtualService
    supportingInformation
    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
    cancellationDate
    note NTE-3
    patientInstruction NTE-3
    basedOn
    subject PID-3-Patient ID List
    participant PID, AIP, AIG, AIL
        type AIP-4, AIG-4
        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.14.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')]
    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.14.10.5 iCalendar ( http://ietf.org/rfc/2445 icon )

Appointment VEVENT
    identifier UID
    status STATUS
    cancellationReason
    class
    serviceCategory CATEGORIES
    serviceType
    specialty
    appointmentType CLASSIFICATION
    reason
    priority PRIORITY
    description SUMMARY
    replaces ATTACH
    virtualService
    supportingInformation ATTACH
    previousAppointment
    originatingAppointment
    start DTSTART
    end DTEND
    minutesDuration DURATION (e.g. PT15M)
    requestedPeriod
    slot
    account
    created CREATED
    cancellationDate
    note DESCRIPTION (for internal use)
    patientInstruction DESCRIPTION (for patient use)
    basedOn
    subject
    participant ATTENDEE component to be created
        type n/a
        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)
    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