Universal API Implementation Guide - Local Development build (v1.1.19). See the Directory of published versions

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

Resource Profile: UapiBundleCopayReqResp - Mappings

Draft as of 2023-03-03

Mappings for the uapi-copay-request-response-bundle resource profile.

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

UapiBundleCopayReqResp
Bundle	N/A
identifier
use	N/A
type	CX.5
coding	C*E.1-8, C*E.10-22
system	C*E.3
version	C*E.7
code	C*E.1
display	C*E.2 - but note this is not well followed
userSelected	Sometimes implied by being first
text	C*E.9. But note many systems use C*E.2 for this
system	CX.4 / EI-2-4
value	CX.1 / EI.1
period	CX.7 + CX.8
assigner	CX.4 / (CX.4,CX.9,CX.10)
entry
resource
entry (messageheader)
resource	MSH / MSA / ERR
entry (list)
resource
entry (task)
resource
entry (patient)
resource
entry (practice)
resource	(also see master files messages)
identifier	XON.10 / XON.3
use	N/A
type	CX.5
system	CX.4 / EI-2-4
value	CX.1 / EI.1
period	CX.7 + CX.8
assigner	CX.4 / (CX.4,CX.9,CX.10)
active	No equivalent in HL7 v2
type	No equivalent in v2
name	XON.1
telecom	ORC-22?
system	XTN.3
value	XTN.1 (or XTN.12)
use	XTN.2 - but often indicated by field
rank	n/a
period	N/A
telecom (Phone)	ORC-22?
system	XTN.3
value	XTN.1 (or XTN.12)
use	XTN.2 - but often indicated by field
rank	n/a
period	N/A
telecom (Fax)	ORC-22?
system	XTN.3
value	XTN.1 (or XTN.12)
use	XTN.2 - but often indicated by field
rank	n/a
period	N/A
address	ORC-23?
use	XAD.7
type	XAD.18
text	XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6
line	XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address)
city	XAD.3
district	XAD.9
state	XAD.4
postalCode	XAD.5
country	XAD.6
period	XAD.12 / XAD.13 + XAD.14
partOf	No equivalent in HL7 v2
contact
name	PID-5, PID-9
use	XPN.7, but often indicated by which field contains the name
text	implied by XPN.11
family	XPN.1/FN.1
given	XPN.2 + XPN.3
prefix	XPN.5
suffix	XPN/4
period	XPN.13 + XPN.14
telecom	PID-13, PID-14
system	XTN.3
value	XTN.1 (or XTN.12)
use	XTN.2 - but often indicated by field
rank	n/a
period	N/A
telecom (Phone)	PID-13, PID-14
system	XTN.3
value	XTN.1 (or XTN.12)
use	XTN.2 - but often indicated by field
rank	n/a
period	N/A
telecom (Fax)	PID-13, PID-14
system	XTN.3
value	XTN.1 (or XTN.12)
use	XTN.2 - but often indicated by field
rank	n/a
period	N/A
telecom (Email)	PID-13, PID-14
system	XTN.3
value	XTN.1 (or XTN.12)
use	XTN.2 - but often indicated by field
rank	n/a
period	N/A
address	PID-11
entry (practitioner)
resource	PRD (as one example)
entry (relatedperson)
resource
entry (req-questionnaireresponse)
resource
entry (req-medicalCoverage)
resource
identifier	IN1-2
type	IN1-15
policyHolder	IN1-16, 18, 19-name of insured, address, date of birth
subscriber	IN1-16, 18, 19-name of insured, address, date of birth
subscriberId	IN1-16, 18, 19-name of insured, address, date of birth
beneficiary	IN1-16, 18, 19-name of insured, address, date of birth
dependent	- No exact HL7 v2 equivalent concept seems to exist;
period	IN1-12 / IN1-13
payor	IN1-3
class
type
coding	C*E.1-8, C*E.10-22
system	C*E.3
version	C*E.7
code	C*E.1
display	C*E.2 - but note this is not well followed
userSelected	Sometimes implied by being first
text	C*E.9. But note many systems use C*E.2 for this
value	IN1-8
name	IN1-8
order	- No exact HL7 v2 equivalent concept seems to exist;
costToBeneficiary
value[x]	IN1-8
contract	IN1-16, 18, 19
entry (req-pharmacyCoverage)
resource
identifier	IN1-2
type	IN1-15
policyHolder	IN1-16, 18, 19-name of insured, address, date of birth
subscriber	IN1-16, 18, 19-name of insured, address, date of birth
subscriberId	IN1-16, 18, 19-name of insured, address, date of birth
beneficiary	IN1-16, 18, 19-name of insured, address, date of birth
dependent	- No exact HL7 v2 equivalent concept seems to exist;
period	IN1-12 / IN1-13
payor	IN1-3
class
type
coding	C*E.1-8, C*E.10-22
system	C*E.3
version	C*E.7
code	C*E.1
display	C*E.2 - but note this is not well followed
userSelected	Sometimes implied by being first
text	C*E.9. But note many systems use C*E.2 for this
value	IN1-8
name	IN1-8
order	- No exact HL7 v2 equivalent concept seems to exist;
costToBeneficiary
value[x]	IN1-8
contract	IN1-16, 18, 19
entry (req-payer)
resource	(also see master files messages)
identifier	XON.10 / XON.3
use	N/A
type	CX.5
system	CX.4 / EI-2-4
value	CX.1 / EI.1
period	CX.7 + CX.8
assigner	CX.4 / (CX.4,CX.9,CX.10)
active	No equivalent in HL7 v2
type	No equivalent in v2
name	XON.1
telecom	ORC-22?
system	XTN.3
value	XTN.1 (or XTN.12)
use	XTN.2 - but often indicated by field
rank	n/a
period	N/A
telecom (Phone)	ORC-22?
system	XTN.3
value	XTN.1 (or XTN.12)
use	XTN.2 - but often indicated by field
rank	n/a
period	N/A
telecom (Fax)	ORC-22?
system	XTN.3
value	XTN.1 (or XTN.12)
use	XTN.2 - but often indicated by field
rank	n/a
period	N/A
address	ORC-23?
use	XAD.7
type	XAD.18
text	XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6
line	XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address)
city	XAD.3
district	XAD.9
state	XAD.4
postalCode	XAD.5
country	XAD.6
period	XAD.12 / XAD.13 + XAD.14
partOf	No equivalent in HL7 v2
contact
name	PID-5, PID-9
use	XPN.7, but often indicated by which field contains the name
text	implied by XPN.11
family	XPN.1/FN.1
given	XPN.2 + XPN.3
prefix	XPN.5
suffix	XPN/4
period	XPN.13 + XPN.14
telecom	PID-13, PID-14
system	XTN.3
value	XTN.1 (or XTN.12)
use	XTN.2 - but often indicated by field
rank	n/a
period	N/A
telecom (Phone)	PID-13, PID-14
system	XTN.3
value	XTN.1 (or XTN.12)
use	XTN.2 - but often indicated by field
rank	n/a
period	N/A
telecom (Fax)	PID-13, PID-14
system	XTN.3
value	XTN.1 (or XTN.12)
use	XTN.2 - but often indicated by field
rank	n/a
period	N/A
telecom (Email)	PID-13, PID-14
system	XTN.3
value	XTN.1 (or XTN.12)
use	XTN.2 - but often indicated by field
rank	n/a
period	N/A
address	PID-11
entry (resp-explanationOfBenefits)
resource
entry (resp-copayCoverage)
resource
identifier	IN1-2
type	IN1-15
policyHolder	IN1-16, 18, 19-name of insured, address, date of birth
subscriber	IN1-16, 18, 19-name of insured, address, date of birth
subscriberId	IN1-16, 18, 19-name of insured, address, date of birth
beneficiary	IN1-16, 18, 19-name of insured, address, date of birth
dependent	- No exact HL7 v2 equivalent concept seems to exist;
period	IN1-12 / IN1-13
payor	IN1-3
class
type
coding	C*E.1-8, C*E.10-22
system	C*E.3
version	C*E.7
code	C*E.1
display	C*E.2 - but note this is not well followed
userSelected	Sometimes implied by being first
text	C*E.9. But note many systems use C*E.2 for this
value	IN1-8
name	IN1-8
order	- No exact HL7 v2 equivalent concept seems to exist;
costToBeneficiary
value[x]	IN1-8
contract	IN1-16, 18, 19

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

