Universal API Implementation Guide
1.1.20 - ci-build

Universal API Implementation Guide - Local Development build (v1.1.20) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: UapiOrganization - Mappings

Active as of 2021-06-04

Mappings for the uapi-organization resource profile.

Mappings to Structures in this Implementation Guide

No Mappings Found

Mappings to other Structures

No Mappings Found

Other Mappings

NameHL7 v2 MappingRIM MappingServDFiveWs Pattern Mappingdoco
.. Organization
(also see master files messages)
  • Organization(classCode=ORG
  • determinerCode=INST)
Organization
administrative.group
... id
... meta
... implicitRules
... text
Act.text?
... contained
N/A
... extension
N/A
... modifierExtension
N/A
... identifier
XON.10 / XON.3
.scopes[Role](classCode=IDENT)
./Identifiers
FiveWs.identifier
.... id
n/a
.... extension
n/a
.... use
N/A
Role.code or implied by context
.... type
CX.5
Role.code or implied by context
.... system
CX.4 / EI-2-4
II.root or Role.id.root
./IdentifierType
.... value
CX.1 / EI.1
II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
./Value
.... period
CX.7 + CX.8
Role.effectiveTime or implied by context
./StartDate and ./EndDate
.... assigner
  • CX.4 / (CX.4
  • CX.9
  • CX.10)
II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
./IdentifierIssuingAuthority
... active
No equivalent in HL7 v2
.status
  • ./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.
FiveWs.status
... type
No equivalent in v2
.code
n/a
FiveWs.class
... name
XON.1
.name
.PreferredName/Name
... alias
.name
... Slices for telecom
ORC-22?
.telecom
./ContactPoints
.... telecom:All Slices
..... id
n/a
..... extension
n/a
..... system
XTN.3
./scheme
./ContactPointType
..... value
XTN.1 (or XTN.12)
./url
./Value
..... use
XTN.2 - but often indicated by field
unique(./use)
./ContactPointPurpose
..... rank
n/a
n/a
..... period
N/A
./usablePeriod[type="IVL<TS>"]
./StartDate and ./EndDate
.... telecom:Phone
ORC-22?
.telecom
./ContactPoints
..... id
n/a
..... extension
n/a
..... system
XTN.3
./scheme
./ContactPointType
..... value
XTN.1 (or XTN.12)
./url
./Value
..... use
XTN.2 - but often indicated by field
unique(./use)
./ContactPointPurpose
..... rank
n/a
n/a
..... period
N/A
./usablePeriod[type="IVL<TS>"]
./StartDate and ./EndDate
.... telecom:Fax
ORC-22?
.telecom
./ContactPoints
..... id
n/a
..... extension
n/a
..... system
XTN.3
./scheme
./ContactPointType
..... value
XTN.1 (or XTN.12)
./url
./Value
..... use
XTN.2 - but often indicated by field
unique(./use)
./ContactPointPurpose
..... rank
n/a
n/a
..... period
N/A
./usablePeriod[type="IVL<TS>"]
./StartDate and ./EndDate
... address
ORC-23?
.address
./PrimaryAddress and ./OtherAddresses
.... id
n/a
.... extension
n/a
.... use
XAD.7
unique(./use)
./AddressPurpose
.... type
XAD.18
unique(./use)
.... text
XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6
./formatted
.... line
XAD.1 and XAD.2 have different meanings for a company address than for a person address)
AD.part[parttype = AL]
./StreetAddress (newline delimitted)
.... city
XAD.3
AD.part[parttype = CTY]
./Jurisdiction
.... district
XAD.9
AD.part[parttype = CNT | CPA]
.... state
XAD.4
AD.part[parttype = STA]
./Region
.... postalCode
XAD.5
AD.part[parttype = ZIP]
./PostalIdentificationCode
.... country
XAD.6
AD.part[parttype = CNT]
./Country
.... period
XAD.12 / XAD.13 + XAD.14
./usablePeriod[type="IVL<TS>"]
./StartDate and ./EndDate
... partOf
No equivalent in HL7 v2
.playedBy[classCode=Part].scoper
n/a
... contact
.contactParty
.... id
n/a
.... extension
n/a
.... modifierExtension
N/A
.... purpose
./type
.... name
  • PID-5
  • PID-9
./name
..... id
n/a
..... extension
n/a
..... use
  • XPN.7
  • but often indicated by which field contains the name
unique(./use)
./NamePurpose
..... text
implied by XPN.11
./formatted
..... family
XPN.1/FN.1
./part[partType = FAM]
./FamilyName
..... given
XPN.2 + XPN.3
./part[partType = GIV]
./GivenNames
..... prefix
XPN.5
./part[partType = PFX]
./TitleCode
..... suffix
XPN/4
./part[partType = SFX]
..... period
XPN.13 + XPN.14
./usablePeriod[type="IVL<TS>"]
./StartDate and ./EndDate
.... Slices for telecom
  • PID-13
  • PID-14
./telecom
..... telecom:All Slices
...... id
n/a
...... extension
n/a
...... system
XTN.3
./scheme
./ContactPointType
...... value
XTN.1 (or XTN.12)
./url
./Value
...... use
XTN.2 - but often indicated by field
unique(./use)
./ContactPointPurpose
...... rank
n/a
n/a
...... period
N/A
./usablePeriod[type="IVL<TS>"]
./StartDate and ./EndDate
..... telecom:Phone
  • PID-13
  • PID-14
./telecom
...... id
n/a
...... extension
n/a
...... system
XTN.3
./scheme
./ContactPointType
...... value
XTN.1 (or XTN.12)
./url
./Value
...... use
XTN.2 - but often indicated by field
unique(./use)
./ContactPointPurpose
...... rank
n/a
n/a
...... period
N/A
./usablePeriod[type="IVL<TS>"]
./StartDate and ./EndDate
..... telecom:Fax
  • PID-13
  • PID-14
./telecom
...... id
n/a
...... extension
n/a
...... system
XTN.3
./scheme
./ContactPointType
...... value
XTN.1 (or XTN.12)
./url
./Value
...... use
XTN.2 - but often indicated by field
unique(./use)
./ContactPointPurpose
...... rank
n/a
n/a
...... period
N/A
./usablePeriod[type="IVL<TS>"]
./StartDate and ./EndDate
..... telecom:Email
  • PID-13
  • PID-14
./telecom
...... id
n/a
...... extension
n/a
...... system
XTN.3
./scheme
./ContactPointType
...... value
XTN.1 (or XTN.12)
./url
./Value
...... use
XTN.2 - but often indicated by field
unique(./use)
./ContactPointPurpose
...... rank
n/a
n/a
...... period
N/A
./usablePeriod[type="IVL<TS>"]
./StartDate and ./EndDate
.... address
PID-11
./addr
... endpoint
n/a

doco Documentation for this format