Publish Box goes here

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON
• TTL

Resource Profile: AthenaPatient - Mappings

Active as of 2022-03-01

Mappings for the athena-patient-profile resource profile.

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

AthenaPatient
Patient	FHIRR4_PATIENTVIEW
id	MakeId(%RESOURCEID%)
meta
lastUpdated	%DB_UPDATED_DATE%
security	CheckSensitive(%SENSITIVECHART%)
extension
extension (mothersMaidenName)
value[x]	%MOTHERSMAIDEN%
extension (RESPPROVID)
value[x]	MakeReference("USR",%RESPPROVID%,"Practitioner")
extension (REFDOCID)
value[x]	MakeReference("USR",%REFDOCID%,"Practitioner")
extension (preferredContact)
value[x]	MapString(%PREFERREDCONTACT%, "PREFCONTACT")
extension (BIRTHTIME)
value[x]	asBirthTimeType(%DATEOFBIRTH%, %TIMEOFBIRTH%)
extension (patientAsGuarantor)
extension (genderIdentity)
value[x]	MakeConceptUsingMedlist(%GENDERIDENTITY%,%GENDERIDENTITYTEXT%,"https://docs.mydata.athenahealth.com/fhir-r4/athenaFlex/genderIdentity")
extension (sexualOrientation)
value[x]	MakeConceptUsingMedlist(%SEXUALORIENTATION%,%SEXUALORIENTATIONTEXT%,"https://docs.mydata.athenahealth.com/fhir-r4/athenaFlex/sexualOrientation")
extension (USCORERACE)	MakeCodingExtension(%RACE%,"RACE","http://hl7.org/fhir/us/core/StructureDefinition/us-core-race")
extension (USCOREETHNICITY)	MakeCodingExtension(%ETHNICITY%,"ETHNICITY","http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity")
extension (USCOREBIRTHSEX)	MakeCodeExtension(%SEX%, "http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex")
identifier
identifier
system	getSiteIdSystem("PatientId")
value	%PATIENTID%
identifier
value	%SOCSECNO%
identifier
system	getSiteIdSystem("MRN")
value	%MEDRECNO%
active	Equals("A",%PSTATUS%)
name
name (Name)	MakeSearchName(%FIRSTNAME%,%MIDDLENAME%,%LASTNAME%,%TITLE%,%ENTITLEMENTS%)
family	%LASTNAME%
given (First Name)	%FIRSTNAME%
given (Middle Name)	%MIDDLENAME%
prefix	%TITLE%
suffix	%ENTITLEMENTS%
name (PreviousName)
family	%PREVIOUSLASTNAME%
given (Previous First Name)	%PREVIOUSFIRSTNAME%
given (Previous Middle Name)	%PREVIOUSMIDDLENAME%
suffix	%PREVIOUSENTITLEMENTS%
period	MakePeriod(%PreviousNameStartDate%,%PreviousNameEndDate%)
name (Nickname)
use	"nickname"
given	%NICKNAME%
telecom
telecom (Work)
value	%WORKPHONE%
telecom (Home)
value	%ALTPHONE%
telecom (Mobile)
value	%CELLPHONE%
telecom (Fax)
value	%FAXPHONE%
telecom (Pager)
value	%PAGERPHONE%
telecom (Email)
value	%EMAIL%
gender	MapCode(%SEX%,"GENDER")
birthDate	%DATEOFBIRTH%
deceased[x]	IfNull(%DATEOFDEATH%).Then(Equals("X",%PSTATUS%)) | IfSet(%DATEOFDEATH%).Then(%DATEOFDEATH%)
address
address (Current Address)	MakeSearchAddress(%ADDRESS1%,%ADDRESS2%,%CITY%,%STATE%,%ZIP%,%COUNTRY%)
line	%ADDRESS1%
line	%ADDRESS2%
city	MakeSearchAddressCity(%CITY%)
state	MakeSearchAddressState(%STATE%)
postalCode	MakeSearchAddressZip(%ZIP%)
country	MakeSearchAddressCountry(%COUNTRY%)
address (Previous Address)	MakePreviousAddressList(%PREVIOUSADDRESSLIST%)
maritalStatus	MapConcept(%MARITALSTATUS%,"MARITALSTATUS")
photo	MakeBinary("Photo",%PHOTO_ID%)
communication
language	MakeConcept(%LANGCODE%,"urn:ietf:bcp:47",%PREFLANG%)
preferred	true
generalPractitioner	MakeReference("USR",%PRICAREID%,"Practitioner")
managingOrganization	MakeReference("LOCREG",%HOMELOCATION%,"Organization")

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

