US Veterans Health Administration FHIR Map Set Implementation Guide
1.9.0 - 251001 United States of America flag

US Veterans Health Administration FHIR Map Set Implementation Guide - Downloaded Version 1.9.0 See the Directory of published versions

Resource Profile: Appointment - Mappings

Active as of 2025-09-30

Mappings for the Appointment resource profile.

Scroll down for the Raw FHIR, CDW & SDA mappings (if any).

Note that the CDW, SDA and VPR XML mappings are derived from a look-up based on the VistA source.

Mapping Sources

Use Case: Appointment (Source)Use Case: Appointment (Source)PATIENT (2)  APPOINTMENT (2.98).001APPOINTMENT DATE/TIME.01CLINIC3STATUS9.5APPOINTMENT TYPE16CANCELLATION REASON20DATE APPT. MADE21OUTPATIENT ENCOUNTERAPPOINTMENT TYPE (409.1).01NAME10DESCRIPTIONOUTPATIENT ENCOUNTER (409.68).07CHECK OUT PROCESS COMPLETIONPATIENT (44.003)1LENGTH OF APP'TSD WAIT LIST (409.3).01PATIENT1ORIGINATING DATE13.2APPT CLINIC13.4APPT STOP CODE22DESIRED DATE OF APPOINTMENT25COMMENTS[SERVICE CONNECTED][Not SERVICE CONNECTED]1900

Raw Mappings

