US Veterans Health Administration FHIR Map Set Implementation Guide
1.6.49 - 250701
US Veterans Health Administration FHIR Map Set Implementation Guide
1.6.49 - 250701
Publication Build: This will be filled in by the publication tooling
| Draft as of 2025-06-13 |
Mappings for the Practitioner 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.
| FHIR Path | VistA | CDW | SDA | VPR |
|---|---|---|---|---|
| Practitioner.identifier[NPI].value | 200-41.99 | SStaff.PrescribingProvider.NPI SStaff.SStaff.NPI |
||
| Practitioner.identifier[va-DEA].value | 200-53.2 | SStaff.PrescribingProvider.DEA SStaff.SStaff.DEA |
||
| Practitioner.identifier[va-nr].value | 200-53.3 | SStaff.PrescribingProvider.VANumber SStaff.SStaff.VANumber |
||
| Practitioner.identifier[va-VPID].value | 200-9000 | SStaff.PrescribingProvider.VPID SStaff.SStaff.VAPersonIdentificationNumber |
||
| Practitioner.identifier[NPI].period.start | 200-42 | |||
| Practitioner.name.text | 20- | |||
| Practitioner.name.family | 20-1 | |||
| Practitioner.name.given | 20-2 | |||
| Practitioner.name.prefix | 20-4 | |||
| Practitioner.name.suffix | 20-5 | |||
| Practitioner.telecom.value | 200-.131 | SStaff.PrescribingProvider.HomePhone SStaff.SStaff.HomePhone |
||
| Practitioner.birthDate | 200-5 | SStaff.SStaff.BirthDateTime Staff.Staff.BirthDateTime |
||
| Practitioner.qualification.code.text | 200-10.6 | SStaff.SStaff.Degree Staff.Staff.Degree |
||
| Practitioner.identifier[va-IEN].value | 200-.001 | |||
| Practitioner.gender | 200-4 | SStaff.SStaff.Gender Staff.Staff.Gender |
| key | status | direction | source | mapApproach | mapCase | FHIR Path | subPath | mapValue | mapParameter | mapComment | FHIR URL | Ver |
|---|---|---|---|---|---|---|---|---|---|---|---|
| 376 | team-approved | V2F | NEW PERSON - NPI (200-41.99) | source value | Practitioner.identifier[NPI] | .value | .system = http://hl7.org/fhir/sid/us-npi .type=http://terminology.hl7.org/CodeSystem/v2-0203#NPI |
changed .code from PRN to NPI | http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner | 5.0.1 | ||
| 377 | team-approved | V2F | NEW PERSON - DEA# (200-53.2) | source value | Practitioner.identifier[va-DEA] | .value | .system = urn:oid:2.16.840.1.113883.4.814 .type=http://terminology.hl7.org/CodeSystem/v2-0203#DEA |
changed .code from PRN to DEA | http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner | 5.0.1 | ||
| 378 | team-approved | V2F | NEW PERSON - VA# (200-53.3) | source value | Practitioner.identifier[va-nr] | .value | .system = urn:oid:2.16.840.1.113883.4.349 .type=http://va.gov/terminology/vistaDefinedTerms/200-53.3#VA_Number |
changed .code from PRN to VA_Number. Value set is extensible | http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner | 5.0.1 | ||
| 379 | team-approved | V2F | NEW PERSON - VPID (200-9000) | source value | Practitioner.identifier[va-VPID] | .value | .system = urn:oid:2.16.840.1.113883.4.349 .type=http://va.gov/terminology/vistaDefinedTerms/200-9000#VPID |
changed .code from PRN to VPID. Value set is extensible | http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner | 5.0.1 | ||
| 380 | team-approved | V2F | NEW PERSON - EFFECTIVE DATE/TIME (200-42) | source value | Practitioner.identifier[NPI] | .period.start | http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner | 5.0.1 | ||||
| 382 | team-approved | V2F | NEW PERSON - NAME COMPONENTS > NAME COMPONENTS - (200-10.1 > 20-) | source value | Practitioner.name | .text | .family = {FAMILY (LAST) NAME (1)} .given = {GIVEN (FIRST) NAME (2)} .prefix = {PREFIX (4)} .suffix = {SUFFIX (5)} |
Change map to better align with US Core Must Support (last name only) | http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner | 5.0.1 | ||
| 383 | team-approved | V2F | NEW PERSON - PHONE (HOME) (200-.131) | source value | Practitioner.telecom | .value | .system=#phone .use=#home |
http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner | 5.0.1 | |||
| 394 | team-approved | V2F | NEW PERSON - DOB (200-5) | source value | Practitioner.birthDate | http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner | 5.0.1 | |||||
| 395 | team-approved | V2F | NEW PERSON - DEGREE (200-10.6) | source value | Practitioner.qualification | .code.text | There is also 12.1 CURRENT DEGREE LEVEL; not in cdw | http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner | 5.0.1 | |||
| 415 | team-approved | V2F | NEW PERSON - IEN (200-.001) | source value | Practitioner.identifier[va-IEN] | .value | .system = http://va.gov/identifiers/$Sta3n/200 .type=http://va.gov/terminology/vistaDefinedTerms/200-.001#IEN |
http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner | 5.0.1 | |||
| 1790 | for review | V2F | NEW PERSON - SEX (200-4) | terminologyMaps | Practitioner.gender | VF_providerGender | Added per LH request to help support deduplication fingerprints | http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner | 5.0.1 | |||
| 2186 | in process | V2F | target not supported | Practitioner.address | auto added because of must-support | http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner | |||||
| 2187 | in process | V2F | target not supported | Practitioner.address.line | auto added because of must-support | http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner | |||||
| 2188 | in process | V2F | target not supported | Practitioner.address.city | auto added because of must-support | http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner | |||||
| 2189 | in process | V2F | target not supported | Practitioner.address.state | auto added because of must-support | http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner | |||||
| 2190 | in process | V2F | target not supported | Practitioner.address.postalCode | auto added because of must-support | http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner | |||||
| 2191 | in process | V2F | target not supported | Practitioner.address.country | auto added because of must-support | http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner |
| Practitioner | ||
| Practitioner | ||
| identifier | ||
| identifier (NPI) | ||
| type | 376-2: fixed value = http://terminology.hl7.org/CodeSystem/v2-0203#NPI | generated from mapParameter line 2 |
| system | 376-1: fixed value = http://hl7.org/fhir/sid/us-npi | generated from mapParameter line 1 |
| value | 376: source value based on NEW PERSON - NPI (200-41.99) | changed .code from PRN to NPI |
| period | ||
| start | 380: source value based on NEW PERSON - EFFECTIVE DATE/TIME (200-42) | |
| identifier (va-DEA) | ||
| type | 377-2: fixed value = http://terminology.hl7.org/CodeSystem/v2-0203#DEA | generated from mapParameter line 2 |
| system | 377-1: fixed value = urn:oid:2.16.840.1.113883.4.814 | generated from mapParameter line 1 |
| value | 377: source value based on NEW PERSON - DEA# (200-53.2) | changed .code from PRN to DEA |
| identifier (va-nr) | ||
| type | 378-2: fixed value = http://va.gov/terminology/vistaDefinedTerms/200-53.3#VA_Number | generated from mapParameter line 2 |
| system | 378-1: fixed value = urn:oid:2.16.840.1.113883.4.349 | generated from mapParameter line 1 |
| value | 378: source value based on NEW PERSON - VA# (200-53.3) | changed .code from PRN to VA_Number. Value set is extensible |
| identifier (va-VPID) | ||
| type | 379-2: fixed value = http://va.gov/terminology/vistaDefinedTerms/200-9000#VPID | generated from mapParameter line 2 |
| system | 379-1: fixed value = urn:oid:2.16.840.1.113883.4.349 | generated from mapParameter line 1 |
| value | 379: source value based on NEW PERSON - VPID (200-9000) | changed .code from PRN to VPID. Value set is extensible |
| identifier (va-IEN) | ||
| type | 415-2: fixed value = http://va.gov/terminology/vistaDefinedTerms/200-.001#IEN | generated from mapParameter line 2 |
| system | 415-1: fixed value = http://va.gov/identifiers/$Sta3n/200 | generated from mapParameter line 1 |
| value | 415: source value based on NEW PERSON - IEN (200-.001) | |
| name | ||
| text | 382: source value based on NEW PERSON - NAME COMPONENTS > NAME COMPONENTS - (200-10.1 > 20-) | Change map to better align with US Core Must Support (last name only) |
| family | 382-1: source value based on NEW PERSON - NAME COMPONENTS > NAME COMPONENTS - FAMILY (LAST) NAME (200-10.1 > 20-1) | generated from mapParameter line 1 |
| given | 382-2: source value based on NEW PERSON - NAME COMPONENTS > NAME COMPONENTS - GIVEN (FIRST) NAME (200-10.1 > 20-2) | generated from mapParameter line 2 |
| prefix | 382-3: source value based on NEW PERSON - NAME COMPONENTS > NAME COMPONENTS - PREFIX (200-10.1 > 20-4) | generated from mapParameter line 3 |
| suffix | 382-4: source value based on NEW PERSON - NAME COMPONENTS > NAME COMPONENTS - SUFFIX (200-10.1 > 20-5) | generated from mapParameter line 4 |
| telecom | ||
| system | 383-1: fixed value = #phone | generated from mapParameter line 1 |
| value | 383: source value based on NEW PERSON - PHONE (HOME) (200-.131) | |
| use | 383-2: fixed value = #home | generated from mapParameter line 2 |
| address | 2186: target not supported | auto added because of must-support |
| line | 2187: target not supported | auto added because of must-support |
| city | 2188: target not supported | auto added because of must-support |
| state | 2189: target not supported | auto added because of must-support |
| postalCode | 2190: target not supported | auto added because of must-support |
| country | 2191: target not supported | auto added because of must-support |
| gender | 1790: terminologyMaps using VF_providerGender on NEW PERSON - SEX (200-4) | Added per LH request to help support deduplication fingerprints |
| birthDate | 394: source value based on NEW PERSON - DOB (200-5) | |
| qualification | ||
| code | ||
| text | 395: source value based on NEW PERSON - DEGREE (200-10.6) | There is also 12.1 CURRENT DEGREE LEVEL; not in cdw |
| Practitioner | ||
| Practitioner | ||
| identifier | ||
| identifier (NPI) | ||
| value | SStaff.PrescribingProvider.NPI SStaff.SStaff.NPI | |
| identifier (va-DEA) | ||
| value | SStaff.PrescribingProvider.DEA SStaff.SStaff.DEA | |
| identifier (va-nr) | ||
| value | SStaff.PrescribingProvider.VANumber SStaff.SStaff.VANumber | |
| identifier (va-VPID) | ||
| value | SStaff.PrescribingProvider.VPID SStaff.SStaff.VAPersonIdentificationNumber | |
| name | ||
| text | SStaff.SStaff.FirstName SStaff.SStaff.LastName SStaff.SStaff.MiddleName SStaff.SStaff.StaffNamePrefix SStaff.SStaff.StaffNameSuffix | |
| family | SStaff.SStaff.FirstName SStaff.SStaff.LastName SStaff.SStaff.MiddleName SStaff.SStaff.StaffNamePrefix SStaff.SStaff.StaffNameSuffix | |
| given | SStaff.SStaff.FirstName SStaff.SStaff.LastName SStaff.SStaff.MiddleName SStaff.SStaff.StaffNamePrefix SStaff.SStaff.StaffNameSuffix | |
| prefix | SStaff.SStaff.FirstName SStaff.SStaff.LastName SStaff.SStaff.MiddleName SStaff.SStaff.StaffNamePrefix SStaff.SStaff.StaffNameSuffix | |
| suffix | SStaff.SStaff.FirstName SStaff.SStaff.LastName SStaff.SStaff.MiddleName SStaff.SStaff.StaffNamePrefix SStaff.SStaff.StaffNameSuffix | |
| telecom | ||
| value | SStaff.PrescribingProvider.HomePhone SStaff.SStaff.HomePhone | |
| gender | SStaff.SStaff.Gender Staff.Staff.Gender | |
| birthDate | SStaff.SStaff.BirthDateTime Staff.Staff.BirthDateTime | |
| qualification | ||
| code | ||
| text | SStaff.SStaff.Degree Staff.Staff.Degree | |
| Practitioner | ||
| Practitioner | PRD (as one example) | |
| identifier | PRD-7 (or XCN.1) | |
| identifier (NPI) | PRD-7 (or XCN.1) | |
| use | N/A | |
| type | CX.5 | |
| system | CX.4 / EI-2-4 | |
| value | CX.1 / EI.1 | |
| period | CX.7 + CX.8 | |
| start | DR.1 | |
| end | DR.2 | |
| assigner | CX.4 / (CX.4,CX.9,CX.10) | |
| identifier (va-DEA) | PRD-7 (or XCN.1) | |
| use | N/A | |
| type | CX.5 | |
| system | CX.4 / EI-2-4 | |
| value | CX.1 / EI.1 | |
| period | CX.7 + CX.8 | |
| assigner | CX.4 / (CX.4,CX.9,CX.10) | |
| identifier (va-nr) | PRD-7 (or XCN.1) | |
| use | N/A | |
| type | CX.5 | |
| system | CX.4 / EI-2-4 | |
| value | CX.1 / EI.1 | |
| period | CX.7 + CX.8 | |
| assigner | CX.4 / (CX.4,CX.9,CX.10) | |
| identifier (va-VPID) | PRD-7 (or XCN.1) | |
| use | N/A | |
| type | CX.5 | |
| system | CX.4 / EI-2-4 | |
| value | CX.1 / EI.1 | |
| period | CX.7 + CX.8 | |
| assigner | CX.4 / (CX.4,CX.9,CX.10) | |
| identifier (va-IEN) | PRD-7 (or XCN.1) | |
| use | N/A | |
| type | CX.5 | |
| system | CX.4 / EI-2-4 | |
| value | CX.1 / EI.1 | |
| period | CX.7 + CX.8 | |
| assigner | CX.4 / (CX.4,CX.9,CX.10) | |
| name | XCN Components | |
| use | XPN.7, but often indicated by which field contains the name | |
| text | implied by XPN.11 | |
| family | XPN.1/FN.1 | |
| given | XPN.2 + XPN.3 | |
| prefix | XPN.5 | |
| suffix | XPN/4 | |
| period | XPN.13 + XPN.14 | |
| telecom | PRT-15, STF-10, ROL-12 | |
| system | XTN.3 | |
| value | XTN.1 (or XTN.12) | |
| use | XTN.2 - but often indicated by field | |
| rank | n/a | |
| period | N/A | |
| address | ORC-24, STF-11, ROL-11, PRT-14 | |
| use | XAD.7 | |
| type | XAD.18 | |
| text | XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6 | |
| line | XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address) | |
| city | XAD.3 | |
| district | XAD.9 | |
| state | XAD.4 | |
| postalCode | XAD.5 | |
| country | XAD.6 | |
| period | XAD.12 / XAD.13 + XAD.14 | |
| gender | STF-5 | |
| birthDate | STF-6 | |
| qualification | CER? | |
| code | ||
| coding | C*E.1-8, C*E.10-22 | |
| text | C*E.9. But note many systems use C*E.2 for this | |
| communication | PID-15, NK1-20, LAN-2 | |
| Practitioner | ||
| Practitioner | Entity. Role, or Act, Role | |
| text | Act.text? | |
| contained | N/A | |
| extension | N/A | |
| modifierExtension | N/A | |
| identifier | ./id | |
| identifier (NPI) | ./id | |
| id | n/a | |
| extension | n/a | |
| use | Role.code or implied by context | |
| type | Role.code or implied by context | |
| system | II.root or Role.id.root | |
| value | II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root) | |
| period | Role.effectiveTime or implied by context | |
| id | n/a | |
| extension | n/a | |
| start | ./low | |
| end | ./high | |
| assigner | II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper | |
| identifier (va-DEA) | ./id | |
| id | n/a | |
| extension | n/a | |
| use | Role.code or implied by context | |
| type | Role.code or implied by context | |
| system | II.root or Role.id.root | |
| value | II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root) | |
| period | Role.effectiveTime or implied by context | |
| assigner | II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper | |
| identifier (va-nr) | ./id | |
| id | n/a | |
| extension | n/a | |
| use | Role.code or implied by context | |
| type | Role.code or implied by context | |
| system | II.root or Role.id.root | |
| value | II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root) | |
| period | Role.effectiveTime or implied by context | |
| assigner | II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper | |
| identifier (va-VPID) | ./id | |
| id | n/a | |
| extension | n/a | |
| use | Role.code or implied by context | |
| type | Role.code or implied by context | |
| system | II.root or Role.id.root | |
| value | II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root) | |
| period | Role.effectiveTime or implied by context | |
| assigner | II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper | |
| identifier (va-IEN) | ./id | |
| id | n/a | |
| extension | n/a | |
| use | Role.code or implied by context | |
| type | Role.code or implied by context | |
| system | II.root or Role.id.root | |
| value | II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root) | |
| period | Role.effectiveTime or implied by context | |
| assigner | II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper | |
| active | ./statusCode | |
| name | ./name | |
| id | n/a | |
| extension | n/a | |
| use | unique(./use) | |
| text | ./formatted | |
| family | ./part[partType = FAM] | |
| given | ./part[partType = GIV] | |
| prefix | ./part[partType = PFX] | |
| suffix | ./part[partType = SFX] | |
| period | ./usablePeriod[type="IVL<TS>"] | |
| telecom | ./telecom | |
| id | n/a | |
| extension | n/a | |
| system | ./scheme | |
| value | ./url | |
| use | unique(./use) | |
| rank | n/a | |
| period | ./usablePeriod[type="IVL<TS>"] | |
| address | ./addr | |
| id | n/a | |
| extension | n/a | |
| use | unique(./use) | |
| type | unique(./use) | |
| text | ./formatted | |
| line | AD.part[parttype = AL] | |
| city | AD.part[parttype = CTY] | |
| district | AD.part[parttype = CNT | CPA] | |
| state | AD.part[parttype = STA] | |
| postalCode | AD.part[parttype = ZIP] | |
| country | AD.part[parttype = CNT] | |
| period | ./usablePeriod[type="IVL<TS>"] | |
| gender | ./administrativeGender | |
| birthDate | ./birthTime | |
| photo | ./subjectOf/ObservationEvent[code="photo"]/value | |
| qualification | .playingEntity.playingRole[classCode=QUAL].code | |
| id | n/a | |
| extension | n/a | |
| modifierExtension | N/A | |
| identifier | .playingEntity.playingRole[classCode=QUAL].id | |
| code | .playingEntity.playingRole[classCode=QUAL].code | |
| id | n/a | |
| extension | n/a | |
| coding | union(., ./translation) | |
| text | ./originalText[mediaType/code="text/plain"]/data | |
| period | .playingEntity.playingRole[classCode=QUAL].effectiveTime | |
| issuer | .playingEntity.playingRole[classCode=QUAL].scoper | |
| communication | ./languageCommunication | |
| Practitioner | ||
| Practitioner | Provider | |
| identifier | ./Identifiers | |
| identifier (NPI) | ./Identifiers | |
| system | ./IdentifierType | |
| value | ./Value | |
| period | ./StartDate and ./EndDate | |
| assigner | ./IdentifierIssuingAuthority | |
| identifier (va-DEA) | ./Identifiers | |
| system | ./IdentifierType | |
| value | ./Value | |
| period | ./StartDate and ./EndDate | |
| assigner | ./IdentifierIssuingAuthority | |
| identifier (va-nr) | ./Identifiers | |
| system | ./IdentifierType | |
| value | ./Value | |
| period | ./StartDate and ./EndDate | |
| assigner | ./IdentifierIssuingAuthority | |
| identifier (va-VPID) | ./Identifiers | |
| system | ./IdentifierType | |
| value | ./Value | |
| period | ./StartDate and ./EndDate | |
| assigner | ./IdentifierIssuingAuthority | |
| identifier (va-IEN) | ./Identifiers | |
| system | ./IdentifierType | |
| value | ./Value | |
| period | ./StartDate and ./EndDate | |
| assigner | ./IdentifierIssuingAuthority | |
| name | ./PreferredName (GivenNames, FamilyName, TitleCode) | |
| use | ./NamePurpose | |
| family | ./FamilyName | |
| given | ./GivenNames | |
| prefix | ./TitleCode | |
| period | ./StartDate and ./EndDate | |
| telecom | ./ContactPoints | |
| system | ./ContactPointType | |
| value | ./Value | |
| use | ./ContactPointPurpose | |
| period | ./StartDate and ./EndDate | |
| address | ./Addresses, n/a | |
| use | ./AddressPurpose | |
| line | ./StreetAddress (newline delimitted) | |
| city | ./Jurisdiction | |
| state | ./Region, ./Sites | |
| postalCode | ./PostalIdentificationCode | |
| country | ./Country | |
| period | ./StartDate and ./EndDate | |
| gender | ./GenderCode | |
| birthDate | (not represented in ServD) | |
| photo | ./ImageURI (only supports the URI reference) | |
| qualification | ./Qualifications | |
| code | ./Qualifications.Value | |
| period | ./Qualifications.StartDate and ./Qualifications.EndDate | |
| communication | ./Languages.LanguageSpokenCode | |
| Practitioner | ||
| Practitioner | ||
| identifier | FiveWs.identifier | |
| identifier (NPI) | FiveWs.identifier | |
| identifier (va-DEA) | FiveWs.identifier | |
| identifier (va-nr) | FiveWs.identifier | |
| identifier (va-VPID) | FiveWs.identifier | |
| identifier (va-IEN) | FiveWs.identifier | |
| active | FiveWs.status | |