MyHealtheVet PHR FHIR API
0.3.9-current - ci-build United States of America flag

MyHealtheVet PHR FHIR API, published by VA Digital Services. This guide is not an authorized publication; it is the continuous build for version 0.3.9-current built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/department-of-veterans-affairs/mhv-fhir-phr-mapping/ and changes regularly. See the Directory of published versions

Resource Profile: MHVorganization - Mappings

Page standards status: Trial-use Maturity Level: 3

Mappings for the VA.MHV.PHR.organization resource profile.

Mappings for VIA to mhv-fhir-phr (labSiteTO)

MHVorganization
OrganizationlabSiteTO
   identifier
      use`usual`
      system`urn:oid:2.16.840.1.113883.4.349`
      value`LabSiteTO.` + {LabSiteTO.id}
   active`true`
   nameLab Site {number}

Mappings for HDR to mhv-fhir-phr (PerformingOrganization)

MHVorganization
OrganizationPerformingOrganization
   identifier
      use`usual`
      system`urn:oid:2.16.840.1.113883.4.349`
      value{identifier.stationNumber}
   active`true`
   name{identifier.name}
   address{address}

Mappings for HDR to mhv-fhir-phr (recordSource)

MHVorganization
OrganizationrecordSource
   identifier
      use`usual`
      system`urn:oid:2.16.840.1.113883.4.349`
      value{identifier.universalId}
   active`true`
   nameMHV FACILITY_INFO table {FACILITY_INFO.NAME}

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

MHVorganization
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 (TOid)XON.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)
   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
      telecomPID-13, PID-14
      addressPID-11

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

MHVorganization
OrganizationEntity. Role, or Act, Organization(classCode=ORG, determinerCode=INST)
   textAct.text?
   containedN/A
   extensionN/A
   modifierExtensionN/A
   identifier.scopes[Role](classCode=IDENT)
      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).scopes[Role](classCode=IDENT)
   identifier (CLIA).scopes[Role](classCode=IDENT)
   identifier (TOid).scopes[Role](classCode=IDENT)
      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
   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
      telecom./telecom
      address./addr
   endpointn/a

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

MHVorganization
OrganizationOrganization
   identifier./Identifiers
      system./IdentifierType
      value./Value
      period./StartDate and ./EndDate
      assigner./IdentifierIssuingAuthority
   identifier (NPI)./Identifiers
   identifier (CLIA)./Identifiers
   identifier (TOid)./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
      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

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

MHVorganization
Organization
   identifierFiveWs.identifier
   identifier (NPI)FiveWs.identifier
   identifier (CLIA)FiveWs.identifier
   identifier (TOid)FiveWs.identifier
   activeFiveWs.status
   typeFiveWs.class