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

Example Bundle: External - UAPI AS Enrollment: Hemlibra

Bundle e905f503-090c-45ab-b197-1b1d10998h2a of type message


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

Resource MessageHeader:

event: uapi-event-type enrollment-only: enrollment-only

Destinations

-Name
*UAPI-ENR-V2.1

sender: Bundle: identifier = Resource identifier: da5e1572-cc88-4e4d-9899-e3553f680d87; type = message; timestamp = 2020-03-11 08:10:13-0500

Sources

-Name
*Vendor_AB

focus: Bundle: identifier = Resource identifier: 316e9740-2c4d-4c5d-98b0-c68c84706807; type = message; timestamp = 2020-03-11 08:10:13-0500


Entry 2 - fullUrl = urn:uuid:2cefcd97-82de-4242-ab0c-6bc37d7ed931

Resource List:

messageContext

Mode: Change List Status: Current
Items
Bundle: identifier = Resource identifier: da5e1572-cc88-4e4d-9899-e3553f680d87; type = message; timestamp = 2020-03-11 08:10:13-0500
Bundle: identifier = Resource identifier: da5e1572-cc88-4e4d-9899-e3553f680d87; type = message; timestamp = 2020-03-11 08:10:13-0500
Bundle: identifier = Resource identifier: da5e1572-cc88-4e4d-9899-e3553f680d87; type = message; timestamp = 2020-03-11 08:10:13-0500
Bundle: identifier = Resource identifier: 316e9740-2c4d-4c5d-98b0-c68c84706807; type = message; timestamp = 2020-03-11 08:10:13-0500
Bundle: identifier = Resource identifier: 6a7dbbed-6c6f-48b0-b32e-0a5d89dc72b2; type = message; timestamp = 2024-04-02 08:10:13-0500
Bundle: identifier = Resource identifier: da5e1572-cc88-4e4d-9899-e3553f680d87; type = message; timestamp = 2020-03-11 08:10:13-0500
Bundle: identifier = Resource identifier: da5e1572-cc88-4e4d-9899-e3553f680d87; type = message; timestamp = 2020-03-11 08:10:13-0500
Bundle: identifier = Resource identifier: 316e9740-2c4d-4c5d-98b0-c68c84706807; type = message; timestamp = 2020-03-11 08:10:13-0500
Bundle: identifier = Resource identifier: 6a7dbbed-6c6f-48b0-b32e-0a5d89dc72b2; type = message; timestamp = 2024-04-02 08:10:13-0500
Bundle: identifier = Resource identifier: 6a7dbbed-6c6f-48b0-b32e-0a5d89dc72b2; type = message; timestamp = 2024-04-02 08:10:13-0500

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

Resource Patient:

Profile: UAPI Patient

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


Contact Detail
Language:English (preferred)
Links:

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

Resource Organization:

identifier: http://vendor.com/ab/HOSP-12345 (use: usual, )

type: Healthcare Provider

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 - fullUrl = urn:uuid:695d0991-5e03-46df-934a-85a28acd95c1

Resource Practitioner:

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

name: MARISSA CRUZ (Official)


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

Resource Coverage:

Profile: UAPI Coverage

status: Active

type: health insurance plan policy

subscriber: Bundle: identifier = Resource identifier: da5e1572-cc88-4e4d-9899-e3553f680d87; type = message; timestamp = 2020-03-11 08:10:13-0500

subscriberId: 4353

beneficiary: Bundle: identifier = Resource identifier: da5e1572-cc88-4e4d-9899-e3553f680d87; type = message; timestamp = 2020-03-11 08:10:13-0500

Classes

-TypeValueName
*Group12344frgrGroup Number

order: 1

network: Dakotacare


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

Resource RelatedPerson:

patient: Bundle: identifier = Resource identifier: da5e1572-cc88-4e4d-9899-e3553f680d87; type = message; timestamp = 2020-03-11 08:10:13-0500

relationship: significant other

name: Bob Paul Smith (Official)

