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 Copay Card Enrollment REQUEST 1

Bundle uapi-copay-bundle-copayCRX1-PACT of type message


Entry 1 - fullUrl = urn:uuid:f8d0f28e-690f-4f24-a315-5f3b0571f79d

Resource MessageHeader:

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

event: uapi-event-type copay-enrollment: copay-enrollment

Destinations

-Name
*UAPI-COPAY-ENR-V1.0

sender: Bundle: identifier = Resource identifier: 7c8f5054-015b-4bce-99f5-4160a82a4225; type = message; timestamp = 2020-03-11 08:10:13-0500

Sources

-Name
*Genentech PACT

focus: Bundle: identifier = Resource identifier: c600e111-c5bf-42d0-93d5-8408c1f18a38; type = message; timestamp = 2020-03-11 08:10:13-0500


Entry 2 - fullUrl = urn:uuid:f603c60a-795b-47fc-981c-b49ab287f0bf

Resource List:

messageContext

Mode: Change List Status: Current
Items
Bundle: identifier = Resource identifier: c600e111-c5bf-42d0-93d5-8408c1f18a38; type = message; timestamp = 2020-03-11 08:10:13-0500
Bundle: identifier = Resource identifier: 7c8f5054-015b-4bce-99f5-4160a82a4225; 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: 7c8f5054-015b-4bce-99f5-4160a82a4225; type = message; timestamp = 2020-03-11 08:10:13-0500
Bundle: identifier = Resource identifier: 7c8f5054-015b-4bce-99f5-4160a82a4225; type = message; timestamp = 2020-03-11 08:10:13-0500
Bundle: identifier = Resource identifier: 88b42c3d-2926-46de-b696-e8713f02f8cb; 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: 7c8f5054-015b-4bce-99f5-4160a82a4225; type = message; timestamp = 2020-03-11 08:10:13-0500
Bundle: identifier = Resource identifier: 88b42c3d-2926-46de-b696-e8713f02f8cb; type = message; timestamp = 2020-03-11 08:10:13-0500
Bundle: identifier = Resource identifier: 7c8f5054-015b-4bce-99f5-4160a82a4225; type = message; timestamp = 2020-03-11 08:10:13-0500

Entry 3 - fullUrl = urn:uuid:1a4935bd-289b-4f11-82bf-a86d10792af4

Resource Patient:

Profile: UAPI Patient

Ryan Michaelson (official) Male, DoB: 1972-10-29 ( Patient internal identifier: PAT-123 (use: usual, ))


Other Id:Patient internal identifier/6bcd8467-0473-4836-9128-2e7972f23177 (use: usual, )
Contact Detail
Language:English (preferred)
Links:

Entry 4 - fullUrl = urn:uuid:be7a688f-cdfd-41f4-9fe1-3e92abbfbbf2

Resource Organization:

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

type: Healthcare Provider

name: Cleveland Clinic

contact

telecom: ph: 8882704882(Work)

address: 8 Ranoldo Terrace Cherry Hill NJ 08034 US

contact

name: MARISSA CRUZ (Official)

telecom: ph: -unknown-


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

Resource Organization:

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

type: Insurance Company

name: Kaiser

Contacts

-Telecom
*ph: 8778472862(Work)

Entry 6 - fullUrl = urn:uuid:982e97af-668d-41ef-b9f9-2bbc4a059330

Resource Organization:

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

type: Insurance Company

name: CVS Specialty

contact

telecom: ph: -unknown-

contact

telecom: ph: 8778472862(Work)


Entry 7 - fullUrl = urn:uuid:cc31cf51-ea4f-4623-bdbb-2ea9e0068a20

Resource Practitioner:

UAPI Practitioner Preferred Contact Method: work-phone

UAPI Practitioner Shipment Method: morning

identifier: Provider identifier/1922071448 (use: official, ), National provider identifier/1639285034 (use: official, )

name: MARISSA ANNE CRUZ (Official)

telecom: ph: 8882704882(Work), fax: 8882704883(Work), prescribercopay@example.com

address: 8 Ranoldo Terrace Cherry Hill NJ 08034 US

Qualifications

-Code
*Doctor of Medicine

Entry 8 - fullUrl = urn:uuid:c29782b4-6ffc-494e-85ab-eee27bfd994a

Resource QuestionnaireResponse:

