Implementation Guide
23.1.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 for athenaFlow (http://unknown.org/athenaFlow)

AthenaOrganization
OrganizationFHIRR4_ORGANIZATIONVIEW
   idMakeIdWithPrefix(%ORGANIZATIONID%,%ID_PREFIX%)
   meta
      lastUpdated%LASTMODIFIED%
   identifier
   identifier (ORGANIZATIONID)MakeIdentifier("XX",getSiteIdSystem("ORGANIZATION"),%ORGANIZATIONID%,%ID_PREFIX%)
   identifier (NCPDPID)MakeIdentifier("NCPDP", "urn:oid:2.16.840.1.113883.3.79", %NCPDPID%)
   identifier (NPI)
      value%NPI%
   activeEquals("A",%ACTIVE%)
   typeMapConcept(%TYPE%,"ORGANIZATIONTYPE")
   name%NAME%
   telecom
   telecom (WORKPHONE)
      value%WORKPHONE%
   telecom (ALTPHONE)
      value%ALTPHONE%
   telecom (CELLPHONE)
      value%CELLPHONE%
   telecom (FAXPHONE)
      value%FAXPHONE%
   telecom (PAGERPHONE)
      value%PAGERPHONE%
   telecom (EMAIL)
      value%EMAIL%
   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)

AthenaOrganization
OrganizationFHIRR4_ORGANIZATIONVIEW
   idMakeIdWithPrefix(%ORGANIZATIONID%,%ID_PREFIX%)
   meta
      lastUpdated%LASTMODIFIED%
   identifier
   identifier (ORGANIZATIONID)MakeIdentifier("XX",getSiteIdSystem("ORGANIZATION"),%ORGANIZATIONID%,%ID_PREFIX%)
   identifier (NCPDPID)MakeIdentifier("NCPDP", "urn:oid:2.16.840.1.113883.3.79", %NCPDPID%)
   identifier (NPI)
      value%NPI%
   identifier (TAX)
      value%TIN%
   activeEquals("0",%INACTIVE%)
   typeMapConcept(%TYPE%,"ORGANIZATIONTYPE")
   name%NAME%
   telecom
   telecom (WORKPHONE)
      value%WORKPHONE%
   telecom (ALTPHONE)
      value%ALTPHONE%
   telecom (CELLPHONE)
      value%CELLPHONE%
   telecom (FAXPHONE)
      value%FAXPHONE%
   telecom (PAGERPHONE)
      value%PAGERPHONE%
   telecom (EMAIL)
      value%EMAIL%
   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)

AthenaOrganization
Organization(also see master files messages)
   identifierXON.10 / XON.3
   identifier (ORGANIZATIONID)XON.10 / XON.3
   identifier (NCPDPID)XON.10 / XON.3
   identifier (NPI)XON.10 / XON.3
      useN/A
      typeCX.5
         codingC*E.1-8, C*E.10-22
            systemC*E.3
            versionC*E.7
            codeC*E.1
            displayC*E.2 - but note this is not well followed
            userSelectedSometimes implied by being first
         textC*E.9. But note many systems use C*E.2 for this
      systemCX.4 / EI-2-4
      valueCX.1 / EI.1
      periodCX.7 + CX.8
      assignerCX.4 / (CX.4,CX.9,CX.10)
   identifier (TAX)XON.10 / XON.3
      useN/A
      typeCX.5
         codingC*E.1-8, C*E.10-22
            systemC*E.3
            versionC*E.7
            codeC*E.1
            displayC*E.2 - but note this is not well followed
            userSelectedSometimes implied by being first
         textC*E.9. But note many systems use C*E.2 for this
      systemCX.4 / EI-2-4
      valueCX.1 / EI.1
      periodCX.7 + CX.8
      assignerCX.4 / (CX.4,CX.9,CX.10)
   activeNo equivalent in HL7 v2
   typeNo equivalent in v2
   nameXON.1
   telecomORC-22?
   telecom (WORKPHONE)ORC-22?
      systemXTN.3
      valueXTN.1 (or XTN.12)
      useXTN.2 - but often indicated by field
      rankn/a
      periodN/A
   telecom (ALTPHONE)ORC-22?
      systemXTN.3
      valueXTN.1 (or XTN.12)
      useXTN.2 - but often indicated by field
      rankn/a
      periodN/A
   telecom (CELLPHONE)ORC-22?
      systemXTN.3
      valueXTN.1 (or XTN.12)
      useXTN.2 - but often indicated by field
      rankn/a
      periodN/A
   telecom (FAXPHONE)ORC-22?
      systemXTN.3
      valueXTN.1 (or XTN.12)
      rankn/a
      periodN/A
   telecom (PAGERPHONE)ORC-22?
      systemXTN.3
      valueXTN.1 (or XTN.12)
      useXTN.2 - but often indicated by field
      rankn/a
      periodN/A
   telecom (EMAIL)ORC-22?
      systemXTN.3
      valueXTN.1 (or XTN.12)
      useXTN.2 - but often indicated by field
      rankn/a
      periodN/A
   addressORC-23?
      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
   partOfNo equivalent in HL7 v2
   contact
      namePID-5, PID-9
      telecomPID-13, PID-14
      addressPID-11

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