AthenaPatient
Patient	FHIRR4_PATIENTVIEW
id	MakeId(%RESOURCEID%)
meta
lastUpdated	%DB_UPDATED_DATE%
security	CheckSensitive(%SENSITIVECHART%)
extension
extension (mothersMaidenName)
value[x]	%MOTHERSMAIDEN%
extension (RESPPROVID)
value[x]	MakeReference("USR",%RESPPROVID%,"Practitioner")
extension (REFDOCID)
value[x]	MakeReference("USR",%REFDOCID%,"Practitioner")
extension (preferredContact)
value[x]	%PREFERREDCONTACT%
extension (BIRTHTIME)
value[x]	asBirthTimeType(%DATEOFBIRTH%, %TIMEOFBIRTH%)
extension (patientAsGuarantor)
value[x]	isPatientAsGuarantor(%PATIENTASGUARANTOR%)
extension (genderIdentity)
value[x]	MakeConceptUsingMedlist(%GENDERIDENTITY%,%GENDERIDENTITYTEXT%,"https://docs.mydata.athenahealth.com/fhir-r4/athenaFlex/genderIdentity")
extension (sexualOrientation)
value[x]	MakeConceptUsingMedlist(%SEXUALORIENTATION%,%SEXUALORIENTATIONTEXT%,"https://docs.mydata.athenahealth.com/fhir-r4/athenaFlex/sexualOrientation")
extension (guarantorDetails)
value[x]	MakeReference("Guarantor",%GUARANTORID%,"RelatedPerson")
extension (USCORERACE)	MakeCodingExtension(%RACE%,"RACE","http://hl7.org/fhir/us/core/StructureDefinition/us-core-race")
extension (USCOREETHNICITY)	MakeCodingExtension(%ETHNICITY%,"ETHNICITY","http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity")
extension (USCOREBIRTHSEX)	MakeCodeExtension(%SEX%, "http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex")
identifier
identifier
system	getSiteIdSystem("PatientId")
value	%PATIENTID%
identifier
value	%SOCSECNO%
identifier
system	getSiteIdSystem("MRN")
value	%MEDRECNO%
active	Equals("A",%PSTATUS%)
name
name (Name)	MakeSearchName(%FIRSTNAME%,%MIDDLENAME%,%LASTNAME%,%TITLE%,%ENTITLEMENTS%)
family	%LASTNAME%
given (First Name)	%FIRSTNAME%
given (Middle Name)	%MIDDLENAME%
prefix	%TITLE%
suffix	%ENTITLEMENTS%
name (PreviousName)
family	%PREVIOUSLASTNAME%
given (Previous First Name)	%PREVIOUSFIRSTNAME%
given (Previous Middle Name)	%PREVIOUSMIDDLENAME%
suffix	%PREVIOUSENTITLEMENTS%
period	MakePeriod(%PreviousNameStartDate%,%PreviousNameEndDate%)
name (Nickname)
use	"nickname"
given	%NICKNAME%
telecom
telecom (Work)
value	%WORKPHONE%
telecom (Home)
value	%ALTPHONE%
telecom (Mobile)
value	%CELLPHONE%
telecom (Fax)
value	%FAXPHONE%
telecom (Pager)
value	%PAGERPHONE%
telecom (Email)
value	%EMAIL%
gender	MapCode(%SEX%,"GENDER")
birthDate	%DATEOFBIRTH%
deceased[x]	IfNull(%DATEOFDEATH%).Then(Equals("X",%PSTATUS%)) | IfSet(%DATEOFDEATH%).Then(%DATEOFDEATH%)
address
address (Current Address)	MakeSearchAddress(%ADDRESS1%,%ADDRESS2%,%CITY%,%STATE%,%ZIP%,%COUNTRY%)
line	%ADDRESS1%
line	%ADDRESS2%
city	MakeSearchAddressCity(%CITY%)
state	MakeSearchAddressState(%STATE%)
postalCode	MakeSearchAddressZip(%ZIP%)
country	MakeSearchAddressCountry(%COUNTRY%)
address (Previous Address)	MakePreviousAddressList(%PREVIOUSADDRESSLIST%)
maritalStatus	MapConcept(%MARITALSTATUS%,"MARITALSTATUS")
photo	MakeBinary("Photo",%PHOTO_ID%)
communication
language	MakeConcept(%LANGCODE%,"urn:ietf:bcp:47",%PREFLANG%)
preferred	true
generalPractitioner	MakeReference("USR",%PRICAREID%,"Practitioner")
managingOrganization	MakeReference("LOCREG",%HOMELOCATION%,"Organization")

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