LinkIDTextDefinitionAnswerdoco
.. c29782b4-6ffc-494e-85ab-eee27bfd994aQuestionnaire:https://dev.gene.com/fhir/uapi/fhirapi/Questionnaire/1234
... consent-to-enrollDoes the patient consent to enroll in the Ocrevus Co-Pay Program?Yes
... ocrevus-fda-approved-indicationsIs the patient using OCREVUS for the following FDA-approved indications?[not stated] Relapsing-forms-of-multiple-sclerosis-(MS),-to-include-clinically-isolated-syndrome,-relapsing-remitting-disease-and-active-secondary-progressive-disease-or-primary-progressive-forms-of-MS,-in-adults: Relapsing forms of multiple sclerosis (MS), to include clinically isolated syndrome, relapsing-remitting disease and active secondary progressive disease or primary progressive forms of MS, in adults
... 18-years-or-olderIs the patient 18 years of age or olderYes
... commercial-private-insuranceIs the patient on commercial (also known as private) insurance? This includes insurance from an employer and non-government funded insurance purchased from a health insurance marketplaceYes
... federal-state-funded-insuranceIs the patient using any federal or state-funded health care program? This includes, but is not limited to, Medicare, Medicaid, Medigap, VA, DoD and TRICARE.No
... have-medicare-cardDoes the patient have a Medicare (red, white and blue) card?Yes
... enter-medicare-numberEnter the Medicare number:M577788
... residence-stateWhat state does the patient live in?CA
... receiving-medication-from-gpfIs the patient currently receiving Ocrevus from the Genentech Patient Foundation?No
... receiving-assistance-from-charitable-organizationIs the patient currently receiving assistance from any other charitable organization for any of their out-of-pocket costs that are covered by the Ocrevus Co-pay Program?No
... agree-to-genentech-privacy-policyThe patient acknowledges and agrees that any patient information disclosed during the enrollment, including contact information, demographic information, and information related to their medical condition, treatments, and health insurance and benefits, will be shared with Genentech, the sponsor of the program, its partners, and their respective affiliates. In addition, information shared by the pharmacy/physician, such as the date the prescription was filled, the date the medication was administered by the physician (if applicable) and the amount that will be reimbursed by Genentech will also be shared. The patient authorizes Genentech to receive, use, and share patient personal information in connection with the Ocrevus Co-pay Program. The patient agrees to be contacted by phone, mail or email about the Ocrevus Co-pay Program. You have notified the patient that they can find more information in the Genentech Privacy Policy at www.gene.com/privacy-policy.Agree
... agree-to-copay-program-termsThe Co-pay Program is valid ONLY for patients with commercial (private or non-governmental) insurance who have a valid prescription for a Food and Drug Administration (FDA)-approved indication of a Genentech medicine. Patients using Medicare, Medicaid, Medigap, Veterans Affairs (VA), Department of Defense (DoD), TRICARE or any other federal or state government program (collectively, “Government Programs”) to pay for their Genentech medicine are not eligible. The Program is not valid for Genentech medicines that are eligible to be reimbursed in their entirety by private insurance plans or other programs. Under the Program, the patient may pay a co-pay. The final amount owed by a patient may be as little as $0 for the Genentech medicine (see Program specific details). The total patient out-of-pocket cost is dependent on the patient’s health insurance plan. The Program assists with the cost of the Genentech medicine only. It does not assist with the cost of other medicines, procedures or office visit fees. After reaching the maximum annual Program benefit amount, the patient will be responsible for all remaining out-of-pocket expenses. The Program benefit amount cannot exceed the patient’s out-of-pocket expenses for the cost associated with the Genentech medicine. The maximum Program benefit will reset every January 1st. The Program is not health insurance or a benefit plan. The patient’s non-governmental insurance is the primary payer. The Program does not obligate the use of any specific medicine or provider. Patients receiving assistance from charitable free medicine programs (such as the Genentech Patient Foundation) or any other charitable organizations for the same expenses covered by the Program are not eligible. The Program benefit cannot be combined with any other rebate, free trial or a similar offer for the Genentech medicine. No party may seek reimbursement for all or any part of the benefit received through the Program. The Program may be accepted by participating pharmacies, physicians’ offices or hospitals. Once a patient is enrolled, the Program will honor claims with a date of service that precedes the Program enrollment date up to 180 days. Claims must be submitted within 365 days from the date of service unless otherwise indicated. Use of the Program must be consistent with all relevant health insurance requirements. Participating patients, pharmacies, physicians’ offices and hospitals are responsible for reporting the receipt of all Program benefits as required by any insurer or by law. Programs’ benefits may not be sold, purchased, traded or offered for sale. The patient or their guardian must be 18 years of age or older to receive Program assistance. The Program is only valid in the United States and U.S. Territories, is void where prohibited by law and shall follow state restrictions in relation to AB-rated generic equivalents (e.g., MA, CA) where applicable. Eligible patients will be automatically re-enrolled in the Program on an annual basis. Eligible patients will be removed from the Program after 3 years of inactivity (e.g., no claims submitted in a 3-year timeframe). Program eligibility and automatic re-enrollment are contingent upon the patient’s ability to meet all requirements set forth by the Program. Healthcare providers may not advertise or otherwise use the Program as a means of promoting their services or Genentech medicines to patients. The Program is intended for the patient. Only the patient using the Program may receive the funds made available through the Program. The Program is not intended for third parties who reduce the amount available to the patient or take a portion for their own purposes. Patients with health plans that redirect Genentech Program assistance intended for patient out-of-pocket costs may be subject to alternate Program benefit structures. Genentech reserves the right to rescind, revoke or amend the Program without notice at any time.
... agree-to-admin-copay-program-termsThe Administration Co-pay Program is valid ONLY for patients with commercial (private or non-governmental) insurance who have a valid prescription for a Food and Drug Administration (FDA)-approved indication of a Genentech medicine. Patients using Medicare, Medicaid, Medigap, Veterans Affairs (VA), Department of Defense (DoD), TRICARE or any other federal or state government program (collectively, “Government Programs”) to pay for their Genentech medicine and/or administration services are not eligible. The Program is not valid for administration that is eligible to be reimbursed in their entirety by private insurance plans or other programs. If the patient chooses to enroll in the Drug Co-pay Program, the patient must separately enroll and meet all eligibility criteria of that program. Under the Program, the patient may pay a co-pay. The final amount owed by a patient may be as little as $0 for the administration of the Genentech medicine (see Program specific details). The total patient out-of-pocket cost is dependent on the patient’s health insurance plan. The Program assists with the costs of the administration of the Genentech medicine only. It does not assist with the cost of other administrations, medicines, procedures or office visit fees. After reaching the maximum per treatment or annual Program benefit amounts, the patient will be responsible for all remaining out-of-pocket expenses. The Program benefit amount cannot exceed the patient’s out-of-pocket expenses for the administration fees associated with the Genentech medicine. The maximum Program benefit will reset every January 1st. The Program is not health insurance or a benefit plan. The patient’s non-governmental insurance is the primary payer. The Program does not obligate the use of any specific medicine or provider. The Program is valid for patients receiving free medicine from the Genentech Patient Foundation. The Program is not valid for patients receiving assistance from any other charitable organizations for the same expenses covered by the Program. The Program benefit cannot be combined with any other rebate, free trial or a similar offer for the administration of the Genentech medicine. No party may seek reimbursement for all or any part of the benefit received through the Program. The Program may be accepted by participating pharmacies, physicians’ offices or hospitals. Once a patient is enrolled, the Program will honor administration claims with a date of service that precedes the Program enrollment up to 180 days. Claims must be submitted within 365 days from the date of service unless otherwise indicated. Use of the Program must be consistent with all relevant health insurance requirements. Participating patients, pharmacies, physicians’ offices and hospitals are responsible for reporting the receipt of all Program benefits as required by any insurer or by law. Programs’ benefits may not be sold, purchased, traded or offered for sale. The patient or their guardian must be 18 years of age or older to receive Program assistance. The Program is only valid in the United States and U.S. Territories and is void where prohibited by law. The Program is not valid for Massachusetts or Rhode Island residents. Eligible patients will be automatically re-enrolled in the Program on an annual basis. Eligible patients will be removed from the Program after 3 years of inactivity (e.g., no claims submitted in a 3-year timeframe). Program eligibility and automatic re-enrollment are contingent upon the patient’s ability to meet all requirements set forth by the Program. Healthcare providers may not advertise or otherwise use the Program as a means of promoting their services or Genentech medicines to patients. The Program is intended for the patient. Only the patient using the Program may receive the funds made available through the Program. The Program is not intended for third parties who reduce the amount available to the patient or take a portion for their own purposes. Patients with health plans that redirect Genentech Program assistance intended for patient out-of-pocket costs may be subject to alternate Program benefit structures. Genentech reserves the right to rescind, revoke or amend the Program without notice at any time.Agree
... information-correctAll information is correct?Yes

