National Directory of Healthcare Providers & Services (NDH) Implementation Guide
1.0.0-ballot - ballot United States of America flag

National Directory of Healthcare Providers & Services (NDH) Implementation Guide, published by HL7 International / Patient Administration. This guide is not an authorized publication; it is the continuous build for version 1.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-us-ndh/ and changes regularly. See the Directory of published versions

Resource Profile: NdhNdApiOrganization - Mappings

Active as of 2024-11-01

Mappings for the ndh-ndapi-Organization resource profile.

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

NdhNdApiOrganization
Organization(also see master files messages)
   identifierXON.10 / XON.3
      useN/A
      typeCX.5
      systemCX.4 / EI-2-4
      valueCX.1 / EI.1
      periodCX.7 + CX.8
      assignerCX.4 / (CX.4,CX.9,CX.10)
   identifier (NPI)XON.10 / XON.3
   identifier (CLIA)XON.10 / XON.3
   identifier (NAIC)XON.10 / XON.3
   identifier (TID)XON.10 / XON.3
   activeNo equivalent in HL7 v2
   typeNo equivalent in v2
   nameXON.1
   telecomORC-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
         useXPN.7, but often indicated by which field contains the name
         textimplied by XPN.11
         familyXPN.1/FN.1
         givenXPN.2 + XPN.3
         prefixXPN.5
         suffixXPN/4
         periodXPN.13 + XPN.14
      telecomPID-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)

NdhNdApiOrganization
OrganizationEntity. Role, or Act, Organization(classCode=ORG, determinerCode=INST)
   meta
      idn/a
      extensionn/a
   textAct.text?
   containedN/A
   extension
   extension (rating)
   extension (paymentaccepted)
   extension (fundingSource)
   extension (org-description)
   extension (digitalcertificate)
   extension (qualification)
   extension (usage-restriction)
   extension (insuranceplan)
      idn/a
      urlN/A
      value[x]N/A
   modifierExtensionN/A
   identifier.scopes[Role](classCode=IDENT)
      idn/a
      useRole.code or implied by context
      typeRole.code or implied by context
      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 (NPI).scopes[Role](classCode=IDENT)
   identifier (CLIA).scopes[Role](classCode=IDENT)
   identifier (NAIC).scopes[Role](classCode=IDENT)
   identifier (TID).scopes[Role](classCode=IDENT)
   active.status
   type.code
   name.name
   alias.name
   telecom.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]
      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
         idn/a
         extensionn/a
         useunique(./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
         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 ServD (http://www.omg.org/spec/ServD/1.0/)

NdhNdApiOrganization
OrganizationOrganization
   identifier./Identifiers
      system./IdentifierType
      value./Value
      period./StartDate and ./EndDate
      assigner./IdentifierIssuingAuthority
   identifier (NPI)./Identifiers
   identifier (CLIA)./Identifiers
   identifier (NAIC)./Identifiers
   identifier (TID)./Identifiers
   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
      system./ContactPointType
      value./Value
      use./ContactPointPurpose
      period./StartDate and ./EndDate
   address./PrimaryAddress and ./OtherAddresses
      use./AddressPurpose
      line./StreetAddress (newline delimitted)
      city./Jurisdiction
      state./Region
      postalCode./PostalIdentificationCode
      country./Country
      period./StartDate and ./EndDate
   partOfn/a
   contact
      name
         use./NamePurpose
         family./FamilyName
         given./GivenNames
         prefix./TitleCode
         period./StartDate and ./EndDate
      telecom
         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 FiveWs Pattern Mapping (http://hl7.org/fhir/fivews)

NdhNdApiOrganization
Organization
   identifierFiveWs.identifier
   identifier (NPI)FiveWs.identifier
   identifier (CLIA)FiveWs.identifier
   identifier (NAIC)FiveWs.identifier
   identifier (TID)FiveWs.identifier
   activeFiveWs.status
   typeFiveWs.class