US Veterans Health Administration FHIR Map Set Implementation Guide
1.6.0 - 250701 United States of America flag

Publication Build: This will be filled in by the publication tooling

Table of Contents

.. 0 Table of Contents
... 1 Index
... 2 Background
.... 2.1 Process
.... 2.2 Profile Hierarchy
.... 2.3 FHIR Design Patterns
.... 2.4 Classes
... 3 Use Cases
.... 3.1 Use Case Overview
.... 3.2 Use Case Debt Portal
.... 3.3 Practitioner and PracitionerRole
.... 3.4 Use Case Vitals
... 4 Extensions
... 5 Must Support
... 6 Changes
... 7 History
... 8 Mapset Qa
... 9 Artifacts Summary
.... 9.1 AMPL GUI
.... 9.2 Debt Portal
.... 9.3 Lighthouse Clinical Health API
.... 9.4 Lighthouse Patient Health API
.... 9.5 Lung Cancer Screening
.... 9.6 Medication Dispense Tracking
.... 9.7 AllergyIntolerance
.... 9.8 Appointment
.... 9.9 Condition: Encounter Diagnosis
.... 9.10 Condition: Problem
.... 9.11 Debt Portal Account
.... 9.12 Debt Portal ChargeItem[charges]
.... 9.13 Debt Portal ChargeItem[interest]
.... 9.14 Debt Portal ChargeItem[removed]
.... 9.15 Debt Portal Invoice
.... 9.16 Debt Portal Patient
.... 9.17 Debt Portal PaymentReconciliation
.... 9.18 Diagnostic Report Note: Cytopathology DiagnosticReport
.... 9.19 Diagnostic Report Note: Cytopathology Specimen
.... 9.20 Diagnostic Report Note: Electron Microscopy DiagnosticReport
.... 9.21 Diagnostic Report Note: Electron Microscopy Specimen
.... 9.22 Diagnostic Report Note: Surgical Pathology DiagnosticReport
.... 9.23 Diagnostic Report Note: Surgical Pathology Specimen
.... 9.24 Document Reference Binary
.... 9.25 Document Reference DocumentReference
.... 9.26 Encounter: Inpatient Condition
.... 9.27 Encounter: Inpatient Encounter
.... 9.28 Encounter: Outpatient
.... 9.29 Immunization Immunization
.... 9.30 Immunization Observation
.... 9.31 Implantable Device
.... 9.32 Implantable Device: A Lead
.... 9.33 Implantable Device: Dental
.... 9.34 Implantable Device: Pacemaker
.... 9.35 Implantable Device: Prosthesis
.... 9.36 Implantable Device: Transmitter
.... 9.37 Implantable Device: V Lead
.... 9.38 Lab Observation
.... 9.39 Lab Observation: Chem, hem, tox, ria, ser DiagnosticReport
.... 9.40 Lab Observation: Chem, hem, tox, ria, ser Observation
.... 9.41 Lab Observation: Chem, hem, tox, ria, ser Specimen
.... 9.42 Lab Observation: Microbiology Bacteriology Observation
.... 9.43 Lab Observation: Microbiology Bacteriology Observation[bacteria]
.... 9.44 Lab Observation: Microbiology Bacteriology Specimen
.... 9.45 Lab Observation: Microbiology Mycobacteriology Observation
.... 9.46 Lab Observation: Microbiology Mycobacteriology Observation[mycobact]
.... 9.47 Lab Observation: Microbiology Mycobacteriology Specimen
.... 9.48 Lab Observation: Microbiology Mycology Observation
.... 9.49 Lab Observation: Microbiology Mycology Observation[fungus]
.... 9.50 Lab Observation: Microbiology Mycology Specimen
.... 9.51 Lab Observation: Microbiology Observation
.... 9.52 Lab Observation: Microbiology Parasitology Observation
.... 9.53 Lab Observation: Microbiology Parasitology Specimen
.... 9.54 Lab Observation: Microbiology Specimen
.... 9.55 Lab Observation: Microbiology Virology Observation
.... 9.56 Lab Observation: Microbiology Virology Observation[virus]
.... 9.57 Lab Observation: Microbiology Virology Specimen
.... 9.58 Location
.... 9.59 MedRefillRequestMHV Provenance[create]
.... 9.60 MedRefillRequestMHV Provenance[review]
.... 9.61 MedRefillRequestMHV Task
.... 9.62 MedicationDispense: Original
.... 9.63 MedicationDispense: Partial
.... 9.64 MedicationDispense: Refill
.... 9.65 MedicationRequest: NonVA
.... 9.66 MedicationRequest: Outpatient
.... 9.67 MedicationRequest: Pending
.... 9.68 MedicationRequest: Unsigned
.... 9.69 Observation Imaging Result
.... 9.70 Organization
.... 9.71 Patient
.... 9.72 Practitioner
.... 9.73 Practitioner Role
.... 9.74 Procedure: Outpatient
.... 9.75 Procedure: Radiology
.... 9.76 Procedure: Surgery Location[OR]
.... 9.77 Procedure: Surgery Procedure
.... 9.78 Smoking Status Observation
.... 9.79 Vital Signs
.... 9.80 Vital Signs: BP
.... 9.81 Vital Signs: SpO2
.... 9.82 A LEAD IMPLANT (698.2)
.... 9.83 ACCOUNTS RECEIVABLE (430)
.... 9.84 ACCOUNTS RECEIVABLE TRANS.TYPE (430.3)
.... 9.85 ADVERSE REACTION REPORTING (120.85)
.... 9.86 APPOINTMENT (2.98)
.... 9.87 APPOINTMENT TYPE (409.1)
.... 9.88 AR DEBTOR (340)
.... 9.89 AR TRANSACTION (433)
.... 9.90 BILL/CLAIMS (399)
.... 9.91 CHEM, HEM, TOX, RIA, SER, etc. (63.04)
.... 9.92 CODE (8926.121)
.... 9.93 CODING SYSTEM (50.65)
.... 9.94 CODING SYSTEM (8926.12)
.... 9.95 COLLECTION SAMPLE (62)
.... 9.96 COMMENT (63.041)
.... 9.97 COMMENTS (120.826)
.... 9.98 CONTACT (4.03)
.... 9.99 COUNTRY CODE (779.004)
.... 9.100 CPT (81)
.... 9.101 CYTOPATHOLOGY (63.09)
.... 9.102 DENTAL DEVICE TRACKING (228.9)
.... 9.103 DRUG (50)
.... 9.104 EM (63.02)
.... 9.105 EXAMINATION STATUS (72)
.... 9.106 EXAMINATIONS (70.03)
.... 9.107 GENERATOR IMPLANT (698)
.... 9.108 GMRV VITAL MEASUREMENT (120.5)
.... 9.109 GMRV VITAL QUALIFIER (120.52)
.... 9.110 GMRV VITAL TYPE (120.51)
.... 9.111 HEALTH FACTORS (9999999.64)
.... 9.112 HOSPITAL LOCATION (44)
.... 9.113 IB ACTION TYPE (350.1)
.... 9.114 IB CHARGE REMOVE REASONS (350.3)
.... 9.115 IB-FB INTERFACE TRACKING (360)
.... 9.116 ICD DIAGNOSIS (80)
.... 9.117 ICD OPERATION/PROCEDURE (80.1)
.... 9.118 IMAGING LOCATIONS (79.1)
.... 9.119 IMAGING TYPE (79.2)
.... 9.120 IMMUNIZATION (9999999.14)
.... 9.121 IMMUNIZATION LOT (9999999.41)
.... 9.122 INPATIENT CPT CODE (46)
.... 9.123 INSTITUTION (4)
.... 9.124 INTEGRATED BILLING ACTION (350)
.... 9.125 LAB DATA (63)
.... 9.126 LAB LOINC (95.3)
.... 9.127 LABORATORY TEST (60)
.... 9.128 LANGUAGE DATE/TIME (2.07)
.... 9.129 LOCATION (9999999.06)
.... 9.130 MEDICAL PATIENT (690)
.... 9.131 MEDICATION INSTRUCTIONS (52.0113)
.... 9.132 MICROBIOLOGY (63.05)
.... 9.133 NAME COMPONENTS (20)
.... 9.134 NEW PERSON (200)
.... 9.135 NON-VA MEDS (55.05)
.... 9.136 OPERATING ROOM (131.7)
.... 9.137 ORDER (100)
.... 9.138 ORDERED TEST (63.07)
.... 9.139 ORDERED TEST (63.5)
.... 9.140 ORDERED TEST (63.51)
.... 9.141 ORDERED TEST (63.52)
.... 9.142 ORDERED TEST (63.53)
.... 9.143 OUTPATIENT ENCOUNTER (409.68)
.... 9.144 OUTPATIENT SITE (59)
.... 9.145 PACEMAKER EQUIPMENT (698.4)
.... 9.146 PACEMAKER MANUFACTURER (698.6)
.... 9.147 PARTIAL DATE (52.2)
.... 9.148 PATIENT (2)
.... 9.149 PATIENT (44.003)
.... 9.150 PATIENT ALLERGIES (120.8)
.... 9.151 PATIENT/IHS (9000001)
.... 9.152 PENDING OUTPATIENT ORDERS (52.41)
.... 9.153 PERSON CLASS (200.05)
.... 9.154 PERSON CLASS (8932.1)
.... 9.155 PRESCRIPTION (52)
.... 9.156 PRESCRIPTION REFILL REQUEST (52.43)
.... 9.157 PROBLEM (9000011)
.... 9.158 PROCEDURES (399.0304)
.... 9.159 PROSTHESIS (131.9)
.... 9.160 PROSTHESIS INSTALLED (130.01)
.... 9.161 PROVIDER NARRATIVE (9999999.27)
.... 9.162 PTF (45)
.... 9.163 RAD/NUC MED PATIENT (70)
.... 9.164 RAD/NUC MED PROCEDURES (71)
.... 9.165 RAD/NUC MED REASON (75.2)
.... 9.166 REACTIONS (120.81)
.... 9.167 REFILL (52.1)
.... 9.168 REGISTERED EXAMS (70.02)
.... 9.169 SD WAIT LIST (409.3)
.... 9.170 SIGN/SYMPTOMS (120.83)
.... 9.171 SITE/SPECIMEN (60.01)
.... 9.172 SOURCE OF ADMISSION (45.1)
.... 9.173 SPECIMEN (63.202)
.... 9.174 SPECIMEN (63.812)
.... 9.175 SPECIMEN (63.902)
.... 9.176 STATE (5)
.... 9.177 SURGERY (130)
.... 9.178 SURGICAL PATHOLOGY (63.08)
.... 9.179 TITLE (3.1)
.... 9.180 TIU DOCUMENT (8925)
.... 9.181 TIU DOCUMENT DEFINITION (8925.1)
.... 9.182 TIU REFERENCE DATE/TIME (63.19)
.... 9.183 TIU REFERENCE DATE/TIME (63.47)
.... 9.184 TIU REFERENCE DATE/TIME (63.49)
.... 9.185 TIU VHA ENTERPRISE STANDARD TITLE (8926.1)
.... 9.186 UCUM CODES (757.5)
.... 9.187 V CPT (9000010.18)
.... 9.188 V HEALTH FACTORS (9000010.23)
.... 9.189 V IMMUNIZATION (9000010.11)
.... 9.190 V LEAD IMPLANT (698.1)
.... 9.191 V POV (9000010.07)
.... 9.192 V PROVIDER (9000010.06)
.... 9.193 VA GENERIC (50.6)
.... 9.194 VA PRODUCT (50.68)
.... 9.195 VISIT (9000010)
.... 9.196 WARD LOCATION (42)
.... 9.197 AccountStatementGenerationDay
.... 9.198 MedicationRequestCancelDate
.... 9.199 MedicationRequestIncludeIndicationInSig
.... 9.200 MedicationRequestPharmacyOrderStatus
.... 9.201 MedicationrequestRecordedLocation
.... 9.202 MedicationrequestRemainingRefillCount
.... 9.203 OrganizationAllowMultipleBedsections
.... 9.204 OrganizationAnotherCompanyProcessesInpatClaims
.... 9.205 OrganizationOneOutpatVisitOnBillOnly
.... 9.206 PatientAgeAtVaccination
.... 9.207 ResourceServiceConnection
.... 9.208 adminGender FHIR
.... 9.209 adminGender VistA
.... 9.210 allergyActive FHIR
.... 9.211 allergyActive VistA
.... 9.212 allergyEnteredInError FHIR
.... 9.213 allergyEnteredInError VistA
.... 9.214 allergyMechanism FHIR
.... 9.215 allergyMechanism VistA
.... 9.216 allergySeverity FHIR
.... 9.217 allergySeverity VistA
.... 9.218 allergySubstanceCategory FHIR
.... 9.219 allergySubstanceCategory VistA
.... 9.220 allergyVerificationStatus FHIR
.... 9.221 allergyVerificationStatus VistA
.... 9.222 AntibioticSensitivityInterpretation FHIR
.... 9.223 AntibioticSensitivityInterpretation VistA
.... 9.224 AppointmentCancellationReason FHIR
.... 9.225 AppointmentCancellationReason VistA
.... 9.226 AppointmentStatus FHIR
.... 9.227 AppointmentStatus VistA
.... 9.228 ARBillStatus FHIR
.... 9.229 ARBillStatus VistA
.... 9.230 birthSex FHIR
.... 9.231 birthSex VistA
.... 9.232 Boolean FHIR
.... 9.233 Boolean VistA
.... 9.234 CommunicationQualifier FHIR
.... 9.235 CommunicationQualifier VistA
.... 9.236 CoverageRelationship FHIR
.... 9.237 CoverageRelationship VistA
.... 9.238 CoverageStatusForce FHIR
.... 9.239 CoverageStatusForce VistA
.... 9.240 DentalDeviceStatus FHIR
.... 9.241 DentalDeviceStatus VistA
.... 9.242 deviceTypePacemaker FHIR
.... 9.243 deviceTypePacemaker VistA
.... 9.244 DiagnosticReportLabStatus FHIR
.... 9.245 DiagnosticReportLabStatus VistA
.... 9.246 documentReferencedocStatus FHIR
.... 9.247 documentReferencedocStatus VistA
.... 9.248 DoseUnits FHIR
.... 9.249 DoseUnits VistA
.... 9.250 DPPLungCancerScreeningDec FHIR
.... 9.251 DPPLungCancerScreeningDec VistA
.... 9.252 DPPLungCancerScreeningFind FHIR
.... 9.253 DPPLungCancerScreeningFind VistA
.... 9.254 DPPLungCancerScreeningOED FHIR
.... 9.255 DPPLungCancerScreeningOED VistA
.... 9.256 DPPLungCancerScreeningOEQ FHIR
.... 9.257 DPPLungCancerScreeningOEQ VistA
.... 9.258 encounterClass FHIR
.... 9.259 encounterClass VistA
.... 9.260 encounterParticipationType FHIR
.... 9.261 encounterParticipationType VistA
.... 9.262 encounterProblemStatus FHIR
.... 9.263 encounterProblemStatus VistA
.... 9.264 encounterProblemVerificationStatus FHIR
.... 9.265 encounterProblemVerificationStatus VistA
.... 9.266 ethnicityCategory FHIR
.... 9.267 ethnicityCategory VistA
.... 9.268 ExamResultInterpretation FHIR
.... 9.269 ExamResultInterpretation VistA
.... 9.270 ExamStatus FHIR
.... 9.271 ExamStatus VistA
.... 9.272 genderIdentity FHIR
.... 9.273 genderIdentity VistA
.... 9.274 ICDCodingSystems FHIR
.... 9.275 ICDCodingSystems VistA
.... 9.276 ICDVersion FHIR
.... 9.277 ICDVersion VistA
.... 9.278 ImageInterpretation FHIR
.... 9.279 ImageInterpretation VistA
.... 9.280 ImageStatus FHIR
.... 9.281 ImageStatus VistA
.... 9.282 ImageStatusRadNuc FHIR
.... 9.283 ImageStatusRadNuc VistA
.... 9.284 immunizationPrimarySource FHIR
.... 9.285 immunizationPrimarySource VistA
.... 9.286 ImmunizationReaction FHIR
.... 9.287 ImmunizationReaction VistA
.... 9.288 immunizationStatusReason FHIR
.... 9.289 immunizationStatusReason VistA
.... 9.290 inferredCVX FHIR
.... 9.291 inferredCVX VistA
.... 9.292 LabInterpretation FHIR
.... 9.293 LabInterpretation VistA
.... 9.294 LabObservationStatus FHIR
.... 9.295 LabObservationStatus VistA
.... 9.296 LocationStatus FHIR
.... 9.297 LocationStatus VistA
.... 9.298 MaritalStatus FHIR
.... 9.299 MaritalStatus VistA
.... 9.300 MicrobiologyUrineScreenResult FHIR
.... 9.301 MicrobiologyUrineScreenResult VistA
.... 9.302 OperatingRoomStatus FHIR
.... 9.303 OperatingRoomStatus VistA
.... 9.304 OrderPatientClass FHIR
.... 9.305 OrderPatientClass VistA
.... 9.306 OrganizationIdentifierType FHIR
.... 9.307 OrganizationIdentifierType VistA
.... 9.308 OutMedRequestStatus FHIR
.... 9.309 OutMedRequestStatus VistA
.... 9.310 PersonIdentifierType FHIR
.... 9.311 PersonIdentifierType VistA
.... 9.312 PharmacyPersonType FHIR
.... 9.313 PharmacyPersonType VistA
.... 9.314 PractitionerCountry FHIR
.... 9.315 PractitionerCountry VistA
.... 9.316 problemStatus FHIR
.... 9.317 problemStatus VistA
.... 9.318 problemVerificationStatus FHIR
.... 9.319 problemVerificationStatus VistA
.... 9.320 ProcedureCodeSystem FHIR
.... 9.321 ProcedureCodeSystem VistA
.... 9.322 providerGender FHIR
.... 9.323 providerGender VistA
.... 9.324 raceCategory FHIR
.... 9.325 raceCategory VistA
.... 9.326 RadiologyProcedureStatus FHIR
.... 9.327 RadiologyProcedureStatus VistA
.... 9.328 RefillRequestStatus FHIR
.... 9.329 RefillRequestStatus VistA
.... 9.330 Religion FHIR
.... 9.331 Religion VistA
.... 9.332 SmokingStatus FHIR
.... 9.333 SmokingStatus VistA
.... 9.334 SourceOfAdmission FHIR
.... 9.335 SourceOfAdmission VistA
.... 9.336 VistaNCPDPCoverageRelationship FHIR
.... 9.337 VistaNCPDPCoverageRelationship VistA
.... 9.338 VitalsBodyPosition FHIR
.... 9.339 VitalsBodyPosition VistA
.... 9.340 VitalsBodySite FHIR
.... 9.341 VitalsBodySite VistA
.... 9.342 VitalsCodes FHIR
.... 9.343 VitalsCodes VistA
.... 9.344 VitalsCuffSize FHIR
.... 9.345 VitalsCuffSize VistA
.... 9.346 VitalsLaterality FHIR
.... 9.347 VitalsLaterality VistA
.... 9.348 VitalsMeasurementDevice FHIR
.... 9.349 VitalsMeasurementDevice VistA
.... 9.350 VitalsMethod FHIR
.... 9.351 VitalsMethod VistA
.... 9.352 VitalsPrecondition FHIR
.... 9.353 VitalsPrecondition VistA
.... 9.354 VitalsQualifyingDevice FHIR
.... 9.355 VitalsQualifyingDevice VistA
.... 9.356 VitalsUnits FHIR
.... 9.357 VitalsUnits VistA
.... 9.358 VSResourceServiceConnection
.... 9.359 YesNo10 FHIR
.... 9.360 YesNo10 VistA
.... 9.361 VF_adminGender
.... 9.362 VF_allergyActive
.... 9.363 VF_allergyEnteredInError
.... 9.364 VF_allergyMechanism
.... 9.365 VF_allergySeverity
.... 9.366 VF_allergySubstanceCategory
.... 9.367 VF_allergyVerificationStatus
.... 9.368 VF_AntibioticSensitivityInterpretation
.... 9.369 VF_AppointmentCancellationReason
.... 9.370 VF_AppointmentStatus
.... 9.371 VF_ARBillStatus
.... 9.372 VF_birthSex
.... 9.373 VF_Boolean
.... 9.374 VF_CommunicationQualifier
.... 9.375 VF_CoverageRelationship
.... 9.376 VF_CoverageStatusForce
.... 9.377 VF_DentalDeviceStatus
.... 9.378 VF_deviceTypePacemaker
.... 9.379 VF_DiagnosticReportLabStatus
.... 9.380 VF_documentReferencedocStatus
.... 9.381 VF_DoseUnits
.... 9.382 VF_DPPLungCancerScreeningDec
.... 9.383 VF_DPPLungCancerScreeningFind
.... 9.384 VF_DPPLungCancerScreeningOED
.... 9.385 VF_DPPLungCancerScreeningOEQ
.... 9.386 VF_encounterClass
.... 9.387 VF_encounterParticipationType
.... 9.388 VF_encounterProblemStatus
.... 9.389 VF_encounterProblemVerificationStatus
.... 9.390 VF_ethnicityCategory
.... 9.391 VF_ExamResultInterpretation
.... 9.392 VF_ExamStatus
.... 9.393 VF_genderIdentity
.... 9.394 VF_ICDCodingSystems
.... 9.395 VF_ICDVersion
.... 9.396 VF_ImageInterpretation
.... 9.397 VF_ImageStatus
.... 9.398 VF_ImageStatusRadNuc
.... 9.399 VF_immunizationPrimarySource
.... 9.400 VF_ImmunizationReaction
.... 9.401 VF_immunizationStatusReason
.... 9.402 VF_inferredCVX
.... 9.403 VF_LabInterpretation
.... 9.404 VF_LabObservationStatus
.... 9.405 VF_LocationStatus
.... 9.406 VF_MaritalStatus
.... 9.407 VF_MicrobiologyUrineScreenResult
.... 9.408 VF_OperatingRoomStatus
.... 9.409 VF_OrderPatientClass
.... 9.410 VF_OrganizationIdentifierType
.... 9.411 VF_OutMedRequestStatus
.... 9.412 VF_PersonIdentifierType
.... 9.413 VF_PharmacyPersonType
.... 9.414 VF_PractitionerCountry
.... 9.415 VF_problemStatus
.... 9.416 VF_problemVerificationStatus
.... 9.417 VF_ProcedureCodeSystem
.... 9.418 VF_providerGender
.... 9.419 VF_raceCategory
.... 9.420 VF_RadiologyProcedureStatus
.... 9.421 VF_RefillRequestStatus
.... 9.422 VF_Religion
.... 9.423 VF_SmokingStatus
.... 9.424 VF_SourceOfAdmission
.... 9.425 VF_VitalsBodyPosition
.... 9.426 VF_VitalsBodySite
.... 9.427 VF_VitalsCodes
.... 9.428 VF_VitalsCuffSize
.... 9.429 VF_VitalsLaterality
.... 9.430 VF_VitalsMeasurementDevice
.... 9.431 VF_VitalsMethod
.... 9.432 VF_VitalsPrecondition
.... 9.433 VF_VitalsQualifyingDevice
.... 9.434 VF_VitalsUnits
.... 9.435 VF_YesNo10
.... 9.436 Vista_NCPDPCoverageRelationship
.... 9.437 Parameters for Terminology selection of US SNOMED CT