doco Documentation for this format

Entry 9 - 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: 7c8f5054-015b-4bce-99f5-4160a82a4225; 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

period: 2023-01-01 --> (ongoing)

class

type: RX BIN

value: K12345

name: BIN

class

type: RX PCN

value: K234516

name: PCN

class

type: Group

value: KAI2345

name: Group Number

class

type: Plan

value: HMO

name: Plan

order: 1

network: Kaiser


Entry 10 - fullUrl = urn:uuid:d212ac11-903c-4040-a3d7-6b3e1874a311

Resource Coverage:

Profile: UAPI Coverage

status: Active

type: drug policy

subscriber: Bundle: identifier = Resource identifier: 7c8f5054-015b-4bce-99f5-4160a82a4225; 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

period: 2023-01-01 --> (ongoing)

class

type: RX BIN

value: K3456

name: BIN

class

type: RX PCN

value: K334455

name: PCN

class

type: Group

value: KAI2345

name: Group Number

class

type: Plan

value: HMO

name: Plan

order: 1

network: CVS Specialty


Entry 11 - fullUrl = urn:uuid:72d8daf1-f80f-4e56-bfcb-0558caf74feb

Resource Task:

status: Requested

intent: Plan

code: Copay

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

authoredOn: 2023-01-23 08:10:13-0500

requester: Bundle: identifier = Resource identifier: 7c8f5054-015b-4bce-99f5-4160a82a4225; type = message; timestamp = 2020-03-11 08:10:13-0500

input

type: enroll-by-id

value: Patient

input

type: brandId

value: 8699576a-3247-429a-9e46-31c00f50f1a0

input

type: brandId

value: 2e340749-5d09-4615-b0cf-29cb13d30972


Entry 12 - fullUrl = urn:uuid:12ed44e8-fde2-415d-9dcc-8e9117c73d2a

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: 310-462-1234(Mobile)

birthDate: 1972-10-29

address: 8 Ranoldo Terrace Cherry Hill NJ 08034 US