key status direction source mapApproach mapCase FHIR Path subPath mapValue mapParameter mapComment FHIR URL | Ver
731 team-approved V2F APPOINTMENT - STATUS (2.98-3) terminologyMaps Appointment.status VF_AppointmentStatus simple maps in Terminology; complex defined here. http://hl7.org/fhir/StructureDefinition/Appointment | 4.0.1
732 team-approved V2F APPOINTMENT - STATUS (2.98-3) fixed value I, NT, Null; Null check-in date (44.003-309), null check-out date (44.003-303) Appointment.status #booked simple maps in Terminology; complex defined here. http://hl7.org/fhir/StructureDefinition/Appointment | 4.0.1
733 team-approved V2F APPOINTMENT - STATUS (2.98-3) fixed value I, NT, Null; Non-null check-in date (44.003-309), null check-out date (44.003-303) Appointment.status #arrived simple maps in Terminology; complex defined here. http://hl7.org/fhir/StructureDefinition/Appointment | 4.0.1
734 team-approved V2F APPOINTMENT - STATUS (2.98-3) fixed value I, NT, Null; Non-null check-in date (44.003-309), non-null check-out date (44.003-303) Appointment.status #fulfilled simple maps in Terminology; complex defined here. http://hl7.org/fhir/StructureDefinition/Appointment | 4.0.1
2033 for review V2F APPOINTMENT - APPOINTMENT TYPE > APPOINTMENT TYPE - NAME (2.98-9.5 > 409.1-.01) fixed value SERVICE CONNECTED Appointment.extension[http://va.gov/fhir/StructureDefinition/resource-serviceConnection].valueCoding http://va.gov/fhir/vistaDefinedTerms/409.1#SC "Service Connected" http://hl7.org/fhir/StructureDefinition/Appointment | 4.0.1
2034 for review V2F APPOINTMENT - APPOINTMENT TYPE > APPOINTMENT TYPE - NAME (2.98-9.5 > 409.1-.01) fixed value Not SERVICE CONNECTED Appointment.extension[http://va.gov/fhir/StructureDefinition/resource-serviceConnection].valueCoding http://va.gov/fhir/vistaDefinedTerms/409.1#NSC "Not Service Connected" http://hl7.org/fhir/StructureDefinition/Appointment | 4.0.1
735 team-approved V2F APPOINTMENT - CANCELLATION REASON (2.98-16) terminologyMaps Appointment.cancelationReason VF_AppointmentCancellationReason http://hl7.org/fhir/StructureDefinition/Appointment | 4.0.1
739 team-approved V2F target not supported Appointment.specialty http://hl7.org/fhir/StructureDefinition/Appointment | 4.0.1
740 team-approved V2F APPOINTMENT - APPOINTMENT TYPE > APPOINTMENT TYPE - NAME (2.98-9.5 > 409.1-.01) source value Appointment.appointmentType .text http://hl7.org/fhir/StructureDefinition/Appointment | 4.0.1
741 team-approved V2F target not supported Appointment.reasonCode http://hl7.org/fhir/StructureDefinition/Appointment | 4.0.1
742 team-approved V2F target not supported Appointment.reasonReference http://hl7.org/fhir/StructureDefinition/Appointment | 4.0.1
743 team-approved V2F APPOINTMENT - APPOINTMENT DATE/TIME (2.98-.001) source value Appointment.start http://hl7.org/fhir/StructureDefinition/Appointment | 4.0.1
1612 for review V2F APPOINTMENT - OUTPATIENT ENCOUNTER > OUTPATIENT ENCOUNTER - CHECK OUT PROCESS COMPLETION (2.98-21 > 409.68-.07) source value Appointment.end Added to meet FHIR Core constraint app-2 http://hl7.org/fhir/StructureDefinition/Appointment | 4.0.1
744 team-approved V2F PATIENT - LENGTH OF APP'T (44.003-1) source value Appointment.minutesDuration This field is associated with appointment in CDW, but VistA does not document the association. http://hl7.org/fhir/StructureDefinition/Appointment | 4.0.1
745 team-approved V2F APPOINTMENT - DATE APPT. MADE (2.98-20) source value Appointment.created http://hl7.org/fhir/StructureDefinition/Appointment | 4.0.1
746 team-approved V2F APPOINTMENT - CLINIC (2.98-.01) reference Appointment.participant[va-clinic] .actor /Location .type.coding.code = #PART
.status = #accepted
http://hl7.org/fhir/StructureDefinition/Appointment | 4.0.1
1722 for review V2F PATIENT - (2-) reference {1900>2.98} Appointment.participant[va-patient] .actor /Patient .type.coding.code = #PART
.status = #accepted
Added patient to the appointment map so that it is not assumed http://hl7.org/fhir/StructureDefinition/Appointment | 4.0.1
748 team-approved V2F SD WAIT LIST - PATIENT (409.3-.01) fixed value not null Appointment.status #waitlist LVH returns "Waitlisted". "Waitlisted" is the display value and "waitlist" is the code. This is a required FHIR value set. 3/15/2023 LVH will fix http://hl7.org/fhir/StructureDefinition/Appointment | 4.0.1
749 team-approved V2F SD WAIT LIST - APPT STOP CODE (409.3-13.4) source value Appointment.serviceCategory[va-stop-code].coding .code .system=http://va.gov/terminology/VistADefinedTerms/409.3-13.4 http://hl7.org/fhir/StructureDefinition/Appointment | 4.0.1
750 team-approved V2F SD WAIT LIST - DESIRED DATE OF APPOINTMENT (409.3-22) source value Appointment.start http://hl7.org/fhir/StructureDefinition/Appointment | 4.0.1
751 team-approved V2F SD WAIT LIST - ORIGINATING DATE (409.3-1) source value Appointment.created http://hl7.org/fhir/StructureDefinition/Appointment | 4.0.1
752 team-approved V2F SD WAIT LIST - COMMENTS (409.3-25) source value Appointment.comment http://hl7.org/fhir/StructureDefinition/Appointment | 4.0.1
754 team-approved V2F SD WAIT LIST - APPT CLINIC (409.3-13.2) reference Appointment.participant[va-apptclinic] .actor /Location .type.coding.code = #PART
.status = #tentative
http://hl7.org/fhir/StructureDefinition/Appointment | 4.0.1
1791 for review V2F APPOINTMENT - APPOINTMENT TYPE > APPOINTMENT TYPE - DESCRIPTION (2.98-9.5 > 409.1-10) source value Appointment.description Added after PHAPI gap analysis to match PHAPI fields http://hl7.org/fhir/StructureDefinition/Appointment | 4.0.1

Mappings to Structures in this Implementation Guide

No Mappings Found

Mappings to other Structures

No Mappings Found

Other Mappings

NameVeterans Health Information Systems Technology and Architecture (VistA)Clinical Data Warehouse (CDW)Summary Document Architecure (SDA)Virtual Patient Record XML (VPR)Workflow PatterniCalendardoco
.. Appointment
Request
VEVENT
... id
... meta
... implicitRules
... language
... text
... contained
... Slices for extension
.... extension:resource-serviceConnection
..... id
..... extension
..... url
..... value[x]
fixed value = http://va.gov/fhir/vistaDefinedTerms/409.1#NSC "Not Service Connected" when APPOINTMENT - APPOINTMENT TYPE > APPOINTMENT TYPE - NAME (2.98-9.5 > 409.1-.01) if Not SERVICE CONNECTED
Appt.Appointment.AppointmentTypeIEN Dim.AppointmentType.AppointmentType
Appointment.Type
appointment.type (>409.1-.01)
... modifierExtension
... identifier
Request.identifier
UID
... status
fixed value = #waitlist when SD WAIT LIST - PATIENT (409.3-.01) if not null
LVH returns "Waitlisted". "Waitlisted" is the display value and "waitlist" is the code. This is a required FHIR value set. 3/15/2023 LVH will fix
Appt.WaitList.PatientIEN
Appointment.NoShow Appointment.Extension[AppointmentExtension].PatientStatus Appointment.Extension[AppointmentExtension].ServiceStatus
appointment.apptStatus appointment.patientClass appointment.serviceCategory
Request.status
STATUS
... cancelationReason
terminologyMaps using VF_AppointmentCancellationReason on APPOINTMENT - CANCELLATION REASON (2.98-16)
Appt.Appointment.CancellationReasonIEN
Appointment.Extension[AppointmentExtension].CancelReason
... Slices for serviceCategory
CATEGORIES
.... serviceCategory:va-stop-code
CATEGORIES
..... id
..... extension
..... coding
...... id
...... extension
...... system
fixed value = http://va.gov/terminology/VistADefinedTerms/409.3-13.4
mapParameter line 1
...... version
...... code
source value based on SD WAIT LIST - APPT STOP CODE (409.3-13.4)
Appt.WaitList.AppointmentPrimaryStopCodeIEN
...... display
...... userSelected
..... text
... serviceType
Request.code
... specialty
target not supported
... appointmentType
CLASSIFICATION
.... id
.... extension
.... coding
.... text
source value based on APPOINTMENT - APPOINTMENT TYPE > APPOINTMENT TYPE - NAME (2.98-9.5 > 409.1-.01)
Appt.Appointment.AppointmentTypeIEN Dim.AppointmentType.AppointmentType
Appointment.Type
appointment.type (>409.1-.01)
... reasonCode
target not supported
Request.reasonCode
... reasonReference
target not supported
Request.reasonReference
... priority
Request.priority
PRIORITY
... description
source value based on APPOINTMENT - APPOINTMENT TYPE > APPOINTMENT TYPE - DESCRIPTION (2.98-9.5 > 409.1-10)
Added after PHAPI gap analysis to match PHAPI fields
Appt.Appointment.AppointmentTypeIEN
Appointment.Type
appointment.type (>409.1-.01)
SUMMARY
... supportingInformation
Request.supportingInfo
ATTACH
... start
source value based on SD WAIT LIST - DESIRED DATE OF APPOINTMENT (409.3-22)
Appt.WaitList.AppointmentDesiredDate
appointment.dateTime appointment.id appointment.visitString
Request.occurrence[x]
DTSTART
... end
source value based on APPOINTMENT - OUTPATIENT ENCOUNTER > OUTPATIENT ENCOUNTER - CHECK OUT PROCESS COMPLETION (2.98-21 > 409.68-.07)
Added to meet FHIR Core constraint app-2
Appt.Appointment.VisitIEN Outpat.Visit.COProcessCompleteDateTime Outpat.Workload.COProcessCompleteDateTime
Appointment.CareProvider Appointment.EncounterNumber Appointment.Extension[AppointmentExtension].AssociatedEncounterNumber
Request.occurrence[x]
DTEND
... minutesDuration
source value based on PATIENT - LENGTH OF APP'T (44.003-1)
This field is associated with appointment in CDW, but VistA does not document the association.
Appt.Appointment.LengthOfAppointment Appt.AppointmentMultiple.LengthOfAppointment
Appointment.Extension[AppointmentExtension].Length
Request.occurrence[x]
DURATION (e.g. PT15M)
... slot
... created
source value based on SD WAIT LIST - ORIGINATING DATE (409.3-1)
Appt.WaitList.OriginatingDate
Appointment.EnteredOn
Request.authoredOn
CREATED
... comment
source value based on SD WAIT LIST - COMMENTS (409.3-25)
Appt.WaitList.WaitListComments
Request.note
DESCRIPTION (for internal use)
... patientInstruction
DESCRIPTION (for patient use)
... basedOn
Request.basedOn
... Slices for participant
  • Request.performer
  • Request.subject
ATTENDEE component to be created
.... participant:All Slices
..... id
..... extension
..... modifierExtension
..... type
n/a
..... actor
(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
mailto:john@doe.com (rsvpparam | partstatparam)
..... period
.... participant:va-clinic
  • Request.performer
  • Request.subject
ATTENDEE component to be created
..... id
..... extension
..... modifierExtension
..... type
n/a
...... id
...... extension
...... coding
....... id
....... extension
....... system
....... version
....... code
fixed value = #PART
mapParameter line 1
....... display
....... userSelected
...... text
..... actor
reference based on APPOINTMENT - CLINIC (2.98-.01)
Appt.Appointment.LocationIEN
Appointment.CareProvider Appointment.EnteredAt Appointment.Location Appointment.PlacerApptId Appointment.Type
appointment.clinicStop (>44-8) appointment.facility (>44-3) appointment.id appointment.provider (>44-2600) appointment.service (>44-9) appointment.visitString
(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
fixed value = #accepted
mapParameter line 2
mailto:john@doe.com (rsvpparam | partstatparam)
..... period
.... participant:va-patient
  • Request.performer
  • Request.subject
ATTENDEE component to be created
..... id
..... extension
..... modifierExtension
..... type
n/a
...... id
...... extension
...... coding
....... id
....... extension
....... system
....... version
....... code
fixed value = #PART if {1900>2.98}
mapParameter line 1
....... display
....... userSelected
...... text
..... actor
reference based on PATIENT - (2-) if {1900>2.98}
Added patient to the appointment map so that it is not assumed
(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
fixed value = #accepted if {1900>2.98}
mapParameter line 2
mailto:john@doe.com (rsvpparam | partstatparam)
..... period
.... participant:va-apptclinic
  • Request.performer
  • Request.subject
ATTENDEE component to be created
..... id
..... extension
..... modifierExtension
..... type
n/a
...... id
...... extension
...... coding
....... id
....... extension
....... system
....... version
....... code
fixed value = #PART
mapParameter line 1
....... display
....... userSelected
...... text
..... actor
reference based on SD WAIT LIST - APPT CLINIC (409.3-13.2)
Appt.WaitList.AppointmentLocationIEN
(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
fixed value = #tentative
mapParameter line 2
mailto:john@doe.com (rsvpparam | partstatparam)
..... period
... requestedPeriod
Request.occurrence[x]

doco Documentation for this format