Universal API Implementation Guide
1.1.0 - ci-build

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

Example Bundle: External - UAPI Copay Enrollment Bundle

Bundle 52b4e271-b63c-41bf-a6ab-7bca6cbda4b3 of type message


Entry 1 - Full URL = urn:uuid:eb5eb40b-78e8-4a52-903a-0348c1eac387

Resource MessageHeader:

Generated Narrative: MessageHeader

Resource MessageHeader "eb5eb40b-78e8-4a52-903a-0348c1eac387"

Profile: UAPI MessageHeader

Texts

-Div
*<div></div>

UAPI MessageHeader Timestamp: 2020-03-11 08:10:13-0500

event: enrollment-with-consent (Details: http://terminology.gene.com/fhir/usix/uapi/CodeSystem/uapi-event-type code enrollment-with-consent = 'enrollment-with-consent', stated as 'null')

Destinations

-NameEndpoint
*UAPI-ENR-V2.0https://test-us-e1.apis.roche.com/pharma-cmg-ehr-fhir-exp-test/v2/enrollment

sender: See above (urn:uuid:01c31a2f-321d-4c6e-8349-206af8a88088)

Sources

-NameEndpoint
*Vendor_ABhttp://vendor.com/fhir/enrollmentID/ENR-00001

focus: See above (urn:uuid:681d6d3e-7e29-44f5-81c2-b5c00f232b19)


Entry 2 - Full URL = urn:uuid:681d6d3e-7e29-44f5-81c2-b5c00f232b19

Resource List:

messageContext

Mode: Change ListStatus: Current
Items
urn:uuid:fc2e5a72-c363-4616-ae00-4ad25cbcb45c
urn:uuid:01c31a2f-321d-4c6e-8349-206af8a88088
urn:uuid:695d0991-5e03-46df-934a-85a28acd95c1
urn:uuid:df610b38-2561-423c-b17a-36364f5a82c1
urn:uuid:5342779a-184f-42ba-ab44-3a8e023979f7
urn:uuid:bc20c5ea-f639-4221-ab61-ce75c5e64aba
urn:uuid:d3637025-883d-4678-9e0a-1d243a338f9f
urn:uuid:42b41bdb-1781-49aa-a091-78cdd92129df
urn:uuid:5cc5785f-002e-48f3-b9b7-893c3321f4b9
urn:uuid:98f1c980-79a9-4f0b-9c14-59bd55aa2c19
urn:uuid:f71a66c4-f747-4b46-8adc-875a45f8ee7e
urn:uuid:4db51d32-65c3-4f8c-959e-0155c6d14545


Entry 3 - Full URL = urn:uuid:fc2e5a72-c363-4616-ae00-4ad25cbcb45c

Resource Patient:

Ryan Michaelson (OFFICIAL) Male, DoB: 1972-10-29 ( Patient internal identifier: 6bcd8467-0473-4836-9128-2e7972f23177(use: OFFICIAL))


Entry 4 - Full URL = urn:uuid:01c31a2f-321d-4c6e-8349-206af8a88088

Resource Organization:

Generated Narrative: Organization

Resource Organization "01c31a2f-321d-4c6e-8349-206af8a88088"

Profile: UAPI Organization

Texts

-Div
*<div></div>

identifier: id: HOSP-12345(use: USUAL)

type: Healthcare Provider (OrganizationType#prov)

name: Mid Atlantic Retina

contact

telecom: ph: -unknown-

address: 8 Ranoldo Terrace Cherry Hill NJ 08034 US

contact

name: Venus Yardav (OFFICIAL)

telecom: ph: -unknown-

contact

telecom: ph: 8882704882(WORK), fax: 8179974042(WORK)


Entry 5 - Full URL = urn:uuid:695d0991-5e03-46df-934a-85a28acd95c1

Resource Practitioner:

Generated Narrative: Practitioner

Resource Practitioner "695d0991-5e03-46df-934a-85a28acd95c1"

Profile: UAPI Practitioner

Texts

-Div
*<div></div>

identifier: Provider identifier: 1922071448(use: OFFICIAL), Tax ID number: 00000000(use: OFFICIAL), National provider identifier: 1639285034(use: OFFICIAL)

name: MARISSA CRUZ (OFFICIAL)


Entry 6 - Full URL = urn:uuid:42b41bdb-1781-49aa-a091-78cdd92129df

Resource Coverage:

Generated Narrative: Coverage

Resource Coverage "42b41bdb-1781-49aa-a091-78cdd92129df"

Profile: UAPI Coverage

Texts

-Div
*<div></div>

status: ACTIVE

type: health insurance plan policy (ActCode#HIP)

subscriber: See above (urn:uuid:4db51d32-65c3-4f8c-959e-0155c6d14545)

subscriberId: id: 4353

beneficiary: See above (urn:uuid:fc2e5a72-c363-4616-ae00-4ad25cbcb45c)

Classes

-TypeValueName
*Group (Coverage Class Codes#group)id: 12344frgrGroup Number

order: 1

network: Dakotacare


Entry 7 - Full URL = urn:uuid:4db51d32-65c3-4f8c-959e-0155c6d14545

Resource RelatedPerson:

Generated Narrative: RelatedPerson

Resource RelatedPerson "4db51d32-65c3-4f8c-959e-0155c6d14545"

Profile: UAPI RelatedPerson

Texts

-Div
*<div></div>

patient: See above (urn:uuid:fc2e5a72-c363-4616-ae00-4ad25cbcb45c)

relationship: significant other (RoleCode#SIGOTHR)

name: Bob Paul Smith (OFFICIAL)

telecom: +33 (237) 998327

birthDate: 1972-10-29


Entry 8 - Full URL = urn:uuid:5342779a-184f-42ba-ab44-3a8e023979f7

Resource QuestionnaireResponse:

LinkIdTextDefinitionAnswerdoco
.. 5342779a-184f-42ba-ab44-3a8e023979f7QuestionnaireResponse
... do-not-contact-patientDo not contact patient
... has-patient-started-therapyHas Patient Started Therapy
... ok-to-send-text-messageOk to send text messag
... ok-to-leave-detailed-messageOk to leave detailed message
... pa-in-placeIs prior authorization in place?
... re-verify-benefits-at-pa-expirationRe-verify benefits at PA expiration
... specialty-pharmacySpecialty Pharmacy?
... onsite-pharmacyOnsite Pharmacy?
... authorizationAuthorization #

doco Documentation for this format


Entry 9 - Full URL = urn:uuid:bc20c5ea-f639-4221-ab61-ce75c5e64aba

Resource Condition:

Generated Narrative: Condition

Resource Condition "bc20c5ea-f639-4221-ab61-ce75c5e64aba"

Texts

-Div
*<div></div>

code: Type 1 diab with mild nonp rtnop with macular edema, r eye (International Classification of Diseases, 10th Revision, Clinical Modification (ICD-10-CM)#E10.3211)

subject: See above (urn:uuid:fc2e5a72-c363-4616-ae00-4ad25cbcb45c)


Entry 10 - Full URL = urn:uuid:5cc5785f-002e-48f3-b9b7-893c3321f4b9

Resource Consent:

Generated Narrative: Consent

Resource Consent "5cc5785f-002e-48f3-b9b7-893c3321f4b9"

Profile: UAPI Consent

Texts

-Div
*<div></div>

status: ACTIVE

category: Patient Authorization Signature (LOINC#59284-0)

dateTime: 2021-05-01


Entry 11 - Full URL = urn:uuid:d3637025-883d-4678-9e0a-1d243a338f9f

Resource Organization:

Generated Narrative: Organization

Resource Organization "d3637025-883d-4678-9e0a-1d243a338f9f"

Profile: UAPI Organization

Texts

-Div
*<div></div>

identifier: id: PAY-111(use: USUAL)

type: Insurance Company (OrganizationType#ins)

name: Dakotacare

Contacts

-Telecom
*ph: 8778472862(WORK)


Entry 12 - Full URL = urn:uuid:f71a66c4-f747-4b46-8adc-875a45f8ee7e

Resource ServiceRequest:

Generated Narrative: ServiceRequest

Resource ServiceRequest "f71a66c4-f747-4b46-8adc-875a45f8ee7e"

Profile: UAPI ServiceRequest

Texts

-Div
*<div></div>

status: ACTIVE

intent: ORDER

code: Copay (UAPI Code System - Service Request Type#copay)

subject: See above (urn:uuid:fc2e5a72-c363-4616-ae00-4ad25cbcb45c)


Entry 13 - Full URL = urn:uuid:df610b38-2561-423c-b17a-36364f5a82c1

Resource MedicationRequest:

Generated Narrative: MedicationRequest

Resource MedicationRequest "df610b38-2561-423c-b17a-36364f5a82c1"

Profile: UAPI MedicationRequest

Texts

-Div
*<div></div>

status: ACTIVE

intent: ORDER

subject: See above (urn:uuid:fc2e5a72-c363-4616-ae00-4ad25cbcb45c)

requester: See above (urn:uuid:695d0991-5e03-46df-934a-85a28acd95c1)

insurance: See above (urn:uuid:42b41bdb-1781-49aa-a091-78cdd92129df)

note: 600 mg twice a day

dispenseRequest

numberOfRepeatsAllowed: 3

ExpectedSupplyDurations

-ValueUnitSystemCode
*1moUnified Code for Units of Measure (UCUM)mo


Entry 14 - Full URL = urn:uuid:98f1c980-79a9-4f0b-9c14-59bd55aa2c19

Resource Account:

Generated Narrative: Account

Resource Account "98f1c980-79a9-4f0b-9c14-59bd55aa2c19"

Profile: UAPI Account

Texts

-Div
*<div></div>

UAPI Account Enrolled By Id: 2

identifier: brandId: bbbbbbbb(use: OFFICIAL), programId: ppppppp(use: SECONDARY)

status: UNKNOWN

name: COPAY Application

subject: See above (urn:uuid:fc2e5a72-c363-4616-ae00-4ad25cbcb45c)

servicePeriod: 2021-01-01 --> 2022-01-01

Coverages

-Coverage
*See above (urn:uuid:42b41bdb-1781-49aa-a091-78cdd92129df)