Implementation Guide
25.0.0 - R4 APIs

Publish Box goes here

Resource Profile: AthenaOrganization - Mappings

Active as of 2022-03-01

Mappings for the athena-organization-profile resource profile.

Mappings to Structures in this Implementation Guide

No Mappings Found

Mappings to other Structures

No Mappings Found

Other Mappings

NameathenaFlowathenaPracticeHL7 v2 MappingRIM MappingServDFiveWs Pattern Mappingdoco
.. Organization
FHIRR4_ORGANIZATIONVIEW
FHIRR4_ORGANIZATIONVIEW
(also see master files messages)
  • Entity. Role
  • or Act
Organization
... id
  • MakeIdWithPrefix(%ORGANIZATIONID%
  • %ID_PREFIX%)
  • MakeIdWithPrefix(%ORGANIZATIONID%
  • %ID_PREFIX%)
... meta
.... id
n/a
.... extension
n/a
.... versionId
.... lastUpdated
%LASTMODIFIED%
%LASTMODIFIED%
.... source
.... Slices for profile
..... profile:us-core-organization
..... profile:athena-organization-profile
.... security
.... tag
... implicitRules
... text
Act.text?
... contained
N/A
... extension
N/A
... modifierExtension
N/A
... Slices for identifier
XON.10 / XON.3
.scopes[Role](classCode=IDENT)
./Identifiers
FiveWs.identifier
.... identifier:ORGANIZATIONID
XON.10 / XON.3
.scopes[Role](classCode=IDENT)
./Identifiers
FiveWs.identifier
.... identifier:NCPDPID
  • MakeIdentifier("NCPDP"
  • oid:2.16.840.1.113883.3.79"
  • %NCPDPID%)
  • MakeIdentifier("NCPDP"
  • oid:2.16.840.1.113883.3.79"
  • %NCPDPID%)
XON.10 / XON.3
.scopes[Role](classCode=IDENT)
./Identifiers
FiveWs.identifier
.... identifier:NPI
  • MakeIdentifier("NPI"
  • //hl7.org/fhir/sid/us-npi"
  • %NPI%)
  • MakeIdentifier("NPI"
  • //hl7.org/fhir/sid/us-npi"
  • %NPI%)
XON.10 / XON.3
.scopes[Role](classCode=IDENT)
./Identifiers
FiveWs.identifier
.... identifier:NAIC
  • MakeIdentifier("NAIC"
  • oid:2.16.840.1.113883.6.300"
  • %OTHERPAYERID%)
XON.10 / XON.3
.scopes[Role](classCode=IDENT)
./Identifiers
FiveWs.identifier
.... identifier:TAX
XON.10 / XON.3
.scopes[Role](classCode=IDENT)
./Identifiers
FiveWs.identifier
..... id
n/a
..... extension
n/a
..... use
N/A
Role.code or implied by context
..... type
CX.5
Role.code or implied by context
...... id
n/a
...... extension
n/a
...... coding
  • C*E.1-8
  • C*E.10-22
  • union(.
  • ./translation)
....... id
n/a
....... extension
n/a
....... system
C*E.3
./codeSystem
....... version
C*E.7
./codeSystemVersion
....... code
C*E.1
./code
....... display
C*E.2 - but note this is not well followed
CV.displayName
....... userSelected
Sometimes implied by being first
CD.codingRationale
...... text
C*E.9. But note many systems use C*E.2 for this
./originalText[mediaType/code="text/plain"]/data
..... system
CX.4 / EI-2-4
II.root or Role.id.root
./IdentifierType
..... value
%TIN%
CX.1 / EI.1
II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
./Value
..... period
CX.7 + CX.8
Role.effectiveTime or implied by context
./StartDate and ./EndDate
..... assigner
  • CX.4 / (CX.4
  • CX.9
  • CX.10)
II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
./IdentifierIssuingAuthority
... active
  • Equals("A"
  • %ACTIVE%)
  • Equals("0"
  • %INACTIVE%)
No equivalent in HL7 v2
.status
  • ./Status (however this concept in ServD more covers why the organization is active or not
  • could be delisted
  • deregistered
  • not operational yet) this could alternatively be derived from ./StartDate and ./EndDate and given a context date.
FiveWs.status
... type
  • MapConcept(%TYPE%
  • "ORGANIZATIONTYPE")
  • MapConcept(%TYPE%
  • "ORGANIZATIONTYPE")
