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: Internal - UAPI Copay request-response combined bundle - error
Profile: UAPI Bundle - Copay Request-Response
Bundle uapi-copay-request-response-with-error of type message
Entry 1 - fullUrl = urn:uuid:cdd9f845-427b-4a48-a02d-279d80b9e415
Resource MessageHeader:
Profile: UAPI MessageHeader
UAPI MessageHeader Timestamp: 2023-03-03 08:10:13-0500
event: uapi-event-type copay-req-resp: copay-req-resp
Destinations
Name CRX Sources
Name Vendor_Tailormed Responses
Identifier Code 1-63c61a26-4965b3a156f488da6e0800ed OK
Entry 2 - fullUrl = urn:uuid:0e5ade69-34b1-4fc4-8681-686ea923267e
Resource List:
messageContext
Mode: Change List Status: Current
Entry 3 - fullUrl = urn:uuid:72d8daf1-f80f-4e56-bfcb-0558caf74feb
Resource Task:
status: Requested
intent: Plan
code: Copay
authoredOn: 2023-01-23 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 4 - fullUrl = urn:uuid:2c5aa62c-b6cd-49d2-ad9f-3128a69a32a9
Resource Patient:
Profile: UAPI Patient
Ryan Michaelson (official) Male, DoB: 1972-10-29 ( Patient internal identifier: ca3c6274-e70b-45cf-a65a-30e8386d50bb (use: usual, ))
Other Id: Patient internal identifier/8132413049 (use: usual, ) Contact Detail
- ph: 1231231234(Home)
- ph: 1234561234(Mobile)
- bobster83@example.com
- 1234 Main St San Francisco CA 94105 US
Language: English (preferred) Links:
Entry 5 - fullUrl = urn:uuid:01c31a2f-321d-4c6e-8349-206af8a88088
Resource Organization:
Profile: UAPI Organization
identifier:
http://vendor.com/ab/HOSP-12345 (use: usual, ),http://dev.gene.com/fhir/mulesoft/Vendor_AB_HOSP-12345 (use: official, )type: Healthcare Provider
name: Mid Atlantic Retina
contact
telecom: ph: -unknown-
address: 8 Ranoldo Terrace Cherry Hill NJ 08034 US
contact
name: Venus Yardav (Official)
telecom: ph: 8882704882(Work), fax: 8179974042(Work)
Entry 6 - fullUrl = urn:uuid:695d0991-5e03-46df-934a-85a28acd95c1
Resource Practitioner:
Profile: UAPI Practitioner
identifier: Provider number/1922071448 (use: official, ), Tax ID number/00000000 (use: official, ), National provider identifier/1639285034 (use: official, )
name: MARISSA CRUZ (Official)
Entry 7 - fullUrl = urn:uuid:4db51d32-65c3-4f8c-959e-0155c6d14545
Resource RelatedPerson:
Profile: UAPI RelatedPerson
relationship: significant other
name: Bob Paul Smith (Official)
telecom: ph: 1234567890(Mobile)
birthDate: 1972-10-29
Entry 8 - fullUrl = urn:uuid:c29782b4-6ffc-494e-85ab-eee27bfd994a
Resource QuestionnaireResponse:
LinkID Text Definition Answer c29782b4-6ffc-494e-85ab-eee27bfd994a
Questionnaire:https://dev.gene.com/fhir/uapi/fhirapi/Questionnaire/1234 consent-to-enroll
Does the patient consent to enroll in the Ocrevus Co-Pay Program? Yes Is 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 Is the patient 18 years of age or older Yes Is 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 marketplace Yes Is 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 Does the patient have a Medicare (red, white and blue) card? Yes Enter the Medicare number: M577788 What state does the patient live in? CA Is the patient currently receiving Ocrevus from the Genentech Patient Foundation? No Is 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 The 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 The 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. The 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 All information is correct? Yes 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
subscriberId: 4353
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
subscriberId: 4353
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:d3637025-883d-4678-9e0a-1d243a338f9f
Resource Organization:
Profile: UAPI Organization
identifier:
http://vendor.com/ab/PAY-111 (use: usual, )type: Insurance Company
name: Dakotacare
Contacts
Telecom ph: 8778472862(Work)
Entry 12 - fullUrl = urn:uuid:982e97af-668d-41ef-b9f9-2bbc4a059330
Resource Organization:
Profile: UAPI Organization
identifier:
http://vendor.com/ab/PAY-145 (use: usual, )type: Insurance Company
name: Pharmacare
contact
telecom: ph: -unknown-
contact
telecom: ph: 8778472862(Work)
Entry 13 - fullUrl = urn:uuid:e344813d-eb60-466e-806b-ebd35c988293
Resource ExplanationOfBenefit:
identifier:
http://connectiverx.com/enrollmentId/ad44f19a-42b6-ed11-827c-9e11af077484 (use: usual, )status: Cancelled
type: institutional
use: Predetermination
created: 2023-04-11 21:01:11+0000
outcome: error
Insurances
Focal Coverage false Bundle: identifier = http://connectiverx.com/requestId#86a42a99-663b-48b8-8fd9-c1afdbca5b98 (use: usual, ); type = message; timestamp = 2023-01-11 08:10:17-0500
Severity Location Code Details Diagnostics Error Processing Failure Provided patient information does not meet minimum criteria for verification.
Entry 14 - fullUrl = urn:uuid:e6e8d8c6-a074-4ea5-be1a-a67cb8628a85
Resource Coverage:
Profile: UAPI Coverage
status: Cancelled
type: Pay
Classes
Type Value Name Plan Vabysmo-Drug Ophthalmology Co Pay program order: 1
network: Genentech
Entry 15 - fullUrl = urn:uuid:d02db104-a75c-433f-8764-9778c2e20626
Resource Organization:
Profile: UAPI Organization
identifier:
http://gene.com/ORG-00002 (use: usual, )type: Insurance Company
name: Copay Organization - CRX
Contacts
Telecom ph: 1800654332211(Work)