MyHealtheVet PHR FHIR API
0.3.9-current - ci-build United States of America flag

MyHealtheVet PHR FHIR API, published by VA Digital Services. This guide is not an authorized publication; it is the continuous build for version 0.3.9-current built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/department-of-veterans-affairs/mhv-fhir-phr-mapping/ and changes regularly. See the Directory of published versions

Resource Profile: MHVpractitioner - Mappings

Page standards status: Trial-use Maturity Level: 3

Mappings for the VA.MHV.PHR.practitioner resource profile.

Mappings for VIA to mhv-fhir-phr (UserTO)

MHVpractitioner
PractitionerUserTO
   identifier
      use`usual`
      systemID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr}
      value`UserTO` + {UserTO.id}
   name
      textUserTO.name
   telecomUserTO.phone, UserTO.pager, UserTO.digitalPager, UserTO.emailAddress
   communicationUserTO.greeting

Mappings for VIA to mhv-fhir-phr (AuthorTO)

MHVpractitioner
PractitionerAuthorTO
   identifier
      use`usual`
      systemID system must start with urn:oid:2.16.840.1.113883.4.349.4. The next would be the {stationNbr}
      value`AuthorTO.` + {AuthorTO.id}
   name
      textAuthorTO.name

Mappings for HDR to mhv-fhir-phr (PractitionerLite)

MHVpractitioner
PractitionerPractitionerLite
   identifier
      use`secondary`
      systemidentifier.assigingFacility, `http://va.gov/systems/` + idSourceTable
      valueidentifier.identity
   namename
      familyname.family
      givenname.given, name.middle
      prefixname.prefix
      suffixname.suffix, name.title

Mappings for HL7 v2 Mapping (http://hl7.org/v2)

MHVpractitioner
PractitionerPRD (as one example)
   identifierPRD-7 (or XCN.1)
      useN/A
      typeCX.5
      systemCX.4 / EI-2-4
      valueCX.1 / EI.1
      periodCX.7 + CX.8
      assignerCX.4 / (CX.4,CX.9,CX.10)
   identifier (TOid)PRD-7 (or XCN.1)
      useN/A
      typeCX.5
      systemCX.4 / EI-2-4
      valueCX.1 / EI.1
      periodCX.7 + CX.8
      assignerCX.4 / (CX.4,CX.9,CX.10)
   identifier (HDRid)PRD-7 (or XCN.1)
      useN/A
      typeCX.5
      systemCX.4 / EI-2-4
      valueCX.1 / EI.1
      periodCX.7 + CX.8
      assignerCX.4 / (CX.4,CX.9,CX.10)
   nameXCN Components
      useXPN.7, but often indicated by which field contains the name
      textimplied by XPN.11
      familyXPN.1/FN.1
      givenXPN.2 + XPN.3
      prefixXPN.5
      suffixXPN/4
      periodXPN.13 + XPN.14
   telecomPRT-15, STF-10, ROL-12
   addressORC-24, STF-11, ROL-11, PRT-14
   genderSTF-5
   birthDateSTF-6
   qualificationCER?
   communicationPID-15, NK1-20, LAN-2

Mappings for RIM Mapping (http://hl7.org/v3)

MHVpractitioner
PractitionerEntity. Role, or Act, Role
   textAct.text?
   containedN/A
   extensionN/A
   modifierExtensionN/A
   identifier./id
      idn/a
      extensionn/a
      useRole.code or implied by context
      typeRole.code or implied by context
      systemII.root or Role.id.root
      valueII.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
      periodRole.effectiveTime or implied by context
      assignerII.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
   identifier (TOid)./id
      idn/a
      extensionn/a
      useRole.code or implied by context
      typeRole.code or implied by context
      systemII.root or Role.id.root
      valueII.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
      periodRole.effectiveTime or implied by context
      assignerII.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
   identifier (HDRid)./id
      idn/a
      extensionn/a
      useRole.code or implied by context
      typeRole.code or implied by context
      systemII.root or Role.id.root
      valueII.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
      periodRole.effectiveTime or implied by context
      assignerII.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
   active./statusCode
   name./name
      idn/a
      extensionn/a
      useunique(./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
   address./addr
   gender./administrativeGender
   birthDate./birthTime
   photo./subjectOf/ObservationEvent[code="photo"]/value
   qualification.playingEntity.playingRole[classCode=QUAL].code
      idn/a
      extensionn/a
      modifierExtensionN/A
      identifier.playingEntity.playingRole[classCode=QUAL].id
      code.playingEntity.playingRole[classCode=QUAL].code
      period.playingEntity.playingRole[classCode=QUAL].effectiveTime
      issuer.playingEntity.playingRole[classCode=QUAL].scoper
   communication./languageCommunication

Mappings for ServD (http://www.omg.org/spec/ServD/1.0/)

MHVpractitioner
PractitionerProvider
   identifier./Identifiers
      system./IdentifierType
      value./Value
      period./StartDate and ./EndDate
      assigner./IdentifierIssuingAuthority
   identifier (TOid)./Identifiers
      system./IdentifierType
      value./Value
      period./StartDate and ./EndDate
      assigner./IdentifierIssuingAuthority
   identifier (HDRid)./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
   address./Addresses
   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

Mappings for FiveWs Pattern Mapping (http://hl7.org/fhir/fivews)

MHVpractitioner
Practitioner
   identifierFiveWs.identifier
   identifier (TOid)FiveWs.identifier
   identifier (HDRid)FiveWs.identifier
   activeFiveWs.status