AthenaPatient
Patient	Entity. Role, or Act, Patient[classCode=PAT]
meta
id	n/a
extension	n/a
text	Act.text?
contained	N/A
extension
extension (mothersMaidenName)	Role relationship to entity with maiden name (?)
id	n/a
url	N/A
value[x]	N/A
extension (RESPPROVID)
id	n/a
extension	n/a
url	N/A
value[x]	N/A
extension (REFDOCID)
id	n/a
extension	n/a
url	N/A
value[x]	N/A
extension (preferredContact)
id	n/a
extension	n/a
url	N/A
value[x]	N/A
extension (BIRTHTIME)
id	n/a
extension	n/a
url	N/A
value[x]	N/A
extension (patientAsGuarantor)
id	n/a
extension	n/a
url	N/A
value[x]	N/A
extension (genderIdentity)
id	n/a
extension	n/a
url	N/A
value[x]	N/A
extension (sexualOrientation)
id	n/a
extension	n/a
url	N/A
value[x]	N/A
extension (guarantorDetails)
id	n/a
extension	n/a
url	N/A
value[x]	N/A
extension (USCOREBIRTHSEX)	player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender
modifierExtension	N/A
identifier	id
identifier	id
id	n/a
extension	n/a
use	Role.code or implied by context
type	Role.code or implied by context
id	n/a
extension	n/a
coding	union(., ./translation)
id	n/a
extension	n/a
system	./codeSystem
version	./codeSystemVersion
code	./code
display	CV.displayName
userSelected	CD.codingRationale
text	./originalText[mediaType/code="text/plain"]/data
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	id
id	n/a
extension	n/a
use	Role.code or implied by context
type	Role.code or implied by context
id	n/a
extension	n/a
coding	union(., ./translation)
id	n/a
extension	n/a
system	./codeSystem
version	./codeSystemVersion
code	./code
display	CV.displayName
userSelected	CD.codingRationale
text	./originalText[mediaType/code="text/plain"]/data
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	id
id	n/a
extension	n/a
use	Role.code or implied by context
type	Role.code or implied by context
id	n/a
extension	n/a
coding	union(., ./translation)
id	n/a
extension	n/a
system	./codeSystem
version	./codeSystemVersion
code	./code
display	CV.displayName
userSelected	CD.codingRationale
text	./originalText[mediaType/code="text/plain"]/data
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	id
active	statusCode
name	name
name (Name)	name
id	n/a
extension	n/a
use	unique(./use)
text	./formatted
family	./part[partType = FAM]
given	./part[partType = GIV]
given (First Name)	./part[partType = GIV]
given (Middle Name)	./part[partType = GIV]
prefix	./part[partType = PFX]
suffix	./part[partType = SFX]
period	./usablePeriod[type="IVL<TS>"]
name (PreviousName)	name
id	n/a
extension	n/a
use	unique(./use)
text	./formatted
family	./part[partType = FAM]
given	./part[partType = GIV]
given (Previous First Name)	./part[partType = GIV]
given (Previous Middle Name)	./part[partType = GIV]
prefix	./part[partType = PFX]
suffix	./part[partType = SFX]
period	./usablePeriod[type="IVL<TS>"]
name (Nickname)	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
telecom (Work)	telecom
id	n/a
extension	n/a
system	./scheme
value	./url
use	unique(./use)
rank	n/a
period	./usablePeriod[type="IVL<TS>"]
telecom (Home)	telecom
id	n/a
extension	n/a
system	./scheme
value	./url
use	unique(./use)
rank	n/a
period	./usablePeriod[type="IVL<TS>"]
telecom (Mobile)	telecom
id	n/a
extension	n/a
system	./scheme
value	./url
use	unique(./use)
rank	n/a
period	./usablePeriod[type="IVL<TS>"]
telecom (Fax)	telecom
id	n/a
extension	n/a
system	./scheme
value	./url
rank	n/a
period	./usablePeriod[type="IVL<TS>"]
telecom (Pager)	telecom
id	n/a
extension	n/a
system	./scheme
value	./url
use	unique(./use)
rank	n/a
period	./usablePeriod[type="IVL<TS>"]
telecom (Email)	telecom
id	n/a
extension	n/a
system	./scheme
value	./url
use	unique(./use)
rank	n/a
period	./usablePeriod[type="IVL<TS>"]
gender	player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender
birthDate	player[classCode=PSN|ANM and determinerCode=INSTANCE]/birthTime
deceased[x]	player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedInd, player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedTime
address	addr
address (Current Address)	addr
id	n/a
extension	n/a
use	unique(./use)
type	unique(./use)
text	./formatted
line	AD.part[parttype = AL]
line	AD.part[parttype = AL]
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 (Previous Address)	addr
maritalStatus	player[classCode=PSN]/maritalStatusCode
multipleBirth[x]	player[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthInd, player[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthOrderNumber
photo	player[classCode=PSN|ANM and determinerCode=INSTANCE]/desc
contact	player[classCode=PSN|ANM and determinerCode=INSTANCE]/scopedRole[classCode=CON]
id	n/a
extension	n/a
modifierExtension	N/A
relationship	code
name	name
telecom	telecom
address	addr
gender	player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender
organization	scoper
period	effectiveTime
communication	LanguageCommunication
id	n/a
extension	n/a
modifierExtension	N/A
language	player[classCode=PSN|ANM and determinerCode=INSTANCE]/languageCommunication/code
preferred	preferenceInd
generalPractitioner	subjectOf.CareEvent.performer.AssignedEntity
managingOrganization	scoper
link	outboundLink
id	n/a
extension	n/a
modifierExtension	N/A
other	id
type	typeCode

Mappings for CDA (R2) (http://hl7.org/v3/cda)

AthenaPatient
Patient	ClinicalDocument.recordTarget.patientRole
identifier	.id
identifier	.id
identifier	.id
identifier	.id
identifier	.id
active	n/a
name	.patient.name
name (Name)	.patient.name
name (PreviousName)	.patient.name
name (Nickname)	.patient.name
telecom	.telecom
telecom (Work)	.telecom
telecom (Home)	.telecom
telecom (Mobile)	.telecom
telecom (Fax)	.telecom
telecom (Pager)	.telecom
telecom (Email)	.telecom
gender	.patient.administrativeGenderCode
birthDate	.patient.birthTime
deceased[x]	n/a
address	.addr
address (Current Address)	.addr
address (Previous Address)	.addr
maritalStatus	.patient.maritalStatusCode
multipleBirth[x]	n/a
photo	n/a
contact	n/a
relationship	n/a
name	n/a
telecom	n/a
address	n/a
gender	n/a
organization	n/a
period	n/a
communication	patient.languageCommunication
language	.languageCode
preferred	.preferenceInd
generalPractitioner	n/a
managingOrganization	.providerOrganization
link	n/a
other	n/a
type	n/a

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

AthenaPatient
Patient
identifier	FiveWs.identifier
identifier	FiveWs.identifier
identifier	FiveWs.identifier
identifier	FiveWs.identifier
identifier	FiveWs.identifier
active	FiveWs.status

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

AthenaPatient
Patient
extension (mothersMaidenName)	PID-6
identifier	PID-3
identifier	PID-3
use	N/A
type	CX.5
coding	C*E.1-8, C*E.10-22
system	C*E.3
version	C*E.7
code	C*E.1
display	C*E.2 - but note this is not well followed
userSelected	Sometimes implied by being first
text	C*E.9. But note many systems use C*E.2 for this
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	PID-3
use	N/A
type	CX.5
coding	C*E.1-8, C*E.10-22
system	C*E.3
version	C*E.7
code	C*E.1
display	C*E.2 - but note this is not well followed
userSelected	Sometimes implied by being first
text	C*E.9. But note many systems use C*E.2 for this
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	PID-3
use	N/A
type	CX.5
coding	C*E.1-8, C*E.10-22
system	C*E.3
version	C*E.7
code	C*E.1
display	C*E.2 - but note this is not well followed
userSelected	Sometimes implied by being first
text	C*E.9. But note many systems use C*E.2 for this
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	PID-3
name	PID-5, PID-9
name (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
given (First Name)	XPN.2 + XPN.3
given (Middle Name)	XPN.2 + XPN.3
prefix	XPN.5
suffix	XPN/4
period	XPN.13 + XPN.14
name (PreviousName)	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
given (Previous First Name)	XPN.2 + XPN.3
given (Previous Middle Name)	XPN.2 + XPN.3
prefix	XPN.5
suffix	XPN/4
period	XPN.13 + XPN.14
name (Nickname)	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, PID-40
telecom (Work)	PID-13, PID-14, PID-40
system	XTN.3
value	XTN.1 (or XTN.12)
use	XTN.2 - but often indicated by field
rank	n/a
period	N/A
telecom (Home)	PID-13, PID-14, PID-40
system	XTN.3
value	XTN.1 (or XTN.12)
use	XTN.2 - but often indicated by field
rank	n/a
period	N/A
telecom (Mobile)	PID-13, PID-14, PID-40
system	XTN.3
value	XTN.1 (or XTN.12)
use	XTN.2 - but often indicated by field
rank	n/a
period	N/A
telecom (Fax)	PID-13, PID-14, PID-40
system	XTN.3
value	XTN.1 (or XTN.12)
rank	n/a
period	N/A
telecom (Pager)	PID-13, PID-14, PID-40
system	XTN.3
value	XTN.1 (or XTN.12)
use	XTN.2 - but often indicated by field
rank	n/a
period	N/A
telecom (Email)	PID-13, PID-14, PID-40
system	XTN.3
value	XTN.1 (or XTN.12)
use	XTN.2 - but often indicated by field
rank	n/a
period	N/A
gender	PID-8
birthDate	PID-7
deceased[x]	PID-30 (bool) and PID-29 (datetime)
address	PID-11
address (Current Address)	PID-11
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)
line	XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address)
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 (Previous Address)	PID-11
maritalStatus	PID-16
multipleBirth[x]	PID-24 (bool), PID-25 (integer)
photo	OBX-5 - needs a profile
contact
relationship	NK1-7, NK1-3
name	NK1-2
telecom	NK1-5, NK1-6, NK1-40
address	NK1-4
gender	NK1-15
organization	NK1-13, NK1-30, NK1-31, NK1-32, NK1-41
communication
language	PID-15, LAN-2
preferred	PID-15
generalPractitioner	PD1-4
link
other	PID-3, MRG-1

Mappings for LOINC code for the element (http://loinc.org)

AthenaPatient
Patient
birthDate	21112-8