Universal API Implementation Guide
1.1.19 - ci-build

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

Example Bundle: External - UAPI AS Enrollment for Evrysdi(Digital Consent)

Bundle e905f503-090c-45ab-b197-5b1d10998a43 of type message

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

Resource MessageHeader:

Generated Narrative: MessageHeader

Resource MessageHeader "fe0cc042-1a9a-4bfc-9989-aba61523366f"

Profile: UAPI MessageHeader

Texts

-Div
*<div></div>

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.1https://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:b9604e41-5785-4a40-a4ac-a6112f22ef70)

Entry 2 - Full URL = urn:uuid:b9604e41-5785-4a40-a4ac-a6112f22ef70

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:5342779a-184f-42ba-ab44-3a8e02397he1
urn:uuid:42b41bdb-1781-49aa-a091-78cdd92129df
urn:uuid:1b53bfb2-1361-4906-acd8-35294d30273b
urn:uuid:45cf0b29-8c1d-4882-91e1-00bc28c06a52
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: USUAL))

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: mar@example.com

address: 8 Ranoldo Terrace Cherry Hill NJ 08034 US

contact

name: Venus Yardav (OFFICIAL)

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:9a41bc06-e936-4b2a-98e2-ecc349581c6e

Resource QuestionnaireResponse:

LinkIdTextDefinitionAnswerdoco
.. beac07da-6fa4-4362-9f39-c9a8a6c6cc50QuestionnaireResponse
... adotAnticipated Date of Treatment (Optional)
... household-sizeHousehold size
... contact-patientDo not contact patient
... has-treatment-startedHas treatment started?
... household-incomeAnnual household income
... posPlace of Service
... prescription-planIs this a Prescription plan?
... site-of-treatmentSite of Treatment
... susvimo-type-of-procedureType of Procedure
... tcpa-consentTCPA Consent Provided?
... text-messageOk to send a text message?

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:1b53bfb2-1361-4906-acd8-35294d30273b

Resource Consent:

Generated Narrative: Consent

Resource Consent "1b53bfb2-1361-4906-acd8-35294d30273b"

Profile: UAPI Consent

Texts

-Div
*<div></div>

status: ACTIVE

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

dateTime: 2016-06-16 04:24:45+0000

Provisions

-Type
*PERMIT

Entry 11 - Full URL = urn:uuid:212c57ad-45cd-4882-87e7-8415ded3db05

Resource ServiceRequest:

Generated Narrative: ServiceRequest

Resource ServiceRequest "212c57ad-45cd-4882-87e7-8415ded3db05"

Profile: UAPI ServiceRequest

Texts

-Div
*<div></div>

status: ACTIVE

intent: ORDER

code: Benefit Investigation / Prior Authorization (UAPI Code System - Service Request Type#bipa)

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

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:99f34ad6-54cd-4422-8cee-b3e6b579a380

Resource MedicationRequest:

Generated Narrative: MedicationRequest

Resource MedicationRequest "99f34ad6-54cd-4422-8cee-b3e6b579a380"

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)

courseOfTherapyType: 0.75mg/mL 80mL (in 100mL bottle) ()

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

note: 5 mg (6.6 mL) once daily

dispenseRequest

UAPI MedicationRequest Dispenser Instructions: Dispense Instruction: 5mg and 6.6mL daily

UAPI MedicationRequest Dispense Quantity Detailed Breakdown

value: 5

value: mg

UAPI MedicationRequest Dispense Quantity Detailed Breakdown

value: 6.6

value: mL

numberOfRepeatsAllowed: 12

ExpectedSupplyDurations

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

Entry 14 - 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 15 - Full URL = urn:uuid:e29f6c9e-4b3f-485f-af90-adcd49260ac0

Resource QuestionnaireResponse:

LinkIdTextDefinitionAnswerdoco
.. e29f6c9e-4b3f-485f-af90-adcd49260ac0QuestionnaireResponse
... applied-for-bipaBIPA Service Request Applied?
... applied-for-copayCopay Service Request Applied?
... do-not-contact-patientDo not contact patient
... household-incomeAnnual household income
... ok-to-send-text-messageOk to send text messag
... anticipated-date-of-treatmentAnticipated Date of Treatment
... ok-to-leave-detailed-messageOk to leave detailed message
... type-of-procedureType of Procedure
... place-of-servicePlace of Service
... site-of-treatmentSite of treatment
... treatment-startedHas treatment started?

doco Documentation for this format

Entry 16 - Full URL = urn:uuid:334d57a4-c441-4603-b0e5-de3e2d89ba94

Resource QuestionnaireResponse:

LinkIdTextDefinitionAnswerdoco
.. 334d57a4-c441-4603-b0e5-de3e2d89ba94QuestionnaireResponse
... authorizationAuthorization #
... dotDate of Treatment
... household-sizeHousehold size
... opn-optionalOnsite Pharmacy Name (Optional)
... pharmacy-contact-person-optionalPharmacy Contact Person (Optional)
... pharmacy-phone-optionalPharmacy Phone (Optional)
... preferred-sp-optionalPreferred Specialty Pharmacy (Optional)
... venclexta-vencompass-dateWhat is the date of Vencompass information filling
... contact-patientDo not contact patient
... detailed-messageOk to leave a detailed message?
... has-treatment-startedHas treatment started?
... household-incomeAnnual household income
... line-of-therapyLine of therapy?
... onsite-pharmacyOnsite Pharmacy?
... pa-in-placeIs prior authorization in place?
... prescription-planIs this a Prescription plan?
... re-verify-benefits-at-pa-expirationRe-verify benefits at PA expiration
... site-of-treatmentSite of Treatment
... specialty-pharmacySpecialty Pharmacy?
... tcpa-consentTCPA Consent Provided?
... text-messageOk to send a text message?
... venclexta-receive-newsDo you want to receive news and updates about AbbVie's products, clinical trials, research opportunities and other information that may be of interest to you?
... venclexta-time-to-callWhat is the best time to call?
... venclexta-vencompassWant to proceed with Vencompass?
... venclexta-which-conditionFor which condition are you being treated?

doco Documentation for this format