Implementation Guide
25.0.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 to Structures in this Implementation Guide

No Mappings Found

Mappings to other Structures

No Mappings Found

Other Mappings

NameathenaFlowathenaPracticeRIM MappingFiveWs Pattern MappingHL7 v2 Mappingdoco
.. RelatedPerson
FHIRR4_RELATEDPERSONVIEW
FHIRR4_RELATEDPERSONVIEW
role
... id
  • MakeIdWithPrefixAndSuffix(%ID%
  • %ID_PREFIX%
  • %PID%)
  • MakeIdWithPrefixAndSuffix(%ID%
  • %ID_PREFIX%
  • %PID%)
... meta
.... id
n/a
.... extension
n/a
.... versionId
.... lastUpdated
.... source
.... Slices for profile
..... profile:athena-relatedperson-profile
.... Slices for security
..... security:SENSITIVECHART
CheckSensitive(%SENSITIVECHART%)
CheckSensitive(%SENSITIVECHART%)
.... tag
... implicitRules
... text
Act.text?
... contained
N/A
... extension
N/A
... modifierExtension
N/A
... Slices for identifier
.id
FiveWs.identifier
NK1-33
.... identifier:SSN
  • MakeIdentifier("secondary"
  • //hl7.org/fhir/identifier-type"
  • "SB"
  • //hl7.org/fhir/sid/us-ssn"
  • %SSN%)
.id
FiveWs.identifier
NK1-33
.... identifier:External
  • MakeIdentifierWithPrefixAndSuffix("U"
  • getSiteSystem("RelatedPersonId")
  • %ID%
  • %ID_PREFIX%
  • %PID%)
  • MakeIdentifierWithPrefixAndSuffix("U"
  • getSiteSystem("RelatedPersonId")
  • %ID%
  • %ID_PREFIX%
  • %PID%)
.id
FiveWs.identifier
NK1-33
... active
  • Equals("true"
  • %ACTIVE%)
  • Equals("true"
  • %ACTIVE%)
.statusCode
FiveWs.status
... patient
  • MakeReference("PERSON"
  • %PID%
  • "Patient")
  • MakeReference("PATIENTPROFILE"
  • %PID%
  • "Patient")
scoper[classCode=PSN|ANM and determinerCode='INSTANCE']/playedRole[classCode='PAT']/id
PID-3
... relationship
  • MapConcept(%RELATIONSHIP%
  • "PATIENTRELATIONSHIP")
  • MapConcept(%RELATIONSHIP%
  • "PATIENTRELATIONSHIP")
code
FiveWs.class
NK1-3
... name
name
NK1-2
.... id
n/a
.... extension
n/a
.... use
unique(./use)
  • XPN.7
  • but often indicated by which field contains the name