AthenaOrganization
OrganizationEntity. Role, or Act, Organization(classCode=ORG, determinerCode=INST)
   meta
      idn/a
      extensionn/a
   textAct.text?
   containedN/A
   extensionN/A
   modifierExtensionN/A
   identifier.scopes[Role](classCode=IDENT)
   identifier (ORGANIZATIONID).scopes[Role](classCode=IDENT)
   identifier (NCPDPID).scopes[Role](classCode=IDENT)
   identifier (NPI).scopes[Role](classCode=IDENT)
      idn/a
      extensionn/a
      useRole.code or implied by context
      typeRole.code or implied by context
         idn/a
         extensionn/a
         codingunion(., ./translation)
            idn/a
            extensionn/a
            system./codeSystem
            version./codeSystemVersion
            code./code
            displayCV.displayName
            userSelectedCD.codingRationale
         text./originalText[mediaType/code="text/plain"]/data
      systemII.root or Role.id.root
      valueII.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
      periodRole.effectiveTime or implied by context
      assignerII.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
   identifier (TAX).scopes[Role](classCode=IDENT)
      idn/a
      extensionn/a
      useRole.code or implied by context
      typeRole.code or implied by context
         idn/a
         extensionn/a
         codingunion(., ./translation)
            idn/a
            extensionn/a
            system./codeSystem
            version./codeSystemVersion
            code./code
            displayCV.displayName
            userSelectedCD.codingRationale
         text./originalText[mediaType/code="text/plain"]/data
      systemII.root or Role.id.root
      valueII.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
      periodRole.effectiveTime or implied by context
      assignerII.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
   active.status
   type.code
   name.name
   alias.name
   telecom.telecom
   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>"]
   telecom (EMAIL).telecom
      idn/a
      extensionn/a
      system./scheme
      value./url
      useunique(./use)
      rankn/a
      period./usablePeriod[type="IVL<TS>"]
   address.address
      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>"]
   partOf.playedBy[classCode=Part].scoper
   contact.contactParty
      idn/a
      extensionn/a
      modifierExtensionN/A
      purpose./type
      name./name
      telecom./telecom
      address./addr
   endpointn/a

Mappings for ServD (http://www.omg.org/spec/ServD/1.0/)

AthenaOrganization
OrganizationOrganization
   identifier./Identifiers
   identifier (ORGANIZATIONID)./Identifiers
   identifier (NCPDPID)./Identifiers
   identifier (NPI)./Identifiers
      system./IdentifierType
      value./Value
      period./StartDate and ./EndDate
      assigner./IdentifierIssuingAuthority
   identifier (TAX)./Identifiers
      system./IdentifierType
      value./Value
      period./StartDate and ./EndDate
      assigner./IdentifierIssuingAuthority
   active./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.
   typen/a
   name.PreferredName/Name
   telecom./ContactPoints
   telecom (WORKPHONE)./ContactPoints
      system./ContactPointType
      value./Value
      use./ContactPointPurpose
      period./StartDate and ./EndDate
   telecom (ALTPHONE)./ContactPoints
      system./ContactPointType
      value./Value
      use./ContactPointPurpose
      period./StartDate and ./EndDate
   telecom (CELLPHONE)./ContactPoints
      system./ContactPointType
      value./Value
      use./ContactPointPurpose
      period./StartDate and ./EndDate
   telecom (FAXPHONE)./ContactPoints
      system./ContactPointType
      value./Value
      period./StartDate and ./EndDate
   telecom (PAGERPHONE)./ContactPoints
      system./ContactPointType
      value./Value
      use./ContactPointPurpose
      period./StartDate and ./EndDate
   telecom (EMAIL)./ContactPoints
      system./ContactPointType
      value./Value
      use./ContactPointPurpose
      period./StartDate and ./EndDate
   address./PrimaryAddress and ./OtherAddresses
      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
   partOfn/a

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

AthenaOrganization
Organization
   identifierFiveWs.identifier
   identifier (ORGANIZATIONID)FiveWs.identifier
   identifier (NCPDPID)FiveWs.identifier
   identifier (NPI)FiveWs.identifier
   identifier (TAX)FiveWs.identifier
   activeFiveWs.status
   typeFiveWs.class