No equivalent in v2
.code
n/a
FiveWs.class
... name
%NAME%
%NAME%
XON.1
.name
.PreferredName/Name
... alias
.name
... Slices for telecom
ORC-22?
.telecom
./ContactPoints
.... telecom:WORKPHONE
ORC-22?
.telecom
./ContactPoints
..... id
n/a
..... extension
n/a
..... system
XTN.3
./scheme
./ContactPointType
..... value
%WORKPHONE%
%WORKPHONE%
XTN.1 (or XTN.12)
./url
./Value
..... use
XTN.2 - but often indicated by field
unique(./use)
./ContactPointPurpose
..... rank
n/a
n/a
..... period
N/A
./usablePeriod[type="IVL<TS>"]
./StartDate and ./EndDate
.... telecom:ALTPHONE
ORC-22?
.telecom
./ContactPoints
..... id
n/a
..... extension
n/a
..... system
XTN.3
./scheme
./ContactPointType
..... value
%ALTPHONE%
%ALTPHONE%
XTN.1 (or XTN.12)
./url
./Value
..... use
XTN.2 - but often indicated by field
unique(./use)
./ContactPointPurpose
..... rank
n/a
n/a
..... period
N/A
./usablePeriod[type="IVL<TS>"]
./StartDate and ./EndDate
.... telecom:CELLPHONE
ORC-22?
.telecom
./ContactPoints
..... id
n/a
..... extension
n/a
..... system
XTN.3
./scheme
./ContactPointType
..... value
%CELLPHONE%
%CELLPHONE%
XTN.1 (or XTN.12)
./url
./Value
..... use
XTN.2 - but often indicated by field
unique(./use)
./ContactPointPurpose
..... rank
n/a
n/a
..... period
N/A
./usablePeriod[type="IVL<TS>"]
./StartDate and ./EndDate
.... telecom:FAXPHONE
ORC-22?
.telecom
./ContactPoints
..... id
n/a
..... extension
n/a
..... system
XTN.3
./scheme
./ContactPointType
..... value
%FAXPHONE%
%FAXPHONE%
XTN.1 (or XTN.12)
./url
./Value
..... use
XTN.2 - but often indicated by field
unique(./use)
./ContactPointPurpose
..... rank
n/a
n/a
..... period
N/A
./usablePeriod[type="IVL<TS>"]
./StartDate and ./EndDate
.... telecom:PAGERPHONE
ORC-22?
.telecom
./ContactPoints
..... id
n/a
..... extension
n/a
..... system
XTN.3
./scheme
./ContactPointType
..... value
%PAGERPHONE%
%PAGERPHONE%
XTN.1 (or XTN.12)
./url
./Value
..... use
XTN.2 - but often indicated by field
unique(./use)
./ContactPointPurpose
..... rank
n/a
n/a
..... period
N/A
./usablePeriod[type="IVL<TS>"]
./StartDate and ./EndDate
.... telecom:EMAIL
ORC-22?
.telecom
./ContactPoints
..... id
n/a
..... extension
n/a
..... system
XTN.3
./scheme
./ContactPointType
..... value
%EMAIL%
%EMAIL%
XTN.1 (or XTN.12)
./url
./Value
..... use
XTN.2 - but often indicated by field
unique(./use)
./ContactPointPurpose
..... rank
n/a
n/a
..... period
N/A
./usablePeriod[type="IVL<TS>"]
./StartDate and ./EndDate
... address
  • MakeSearchAddress(%ADDRESS1%
  • %ADDRESS2%
  • %CITY%
  • %STATE%
  • %ZIP%
  • %COUNTRY%)
  • MakeSearchAddress(%ADDRESS1%
  • %ADDRESS2%
  • %CITY%
  • %STATE%
  • %ZIP%
  • %COUNTRY%)
ORC-23?
.address
./PrimaryAddress and ./OtherAddresses
.... id
n/a
.... extension
n/a
.... use
XAD.7
unique(./use)
./AddressPurpose
.... type
XAD.18
unique(./use)
.... text
XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6
./formatted
.... Slices for line
XAD.1 and XAD.2 have different meanings for a company address than for a person address)
AD.part[parttype = AL]
./StreetAddress (newline delimitted)
..... line:ADDRESS1
%ADDRESS1%
%ADDRESS1%
XAD.1 and XAD.2 have different meanings for a company address than for a person address)
AD.part[parttype = AL]
./StreetAddress (newline delimitted)
..... line:ADDRESS2
%ADDRESS2%
%ADDRESS2%
XAD.1 and XAD.2 have different meanings for a company address than for a person address)
AD.part[parttype = AL]
./StreetAddress (newline delimitted)
.... city
%CITY%
%CITY%
XAD.3
AD.part[parttype = CTY]
./Jurisdiction
.... district
XAD.9
AD.part[parttype = CNT | CPA]
.... state
%STATE%
%STATE%
XAD.4
AD.part[parttype = STA]
./Region
.... postalCode
%ZIP%
%ZIP%
XAD.5
AD.part[parttype = ZIP]
./PostalIdentificationCode
.... country
%COUNTRY%
%COUNTRY%
XAD.6
AD.part[parttype = CNT]
./Country
.... period
XAD.12 / XAD.13 + XAD.14
./usablePeriod[type="IVL<TS>"]
./StartDate and ./EndDate
... partOf
No equivalent in HL7 v2
.playedBy[classCode=Part].scoper
n/a
... contact
.contactParty
.... id
n/a
.... extension
n/a
.... modifierExtension
N/A
.... purpose
./type
.... name
  • PID-5
  • PID-9
./name
.... telecom
  • PID-13
  • PID-14
./telecom
.... address
PID-11
./addr
... endpoint
  • MakeEndpointReferenceList("ENDPOINT"
  • %ID_PREFIX%
  • %ORGANIZATIONID%
  • "Endpoint")
  • MakeEndpointReferenceList("ENDPOINT"
  • %ID_PREFIX%
  • %ORGANIZATIONID%
  • "Endpoint")
n/a

doco Documentation for this format