US Veterans Health Administration FHIR Map Set Implementation Guide
2.3.0 - 260301 United States of America flag

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

Resource Profile: VAPatient - Mappings

Active as of 2026-02-27

Mappings for the VAPatient 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: VAPatient (Source)Use Case: VAPatient (Source)PATIENT (2).02SEX.024SELF IDENTIFIED GENDER.03DATE OF BIRTH.05MARITAL STATUS.08RELIGIOUS PREFERENCE.111STREET ADDRESS [LINE 1].1112ZIP+4.112STREET ADDRESS [LINE 2].113STREET ADDRESS [LINE 3].114CITY.115STATE.1173COUNTRY.1217TEMPORARY ADDRESS START DATE.1218TEMPORARY ADDRESS END DATE.131PHONE NUMBER [RESIDENCE].132PHONE NUMBER [WORK].134PHONE NUMBER [CELLULAR].351DATE OF DEATH1.01NAME COMPONENTS2RACE INFORMATION6ETHNICITY INFORMATION7LANGUAGE DATE/TIME991.01INTEGRATION CONTROL NUMBERNAME COMPONENTS (20)1FAMILY (LAST) NAME2GIVEN (FIRST) NAME4PREFIX5SUFFIXLANGUAGE DATE/TIME (2.07).02PREFERRED LANGUAGEETHNICITY INFORMATION (2.06).01ETHNICITY INFORMATIONRACE INFORMATION (2.02).01RACE INFORMATION

Raw Mappings

