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: DebtPortalPatient - Mappings

Active as of 2025-09-30

Mappings for the DebtPortalPatient 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: Debt Portal (Source)Use Case: Debt Portal (Source)PATIENT (2)PRESCRIPTION (52)106IB NUMBERAR DEBTOR (340).01DEBTOR.03STATEMENT DAY1.01STREET ADDRESS #11.02STREET ADDRESS #21.03STREET ADDRESS #31.04CITY1.05STATE1.06ZIP CODE1.07PHONE NUMBER1.08FOREIGN COUNTRY CODEINTEGRATED BILLING ACTION (350).001IEN.02PATIENT.03ACTION TYPE.07TOTAL CHARGE.09PARENT CHARGE.1CANCELLATION REASON.11AR BILL NUMBER.12AR TRANSACTION NUMBER.14DATE BILLED FROM.15DATE BILLED TO12DATE ENTRY ADDEDIB-FB INTERFACE TRACKING (360)1.02BILL/CLAIMSBILL/CLAIMS (399).08PTF ENTRY NUMBER304PROCEDURESACCOUNTS RECEIVABLE (430).01BILL NO.3ORIGINAL AMOUNT7PATIENT8CURRENT STATUS9DEBTOR10DATE BILL PREPARED11CURRENT BALANCE12SITE35AMENDED AMOUNT71PRINCIPAL BALANCE72INTEREST BALANCE73ADMINISTRATIVE COST BALANCE74MARSHAL FEE75COURT COST77TOTAL PAID PRINCIPAL78TOTAL PAID INTEREST79TOTAL PAID ADMINISTRATIVE COST79.1TOTAL PAID MARSHAL FEE79.2TOTAL PAID COURT COSTAR TRANSACTION (433).01TRANSACTION NUMBER.03BILL NUMBER11TRANSACTION DATE12TRANSACTION TYPE13RECEIPT #15TRANS. AMOUNT19DATE ENTERED25MARSHAL FEE26COURT COST27INT.CHARGE28ADM.CHARGE31PRIN.COLLECTED32INTEREST COLLECTED33ADMIN.COLLECTED34MARSHAL FEE COLLECTED35COURT COST COLLECTEDACCOUNTS RECEIVABLE TRANS.TYPE (430.3).001TRANSACTION TYPE IEN.01NAMEIB ACTION TYPE (350.1).03CHARGE CATEGORYPROCEDURES (399.0304)20OUTPATIENT ENCOUNTEROUTPATIENT ENCOUNTER (409.68).05VISIT FILE ENTRYIB CHARGE REMOVE REASONS (350.3).01NAME[type is PATIENT (#2)][Outpatient][Outpatient][Outpatient][Inpatient][NOT NULL and INTEGRATED BILLING ACTION - PARENT CHARGE (350-.09) <> INTEGRATED BILLING ACTION - IEN (350-.001)][IEN = 12 OR 13][IEN = 34 OR 2]

Raw Mappings