telecom: ph: 1234567890(Mobile)

birthDate: 1972-10-29


Entry 8 - fullUrl = urn:uuid:5342779a-184f-42ba-ab44-3a8e02397he1

Resource QuestionnaireResponse:

LinkIDTextDefinitionAnswerdoco
.. 5342779a-184f-42ba-ab44-3a8e02397he1Questionnaire:https://dev.gene.com/fhir/uapi/fhirapi/Questionnaire/1234
... detailed-messageOk to leave a detailed message?Yes
... tcpa-consentTCPA Consent Provided?Yes
... hemlibra-weight-kgWeight (kg)80
... hemlibra-12-months-or-more-since-hemlibra-injectionHas it been 12 months or more since the patient's last HEMLIBRA injection?Yes
... hemlibra-started-prescribed-hemlibra-emicizumabHas the patient started prescribed HEMLIBRA® (emicizumab)?Yes
... hemlibra-hemophilia-aDoes your patient have Hemophilia AWith Inhibitors
... contact-patientDo not contact patientYes
... prescription-planIs this a Prescription plan?No
... enroll-in-brEnroll Patient in Benefits ReverificationYes
... preferred-sp-optionalPreferred Specialty Pharmacy (Optional)Optional Specialty Pharmacy
... opn-optionalOnsite Pharmacy Name (Optional)Onsite Pharmacy Name

doco Documentation for this format

Entry 9 - fullUrl = urn:uuid:80addde0-ebdf-48fa-abf9-a72961769b6e

Resource MedicationRequest:

status: Active

intent: Order

subject: Bundle: identifier = Resource identifier: da5e1572-cc88-4e4d-9899-e3553f680d87; type = message; timestamp = 2020-03-11 08:10:13-0500

requester: Bundle: identifier = Resource identifier: da5e1572-cc88-4e4d-9899-e3553f680d87; type = message; timestamp = 2020-03-11 08:10:13-0500

courseOfTherapyType: Subsequent Dose

insurance: Bundle: identifier = Resource identifier: 6a7dbbed-6c6f-48b0-b32e-0a5d89dc72b2; type = message; timestamp = 2024-04-02 08:10:13-0500

note:

6-mg/kg

dosageInstruction

text: String (up to 50 characters)

DoseAndRates

-Dose[x]
*6 mg/kg

dispenseRequest

UAPI MedicationRequest Dispenser Instructions:

Dispense Instruction: Quantity 1 of 12 mg vial(s) and Quantity 1 of 30 mg vial(s)

UAPI MedicationRequest Dispense Quantity Detailed Breakdown

  • dispenseQuantity: 1
  • dispenseUnit: 12mg vial(s)

UAPI MedicationRequest Dispense Quantity Detailed Breakdown

  • dispenseQuantity: 1
  • dispenseUnit: 30mg vial(s)

numberOfRepeatsAllowed: 0

ExpectedSupplyDurations

-ValueUnitSystemCode
*1mohttp://unitsofmeasure.orgmo

Entry 10 - fullUrl = urn:uuid:d3637025-883d-4678-9e0a-1d243a338f9f

Resource Organization:

identifier: http://vendor.com/ab/PAY-111 (use: usual, )

type: Insurance Company

name: Dakotacare

Contacts

-Telecom
*ph: 8778472862(Work)

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

Resource ServiceRequest:

status: Active

intent: Order

code: Benefit Investigation / Prior Authorization

subject: Bundle: identifier = Resource identifier: da5e1572-cc88-4e4d-9899-e3553f680d87; type = message; timestamp = 2020-03-11 08:10:13-0500


Entry 12 - fullUrl = urn:uuid:bc20c5ea-f639-4221-ab61-ce75c5e64aba

Resource Condition:

code: Hereditary factor VIII deficiency

subject: Bundle: identifier = Resource identifier: da5e1572-cc88-4e4d-9899-e3553f680d87; type = message; timestamp = 2020-03-11 08:10:13-0500