key status direction source mapApproach mapCase FHIR Path subPath mapValue mapParameter mapComment FHIR URL | Ver
272 for review V2F PATIENT - INTEGRATION CONTROL NUMBER (2-991.01) source value Patient.identifier[va-icn] .value .system=urn:oid:2.16.840.1.113883.4.349
.type=http://terminology.hl7.org/CodeSystem/v2-0203#PN		 http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient | 6.1.0
273 for review V2F PATIENT - NAME COMPONENTS > NAME COMPONENTS - (2-1.01 > 20-) source value Patient.name .family = {FAMILY (LAST) NAME (1)}
.given = {GIVEN (FIRST) NAME (2)}
.prefix = {PREFIX (4)}
.suffix = {SUFFIX (5)}		 Changed to name components to align with US Core. If full name is needed, will need another row to map to 2-.01 and the .text field http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient | 6.1.0
274 for review V2F PATIENT - PHONE NUMBER [RESIDENCE] (2-.131) source value Patient.telecom[va-home] .value .system=#phone
.use=#home		 http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient | 6.1.0
275 for review V2F PATIENT - PHONE NUMBER [WORK] (2-.132) source value Patient.telecom[va-work] .value .system=#phone
.use=#work		 http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient | 6.1.0
276 for review V2F PATIENT - PHONE NUMBER [CELLULAR] (2-.134) source value Patient.telecom[va-mobile] .value .system=#phone
.use=#mobile		 http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient | 6.1.0
284 for review V2F PATIENT - DATE OF BIRTH (2-.03) source value Patient.birthDate http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient | 6.1.0
285 for review V2F PATIENT - DATE OF DEATH (2-.351) source value not null Patient.deceasedDateTime removed "true" based on Validator testing 6/30/23 http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient | 6.1.0
286 for review V2F PATIENT - STREET ADDRESS [LINE 1] (2-.111) source value Patient.address[va-home] .line .use=#home
.type=#postal		 http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient | 6.1.0
287 for review V2F PATIENT - STREET ADDRESS [LINE 2] (2-.112) source value Patient.address[va-home] .line http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient | 6.1.0
288 for review V2F PATIENT - STREET ADDRESS [LINE 3] (2-.113) source value Patient.address[va-home] .line http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient | 6.1.0
289 for review V2F PATIENT - CITY (2-.114) source value Patient.address[va-home] .city http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient | 6.1.0
290 for review V2F PATIENT - STATE (2-.115) source value Patient.address[va-home] .state http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient | 6.1.0
291 for review V2F PATIENT - ZIP+4 (2-.1112) source value Patient.address[va-home] .postalCode http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient | 6.1.0
292 for review V2F PATIENT - COUNTRY (2-.1173) source value Patient.address[va-home] .country confirm association with .111 etc. http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient | 6.1.0
293 for review V2F PATIENT - TEMPORARY ADDRESS START DATE (2-.1217) source value Patient.address[va-home] .period.start need other addresses, including temp; not just range http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient | 6.1.0
294 for review V2F PATIENT - TEMPORARY ADDRESS END DATE (2-.1218) source value Patient.address[va-home] .period.end need other addresses, including temp; not just range http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient | 6.1.0
295 for review V2F PATIENT - LANGUAGE DATE/TIME > LANGUAGE DATE/TIME - PREFERRED LANGUAGE (2-7 > 2.07-.02) source value Patient.communication.language http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient | 6.1.0
296 for review V2F fixed value Patient.managingOrganization .display Veterans Health Administration http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient | 6.1.0
555 for review V2F PATIENT - SEX (2-.02) terminologyMaps Patient.gender VF_adminGender Map VA sex to FHIR gender; both are vague. For now. http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient | 6.1.0
1808 for review V2F PATIENT - SELF IDENTIFIED GENDER (2-.024) terminologyMaps Patient.extension[http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity] .valueCodeableConcept VF_genderIdentity http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient | 6.1.0
575 for review V2F PATIENT - ETHNICITY INFORMATION > ETHNICITY INFORMATION - ETHNICITY INFORMATION (2-6 > 2.06-.01) terminologyMaps Patient.extension[http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity] .extension[ombCategory].valueCoding.code VF_ethnicityCategory .extension[text].valueString={} http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient | 6.1.0
576 for review V2F PATIENT - RACE INFORMATION > RACE INFORMATION - RACE INFORMATION (2-2 > 2.02-.01) terminologyMaps Patient.extension[http://hl7.org/fhir/us/core/StructureDefinition/us-core-race] .extension[ombCategory].valueCoding.code VF_raceCategory .extension[text].valueString={} Do we collect any detailed race data? http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient | 6.1.0
1597 for review V2F PATIENT - MARITAL STATUS (2-.05) terminologyMaps Patient.maritalStatus VF_MaritalStatus http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient | 6.1.0
1598 for review V2F PATIENT - RELIGIOUS PREFERENCE (2-.08) terminologyMaps Patient.extension[http://hl7.org/fhir/StructureDefinition/patient-religion] .valueCodeableConcept VF_Religion http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient | 6.1.0

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)doco
.. Patient
... id
... meta
... implicitRules
... text
... contained
... Slices for extension
.... extension:race
..... id
..... Slices for extension
...... extension:ombCategory
....... id
....... extension
....... url
....... value[x]
........ id
........ extension
........ system
........ version
........ code
terminologyMaps using VF_raceCategory on PATIENT - RACE INFORMATION > RACE INFORMATION - RACE INFORMATION (2-2 > 2.02-.01)
Do we collect any detailed race data?
PatSub.PatientRace.RaceIEN
Patient.Races
10] (>10-3)
........ display
........ userSelected
...... extension:detailed
....... id
....... extension
....... url
....... value[x]
...... extension:text
....... id
....... extension
....... url
....... value[x]
source value based on PATIENT - RACE INFORMATION > RACE INFORMATION - RACE INFORMATION (2-2 > 2.02-.01)
mapParameter line 1
PatSub.PatientRace.RaceIEN
Patient.Races
10] (>10-3)
..... url
..... value[x]
.... extension:ethnicity
..... id
..... Slices for extension
...... extension:ombCategory
....... id
....... extension
....... url
....... value[x]
........ id
........ extension
........ system
........ version
........ code
terminologyMaps using VF_ethnicityCategory on PATIENT - ETHNICITY INFORMATION > ETHNICITY INFORMATION - ETHNICITY INFORMATION (2-6 > 2.06-.01)
PatSub.PatientEthnicity.EthnicityIEN
Patient.EthnicGroup
........ display
........ userSelected
...... extension:detailed
....... id
....... extension
....... url
....... value[x]
...... extension:text
....... id
....... extension
....... url
....... value[x]
source value based on PATIENT - ETHNICITY INFORMATION > ETHNICITY INFORMATION - ETHNICITY INFORMATION (2-6 > 2.06-.01)
mapParameter line 1
PatSub.PatientEthnicity.EthnicityIEN
Patient.EthnicGroup
..... url
..... value[x]
.... extension:tribalAffiliation
.... extension:birthsex
.... extension:sex
.... extension:genderIdentity
..... id
..... extension
..... url
..... value[x]
terminologyMaps using VF_genderIdentity on PATIENT - SELF IDENTIFIED GENDER (2-.024)
Patient.Patient.SelfIdentifiedGender SPatient.SPatient.SelfIdentifiedGender
.... extension:patient-religion
..... id
..... extension
..... url
..... value[x]
terminologyMaps using VF_Religion on PATIENT - RELIGIOUS PREFERENCE (2-.08)
Outpat.Visit.PatientReligion Outpat.Visit.PatientReligionCode Outpat.Workload.PatientReligion Outpat.Workload.PatientReligionCode Patient.Patient.ReligionIEN SPatient.SPatient.ReligionIEN
Patient.Religion
demographics.religion
... modifierExtension
... Slices for identifier
.... identifier:All Slices
..... id
..... extension
..... use
..... type
..... system
..... value
..... period
..... assigner
.... identifier:va-icn
..... id
..... extension
..... use
..... type
fixed value = http://terminology.hl7.org/CodeSystem/v2-0203#PN
mapParameter line 2
Patient.Patient.PatientICN Patient.PatientICN.PatientICN SPatient.SPatient.PatientICN SPatient.SPatientGISAddress.PatientICN
demographics.icn
..... system
fixed value = urn:oid:2.16.840.1.113883.4.349
mapParameter line 1
Patient.Patient.PatientICN Patient.PatientICN.PatientICN SPatient.SPatient.PatientICN SPatient.SPatientGISAddress.PatientICN
demographics.icn
..... value
source value based on PATIENT - INTEGRATION CONTROL NUMBER (2-991.01)
Patient.Patient.PatientICN Patient.PatientICN.PatientICN SPatient.SPatient.PatientICN SPatient.SPatientGISAddress.PatientICN
demographics.icn
..... period
..... assigner
... active
... name
source value based on PATIENT - NAME COMPONENTS > NAME COMPONENTS - (2-1.01 > 20-)
Changed to name components to align with US Core. If full name is needed, will need another row to map to 2-.01 and the .text field
.... id
.... extension
.... use
.... text
.... family
source value based on PATIENT - NAME COMPONENTS > NAME COMPONENTS - FAMILY (LAST) NAME (2-1.01 > 20-1)
mapParameter line 1
.... given
source value based on PATIENT - NAME COMPONENTS > NAME COMPONENTS - GIVEN (FIRST) NAME (2-1.01 > 20-2)
mapParameter line 2
.... prefix
source value based on PATIENT - NAME COMPONENTS > NAME COMPONENTS - PREFIX (2-1.01 > 20-4)
mapParameter line 3
.... suffix
source value based on PATIENT - NAME COMPONENTS > NAME COMPONENTS - SUFFIX (2-1.01 > 20-5)
mapParameter line 4
.... period
... Slices for telecom
.... telecom:All Slices
..... id
..... extension
..... system
..... value
..... use
..... rank
..... period
.... telecom:va-home
..... id
..... extension
..... system
fixed value = #phone
mapParameter line 1
Patient.HomePhoneNumber
demographics.telecom
..... value
source value based on PATIENT - PHONE NUMBER [RESIDENCE] (2-.131)
Patient.HomePhoneNumber
demographics.telecom
..... use
fixed value = #home
mapParameter line 2
Patient.HomePhoneNumber
demographics.telecom
..... rank
..... period
.... telecom:va-work
..... id
..... extension
..... system
fixed value = #phone
mapParameter line 1
Patient.WorkPhoneNumber
demographics.telecom
..... value
source value based on PATIENT - PHONE NUMBER [WORK] (2-.132)
Patient.WorkPhoneNumber
demographics.telecom
..... use
fixed value = #work
mapParameter line 2
Patient.WorkPhoneNumber
demographics.telecom
..... rank
..... period
.... telecom:va-mobile
..... id
..... extension
..... system
fixed value = #phone
mapParameter line 1
Patient.MobilePhoneNumber
demographics.telecom
..... value
source value based on PATIENT - PHONE NUMBER [CELLULAR] (2-.134)
Patient.MobilePhoneNumber
demographics.telecom
..... use
fixed value = #mobile
mapParameter line 2
Patient.MobilePhoneNumber
demographics.telecom
..... rank
..... period
... gender
terminologyMaps using VF_adminGender on PATIENT - SEX (2-.02)
Map VA sex to FHIR gender; both are vague. For now.
Patient.Patient.Gender Patient.PatientBirthSex.BirthSex SPatient.SPatient.Gender SPatient.SPatientBirthSex.BirthSex SPatient.SPatientBirthSex.BirthSex
Patient.BirthGender Patient.Gender
demographics.gender
... birthDate
source value based on PATIENT - DATE OF BIRTH (2-.03)
SPatient.PlaceOfBirth.BirthDateTime SPatient.SPatient.BirthDateTime
Patient.BirthTime Patient.Extension[PatientExtension].Dob
demographics.dob
... Slices for deceased[x]
.... deceased[x]:deceasedDateTime
source value based on PATIENT - DATE OF DEATH (2-.351) is not null
removed "true" based on Validator testing 6/30/23
Patient.Patient.DeathDateTime SPatient.SPatient.DeathDateTime
Patient.DeathTime Patient.IsDead
demographics.died
... Slices for address
.... address:All Slices
..... id
..... extension
..... use
..... type
..... text
..... line
..... city
..... district
..... state
..... postalCode
..... country
..... period
.... address:va-home
..... id
..... extension
..... use
fixed value = #home
mapParameter line 1
SPatient.SPatientGISAddress.StreetAddress1
Patient.PermanentAddress[Address].Street
demographics.address (>5-.01)
..... type
fixed value = #postal
mapParameter line 2
SPatient.SPatientGISAddress.StreetAddress1
Patient.PermanentAddress[Address].Street
demographics.address (>5-.01)
..... text
..... line
source value based on PATIENT - STREET ADDRESS [LINE 3] (2-.113)
SPatient.SPatientGISAddress.StreetAddress2
Patient.PermanentAddress[Address].Street
demographics.address
..... city
source value based on PATIENT - CITY (2-.114)
SPatient.SPatientGISAddress.City
Patient.PermanentAddress[Address].City
demographics.address
..... district
..... state
source value based on PATIENT - STATE (2-.115)
SPatient.SPatientGISAddress.StateIEN SPatient.SPatientGISAddress.StateSID
Patient.PermanentAddress[Address].State
demographics.address
..... postalCode
source value based on PATIENT - ZIP+4 (2-.1112)
SPatient.SPatientGISAddress.Zip4
demographics.address
..... country
source value based on PATIENT - COUNTRY (2-.1173)
confirm association with .111 etc.
Patient.PermanentAddress[Address].Country
..... period
...... id
...... extension
...... start
source value based on PATIENT - TEMPORARY ADDRESS START DATE (2-.1217)
need other addresses, including temp; not just range
Patient.TemporaryAddress[Address].FromTime
...... end
source value based on PATIENT - TEMPORARY ADDRESS END DATE (2-.1218)
need other addresses, including temp; not just range
Patient.TemporaryAddress[Address].ToTime
... maritalStatus
terminologyMaps using VF_MaritalStatus on PATIENT - MARITAL STATUS (2-.05)
Outpat.Visit.PatientMaritalStatus Outpat.Workload.PatientMaritalStatus Patient.Patient.MaritalStatusIEN SPatient.SPatient.MaritalStatusIEN
Patient.MaritalStatus
demographics.maritalStatus
... multipleBirth[x]
... photo
... contact
.... id
.... extension
.... modifierExtension
.... relationship
.... name
.... telecom
.... address
.... gender
.... organization
.... period
... communication
.... id
.... extension
.... modifierExtension
.... language
source value based on PATIENT - LANGUAGE DATE/TIME > LANGUAGE DATE/TIME - PREFERRED LANGUAGE (2-7 > 2.07-.02)
Patient.PreferredLanguage.PreferredLanguage
Patient.PatientLanguage.Preferred Language
.... preferred
... generalPractitioner
... managingOrganization
.... id
.... extension
.... reference
.... type
.... identifier
.... display
fixed value = Veterans Health Administration
... link
.... id
.... extension
.... modifierExtension
.... other
.... type

doco Documentation for this format