key status direction source mapApproach mapCase FHIR Path subPath mapValue mapParameter mapComment FHIR URL | Ver
1819 for review V2F ACCOUNTS RECEIVABLE - DEBTOR > AR DEBTOR - STREET ADDRESS #1 (430-9 > 340-1.01) source value Patient.contact.address .line .use=#billing http://va.gov/fhir/StructureDefinition/Patient
1820 for review V2F ACCOUNTS RECEIVABLE - DEBTOR > AR DEBTOR - STREET ADDRESS #2 (430-9 > 340-1.02) source value Patient.contact.address .line http://va.gov/fhir/StructureDefinition/Patient
1821 for review V2F ACCOUNTS RECEIVABLE - DEBTOR > AR DEBTOR - STREET ADDRESS #3 (430-9 > 340-1.03) source value Patient.contact.address .line http://va.gov/fhir/StructureDefinition/Patient
1822 for review V2F ACCOUNTS RECEIVABLE - DEBTOR > AR DEBTOR - CITY (430-9 > 340-1.04) source value Patient.contact.address .city http://va.gov/fhir/StructureDefinition/Patient
1823 for review V2F ACCOUNTS RECEIVABLE - DEBTOR > AR DEBTOR - STATE (430-9 > 340-1.05) source value Patient.contact.address .state http://va.gov/fhir/StructureDefinition/Patient
1824 for review V2F ACCOUNTS RECEIVABLE - DEBTOR > AR DEBTOR - ZIP CODE (430-9 > 340-1.06) source value Patient.contact.address .postalCode http://va.gov/fhir/StructureDefinition/Patient
1825 for review V2F ACCOUNTS RECEIVABLE - DEBTOR > AR DEBTOR - PHONE NUMBER (430-9 > 340-1.07) source value Patient.contact.telecom .value http://va.gov/fhir/StructureDefinition/Patient
1826 for review V2F ACCOUNTS RECEIVABLE - DEBTOR > AR DEBTOR - FOREIGN COUNTRY CODE (430-9 > 340-1.08) source value Patient.contact.address .country http://va.gov/fhir/StructureDefinition/Patient
1827 for review V2F ACCOUNTS RECEIVABLE - DEBTOR > AR DEBTOR - DEBTOR (430-9 > 340-.01) source value Patient.contact.name .text .family=LAST
.given=FIRST & MIDDLE
.suffix=SUFFIX
Add NAME to subpath of VARIABLE POINTER http://va.gov/fhir/StructureDefinition/Patient

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 (2-2)
Do we collect any detailed race data?
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 (2-2)
mapParameter line 1
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 (2-6)
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 (2-6)
mapParameter line 1
Patient.EthnicGroup
..... url
..... value[x]
.... extension:birthsex
.... 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-mr
..... id
..... extension
..... use
..... type
fixed value = http://terminology.hl7.org/CodeSystem/v2-0203#MR
mapParameter line 2
..... system
fixed value = urn:oid:2.16.840.1.113883.4.349
mapParameter line 1
..... 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
.... id
.... extension
.... use
.... text
source value based on PATIENT - NAME (2-.01)
SPatient.SPatient.DestinationMergePatientIEN SPatient.SPatient.PatientFirstName SPatient.SPatient.PatientLastName SPatient.SPatient.PatientName SPatient.SPatientAlias.PatientName
Patient.Name
demographics.familyName demographics.fullName demographics.givenNames
.... family
fixed value = LAST
mapParameter line 1
.... given
fixed value = FIRST & MIDDLE
mapParameter line 2
.... prefix
.... suffix
fixed value = SUFFIX
mapParameter line 3
.... 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
..... value
source value based on PATIENT - PHONE NUMBER [RESIDENCE] (2-.131)
Patient.HomePhoneNumber
demographics.telecom
..... use
fixed value = #home
mapParameter line 2
..... rank
..... period
.... telecom:va-work
..... id
..... extension
..... system
fixed value = #phone
mapParameter line 1
..... value
source value based on PATIENT - PHONE NUMBER [WORK] (2-.132)
Patient.WorkPhoneNumber
demographics.telecom
..... use
fixed value = #work
mapParameter line 2
..... rank
..... period
.... telecom:va-mobile
..... id
..... extension
..... system
fixed value = #phone
mapParameter line 1
..... value
source value based on PATIENT - PHONE NUMBER [CELLULAR] (2-.134)
Patient.MobilePhoneNumber
demographics.telecom
..... use
fixed value = #mobile
mapParameter line 2
..... 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) if 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
..... type
fixed value = #postal
mapParameter line 2
..... 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
..... id
..... extension
..... use
..... text
source value based on ACCOUNTS RECEIVABLE - DEBTOR > AR DEBTOR - DEBTOR (430-9 > 340-.01)
Add NAME to subpath of VARIABLE POINTER
IB.AccountsReceivable.ARDebtorIEN Dim.ARDebtor.InstitutionIEN Dim.ARDebtor.InsuranceCompanyIEN Dim.ARDebtor.PatientIEN Dim.ARDebtor.StaffIEN Dim.ARDebtor.VendorIEN
..... family
fixed value = LAST
mapParameter line 1
..... given
fixed value = FIRST & MIDDLE
mapParameter line 2
..... prefix
..... suffix
fixed value = SUFFIX
mapParameter line 3
..... period
.... telecom
..... id
..... extension
..... system
..... value
source value based on ACCOUNTS RECEIVABLE - DEBTOR > AR DEBTOR - PHONE NUMBER (430-9 > 340-1.07)
IB.AccountsReceivable.ARDebtorIEN
..... use
..... rank
..... period
.... address
..... id
..... extension
..... use
fixed value = #billing
mapParameter line 1
..... type
..... text
..... line
source value based on ACCOUNTS RECEIVABLE - DEBTOR > AR DEBTOR - STREET ADDRESS #3 (430-9 > 340-1.03)
IB.AccountsReceivable.ARDebtorIEN
..... city
source value based on ACCOUNTS RECEIVABLE - DEBTOR > AR DEBTOR - CITY (430-9 > 340-1.04)
IB.AccountsReceivable.ARDebtorIEN
..... district
..... state
source value based on ACCOUNTS RECEIVABLE - DEBTOR > AR DEBTOR - STATE (430-9 > 340-1.05)
IB.AccountsReceivable.ARDebtorIEN
..... postalCode
source value based on ACCOUNTS RECEIVABLE - DEBTOR > AR DEBTOR - ZIP CODE (430-9 > 340-1.06)
IB.AccountsReceivable.ARDebtorIEN
..... country
source value based on ACCOUNTS RECEIVABLE - DEBTOR > AR DEBTOR - FOREIGN COUNTRY CODE (430-9 > 340-1.08)
IB.AccountsReceivable.ARDebtorIEN Dim.ARDebtor.ForeignCountryCode
..... period
.... 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