eHealthExchange Healthcare Directory Implementation Guide
0.0.7 - CI Build United States of America flag

eHealthExchange Healthcare Directory Implementation Guide - Local Development build (v0.0.7). See the Directory of published versions

Resource Profile: EHxOrganization - Mappings

Active as of 2020-12-09

Mappings for the eHxOrganization resource profile.

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

EHxOrganization
OrganizationOrganization
   identifier./Identifiers, n/a
   identifier (NPI)./Identifiers, n/a
   identifier (CLIA)./Identifiers, n/a
   identifier (CCN)./Identifiers, n/a
   identifier (HCID)./Identifiers, n/a
   identifier (AAID)./Identifiers, n/a
   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
   type (sequoiaorgtype)n/a
   type (hl7orgrole)n/a
   name.PreferredName/Name, ./PrimaryAddress and ./OtherAddresses
   telecom./ContactPoints
   telecom (phone)./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, n/a
      use./AddressPurpose
      line./StreetAddress (newline delimitted)
      city./Jurisdiction
      state./Region, ./Sites
      postalCode./PostalIdentificationCode
      country./Country
      period./StartDate and ./EndDate
   partOfn/a
   contact
      telecom
      telecom (phone)
         system./ContactPointType
         value./Value
         use./ContactPointPurpose
         period./StartDate and ./EndDate
      telecom (email)
         system./ContactPointType
         value./Value
         use./ContactPointPurpose
         period./StartDate and ./EndDate
      address
         use./AddressPurpose
         line./StreetAddress (newline delimitted)
         city./Jurisdiction
         state./Region
         postalCode./PostalIdentificationCode
         country./Country
         period./StartDate and ./EndDate

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

EHxOrganization
Organization(also see master files messages)
   identifierXON.10 / XON.3
   identifier (NPI)XON.10 / XON.3
   identifier (CLIA)XON.10 / XON.3
   identifier (CCN)XON.10 / XON.3
   identifier (HCID)XON.10 / XON.3
   identifier (AAID)XON.10 / XON.3
   activeNo equivalent in HL7 v2
   typeNo equivalent in v2
   type (sequoiaorgtype)No equivalent in v2
   type (hl7orgrole)No equivalent in v2
   nameXON.1
   telecomORC-22?
   telecom (phone)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)
      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
      telecom (phone)PID-13, PID-14
         systemXTN.3
         valueXTN.1 (or XTN.12)
         useXTN.2 - but often indicated by field
         rankn/a
         periodN/A
      telecom (email)PID-13, PID-14
         systemXTN.3
         valueXTN.1 (or XTN.12)
         useXTN.2 - but often indicated by field
         rankn/a
         periodN/A
      addressPID-11
         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)
         cityXAD.3
         districtXAD.9
         stateXAD.4
         postalCodeXAD.5
         countryXAD.6
         periodXAD.12 / XAD.13 + XAD.14

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

EHxOrganization
OrganizationEntity. Role, or Act, Organization(classCode=ORG, determinerCode=INST)
   textAct.text?
   containedN/A
   modifierExtensionN/A
   identifier.scopes[Role](classCode=IDENT)
   identifier (NPI).scopes[Role](classCode=IDENT)
   identifier (CLIA).scopes[Role](classCode=IDENT)
   identifier (CCN).scopes[Role](classCode=IDENT)
   identifier (HCID).scopes[Role](classCode=IDENT)
   identifier (AAID).scopes[Role](classCode=IDENT)
   active.status
   type.code
   type (sequoiaorgtype).code
   type (hl7orgrole).code
   name.name
   alias.name
   telecom.telecom
   telecom (phone).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
      useunique(./use)
      typeunique(./use)
      text./formatted
      lineAD.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
      modifierExtensionN/A
      purpose./type
      name./name
      telecom./telecom
      telecom (phone)./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./addr
         idn/a
         extensionn/a
         useunique(./use)
         typeunique(./use)
         text./formatted
         lineAD.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>"]
   endpointn/a

Mappings for W5 Mapping (http://hl7.org/fhir/w5)

EHxOrganization
Organization
   identifierFiveWs.identifier
   identifier (NPI)FiveWs.identifier
   identifier (CLIA)FiveWs.identifier
   identifier (CCN)FiveWs.identifier
   identifier (HCID)FiveWs.identifier
   identifier (AAID)FiveWs.identifier
   activeFiveWs.status
   typeFiveWs.class
   type (sequoiaorgtype)FiveWs.class
   type (hl7orgrole)FiveWs.class

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

EHxOrganization
Organization
   identifierFiveWs.identifier
   identifier (NPI)FiveWs.identifier
   identifier (CLIA)FiveWs.identifier
   identifier (CCN)FiveWs.identifier
   identifier (HCID)FiveWs.identifier
   identifier (AAID)FiveWs.identifier
   activeFiveWs.status
   typeFiveWs.class
   type (sequoiaorgtype)FiveWs.class
   type (hl7orgrole)FiveWs.class