US Veterans Health Administration FHIR Map Set Implementation Guide
1.3.1 - 250401
Publication Build: This will be filled in by the publication tooling
Active as of 2025-03-31 |
Mappings for the Organization resource profile.
Scroll down for the Raw FHIR, CDW & SDA mappings (if any).
Note that the CDW and SDA mappings are derived from a look-up based on the VistA source mappings in CDW and VPR SDA.
key | status | direction | source | mapApproach | mapCase | FHIR Path | subPath | mapValue | mapParameter | mapComment | FHIR URL | Ver |
---|---|---|---|---|---|---|---|---|---|---|---|
1251 | for review | V2F | INSTITUTION - NAME (4-.01) | source value | Organization.name | http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization | 5.0.1 | |||||
1252 | for review | V2F | INSTITUTION - NPI (4-41.99) | source value | Organization.identifier[NPI] | .value | .system=http://hl7.org/fhir/sid/us-npi | http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization | 5.0.1 | |||
1252-1 | for review | V2F | fixed value | Organization.identifier[NPI] | .system | http://hl7.org/fhir/sid/us-npi | generated from mapParameter line 1 | http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization | 5.0.1 | |||
1253 | for review | V2F | fixed value | Organization.active | true | http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization | 5.0.1 | |||||
1254 | for review | V2F | fixed value | Organization.type | http://terminology.hl7.org/CodeSystem/organization-type#prov | http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization | 5.0.1 | |||||
1255 | for review | V2F | INSTITUTION - SHORT NAME (4-.05) | source value | Organization.alias | http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization | 5.0.1 | |||||
1257 | for review | V2F | fixed value | Organization.address[va-physical] | .type | #physical | http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization | 5.0.1 | ||||
1258 | for review | V2F | INSTITUTION - STREET ADDR. 1 (4-1.01) | source value | Organization.address[va-physical] | .line | http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization | 5.0.1 | ||||
1259 | for review | V2F | INSTITUTION - STREET ADDR. 2 (4-1.02) | source value | Organization.address[va-physical] | .line | http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization | 5.0.1 | ||||
1260 | for review | V2F | INSTITUTION - CITY (4-1.03) | source value | Organization.address[va-physical] | .city | http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization | 5.0.1 | ||||
1261 | for review | V2F | INSTITUTION - DISTRICT (4-.03) | source value | Organization.address[va-physical] | .district | http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization | 5.0.1 | ||||
1262 | for review | V2F | INSTITUTION - STATE > STATE - ABBREVIATION (4-.02 > 5-1) | source value | Organization.address[va-physical] | .state | http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization | 5.0.1 | ||||
1263 | for review | V2F | INSTITUTION - ZIP (4-1.04) | source value | Organization.address[va-physical] | .postalCode | http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization | 5.0.1 | ||||
1264 | for review | V2F | INSTITUTION - COUNTRY > COUNTRY CODE - CODE (4-801 > 779.004-.01) | source value | Organization.address[va-physical] | .country | http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization | 5.0.1 | ||||
1265 | for review | V2F | INSTITUTION - CONTACT > CONTACT - CONTACT (4-4 > 4.03-.01) | source value | Organization.contact.name | .text | http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization | 5.0.1 | ||||
1266 | for review | V2F | INSTITUTION - CONTACT > CONTACT - PHONE # (4-4 > 4.03-.03) | source value | Organization.contact.telecom | .value | .system=#phone | http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization | 5.0.1 | |||
1266-1 | for review | V2F | fixed value | Organization.contact.telecom | .system | #phone | generated from mapParameter line 1 | http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization | 5.0.1 | |||
1268 | for review | V2F | fixed value | Organization.address[va-postal] | .type | #postal | http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization | 5.0.1 | ||||
1269 | for review | V2F | INSTITUTION - ST. ADDR. 1 (MAILING) (4-4.01) | source value | Organization.address[va-postal] | .line | http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization | 5.0.1 | ||||
1270 | for review | V2F | INSTITUTION - ST. ADDR. 2 (MAILING) (4-4.02) | source value | Organization.address[va-postal] | .line | http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization | 5.0.1 | ||||
1271 | for review | V2F | INSTITUTION - CITY (MAILING) (4-4.03) | source value | Organization.address[va-postal] | .city | http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization | 5.0.1 | ||||
1272 | for review | V2F | INSTITUTION - STATE (MAILING) (4-4.04) | source value | Organization.address[va-postal] | .state | http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization | 5.0.1 | ||||
1273 | for review | V2F | INSTITUTION - ZIP (MAILING) (4-4.05) | source value | Organization.address[va-postal] | .postalCode | http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization | 5.0.1 | ||||
1274 | for review | V2F | INSTITUTION - COUNTRY > COUNTRY CODE - CODE (4-801 > 779.004-.01) | source value | Organization.address[va-postal] | .country | Assume country is same as for physical Organization.address.where(type="postal") | http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization | 5.0.1 | |||
1786 | for review | V2F | target not supported | Organization.telecom | Institution does not have a root level phone number | http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization | 5.0.1 |
Organization | ||
Organization | ||
identifier | ||
identifier (NPI) | ||
system | 1252-1: fixed value = http://hl7.org/fhir/sid/us-npi | generated from mapParameter line 1 |
value | 1252: source value based on INSTITUTION - NPI (4-41.99) | |
active | 1253: fixed value = true | |
type | 1254: fixed value = http://terminology.hl7.org/CodeSystem/organization-type#prov | |
name | 1251: source value based on INSTITUTION - NAME (4-.01) | |
alias | 1255: source value based on INSTITUTION - SHORT NAME (4-.05) | |
telecom | 1786: target not supported | Institution does not have a root level phone number |
address | ||
address (va-physical) | ||
type | 1257: fixed value = #physical | |
line | 1258: source value based on INSTITUTION - STREET ADDR. 1 (4-1.01), 1259: source value based on INSTITUTION - STREET ADDR. 2 (4-1.02) | , |
city | 1260: source value based on INSTITUTION - CITY (4-1.03) | |
district | 1261: source value based on INSTITUTION - DISTRICT (4-.03) | |
state | 1262: source value based on INSTITUTION - STATE > STATE - ABBREVIATION (4-.02 > 5-1) | |
postalCode | 1263: source value based on INSTITUTION - ZIP (4-1.04) | |
country | 1264: source value based on INSTITUTION - COUNTRY > COUNTRY CODE - CODE (4-801 > 779.004-.01) | |
address (va-postal) | ||
type | 1268: fixed value = #postal | |
line | 1269: source value based on INSTITUTION - ST. ADDR. 1 (MAILING) (4-4.01), 1270: source value based on INSTITUTION - ST. ADDR. 2 (MAILING) (4-4.02) | , |
city | 1271: source value based on INSTITUTION - CITY (MAILING) (4-4.03) | |
state | 1272: source value based on INSTITUTION - STATE (MAILING) (4-4.04) | |
postalCode | 1273: source value based on INSTITUTION - ZIP (MAILING) (4-4.05) | |
country | 1274: source value based on INSTITUTION - COUNTRY > COUNTRY CODE - CODE (4-801 > 779.004-.01) | Assume country is same as for physical Organization.address.where(type="postal") |
contact | ||
name | ||
text | 1265: source value based on INSTITUTION - CONTACT > CONTACT - CONTACT (4-4 > 4.03-.01) | |
telecom | ||
system | 1266-1: fixed value = #phone | generated from mapParameter line 1 |
value | 1266: source value based on INSTITUTION - CONTACT > CONTACT - PHONE # (4-4 > 4.03-.03) |
Organization | ||
Organization | ||
identifier | ||
identifier (NPI) | ||
value | Dim.Institution.NPI,Dim.Institution.NPI,Dim.InstitutionTimeZone.NPI,NDim.MVIInstitution.NPI | |
name | Dim.AutoDiscontinuedRule.InstitutionName,Dim.Institution.InstitutionName,Dim.Institution.InstitutionName,Dim.InstitutionTimeZone.Institution,Dim.RequestService.IFCRoutingInstitution,NDim.MVIInstitution.InstitutionName | |
alias | Dim.Institution.InstitutionShortName,Dim.Institution.InstitutionShortName,Dim.InstitutionTimeZone.InstitutionShortName,NDim.MVIInstitution.InstitutionShortName | |
address | ||
address (va-physical) | ||
line | Dim.Institution.StreetAddress1,Dim.Institution.StreetAddress1,Dim.InstitutionTimeZone.StreetAddress1,NDim.MVIInstitution.StreetAddress1, Dim.Institution.StreetAddress2,Dim.Institution.StreetAddress2,Dim.InstitutionTimeZone.StreetAddress2,NDim.MVIInstitution.StreetAddress2 | |
city | Dim.Institution.City,Dim.Institution.City,Dim.InstitutionTimeZone.City,NDim.MVIInstitution.City | |
district | Dim.Institution.MedicalDistrict,Dim.Institution.MedicalDistrict,NDim.MVIInstitution.MedicalDistrict | |
state | Dim.Institution.StateIEN,Dim.InstitutionTimeZone.StateIEN,Dim.InstitutionTimeZone.StateSID,NDim.MVIInstitution.MVIStateIEN Dim.State.StateAbbrev,Dim.State.StateAbbrev,NDim.MVIState.StateAbbrev | |
postalCode | Dim.Institution.Zip,Dim.Institution.Zip,Dim.InstitutionTimeZone.Zip,NDim.MVIInstitution.Zip | |
country | Dim.Country.CountryCode,NDim.MVICountryCode.CountryCode | |
address (va-postal) | ||
line | Dim.InstitutionTimeZone.MailingStreetAddress1, Dim.InstitutionTimeZone.MailingStreetAddress2 | |
city | Dim.InstitutionTimeZone.MailingCity | |
state | Dim.InstitutionTimeZone.MailingStateIEN,Dim.InstitutionTimeZone.MailingStateSID | |
postalCode | Dim.InstitutionTimeZone.MailingZip | |
country | Dim.Country.CountryCode,NDim.MVICountryCode.CountryCode |
Organization | ||
Organization | (also see master files messages) | |
identifier | XON.10 / XON.3 | |
identifier (NPI) | XON.10 / XON.3 | |
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 (CLIA) | XON.10 / XON.3 | |
active | No equivalent in HL7 v2 | |
type | No equivalent in v2 | |
name | XON.1 | |
telecom | ORC-22? | |
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-23? | |
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 | |
address (va-physical) | ORC-23? | |
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 | |
address (va-postal) | ORC-23? | |
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 | |
partOf | No equivalent in HL7 v2 | |
contact | ||
name | PID-5, PID-9 | |
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 | PID-13, PID-14 | |
system | XTN.3 | |
value | XTN.1 (or XTN.12) | |
use | XTN.2 - but often indicated by field | |
rank | n/a | |
period | N/A | |
address | PID-11 |
Organization | ||
Organization | Entity. Role, or Act, Organization(classCode=ORG, determinerCode=INST) | |
text | Act.text? | |
contained | N/A | |
extension | N/A | |
modifierExtension | N/A | |
identifier | .scopes[Role](classCode=IDENT) | |
identifier (NPI) | .scopes[Role](classCode=IDENT) | |
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 (CLIA) | .scopes[Role](classCode=IDENT) | |
active | .status | |
type | .code | |
name | .name | |
alias | .name | |
telecom | .telecom | |
id | n/a | |
extension | n/a | |
system | ./scheme | |
value | ./url | |
use | unique(./use) | |
rank | n/a | |
period | ./usablePeriod[type="IVL<TS>"] | |
address | .address | |
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>"] | |
address (va-physical) | .address | |
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>"] | |
address (va-postal) | .address | |
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>"] | |
partOf | .playedBy[classCode=Part].scoper | |
contact | .contactParty | |
id | n/a | |
extension | n/a | |
modifierExtension | N/A | |
purpose | ./type | |
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 | |
endpoint | n/a |
Organization | ||
Organization | Organization | |
identifier | ./Identifiers | |
identifier (NPI) | ./Identifiers | |
system | ./IdentifierType | |
value | ./Value | |
period | ./StartDate and ./EndDate | |
assigner | ./IdentifierIssuingAuthority | |
identifier (CLIA) | ./Identifiers | |
active | ./Status (however this concept in ServD more covers why the organization is active or not, could be delisted, deregistered, not operational yet) this could alternatively be derived from ./StartDate and ./EndDate and given a context date. | |
type | n/a | |
name | .PreferredName/Name | |
telecom | ./ContactPoints | |
system | ./ContactPointType | |
value | ./Value | |
use | ./ContactPointPurpose | |
period | ./StartDate and ./EndDate | |
address | ./PrimaryAddress and ./OtherAddresses | |
use | ./AddressPurpose | |
line | ./StreetAddress (newline delimitted) | |
city | ./Jurisdiction | |
state | ./Region | |
postalCode | ./PostalIdentificationCode | |
country | ./Country | |
period | ./StartDate and ./EndDate | |
address (va-physical) | ./PrimaryAddress and ./OtherAddresses | |
use | ./AddressPurpose | |
line | ./StreetAddress (newline delimitted) | |
city | ./Jurisdiction | |
state | ./Region | |
postalCode | ./PostalIdentificationCode | |
country | ./Country | |
period | ./StartDate and ./EndDate | |
address (va-postal) | ./PrimaryAddress and ./OtherAddresses | |
use | ./AddressPurpose | |
line | ./StreetAddress (newline delimitted) | |
city | ./Jurisdiction | |
state | ./Region | |
postalCode | ./PostalIdentificationCode | |
country | ./Country | |
period | ./StartDate and ./EndDate | |
partOf | n/a | |
contact | ||
name | ||
use | ./NamePurpose | |
family | ./FamilyName | |
given | ./GivenNames | |
prefix | ./TitleCode | |
period | ./StartDate and ./EndDate | |
telecom | ||
system | ./ContactPointType | |
value | ./Value | |
use | ./ContactPointPurpose | |
period | ./StartDate and ./EndDate |
Organization | ||
Organization | ||
identifier | FiveWs.identifier | |
identifier (NPI) | FiveWs.identifier | |
identifier (CLIA) | FiveWs.identifier | |
active | FiveWs.status | |
type | FiveWs.class |