Implementation Guide
23.1.0 - R4 APIs

Publish Box goes here

Resource Profile: AthenaPractitioner - Mappings

Active as of 2022-03-01

Mappings for the athena-practitioner-profile resource profile.

Mappings for athenaFlow (http://unknown.org/athenaFlow)

AthenaPractitioner
PractitionerFHIRR4_PRACTITIONERVIEW
   idMakeId(%ID%)
   identifier (NPI)MakeIdentifier("NPI", "http://hl7.org/fhir/sid/us-npi", %NPI%, true)
   activeEquals("A",%STATUS%)
   nameMakeSearchName(%PREFIX%,%FIRSTNAME%,%MIDDLENAME%,%LASTNAME%,%SUFFIX%)
      family%LASTNAME%
      given (FIRSTNAME)%FIRSTNAME%
      given (MIDDLENAME)%MIDDLENAME%
      prefix%PREFIX%
      suffix%SUFFIX%
   telecom
   telecom (WORKPHONE)
      value%WORKPHONE%
   telecom (FAXPHONE)
      value%FAXPHONE%
   addressMakeSearchAddress(%ADDRESS1%,%ADDRESS2%,%CITY%,%STATE%,%ZIP%,%COUNTRY%)
      line (ADDRESS1)%ADDRESS1%
      line (ADDRESS2)%ADDRESS2%
      city%CITY%
      state%STATE%
      postalCode%ZIP%
      country%COUNTRY%

Mappings for athenaPractice (http://unknown.org/athenaPractice)

AthenaPractitioner
PractitionerFHIRR4_PRACTITIONERVIEW
   idMakeId(%ID%)
   identifier (PVID)MakeIdentifier("PN", getSiteIdSystem("DOCTORFACILITYID"), %DOCTORFACILITYID%)
   identifier (NPI)MakeIdentifier("NPI", "http://hl7.org/fhir/sid/us-npi", %NPI%, true)
   identifier (TAX)MakeIdentifier("TAX", getSiteIdSystem("TAX"), %TAX%)
   activeEquals("0",%INACTIVE%)
   nameMakeSearchName(%PREFIX%,%FIRSTNAME%,%MIDDLENAME%,%LASTNAME%,%SUFFIX%)
      family%LASTNAME%
      given (FIRSTNAME)%FIRSTNAME%
      given (MIDDLENAME)%MIDDLENAME%
      prefix%PREFIX%
      suffix%SUFFIX%
   telecom
   telecom (WORKPHONE)
      value%WORKPHONE%
   telecom (FAXPHONE)
      value%FAXPHONE%
   addressMakeSearchAddress(%ADDRESS1%,%ADDRESS2%,%CITY%,%STATE%,%ZIP%,%COUNTRY%)
      line (ADDRESS1)%ADDRESS1%
      line (ADDRESS2)%ADDRESS2%
      city%CITY%
      state%STATE%
      postalCode%ZIP%
      country%COUNTRY%

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

AthenaPractitioner
PractitionerPRD (as one example)
   identifierPRD-7 (or XCN.1)
   identifier (PVID)PRD-7 (or XCN.1)
   identifier (NPI)PRD-7 (or XCN.1)
   identifier (TAX)PRD-7 (or XCN.1)
   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
      given (FIRSTNAME)XPN.2 + XPN.3
      given (MIDDLENAME)XPN.2 + XPN.3
      prefixXPN.5
      suffixXPN/4
      periodXPN.13 + XPN.14
   telecomPRT-15, STF-10, ROL-12
   telecom (WORKPHONE)PRT-15, STF-10, ROL-12
      systemXTN.3
      valueXTN.1 (or XTN.12)
      useXTN.2 - but often indicated by field
      rankn/a
      periodN/A
   telecom (FAXPHONE)PRT-15, STF-10, ROL-12
      systemXTN.3
      valueXTN.1 (or XTN.12)
      useXTN.2 - but often indicated by field
      rankn/a
      periodN/A
   addressORC-24, STF-11, ROL-11, PRT-14
      useXAD.7
      typeXAD.18
      textXAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6
      lineXAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address)
      line (ADDRESS1)XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address)
      line (ADDRESS2)XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address)
      cityXAD.3
      districtXAD.9
      stateXAD.4
      postalCodeXAD.5
      countryXAD.6
      periodXAD.12 / XAD.13 + XAD.14
   genderSTF-5
   birthDateSTF-6
   qualificationCER?
   communicationPID-15, NK1-20, LAN-2

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

AthenaPractitioner
PractitionerEntity. Role, or Act, Role
   meta
      idn/a
      extensionn/a
   textAct.text?
   containedN/A
   extensionN/A
   modifierExtensionN/A
   identifier./id
   identifier (PVID)./id
   identifier (NPI)./id
   identifier (TAX)./id
   active./statusCode
   name./name
      idn/a
      extensionn/a
      useunique(./use)
      text./formatted
      family./part[partType = FAM]
      given./part[partType = GIV]
      given (FIRSTNAME)./part[partType = GIV]
      given (MIDDLENAME)./part[partType = GIV]
      prefix./part[partType = PFX]
      suffix./part[partType = SFX]
      period./usablePeriod[type="IVL<TS>"]
   telecom./telecom
   telecom (WORKPHONE)./telecom
      idn/a
      extensionn/a
      system./scheme
      value./url
      useunique(./use)
      rankn/a
      period./usablePeriod[type="IVL<TS>"]
   telecom (FAXPHONE)./telecom
      idn/a
      extensionn/a
      system./scheme
      value./url
      useunique(./use)
      rankn/a
      period./usablePeriod[type="IVL<TS>"]
   address./addr
      idn/a
      extensionn/a
      useunique(./use)
      typeunique(./use)
      text./formatted
      lineAD.part[parttype = AL]
      line (ADDRESS1)AD.part[parttype = AL]
      line (ADDRESS2)AD.part[parttype = AL]
      cityAD.part[parttype = CTY]
      districtAD.part[parttype = CNT | CPA]
      stateAD.part[parttype = STA]
      postalCodeAD.part[parttype = ZIP]
      countryAD.part[parttype = CNT]
      period./usablePeriod[type="IVL<TS>"]
   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/)

AthenaPractitioner
PractitionerProvider
   identifier./Identifiers
   identifier (PVID)./Identifiers
   identifier (NPI)./Identifiers
   identifier (TAX)./Identifiers
   name./PreferredName (GivenNames, FamilyName, TitleCode)
      use./NamePurpose
      family./FamilyName
      given./GivenNames
      given (FIRSTNAME)./GivenNames
      given (MIDDLENAME)./GivenNames
      prefix./TitleCode
      period./StartDate and ./EndDate
   telecom./ContactPoints
   telecom (WORKPHONE)./ContactPoints
      system./ContactPointType
      value./Value
      use./ContactPointPurpose
      period./StartDate and ./EndDate
   telecom (FAXPHONE)./ContactPoints
      system./ContactPointType
      value./Value
      use./ContactPointPurpose
      period./StartDate and ./EndDate
   address./Addresses
      use./AddressPurpose
      line./StreetAddress (newline delimitted)
      line (ADDRESS1)./StreetAddress (newline delimitted)
      line (ADDRESS2)./StreetAddress (newline delimitted)
      city./Jurisdiction
      state./Region
      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

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

AthenaPractitioner
Practitioner
   identifierFiveWs.identifier
   identifier (PVID)FiveWs.identifier
   identifier (NPI)FiveWs.identifier
   identifier (TAX)FiveWs.identifier
   activeFiveWs.status