UapiBundleCopayReqResp
Bundle	Entity. Role, or Act, N/A
identifier
id	n/a
extension	n/a
use	Role.code or implied by context
type	Role.code or implied by context
id	n/a
extension	n/a
coding	union(., ./translation)
id	n/a
extension	n/a
system	./codeSystem
version	./codeSystemVersion
code	./code
display	CV.displayName
userSelected	CD.codingRationale
text	./originalText[mediaType/code="text/plain"]/data
system	II.root or Role.id.root
value	II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
period	Role.effectiveTime or implied by context
assigner	II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
link
id	n/a
extension	n/a
modifierExtension	N/A
entry
id	n/a
extension	n/a
modifierExtension	N/A
resource
entry (messageheader)
id	n/a
extension	n/a
modifierExtension	N/A
resource	Entity. Role, or Act, Message
search
id	n/a
extension	n/a
modifierExtension	N/A
request
id	n/a
extension	n/a
modifierExtension	N/A
response
id	n/a
extension	n/a
modifierExtension	N/A
entry (list)
id	n/a
extension	n/a
modifierExtension	N/A
resource
search
id	n/a
extension	n/a
modifierExtension	N/A
request
id	n/a
extension	n/a
modifierExtension	N/A
response
id	n/a
extension	n/a
modifierExtension	N/A
entry (task)
id	n/a
extension	n/a
modifierExtension	N/A
resource
search
id	n/a
extension	n/a
modifierExtension	N/A
request
id	n/a
extension	n/a
modifierExtension	N/A
response
id	n/a
extension	n/a
modifierExtension	N/A
entry (patient)
id	n/a
extension	n/a
modifierExtension	N/A
resource	Entity. Role, or Act, Patient[classCode=PAT]
search
id	n/a
extension	n/a
modifierExtension	N/A
request
id	n/a
extension	n/a
modifierExtension	N/A
response
id	n/a
extension	n/a
modifierExtension	N/A
entry (practice)
id	n/a
extension	n/a
modifierExtension	N/A
resource	Entity. Role, or Act, Organization(classCode=ORG, determinerCode=INST)
text	Act.text?
contained	N/A
extension	N/A
modifierExtension	N/A
identifier	.scopes[Role](classCode=IDENT)
id	n/a
extension	n/a
use	Role.code or implied by context
type	Role.code or implied by context
system	II.root or Role.id.root
value	II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
period	Role.effectiveTime or implied by context
assigner	II.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
id	n/a
extension	n/a
system	./scheme
value	./url
use	unique(./use)
rank	n/a
period	./usablePeriod[type="IVL<TS>"]
telecom (Phone)	.telecom
id	n/a
extension	n/a
system	./scheme
value	./url
use	unique(./use)
rank	n/a
period	./usablePeriod[type="IVL<TS>"]
telecom (Fax)	.telecom
id	n/a
extension	n/a
system	./scheme
value	./url
use	unique(./use)
rank	n/a
period	./usablePeriod[type="IVL<TS>"]
address	.address
id	n/a
extension	n/a
use	unique(./use)
type	unique(./use)
text	./formatted
line	AD.part[parttype = AL]
city	AD.part[parttype = CTY]
district	AD.part[parttype = CNT | CPA]
state	AD.part[parttype = STA]
postalCode	AD.part[parttype = ZIP]
country	AD.part[parttype = CNT]
period	./usablePeriod[type="IVL<TS>"]
partOf	.playedBy[classCode=Part].scoper
contact	.contactParty
id	n/a
extension	n/a
modifierExtension	N/A
purpose	./type
name	./name
id	n/a
extension	n/a
use	unique(./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
id	n/a
extension	n/a
system	./scheme
value	./url
use	unique(./use)
rank	n/a
period	./usablePeriod[type="IVL<TS>"]
telecom (Phone)	./telecom
id	n/a
extension	n/a
system	./scheme
value	./url
use	unique(./use)
rank	n/a
period	./usablePeriod[type="IVL<TS>"]
telecom (Fax)	./telecom
id	n/a
extension	n/a
system	./scheme
value	./url
use	unique(./use)
rank	n/a
period	./usablePeriod[type="IVL<TS>"]
telecom (Email)	./telecom
id	n/a
extension	n/a
system	./scheme
value	./url
use	unique(./use)
rank	n/a
period	./usablePeriod[type="IVL<TS>"]
address	./addr
endpoint	n/a
search
id	n/a
extension	n/a
modifierExtension	N/A
request
id	n/a
extension	n/a
modifierExtension	N/A
response
id	n/a
extension	n/a
modifierExtension	N/A
entry (practitioner)
id	n/a
extension	n/a
modifierExtension	N/A
resource	Entity. Role, or Act, Role
search
id	n/a
extension	n/a
modifierExtension	N/A
request
id	n/a
extension	n/a
modifierExtension	N/A
response
id	n/a
extension	n/a
modifierExtension	N/A
entry (relatedperson)
id	n/a
extension	n/a
modifierExtension	N/A
resource	Entity. Role, or Act, role
search
id	n/a
extension	n/a
modifierExtension	N/A
request
id	n/a
extension	n/a
modifierExtension	N/A
response
id	n/a
extension	n/a
modifierExtension	N/A
entry (req-questionnaireresponse)
id	n/a
extension	n/a
modifierExtension	N/A
resource
search
id	n/a
extension	n/a
modifierExtension	N/A
request
id	n/a
extension	n/a
modifierExtension	N/A
response
id	n/a
extension	n/a
modifierExtension	N/A
entry (req-medicalCoverage)
id	n/a
extension	n/a
modifierExtension	N/A
resource	Entity. Role, or Act, Coverage
text	Act.text?
contained	N/A
modifierExtension	N/A
identifier	.id
status	Act.status
subscriber
id	n/a
extension	n/a
reference	N/A
type	N/A
identifier	.identifier
display	N/A
beneficiary
id	n/a
extension	n/a
reference	N/A
type	N/A
identifier	.identifier
display	N/A
period	Act.effectiveTime
payor
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	union(., ./translation)
id	n/a
extension	n/a
system	./codeSystem
version	./codeSystemVersion
code	./code
display	CV.displayName
userSelected	CD.codingRationale
text	./originalText[mediaType/code="text/plain"]/data
costToBeneficiary
id	n/a
extension	n/a
modifierExtension	N/A
exception
id	n/a
extension	n/a
modifierExtension	N/A
contract	n/a
search
id	n/a
extension	n/a
modifierExtension	N/A
request
id	n/a
extension	n/a
modifierExtension	N/A
response
id	n/a
extension	n/a
modifierExtension	N/A
entry (req-pharmacyCoverage)
id	n/a
extension	n/a
modifierExtension	N/A
resource	Entity. Role, or Act, Coverage
text	Act.text?
contained	N/A
modifierExtension	N/A
identifier	.id
status	Act.status
subscriber
id	n/a
extension	n/a
reference	N/A
type	N/A
identifier	.identifier
display	N/A
beneficiary
id	n/a
extension	n/a
reference	N/A
type	N/A
identifier	.identifier
display	N/A
period	Act.effectiveTime
payor
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	union(., ./translation)
id	n/a
extension	n/a
system	./codeSystem
version	./codeSystemVersion
code	./code
display	CV.displayName
userSelected	CD.codingRationale
text	./originalText[mediaType/code="text/plain"]/data
costToBeneficiary
id	n/a
extension	n/a
modifierExtension	N/A
exception
id	n/a
extension	n/a
modifierExtension	N/A
contract	n/a
search
id	n/a
extension	n/a
modifierExtension	N/A
request
id	n/a
extension	n/a
modifierExtension	N/A
response
id	n/a
extension	n/a
modifierExtension	N/A
entry (req-payer)
id	n/a
extension	n/a
modifierExtension	N/A
resource	Entity. Role, or Act, Organization(classCode=ORG, determinerCode=INST)
text	Act.text?
contained	N/A
extension	N/A
modifierExtension	N/A
identifier	.scopes[Role](classCode=IDENT)
id	n/a
extension	n/a
use	Role.code or implied by context
type	Role.code or implied by context
system	II.root or Role.id.root
value	II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
period	Role.effectiveTime or implied by context
assigner	II.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
id	n/a
extension	n/a
system	./scheme
value	./url
use	unique(./use)
rank	n/a
period	./usablePeriod[type="IVL<TS>"]
telecom (Phone)	.telecom
id	n/a
extension	n/a
system	./scheme
value	./url
use	unique(./use)
rank	n/a
period	./usablePeriod[type="IVL<TS>"]
telecom (Fax)	.telecom
id	n/a
extension	n/a
system	./scheme
value	./url
use	unique(./use)
rank	n/a
period	./usablePeriod[type="IVL<TS>"]
address	.address
id	n/a
extension	n/a
use	unique(./use)
type	unique(./use)
text	./formatted
line	AD.part[parttype = AL]
city	AD.part[parttype = CTY]
district	AD.part[parttype = CNT | CPA]
state	AD.part[parttype = STA]
postalCode	AD.part[parttype = ZIP]
country	AD.part[parttype = CNT]
period	./usablePeriod[type="IVL<TS>"]
partOf	.playedBy[classCode=Part].scoper
contact	.contactParty
id	n/a
extension	n/a
modifierExtension	N/A
purpose	./type
name	./name
id	n/a
extension	n/a
use	unique(./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
id	n/a
extension	n/a
system	./scheme
value	./url
use	unique(./use)
rank	n/a
period	./usablePeriod[type="IVL<TS>"]
telecom (Phone)	./telecom
id	n/a
extension	n/a
system	./scheme
value	./url
use	unique(./use)
rank	n/a
period	./usablePeriod[type="IVL<TS>"]
telecom (Fax)	./telecom
id	n/a
extension	n/a
system	./scheme
value	./url
use	unique(./use)
rank	n/a
period	./usablePeriod[type="IVL<TS>"]
telecom (Email)	./telecom
id	n/a
extension	n/a
system	./scheme
value	./url
use	unique(./use)
rank	n/a
period	./usablePeriod[type="IVL<TS>"]
address	./addr
endpoint	n/a
search
id	n/a
extension	n/a
modifierExtension	N/A
request
id	n/a
extension	n/a
modifierExtension	N/A
response
id	n/a
extension	n/a
modifierExtension	N/A
entry (resp-explanationOfBenefits)
id	n/a
extension	n/a
modifierExtension	N/A
resource
search
id	n/a
extension	n/a
modifierExtension	N/A
request
id	n/a
extension	n/a
modifierExtension	N/A
response
id	n/a
extension	n/a
modifierExtension	N/A
entry (resp-copayCoverage)
id	n/a
extension	n/a
modifierExtension	N/A
resource	Entity. Role, or Act, Coverage
text	Act.text?
contained	N/A
modifierExtension	N/A
identifier	.id
status	Act.status
subscriber
id	n/a
extension	n/a
reference	N/A
type	N/A
identifier	.identifier
display	N/A
beneficiary
id	n/a
extension	n/a
reference	N/A
type	N/A
identifier	.identifier
display	N/A
period	Act.effectiveTime
payor
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	union(., ./translation)
id	n/a
extension	n/a
system	./codeSystem
version	./codeSystemVersion
code	./code
display	CV.displayName
userSelected	CD.codingRationale
text	./originalText[mediaType/code="text/plain"]/data
costToBeneficiary
id	n/a
extension	n/a
modifierExtension	N/A
exception
id	n/a
extension	n/a
modifierExtension	N/A
contract	n/a
search
id	n/a
extension	n/a
modifierExtension	N/A
request
id	n/a
extension	n/a
modifierExtension	N/A
response
id	n/a
extension	n/a
modifierExtension	N/A

Mappings for CDA (R2) (http://hl7.org/v3/cda)

UapiBundleCopayReqResp
Bundle	ClinicalDocument, if bundle.type = document
identifier	ClinicalDocument.id
timestamp	ClinicalDocument.effectiveTime
entry
entry (messageheader)
entry (list)
entry (task)
entry (patient)
resource	ClinicalDocument.recordTarget.patientRole

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

UapiBundleCopayReqResp
Bundle	infrastructure.structure
identifier	FiveWs.identifier
type	FiveWs.class
timestamp	FiveWs.init
entry
resource
entry (messageheader)
resource	infrastructure.exchange
entry (list)
resource
entry (task)
resource
entry (patient)
resource	administrative.individual
entry (practice)
resource	administrative.group
identifier	FiveWs.identifier
active	FiveWs.status
type	FiveWs.class
entry (practitioner)
resource	administrative.individual
entry (relatedperson)
resource	administrative.individual
entry (req-questionnaireresponse)
resource
entry (req-medicalCoverage)
resource	financial.support
identifier	FiveWs.identifier
status	FiveWs.status
type	FiveWs.class
policyHolder	FiveWs.subject[x], FiveWs.subject
subscriber	FiveWs.subject[x], FiveWs.subject
subscriberId	FiveWs.subject[x], FiveWs.subject
beneficiary	FiveWs.subject[x], FiveWs.subject
period	FiveWs.done[x]
payor	FiveWs.author
entry (req-pharmacyCoverage)
resource	financial.support
identifier	FiveWs.identifier
status	FiveWs.status
type	FiveWs.class
policyHolder	FiveWs.subject[x], FiveWs.subject
subscriber	FiveWs.subject[x], FiveWs.subject
subscriberId	FiveWs.subject[x], FiveWs.subject
beneficiary	FiveWs.subject[x], FiveWs.subject
period	FiveWs.done[x]
payor	FiveWs.author
entry (req-payer)
resource	administrative.group
identifier	FiveWs.identifier
active	FiveWs.status
type	FiveWs.class
entry (resp-explanationOfBenefits)
resource
entry (resp-copayCoverage)
resource	financial.support
identifier	FiveWs.identifier
status	FiveWs.status
type	FiveWs.class
policyHolder	FiveWs.subject[x], FiveWs.subject
subscriber	FiveWs.subject[x], FiveWs.subject
subscriberId	FiveWs.subject[x], FiveWs.subject
beneficiary	FiveWs.subject[x], FiveWs.subject
period	FiveWs.done[x]
payor	FiveWs.author