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

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON
• TTL

Resource Profile: UapiBundleCopayEnrollment - Mappings

Mappings for the uapi-copay-enrollment-bundle resource profile.

Mappings to Structures in this Implementation Guide

No Mappings Found

Mappings to other Structures

No Mappings Found

Other Mappings

Name	HL7 v2 Mapping	RIM Mapping	CDA (R2)	FiveWs Pattern Mapping
Bundle	N/A	N/A	ClinicalDocument if bundle.type = document	infrastructure.structure
id
meta
implicitRules
language
identifier			ClinicalDocument.id	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
id		n/a
extension		n/a
coding	C*E.1-8 C*E.10-22	union(. ./translation)
id		n/a
extension		n/a
system	C*E.3	./codeSystem
version	C*E.7	./codeSystemVersion
code	C*E.1	./code
display	C*E.2 - but note this is not well followed	CV.displayName
userSelected	Sometimes implied by being first	CD.codingRationale
text	C*E.9. But note many systems use C*E.2 for this	./originalText[mediaType/code="text/plain"]/data
system	CX.4 / EI-2-4	II.root or Role.id.root
value	CX.1 / EI.1	II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
period	CX.7 + CX.8	Role.effectiveTime or implied by context
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
type				FiveWs.class
timestamp			ClinicalDocument.effectiveTime	FiveWs.init
total
link
id		n/a
extension		n/a
modifierExtension		N/A
relation
url
Slices for entry
entry:All Slices
id		n/a
extension		n/a
modifierExtension		N/A
link
fullUrl
resource
search
request
response
entry:messageheader
id		n/a
extension		n/a
modifierExtension		N/A
link
fullUrl
resource	MSH / MSA / ERR	Message		infrastructure.exchange
search
request
response
entry:task
id		n/a
extension		n/a
modifierExtension		N/A
link
fullUrl
resource
search
request
response
entry:list
id		n/a
extension		n/a
modifierExtension		N/A
link
fullUrl
resource
search
request
response
entry:patient
id		n/a
extension		n/a
modifierExtension		N/A
link
fullUrl
resource		Patient[classCode=PAT]	ClinicalDocument.recordTarget.patientRole	administrative.individual
search
request
response
entry:practice
id		n/a
extension		n/a
modifierExtension		N/A
link
fullUrl
resource	(also see master files messages)	Organization(classCode=ORG determinerCode=INST)		administrative.group
id
meta
implicitRules
language
text		Act.text?
contained		N/A
extension		N/A
modifierExtension		N/A
identifier	XON.10 / XON.3	.scopes[Role](classCode=IDENT)		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
value	CX.1 / EI.1	II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
period	CX.7 + CX.8	Role.effectiveTime or implied by context
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
active	No equivalent in HL7 v2	.status		FiveWs.status
type	No equivalent in v2	.code		FiveWs.class
name	XON.1	.name
alias		.name
Slices for telecom	ORC-22?	.telecom
telecom:All Slices
id		n/a
extension		n/a
system	XTN.3	./scheme
value	XTN.1 (or XTN.12)	./url
use	XTN.2 - but often indicated by field	unique(./use)
rank	n/a	n/a
period	N/A	./usablePeriod[type="IVL<TS>"]
telecom:Phone	ORC-22?	.telecom
id		n/a
extension		n/a
system	XTN.3	./scheme
value	XTN.1 (or XTN.12)	./url
use	XTN.2 - but often indicated by field	unique(./use)
rank	n/a	n/a
period	N/A	./usablePeriod[type="IVL<TS>"]
telecom:Fax	ORC-22?	.telecom
id		n/a
extension		n/a
system	XTN.3	./scheme
value	XTN.1 (or XTN.12)	./url
use	XTN.2 - but often indicated by field	unique(./use)
rank	n/a	n/a
period	N/A	./usablePeriod[type="IVL<TS>"]
address	ORC-23?	.address
id		n/a
extension		n/a
use	XAD.7	unique(./use)
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]
city	XAD.3	AD.part[parttype = CTY]
district	XAD.9	AD.part[parttype = CNT | CPA]
state	XAD.4	AD.part[parttype = STA]
postalCode	XAD.5	AD.part[parttype = ZIP]
country	XAD.6	AD.part[parttype = CNT]
period	XAD.12 / XAD.13 + XAD.14	./usablePeriod[type="IVL<TS>"]
partOf	No equivalent in HL7 v2	.playedBy[classCode=Part].scoper
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)
text	implied by XPN.11	./formatted
family	XPN.1/FN.1	./part[partType = FAM]
given	XPN.2 + XPN.3	./part[partType = GIV]
prefix	XPN.5	./part[partType = PFX]
suffix	XPN/4	./part[partType = SFX]
period	XPN.13 + XPN.14	./usablePeriod[type="IVL<TS>"]
Slices for telecom	PID-13 PID-14	./telecom
telecom:All Slices
id		n/a
extension		n/a
system	XTN.3	./scheme
value	XTN.1 (or XTN.12)	./url
use	XTN.2 - but often indicated by field	unique(./use)
rank	n/a	n/a
period	N/A	./usablePeriod[type="IVL<TS>"]
telecom:Phone	PID-13 PID-14	./telecom
id		n/a
extension		n/a
system	XTN.3	./scheme
value	XTN.1 (or XTN.12)	./url
use	XTN.2 - but often indicated by field	unique(./use)
rank	n/a	n/a
period	N/A	./usablePeriod[type="IVL<TS>"]
telecom:Fax	PID-13 PID-14	./telecom
id		n/a
extension		n/a
system	XTN.3	./scheme
value	XTN.1 (or XTN.12)	./url
use	XTN.2 - but often indicated by field	unique(./use)
rank	n/a	n/a
period	N/A	./usablePeriod[type="IVL<TS>"]
telecom:Email	PID-13 PID-14	./telecom
id		n/a
extension		n/a
system	XTN.3	./scheme
value	XTN.1 (or XTN.12)	./url
use	XTN.2 - but often indicated by field	unique(./use)
rank	n/a	n/a
period	N/A	./usablePeriod[type="IVL<TS>"]
address	PID-11	./addr
endpoint		n/a
search
request
response
entry:practitioner
id		n/a
extension		n/a
modifierExtension		N/A
link
fullUrl
resource	PRD (as one example)	Role		administrative.individual
search
request
response
entry:questionnaireresponse
id		n/a
extension		n/a
modifierExtension		N/A
link
fullUrl
resource
search
request
response
entry:medicalCoverage
id		n/a
extension		n/a
modifierExtension		N/A
link
fullUrl
resource		Coverage		financial.support
id
meta
implicitRules
language
text		Act.text?
contained		N/A
Slices for extension
extension:PlanYear
extension:ReferenceNumber
extension:IssuedDate
modifierExtension		N/A
identifier	IN1-2	.id		FiveWs.identifier
status		Act.status		FiveWs.status
type	IN1-15			FiveWs.class
policyHolder	IN1-16 18 19-name of insured address date of birth			FiveWs.subject
subscriber	IN1-16 18 19-name of insured address date of birth			FiveWs.subject
id		n/a
extension		n/a
reference		N/A
type		N/A
identifier		.identifier
display		N/A
subscriberId	IN1-16 18 19-name of insured address date of birth			FiveWs.subject
beneficiary	IN1-16 18 19-name of insured address date of birth			FiveWs.subject
id		n/a
extension		n/a
reference		N/A
type		N/A
identifier		.identifier
display		N/A
dependent	- No exact HL7 v2 equivalent concept seems to exist;
relationship
period	IN1-12 / IN1-13	Act.effectiveTime		FiveWs.done[x]
payor	IN1-3			FiveWs.author
id		n/a
extension		n/a
reference		N/A
type		N/A
identifier		.identifier
display		N/A
class
id		n/a
extension		n/a
modifierExtension		N/A
type
id		n/a
extension		n/a
coding	C*E.1-8 C*E.10-22	union(. ./translation)
id		n/a
extension		n/a
system	C*E.3	./codeSystem
version	C*E.7	./codeSystemVersion
code	C*E.1	./code
display	C*E.2 - but note this is not well followed	CV.displayName
userSelected	Sometimes implied by being first	CD.codingRationale
text	C*E.9. But note many systems use C*E.2 for this	./originalText[mediaType/code="text/plain"]/data
value	IN1-8
name	IN1-8
order	- No exact HL7 v2 equivalent concept seems to exist;
network
costToBeneficiary
id		n/a
extension		n/a
modifierExtension		N/A
type
value[x]	IN1-8
exception
id		n/a
extension		n/a
modifierExtension		N/A
type
period
subrogation
contract	IN1-16 18 19	n/a
search
request
response
entry:pharmacyCoverage
id		n/a
extension		n/a
modifierExtension		N/A
link
fullUrl
resource		Coverage		financial.support
id
meta
implicitRules
language
text		Act.text?
contained		N/A
Slices for extension
extension:PlanYear
extension:ReferenceNumber
extension:IssuedDate
modifierExtension		N/A
identifier	IN1-2	.id		FiveWs.identifier
status		Act.status		FiveWs.status
type	IN1-15			FiveWs.class
policyHolder	IN1-16 18 19-name of insured address date of birth			FiveWs.subject
subscriber	IN1-16 18 19-name of insured address date of birth			FiveWs.subject
id		n/a
extension		n/a
reference		N/A
type		N/A
identifier		.identifier
display		N/A
subscriberId	IN1-16 18 19-name of insured address date of birth			FiveWs.subject
beneficiary	IN1-16 18 19-name of insured address date of birth			FiveWs.subject
id		n/a
extension		n/a
reference		N/A
type		N/A
identifier		.identifier
display		N/A
dependent	- No exact HL7 v2 equivalent concept seems to exist;
relationship
period	IN1-12 / IN1-13	Act.effectiveTime		FiveWs.done[x]
payor	IN1-3			FiveWs.author
id		n/a
extension		n/a
reference		N/A
type		N/A
identifier		.identifier
display		N/A
class
id		n/a
extension		n/a
modifierExtension		N/A
type
id		n/a
extension		n/a
coding	C*E.1-8 C*E.10-22	union(. ./translation)
id		n/a
extension		n/a
system	C*E.3	./codeSystem
version	C*E.7	./codeSystemVersion
code	C*E.1	./code
display	C*E.2 - but note this is not well followed	CV.displayName
userSelected	Sometimes implied by being first	CD.codingRationale
text	C*E.9. But note many systems use C*E.2 for this	./originalText[mediaType/code="text/plain"]/data
value	IN1-8
name	IN1-8
order	- No exact HL7 v2 equivalent concept seems to exist;
network
costToBeneficiary
id		n/a
extension		n/a
modifierExtension		N/A
type
value[x]	IN1-8
exception
id		n/a
extension		n/a
modifierExtension		N/A
type
period
subrogation
contract	IN1-16 18 19	n/a
search
request
response
entry:payer
id		n/a
extension		n/a
modifierExtension		N/A
link
fullUrl
resource	(also see master files messages)	Organization(classCode=ORG determinerCode=INST)		administrative.group
id
meta
implicitRules
language
text		Act.text?
contained		N/A
extension		N/A
modifierExtension		N/A
identifier	XON.10 / XON.3	.scopes[Role](classCode=IDENT)		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
value	CX.1 / EI.1	II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
period	CX.7 + CX.8	Role.effectiveTime or implied by context
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
active	No equivalent in HL7 v2	.status		FiveWs.status
type	No equivalent in v2	.code		FiveWs.class
name	XON.1	.name
alias		.name
Slices for telecom	ORC-22?	.telecom
telecom:All Slices
id		n/a
extension		n/a
system	XTN.3	./scheme
value	XTN.1 (or XTN.12)	./url
use	XTN.2 - but often indicated by field	unique(./use)
rank	n/a	n/a
period	N/A	./usablePeriod[type="IVL<TS>"]
telecom:Phone	ORC-22?	.telecom
id		n/a
extension		n/a
system	XTN.3	./scheme
value	XTN.1 (or XTN.12)	./url
use	XTN.2 - but often indicated by field	unique(./use)
rank	n/a	n/a
period	N/A	./usablePeriod[type="IVL<TS>"]
telecom:Fax	ORC-22?	.telecom
id		n/a
extension		n/a
system	XTN.3	./scheme
value	XTN.1 (or XTN.12)	./url
use	XTN.2 - but often indicated by field	unique(./use)
rank	n/a	n/a
period	N/A	./usablePeriod[type="IVL<TS>"]
address	ORC-23?	.address
id		n/a
extension		n/a
use	XAD.7	unique(./use)
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]
city	XAD.3	AD.part[parttype = CTY]
district	XAD.9	AD.part[parttype = CNT | CPA]
state	XAD.4	AD.part[parttype = STA]
postalCode	XAD.5	AD.part[parttype = ZIP]
country	XAD.6	AD.part[parttype = CNT]
period	XAD.12 / XAD.13 + XAD.14	./usablePeriod[type="IVL<TS>"]
partOf	No equivalent in HL7 v2	.playedBy[classCode=Part].scoper
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)
text	implied by XPN.11	./formatted
family	XPN.1/FN.1	./part[partType = FAM]
given	XPN.2 + XPN.3	./part[partType = GIV]
prefix	XPN.5	./part[partType = PFX]
suffix	XPN/4	./part[partType = SFX]
period	XPN.13 + XPN.14	./usablePeriod[type="IVL<TS>"]
Slices for telecom	PID-13 PID-14	./telecom
telecom:All Slices
id		n/a
extension		n/a
system	XTN.3	./scheme
value	XTN.1 (or XTN.12)	./url
use	XTN.2 - but often indicated by field	unique(./use)
rank	n/a	n/a
period	N/A	./usablePeriod[type="IVL<TS>"]
telecom:Phone	PID-13 PID-14	./telecom
id		n/a
extension		n/a
system	XTN.3	./scheme
value	XTN.1 (or XTN.12)	./url
use	XTN.2 - but often indicated by field	unique(./use)
rank	n/a	n/a
period	N/A	./usablePeriod[type="IVL<TS>"]
telecom:Fax	PID-13 PID-14	./telecom
id		n/a
extension		n/a
system	XTN.3	./scheme
value	XTN.1 (or XTN.12)	./url
use	XTN.2 - but often indicated by field	unique(./use)
rank	n/a	n/a
period	N/A	./usablePeriod[type="IVL<TS>"]
telecom:Email	PID-13 PID-14	./telecom
id		n/a
extension		n/a
system	XTN.3	./scheme
value	XTN.1 (or XTN.12)	./url
use	XTN.2 - but often indicated by field	unique(./use)
rank	n/a	n/a
period	N/A	./usablePeriod[type="IVL<TS>"]
address	PID-11	./addr
endpoint		n/a
search
request
response
signature
Documentation for this format