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: NdhPnLdApiPractitioner - Mappings

Active as of 2024-06-17

Mappings for the ndhPn-ldapi-Practitioner resource profile.

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

NdhPnLdApiPractitioner
PractitionerPRD (as one example)
   identifierPRD-7 (or XCN.1)
      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)PRD-7 (or XCN.1)
   nameXCN Components
      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
   telecomPRT-15, STF-10, ROL-12
      systemXTN.3
      valueXTN.1 (or XTN.12)
      useXTN.2 - but often indicated by field
      rankn/a
      periodN/A
   addressORC-24, STF-11, ROL-11, PRT-14
      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
   genderSTF-5
   birthDateSTF-6
   qualificationCER?
      identifier
         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)
   communicationPID-15, NK1-20, LAN-2
      codingC*E.1-8, C*E.10-22
      textC*E.9. But note many systems use C*E.2 for this

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

NdhPnLdApiPractitioner
PractitionerEntity. Role, or Act, Role
   meta
      idn/a
      extensionn/a
   textAct.text?
   containedN/A
   extension
   extension (us-core-race)
   extension (us-core-ethnicity)
   extension (individual-genderIdentity)
   extension (individual-pronouns)
   extension (individual-recordedSexOrGender)
   extension (usage-restriction)
   extension (endpoint)
      idn/a
      urlN/A
      value[x]N/A
   modifierExtensionN/A
   identifier./id
      idn/a
      extensionn/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)./id
   active./statusCode
   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>"]
   gender./administrativeGender
   birthDate./birthTime
   photo./subjectOf/ObservationEvent[code="photo"]/value
   qualification.playingEntity.playingRole[classCode=QUAL].code
      idn/a
      modifierExtensionN/A
      identifier.playingEntity.playingRole[classCode=QUAL].id
         idn/a
         extensionn/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
      code.playingEntity.playingRole[classCode=QUAL].code
      period.playingEntity.playingRole[classCode=QUAL].effectiveTime
      issuer.playingEntity.playingRole[classCode=QUAL].scoper
   communication./languageCommunication
      idn/a
      extensionn/a
      codingunion(., ./translation)
      text./originalText[mediaType/code="text/plain"]/data

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

NdhPnLdApiPractitioner
PractitionerProvider
   identifier./Identifiers
      system./IdentifierType
      value./Value
      period./StartDate and ./EndDate
      assigner./IdentifierIssuingAuthority
   identifier (NPI)./Identifiers
   name./PreferredName (GivenNames, FamilyName, TitleCode)
      use./NamePurpose
      family./FamilyName
      given./GivenNames
      prefix./TitleCode
      period./StartDate and ./EndDate
   telecom./ContactPoints
      system./ContactPointType
      value./Value
      use./ContactPointPurpose
      period./StartDate and ./EndDate
   address./Addresses
      use./AddressPurpose
      line./StreetAddress (newline delimitted)
      city./Jurisdiction
      state./Region, ./Sites
      postalCode./PostalIdentificationCode
      country./Country
      period./StartDate and ./EndDate
   gender./GenderCode
   birthDate(not represented in ServD)
   photo./ImageURI (only supports the URI reference)
   qualification./Qualifications
      identifier
         system./IdentifierType
         value./Value
         period./StartDate and ./EndDate
         assigner./IdentifierIssuingAuthority
      code./Qualifications.Value
      period./Qualifications.StartDate and ./Qualifications.EndDate
   communication./Languages.LanguageSpokenCode

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

NdhPnLdApiPractitioner
Practitioner
   identifierFiveWs.identifier
   identifier (NPI)FiveWs.identifier
   activeFiveWs.status