Release 5

This page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version. 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 GroupMaturity Level: N/AStandards Status: InformativeSecurity 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)

Appointmentworkflow.scheduling
    identifierFiveWs.identifier
    statusFiveWs.status
    classFiveWs.class
    specialtyFiveWs.class
    priorityFiveWs.class
    replacesFiveWs.context
    supportingInformationFiveWs.context
    previousAppointmentFiveWs.context
    originatingAppointmentFiveWs.context
    startFiveWs.init
    endFiveWs.done[x]
    subjectFiveWs.who
        actorFiveWs.who

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

AppointmentRequest
    identifierRequest.identifier
    statusRequest.status
    serviceTypeRequest.code
    reasonRequest.reason
    priorityRequest.priority
    replacesRequest.replaces
    supportingInformationRequest.supportingInfo
    startRequest.occurrence[x]
    endRequest.occurrence[x]
    minutesDurationRequest.occurrence[x]
    requestedPeriodRequest.occurrence[x]
    createdRequest.authoredOn
    noteRequest.note
    basedOnRequest.basedOn
    participantRequest.performer, Request.subject

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

Appointment
    identifierSCH-1, SCH-2, ARQ-1, ARQ-2
    statusSCH-25
    cancellationReason
    classPV1-2
    serviceCategory
    serviceTypeARQ-8, SCH-8
    specialty
    appointmentTypeARQ-7, SCH-7
    reasonAIS-3
    priorityARQ-12, SCH-11.6 / TQ1-9
    descriptionNTE-3
    replaces
    virtualService
    supportingInformation
    previousAppointment
    originatingAppointment
    startARQ-11.1, SCH-11.4 / TQ1-7
    endSCH-11.5 / TQ1-8/ calculated based on the start and the duration which is in ARQ-9
    minutesDuration
    requestedPeriodARQ-11
    slot
    account
    created
    cancellationDate
    noteNTE-3
    patientInstructionNTE-3
    basedOn
    subjectPID-3-Patient ID List
    participantPID, AIP, AIG, AIL
        typeAIP-4, AIG-4
        period
        actorPID-3-Patient ID List | AIL-3 | AIG-3 | AIP-3
        required
        statusAIP-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)

AppointmentAct[@moodCode <= 'INT']
    identifier.id
    status.statusCode
    cancellationReasonn/a
    class.inboundRelationship[typeCode=SUBJ].source[classCode=LIST].code
    serviceCategoryn/a, might be inferred from the ServiceDeliveryLocation
    serviceTypen/a, might be inferred from the ServiceDeliveryLocation
    specialty.performer.AssignedPerson.code
    appointmentType.code
    reason.reasonCode
    priority.priorityCode
    description.text
    replaces.inboundRelationship[@typeCode = 'SPRT'].observation
    virtualServiceN/A
    supportingInformation.inboundRelationship[@typeCode = 'SPRT'].observation
    previousAppointmentN/A
    originatingAppointmentN/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']
    subjectsubject.patient
    participantperformer | reusableDevice | subject | location
        type(performer | reusableDevice | subject | location).@typeCode
        periodn/a
        actorperformer.person | reusableDevice.manufacturedDevice | subject.patient | location.serviceDeliveryLocation
        required(performer | reusableDevice | subject | location).@performInd
        status(performer | reusableDevice | subject | location).statusCode
    recurrenceIdN/A
    occurrenceChangedN/A
    recurrenceTemplateN/A
        timezoneN/A

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

AppointmentVEVENT
    identifierUID
    statusSTATUS
    cancellationReason
    class
    serviceCategoryCATEGORIES
    serviceType
    specialty
    appointmentTypeCLASSIFICATION
    reason
    priorityPRIORITY
    descriptionSUMMARY
    replacesATTACH
    virtualService
    supportingInformationATTACH
    previousAppointment
    originatingAppointment
    startDTSTART
    endDTEND
    minutesDurationDURATION (e.g. PT15M)
    requestedPeriod
    slot
    account
    createdCREATED
    cancellationDate
    noteDESCRIPTION (for internal use)
    patientInstructionDESCRIPTION (for patient use)
    basedOn
    subject
    participantATTENDEE component to be created
        typen/a
        period
        actorATTENDEE: (Need to provide the common name CN and also the MAILTO properties from the practitioner resource) where the participant type is not "information-only"
        requiredROLE=REQ-PARTICIPANT (roleparam)
        statusATTENDEE;CN="John Doe";RSVP=TRUE:mailto:john@doe.com (rsvpparam | partstatparam)
    recurrenceId
    occurrenceChanged
    recurrenceTemplate
        timezoneTZID
        recurrenceTypeFREQ
        lastOccurrenceDateUNTIL
        occurrenceCountCOUNT
        occurrenceDateRDATE
        weeklyTemplate
            monday
            tuesday
            wednesday
            thursday
            friday
            saturday
            sunday
            weekInterval
        monthlyTemplate
            dayOfMonth
            nthWeekOfMonth
            dayOfWeek
            monthInterval
        yearlyTemplate
            yearInterval
        excludingDateEXDATE
        excludingRecurrenceId