US Veterans Health Administration FHIR Map Set Implementation Guide
1.9.0 - 251001
US Veterans Health Administration FHIR Map Set Implementation Guide - Downloaded Version 1.9.0 See the Directory of published versions
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.
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 |
No Mappings Found
No Mappings Found
Name | Veterans Health Information Systems Technology and Architecture (VistA) | Clinical Data Warehouse (CDW) | Summary Document Architecure (SDA) | Virtual Patient Record XML (VPR) | Workflow Pattern | iCalendar![]() |
---|---|---|---|---|---|---|
![]() ![]() |
Request |
VEVENT | ||||
![]() ![]() ![]() |
||||||
![]() ![]() ![]() |
||||||
![]() ![]() ![]() |
||||||
![]() ![]() ![]() |
||||||
![]() ![]() ![]() |
||||||
![]() ![]() ![]() |
||||||
![]() ![]() ![]() |
||||||
![]() ![]() ![]() ![]() |
||||||
![]() ![]() ![]() ![]() ![]() |
||||||
![]() ![]() ![]() ![]() ![]() |
||||||
![]() ![]() ![]() ![]() ![]() |
||||||
![]() ![]() ![]() ![]() ![]() |
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) |
||
![]() ![]() ![]() |
||||||
![]() ![]() ![]() |
Request.identifier |
UID | ||||
![]() ![]() ![]() |
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 |
![]() ![]() ![]() |
terminologyMaps using VF_AppointmentCancellationReason on APPOINTMENT - CANCELLATION REASON (2.98-16) |
Appt.Appointment.CancellationReasonIEN |
Appointment.Extension[AppointmentExtension].CancelReason |
|||
![]() ![]() ![]() |
CATEGORIES | |||||
![]() ![]() ![]() ![]() |
CATEGORIES | |||||
![]() ![]() ![]() ![]() ![]() |
||||||
![]() ![]() ![]() ![]() ![]() |
||||||
![]() ![]() ![]() ![]() ![]() |
||||||
![]() ![]() ![]() ![]() ![]() ![]() |
||||||
![]() ![]() ![]() ![]() ![]() ![]() |
||||||
![]() ![]() ![]() ![]() ![]() ![]() |
fixed value = http://va.gov/terminology/VistADefinedTerms/409.3-13.4 mapParameter line 1 |
|||||
![]() ![]() ![]() ![]() ![]() ![]() |
||||||
![]() ![]() ![]() ![]() ![]() ![]() |
source value based on SD WAIT LIST - APPT STOP CODE (409.3-13.4) |
Appt.WaitList.AppointmentPrimaryStopCodeIEN |
||||
![]() ![]() ![]() ![]() ![]() ![]() |
||||||
![]() ![]() ![]() ![]() ![]() ![]() |
||||||
![]() ![]() ![]() ![]() ![]() |
||||||
![]() ![]() ![]() |
Request.code |
|||||
![]() ![]() ![]() |
target not supported |
|||||
![]() ![]() ![]() |
CLASSIFICATION | |||||
![]() ![]() ![]() ![]() |
||||||
![]() ![]() ![]() ![]() |
||||||
![]() ![]() ![]() ![]() |
||||||
![]() ![]() ![]() ![]() |
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) |
||
![]() ![]() ![]() |
target not supported |
Request.reasonCode |
||||
![]() ![]() ![]() |
target not supported |
Request.reasonReference |
||||
![]() ![]() ![]() |
Request.priority |
PRIORITY | ||||
![]() ![]() ![]() |
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 | |
![]() ![]() ![]() |
Request.supportingInfo |
ATTACH | ||||
![]() ![]() ![]() |
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 | |
![]() ![]() ![]() |
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 | |
![]() ![]() ![]() |
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) | |
![]() ![]() ![]() |
||||||
![]() ![]() ![]() |
source value based on SD WAIT LIST - ORIGINATING DATE (409.3-1) |
Appt.WaitList.OriginatingDate |
Appointment.EnteredOn |
Request.authoredOn |
CREATED | |
![]() ![]() ![]() |
source value based on SD WAIT LIST - COMMENTS (409.3-25) |
Appt.WaitList.WaitListComments |
Request.note |
DESCRIPTION (for internal use) | ||
![]() ![]() ![]() |
DESCRIPTION (for patient use) | |||||
![]() ![]() ![]() |
Request.basedOn |
|||||
![]() ![]() ![]() |
|
ATTENDEE component to be created | ||||
![]() ![]() ![]() ![]() |
||||||
![]() ![]() ![]() ![]() ![]() |
||||||
![]() ![]() ![]() ![]() ![]() |
||||||
![]() ![]() ![]() ![]() ![]() |
||||||
![]() ![]() ![]() ![]() ![]() |
n/a | |||||
![]() ![]() ![]() ![]() ![]() |
(Need to provide the common name CN and also the MAILTO properties from the practitioner resource) where the participant type is not "information-only" | |||||
![]() ![]() ![]() ![]() ![]() |
ROLE=REQ-PARTICIPANT (roleparam) | |||||
![]() ![]() ![]() ![]() ![]() |
mailto:john@doe.com (rsvpparam | partstatparam) | |||||
![]() ![]() ![]() ![]() ![]() |
||||||
![]() ![]() ![]() ![]() |
|
ATTENDEE component to be created | ||||
![]() ![]() ![]() ![]() ![]() |
||||||
![]() ![]() ![]() ![]() ![]() |
||||||
![]() ![]() ![]() ![]() ![]() |
||||||
![]() ![]() ![]() ![]() ![]() |
n/a | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
||||||
![]() ![]() ![]() ![]() ![]() ![]() |
||||||
![]() ![]() ![]() ![]() ![]() ![]() |
||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
fixed value = #PART mapParameter line 1 |
|||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
||||||
![]() ![]() ![]() ![]() ![]() ![]() |
||||||
![]() ![]() ![]() ![]() ![]() |
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" | |
![]() ![]() ![]() ![]() ![]() |
ROLE=REQ-PARTICIPANT (roleparam) | |||||
![]() ![]() ![]() ![]() ![]() |
fixed value = #accepted mapParameter line 2 |
mailto:john@doe.com (rsvpparam | partstatparam) | ||||
![]() ![]() ![]() ![]() ![]() |
||||||
![]() ![]() ![]() ![]() |
|
ATTENDEE component to be created | ||||
![]() ![]() ![]() ![]() ![]() |
||||||
![]() ![]() ![]() ![]() ![]() |
||||||
![]() ![]() ![]() ![]() ![]() |
||||||
![]() ![]() ![]() ![]() ![]() |
n/a | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
||||||
![]() ![]() ![]() ![]() ![]() ![]() |
||||||
![]() ![]() ![]() ![]() ![]() ![]() |
||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
fixed value = #PART if {1900>2.98} mapParameter line 1 |
|||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
||||||
![]() ![]() ![]() ![]() ![]() ![]() |
||||||
![]() ![]() ![]() ![]() ![]() |
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" | ||||
![]() ![]() ![]() ![]() ![]() |
ROLE=REQ-PARTICIPANT (roleparam) | |||||
![]() ![]() ![]() ![]() ![]() |
fixed value = #accepted if {1900>2.98} mapParameter line 2 |
mailto:john@doe.com (rsvpparam | partstatparam) | ||||
![]() ![]() ![]() ![]() ![]() |
||||||
![]() ![]() ![]() ![]() |
|
ATTENDEE component to be created | ||||
![]() ![]() ![]() ![]() ![]() |
||||||
![]() ![]() ![]() ![]() ![]() |
||||||
![]() ![]() ![]() ![]() ![]() |
||||||
![]() ![]() ![]() ![]() ![]() |
n/a | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
||||||
![]() ![]() ![]() ![]() ![]() ![]() |
||||||
![]() ![]() ![]() ![]() ![]() ![]() |
||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
fixed value = #PART mapParameter line 1 |
|||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
||||||
![]() ![]() ![]() ![]() ![]() ![]() |
||||||
![]() ![]() ![]() ![]() ![]() |
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" | |||
![]() ![]() ![]() ![]() ![]() |
ROLE=REQ-PARTICIPANT (roleparam) | |||||
![]() ![]() ![]() ![]() ![]() |
fixed value = #tentative mapParameter line 2 |
mailto:john@doe.com (rsvpparam | partstatparam) | ||||
![]() ![]() ![]() ![]() ![]() |
||||||
![]() ![]() ![]() |
Request.occurrence[x] |
|||||
![]() |