Implementation Guide
23.1.0 - R4 APIs

Publish Box goes here

Resource Profile: AthenaRelatedPerson - Mappings

Active as of 2022-03-01

Mappings for the athena-relatedperson-profile resource profile.

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

AthenaRelatedPerson
RelatedPersonFHIRR4_RELATEDPERSONVIEW
   idMakeId(%ID%)
   meta
      security (SENSITIVECHART)CheckSensitive(%SENSITIVECHART%)
   identifier (External)MakeIdentifier("U",getSiteSystem("RelatedPersonId"),%ID%)
   activeEquals("true",%ACTIVE%)
   patientMakeReference("PERSON",%PID%,"Patient")
   relationshipMapConcept(%RELATIONSHIP%,"PATIENTRELATIONSHIP")
   name
      family%LASTNAME%
      given (FIRSTNAME)%FIRSTNAME%
      given (MIDDLENAME)%MIDDLENAME%
      prefix%TITLE%
      suffix%ENTITLEMENTS%
   telecom
   telecom (WORKPHONE)
      value%WORKPHONE%
   telecom (ALTPHONE)
      value%ALTPHONE%
   telecom (CELLPHONE)
      value%CELLPHONE%
   telecom (FAXPHONE)
      value%FAXPHONE%
   telecom (PAGERPHONE)
      value%PAGERPHONE%
   genderMapCode(%SEX%,"GENDER")
   birthDate%BIRTHDATE%
   address
      line (ADDRESS1)%ADDRESS1%
      line (ADDRESS2)%ADDRESS2%
      city%CITY%
      state%STATE%
      postalCode%ZIP%
      country%COUNTRY%

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

AthenaRelatedPerson
RelatedPersonFHIRR4_RELATEDPERSONVIEW
   idMakeIdWithPrefixAndSuffix(%ID%,%ID_PREFIX%,%PID%)
   meta
      security (SENSITIVECHART)CheckSensitive(%SENSITIVECHART%)
   identifier (SSN)MakeIdentifier("secondary","http://hl7.org/fhir/identifier-type","SB","http://hl7.org/fhir/sid/us-ssn",%SSN%)
   identifier (External)MakeIdentifierWithPrefixAndSuffix("U",getSiteSystem("RelatedPersonId"),%ID%,%ID_PREFIX%,%PID%)
   activeEquals("true",%ACTIVE%)
   patientMakeReference("PATIENTPROFILE",%PID%,"Patient")
   relationshipMapConcept(%RELATIONSHIP%,"PATIENTRELATIONSHIP")
   name
      family%LASTNAME%
      given (FIRSTNAME)%FIRSTNAME%
      given (MIDDLENAME)%MIDDLENAME%
      prefix%TITLE%
      suffix%ENTITLEMENTS%
   telecom
   telecom (WORKPHONE)
      value%WORKPHONE%
   telecom (ALTPHONE)
      value%ALTPHONE%
   telecom (CELLPHONE)
      value%CELLPHONE%
   telecom (FAXPHONE)
      value%FAXPHONE%
   telecom (PAGERPHONE)
      value%PAGERPHONE%
   genderMapCode(%SEX%,"GENDER")
   birthDate%BIRTHDATE%
   address
      line (ADDRESS1)%ADDRESS1%
      line (ADDRESS2)%ADDRESS2%
      city%CITY%
      state%STATE%
      postalCode%ZIP%
      country%COUNTRY%

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

AthenaRelatedPerson
RelatedPersonEntity. Role, or Act, role
   meta
      idn/a
      extensionn/a
   textAct.text?
   containedN/A
   extensionN/A
   modifierExtensionN/A
   identifier.id
   identifier (SSN).id
   identifier (External).id
   active.statusCode
   patientscoper[classCode=PSN|ANM and determinerCode='INSTANCE']/playedRole[classCode='PAT']/id
   relationshipcode
   namename
      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>"]
   telecomtelecom
   telecom (WORKPHONE)telecom
      idn/a
      extensionn/a
      system./scheme
      value./url
      useunique(./use)
      rankn/a
      period./usablePeriod[type="IVL<TS>"]
   telecom (ALTPHONE)telecom
      idn/a
      extensionn/a
      system./scheme
      value./url
      useunique(./use)
      rankn/a
      period./usablePeriod[type="IVL<TS>"]
   telecom (CELLPHONE)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
      rankn/a
      period./usablePeriod[type="IVL<TS>"]
   telecom (PAGERPHONE)telecom
      idn/a
      extensionn/a
      system./scheme
      value./url
      useunique(./use)
      rankn/a
      period./usablePeriod[type="IVL<TS>"]
   genderadministrativeGender
   birthDateplayer.birthTime
   addressaddr
      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>"]
   photoplayer[classCode='PSN' and determinerCode='INSTANCE']/desc
   period.effectiveTime
   communicationLanguageCommunication
      idn/a
      extensionn/a
      modifierExtensionN/A
      languageplayer[classCode=PSN|ANM and determinerCode=INSTANCE]/languageCommunication/code
      preferredpreferenceInd

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

AthenaRelatedPerson
RelatedPerson
   identifierFiveWs.identifier
   identifier (SSN)FiveWs.identifier
   identifier (External)FiveWs.identifier
   activeFiveWs.status
   relationshipFiveWs.class
   periodFiveWs.done[x]

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

AthenaRelatedPerson
RelatedPerson
   identifierNK1-33
   identifier (SSN)NK1-33
   identifier (External)NK1-33
   patientPID-3
   relationshipNK1-3
   nameNK1-2
      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
   telecomNK1-5 / NK1-6 / NK1-40
   telecom (WORKPHONE)NK1-5 / NK1-6 / NK1-40
      systemXTN.3
      valueXTN.1 (or XTN.12)
      useXTN.2 - but often indicated by field
      rankn/a
      periodN/A
   telecom (ALTPHONE)NK1-5 / NK1-6 / NK1-40
      systemXTN.3
      valueXTN.1 (or XTN.12)
      useXTN.2 - but often indicated by field
      rankn/a
      periodN/A
   telecom (CELLPHONE)NK1-5 / NK1-6 / NK1-40
      systemXTN.3
      valueXTN.1 (or XTN.12)
      useXTN.2 - but often indicated by field
      rankn/a
      periodN/A
   telecom (FAXPHONE)NK1-5 / NK1-6 / NK1-40
      systemXTN.3
      valueXTN.1 (or XTN.12)
      rankn/a
      periodN/A
   telecom (PAGERPHONE)NK1-5 / NK1-6 / NK1-40
      systemXTN.3
      valueXTN.1 (or XTN.12)
      useXTN.2 - but often indicated by field
      rankn/a
      periodN/A
   genderNK1-15
   addressNK1-4
      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
   photoOBX-5 - needs a profile