.... text
./formatted
implied by XPN.11
.... family
%LASTNAME%
%LASTNAME%
./part[partType = FAM]
XPN.1/FN.1
.... Slices for given
./part[partType = GIV]
XPN.2 + XPN.3
..... given:FIRSTNAME
%FIRSTNAME%
%FIRSTNAME%
./part[partType = GIV]
XPN.2 + XPN.3
..... given:MIDDLENAME
%MIDDLENAME%
%MIDDLENAME%
./part[partType = GIV]
XPN.2 + XPN.3
.... prefix
%TITLE%
%TITLE%
./part[partType = PFX]
XPN.5
.... suffix
%ENTITLEMENTS%
%ENTITLEMENTS%
./part[partType = SFX]
XPN/4
.... period
./usablePeriod[type="IVL<TS>"]
XPN.13 + XPN.14
... Slices for telecom
telecom
NK1-5 / NK1-6 / NK1-40
.... telecom:WORKPHONE
telecom
NK1-5 / NK1-6 / NK1-40
..... id
n/a
..... extension
n/a
..... system
./scheme
XTN.3
..... value
%WORKPHONE%
%WORKPHONE%
./url
XTN.1 (or XTN.12)
..... use
unique(./use)
XTN.2 - but often indicated by field
..... rank
n/a
n/a
..... period
./usablePeriod[type="IVL<TS>"]
N/A
.... telecom:ALTPHONE
telecom
NK1-5 / NK1-6 / NK1-40
..... id
n/a
..... extension
n/a
..... system
./scheme
XTN.3
..... value
%ALTPHONE%
%ALTPHONE%
./url
XTN.1 (or XTN.12)
..... use
unique(./use)
XTN.2 - but often indicated by field
..... rank
n/a
n/a
..... period
./usablePeriod[type="IVL<TS>"]
N/A
.... telecom:CELLPHONE
telecom
NK1-5 / NK1-6 / NK1-40
..... id
n/a
..... extension
n/a
..... system
./scheme
XTN.3
..... value
%CELLPHONE%
%CELLPHONE%
./url
XTN.1 (or XTN.12)
..... use
unique(./use)
XTN.2 - but often indicated by field
..... rank
n/a
n/a
..... period
./usablePeriod[type="IVL<TS>"]
N/A
.... telecom:FAXPHONE
telecom
NK1-5 / NK1-6 / NK1-40
..... id
n/a
..... extension
n/a
..... system
./scheme
XTN.3
..... value
%FAXPHONE%
%FAXPHONE%
./url
XTN.1 (or XTN.12)
..... use
unique(./use)
XTN.2 - but often indicated by field
..... rank
n/a
n/a
..... period
./usablePeriod[type="IVL<TS>"]
N/A
.... telecom:PAGERPHONE
telecom
NK1-5 / NK1-6 / NK1-40
..... id
n/a
..... extension
n/a
..... system
./scheme
XTN.3
..... value
%PAGERPHONE%
%PAGERPHONE%
./url
XTN.1 (or XTN.12)
..... use
unique(./use)
XTN.2 - but often indicated by field
..... rank
n/a
n/a
..... period
./usablePeriod[type="IVL<TS>"]
N/A
... gender
  • MapCode(%SEX%
  • "GENDER")
  • MapCode(%SEX%
  • "GENDER")
administrativeGender
NK1-15
... birthDate
%BIRTHDATE%
%BIRTHDATE%
player.birthTime
... address
addr
NK1-4
.... id
n/a
.... extension
n/a
.... use
unique(./use)
XAD.7
.... type
unique(./use)
XAD.18
.... text
./formatted
XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6
.... Slices for line
AD.part[parttype = AL]
XAD.1 and XAD.2 have different meanings for a company address than for a person address)
..... line:ADDRESS1
MakeAddressLineForRelatedPerson(%ADDRESS1%)
MakeAddressLineForRelatedPerson(%ADDRESS1%)
AD.part[parttype = AL]
XAD.1 and XAD.2 have different meanings for a company address than for a person address)
..... line:ADDRESS2
%ADDRESS2%
%ADDRESS2%
AD.part[parttype = AL]
XAD.1 and XAD.2 have different meanings for a company address than for a person address)
.... city
%CITY%
%CITY%
AD.part[parttype = CTY]
XAD.3
.... district
AD.part[parttype = CNT | CPA]
XAD.9
.... state
%STATE%
%STATE%
AD.part[parttype = STA]
XAD.4
.... postalCode
%ZIP%
%ZIP%
AD.part[parttype = ZIP]
XAD.5
.... country
%COUNTRY%
%COUNTRY%
AD.part[parttype = CNT]
XAD.6
.... period
./usablePeriod[type="IVL<TS>"]
XAD.12 / XAD.13 + XAD.14
... photo
player[classCode='PSN' and determinerCode='INSTANCE']/desc
OBX-5 - needs a profile
... period
.effectiveTime
FiveWs.done[x]
... communication
LanguageCommunication
.... id
n/a
.... extension
n/a
.... modifierExtension
N/A
.... language
player[classCode=PSN|ANM and determinerCode=INSTANCE]/languageCommunication/code
.... preferred
preferenceInd

doco Documentation for this format