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
Contents:
This page provides a list of the FHIR artifacts defined as part of this implementation guide.
The following artifacts define the specific capabilities that different types of systems are expected to have in order to comply with this implementation guide. Systems conforming to this implementation guide are expected to declare conformance to one or more of the following capability statements.
UAPI CapabilityStatement - Genentech FHIR Server |
This CapabilityStatement describes the capabilities of a Genentech FHIR server which receives patient enrollments, sends enrollment status updates and serves related Questionnaire resources. |
These define the properties by which a RESTful server can be searched. They can also be used for sorting and including related resources.
ServiceRequestTypeSearch |
Enables searching by extension ServiceRequestType on CoverageEligilibityRequest resource. |
These define forms used by systems conforming to this implementation guide to capture or expose data to end users.
External - Alecensa Questionnaire |
Example of questionnaire to be filled out when submitting enrollment bundle for product Alecensa. |
External - Cotellic Copay Questionnaire |
Example of questionnaire to be filled out when submitting Copay enrollment bundle for product Cotellic. |
External - Cotellic Questionnaire |
Example of questionnaire to be filled out when submitting enrollment bundle for product Cotellic. |
External - Herceptin Questionnaire |
Example of questionnaire to be filled out when submitting enrollment bundle for product Herceptin. |
External - Lucentis Questionnaire |
Example of questionnaire to be filled out when submitting enrollment bundle for product Lucentis. |
These define constraints on FHIR resources for systems conforming to this implementation guide.
UAPI Bundle - AS Enrollment |
This profile constrains a Bundle resource for use to submit enrollment into Access Solutions services. It CAN be used in following scenarios:
|
UAPI Bundle - Copay Enrollment |
This profile constrains a Bundle resource for use as Copay enrollment submission |
UAPI Bundle - Copay Error Reconciliation |
This profile constrains a Bundle resource for use as Copay error reconciliation. |
UAPI Bundle - Copay Management |
This profile constrains a Bundle resource for use in copay workflow to:
|
UAPI Bundle - Copay Request-Response |
This profile constrains a Bundle resource which combines all elements from copay request with all elements from copay response. Combine uapi-copay-enrollment-bundle with uapi-bundle-query-response for copay. |
UAPI Bundle - Patient Consent Form Only Enrollment |
This profile constrains a Bundle resource for use as Access Solutions patient consent form submission |
UAPI Bundle - Query Message |
This profile constrains a Bundle resource for use as the request message in a UAPI Query process–with a Parameters resource as the bundle's message focus. It is based on IG http://build.fhir.org/ig/HL7/fhir-specialty-rx/branches/master/StructureDefinition-specialty-rx-bundle-query.html |
UAPI Bundle - Query Response Message |
This profile constrains a Bundle resource for use as the response message in a UAPI Query process–with a Parameters resource as the bundle's message focus. It is based on IG http://build.fhir.org/ig/HL7/fhir-specialty-rx/branches/master/StructureDefinition-specialty-rx-bundle-query-response.html |
UAPI Bundle - Query Response Multi Patient Message |
This profile constrains a Bundle resource for use as the response message in a Copay Search use case. It returns potentially multiple matching patients in query-result-patient entry element. |
UAPI Bundle - Search Result |
This profile constrains a Bundle resource to carry the query results from a UAPI Query - it is derived from IG http://build.fhir.org/ig/HL7/fhir-specialty-rx/branches/master/StructureDefinition-specialty-rx-bundle-search-result.html |
UAPI Bundle - Search Result Patient |
This profile constrains a Bundle resource for use as an element in UapiBundleQueryResponseMultiPatient bundle query-result-patient entry element. It contains Patient with related query-result resources. |
UAPI Bundle - Status Update |
This profile constrains a Bundle resource for use as the Status Update for Service Request Using Coverage Eligibility Response |
UAPI Condition |
This profile constrains the Condition resource |
UAPI Consent |
This profile constrains the Consent resource for Patient and Practioner |
UAPI Coverage |
This profile constrains the Coverage resource |
UAPI CoverageEligibilityRequest |
This profile constrains the CoverageEligibilityRequest resource to be used in sharing service request results in UAPI |
UAPI CoverageEligibilityResponse |
This profile constrains the CoverageEligibilityResponse resource to be used in sharing service request results in UAPI |
UAPI MedicationRequest |
This profile constrains the MedicationRequest resource to be included in UAPI data exchanges |
UAPI MessageHeader |
This profile constrains the MessageHeader resource to be included in each bundle |
UAPI Organization |
This profile constrains the Organization resource for representing practice and insurance |
UAPI Patient |
This profile constrains the Patient resource to be included in UAPI data exchanges |
UAPI Practitioner |
This profile constrains the Practitioner resource to be included in UAPI data exchanges |
UAPI Provenance |
This profile constrains the Provenance resource to be included in UAPI data exchanges |
UAPI RelatedPerson |
This profile constrains the Related Person resource to be included in UAPI data exchanges |
UAPI ServiceRequest |
This profile constrains the ServiceRequest resource |
These define constraints on FHIR data types for systems conforming to this implementation guide.
UAPI # of Appeals Allowed |
States how many level of appeals the Insurance allows. |
UAPI Additional Documents Required |
States what documents are required to submit for appeal. |
UAPI Appeal Submission Deadline |
States when the deadline is to submit for an appeal with the Insurance. |
UAPI BI - Benefits Summary |
Benefit Investigation Benefits Summary |
UAPI BI - Billing Instructions |
Benefit Investigation Billing Instructions |
UAPI BI - Specialty Pharmacy |
Benefit Investigation Specialty Pharmacy |
UAPI Coverage - Card issuance date |
Date when the insurance company issued the insurance card. |
UAPI Coverage Plan Year |
Describes Plan year for Coverage Status Outcome |
UAPI Coverage Reference Number |
Describes Reference Number for Coverage Status Outcome |
UAPI CoverageEligibilityRequest Product |
Describes the Medication(Product) related to Coverage eligibility Request |
UAPI CoverageEligibilityRequest ServiceRequestType |
Describes the ServiceRequest related to Coverage Eligibility Request |
UAPI CoverageEligibilityResponse Shipment Method |
Describes shipment method for GPF Shipments, currently supported values are 'Upfront' and 'Replacement' |
UAPI CoverageEligibilityResponse Status |
Provides the updated status of successfully enrolled Service Requests |
UAPI Estimated Appeal TAT |
Appeal Turn Around Time: Estimated time Insurance needs to review an appeal in business days. |
UAPI MedicationRequest Dispense Quantity Detailed Breakdown |
Detailed breakdown of medication units with quantity to fill the prescription dosage requirement |
UAPI MedicationRequest Dispenser Instructions |
Additional information for the dispenser |
UAPI MessageHeader Timestamp |
Timestamp when bundle was submitted |
UAPI PCP Referral Effective Date |
States what the first day of an on-file referral from a Primary Care Physician (When it starts) |
UAPI PCP Referral On-file? |
States whether a referral from a Primary Care Physician is on-file with the Insurance |
UAPI PCP Referral Recertification Date |
States what the last day of a on-file referral from a Primary Care Physician (When it expires) |
UAPI PCP Referral Required? |
States whether a referral from a Primary Care Physician is required. |
UAPI Peer to Peer Available |
States whether Peer to Peer is an option for appeals. |
UAPI Practitioner Preferred Contact Method |
The preferred method of contact. |
UAPI Practitioner Shipment Method |
The preferred contact time. |
UAPI PreD Est. TAT |
PreDetermination Turn Around Time: Estimated time Insurance needs to review a PreDetermination in business days. |
UAPI Prior Auth Est. TAT |
Prior Authorization Turn Around Time: Estimated time Insurance needs to review a Prior Authorization in business days. |
UAPI Spend Down Frequency |
States what the Spend down frequency is for Medicaid. Only applies to patients with Medicaid |
These define sets of codes used by systems conforming to this implementation guide.
UAPI Value Set - Benefit Type |
This value set contains Benefit Types used in the UAPI |
UAPI Value Set - Copay Adjudication Categories |
This value set contains Copay Adjudication Categories values used in copay enrollments in the UAPI. It is a combination of https://hl7.org/fhir/us/carin-bb/ValueSet-C4BBAdjudicationCategoryDiscriminator.html standard codes with subset of custom additional codes required for UAPI implementation. |
UAPI Value Set - Copay Insurance Plan Types |
This value set contains Insurance Plan Types values used in copay enrollments in the UAPI. It is a combination of http://terminology.hl7.org/ValueSet/v3-ActCoverageTypeCode standard codes with subset of custom additional codes required for UAPI implementation. |
UAPI Value Set - Coverage Outcome |
This value set contains Coverage outcome as result of patient enrollment. |
UAPI Value Set - Insurance Unit |
This value set contains Insurance Unit used in the UAPI |
UAPI Value Set - Organization Type |
This value set contains Organization Types used in the UAPI |
UAPI Value Set - PreDetermination |
This value set contains PreDetermination information for patient enrollments. |
UAPI Value Set - Prescriber Contact Method |
This value set contains preferred contact methods. |
UAPI Value Set - Prescriber Contact Time |
This value set contains preferred contact times. |
UAPI Value Set - Product Authorization |
This value set contains product Auth used in the UAPI |
UAPI Value Set - Product JCode |
This value set contains Specialty Pharmacy information for patient enrollments. |
UAPI Value Set - Product Name |
This value set contains product names used in the UAPI MedicationRequest profile. |
UAPI Value Set - Product Service |
This value set contains product service used in the UAPI |
UAPI Value Set - Regimen Product Name |
This value set contains regimen product names used in the UAPI MedicationRequest profile. |
UAPI Value Set - Service Request Type |
This value set contains Service Request types used in the UAPI ServiceRequest profile. |
UAPI Value Set - Shipment Method |
This value set contains Shipment method used for GPF medicine. |
UAPI Value Set - Specialty Pharmacy |
This value set contains Specialty Pharmacy information for patient enrollments. |
UAPI Value Set - System Event Type |
This value set contains system event types used in the UAPI MessageHeader profile. |
These define new code systems used by systems conforming to this implementation guide.
UAPI Code System - Authorization-Supporting Documents Submission |
Genentech Authorizations Supported in UAPI |
UAPI Code System - Benefit Type |
Genentech Benefit Types Supported in UAPI |
UAPI Code System - Copay Adjudication Category |
Genentech additional Adjudication Categories supported in UAPI for Copay claims. |
UAPI Code System - Copay Benefit Types |
Genentech additional Benefit Types supported in UAPI |
UAPI Code System - Copay Brand ID |
The BrandID identifies the product and the type(s) of Copay assistance the patient is applying for. |
UAPI Code System - Copay CRX enrollment channel |
Copay Enrollment Channel |
UAPI Code System - Copay CRX enrollment status |
Copay Enrollment Status |
UAPI Code System - Copay CRX workflow selection |
Workflow selection. A workflow is a predetermined sequence of actions represented by a unique workflow name and capable of being mutated at the various available states via the settings object. Each workflow consists of a subset combination of these available internal actions: |
UAPI Code System - Copay Claim Status |
Genentech claim statuses supported in UAPI for Copay claims. |
UAPI Code System - Copay Claim Supporting Information Category |
Genentech supporting info categories utilized in UAPI for Copay claims. |
UAPI Code System - Copay Enrollment Errors |
Genentech possible Errors on rejected Copay Enrollment |
UAPI Code System - Copay Genentech processing error |
Internal validation errors when processing incoming enrollment and claims copay messages. |
UAPI Code System - Copay Insurance Plan Types |
Genentech additional Insurance Plan Types supported in UAPI for Copay enrollments. |
UAPI Code System - Copay Payment Type |
Genentech payment types supported in UAPI for Copay claims. |
UAPI Code System - Copay Task input types |
This is used to define copay identifiers required by the system to process the Copay enrollment. |
UAPI Code System - Copay Task output types |
This is used to define copay identifiers returned by the Copay enrollment. |
UAPI Code System - Copay Who is applying |
The enroll-by-id field identifies who is applying for Copay assistance. |
UAPI Code System - Copay assigned card type |
Value to represent the type of Debit Card assignment that should occur with this enrollment. |
UAPI Code System - CoverageEligibilityRequest outcome |
This code system defines outcomes of eligibility status for requested services. |
UAPI Code System - Event Type |
This code system defines event types used in UAPI message headers |
UAPI Code System - Insurance Unit |
Genentech Insurance Unit Supported in UAPI |
UAPI Code System - PreDetermination |
PreDetermination information for patient enrollment |
UAPI Code System - Prescriber Contact Methods |
Prescriber's preferred contact methods supported in UAPI |
UAPI Code System - Prescriber Contact Times |
Prescriber's preferred contact times supported in UAPI |
UAPI Code System - Product JCode |
JCodes for Products supported by UAPI |
UAPI Code System - Product Names |
Genentech Product names supported in UAPI |
UAPI Code System - Product/Service |
Genentech product coverage categories returned in CoverageEligibilityResponse |
UAPI Code System - Regimen Product Names |
Regimen Product names supported in UAPI |
UAPI Code System - Service Request Type |
This code system defines Service Request types used in UAPI to indicate Patient Assistance Program services |
UAPI Code System - Shipment Methods |
Genentech shipment categories supported in UAPI |
UAPI Code System - Specialty Pharmacy |
Specialty Pharmacy information for patient enrollments |
These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.
External - Alecensa QuestionnaireResponse |
Example of Questionnaire Response for product Alecensa. |
External - Herceptin Hylecta QuestionnaireResponse |
Example of Questionnaire Response for BIPA for Herceptin Hylecta . |
External - Medication Request: Actemra Intravenous |
Example for External Vendor systems. Include this prescription example in the enrollment bundle when requesting Patient Foundation services. |
External - Medication Request: Actemra Subcutaneous |
Example for External Vendor systems. Include this prescription example in the enrollment bundle when requesting BIPA or Patient Foundation services. Includes complex medicationRequest. |
External - Medication Request: Enspryng |
Example for External Vendor systems. Include this prescription example in the enrollment bundle when requesting Patient Foundation services. |
External - Medication Request: Evrysdi |
Example for External Vendor systems. Include this prescription example in the enrollment bundle when requesting BIPA services. |
External - Medication Request: Hemlibra |
Example for External Vendor systems. Include this prescription example in the enrollment bundle when requesting BIPA services. Includes complex medicationRequest with multiple dispense quantities. |
External - Medication Request: Itovebi |
Example for External Vendor systems. Include this prescription example in the Itovebi enrollment bundle when requesting Patient Foundation services. |
External - Medication Request: Ocrevus |
Example for External Vendor systems. Include this prescription example in the enrollment bundle when requesting Patient Foundation services. |
External - Medication Request: Ocrevus Zunovo - GPF |
Example for External Vendor systems. Include this prescription example in the enrollment bundle when requesting GPF services. |
External - Medication Request: Ocrevus Zunovo - Starter |
Example for External Vendor systems. Include this prescription example in the enrollment bundle when requesting Starter services. |
External - Medication Request: Pulmozyme |
Example for External Vendor systems. Include this prescription example in the enrollment bundle when requesting BIPA or GPF services. |
External - Medication Request: Rituxan for Immunology |
Example for External Vendor systems. Include this prescription example in the enrollment bundle when requesting Patient Foundation services. Includes complex medicationRequest (prescription). |
External - Medication Request: Tecentriq Hybreza |
Example for External Vendor systems. Include this prescription example in the enrollment bundle when requesting GPF services. |
External - MedicationRequest: Alecensa |
Example for External Vendor systems. Include this prescription example in the Alecesna enrollment bundle when requesting BIPA services. |
External - MedicationRequest: Cotellic |
Example for External Vendor systems. Include this prescription example in the Cotellic enrollment bundle when requesting BIPA services. |
External - MedicationRequest: Erivedge |
Example for External Vendor systems. Include this prescription example in the Erivedge enrollment bundle when requesting BIPA services. |
External - MedicationRequest: Herceptin |
Example for External Vendor systems. Include this prescription example in the Herceptin enrollment bundle when requesting Patient Foundation services. |
External - MedicationRequest: Lucentis |
Example for External Vendor systems. Include this prescription example in the Lucentis enrollment bundle when requesting Patient Foundation services. |
External - MedicationRequest: Lunsumio |
Example for External Vendor systems. Include this prescription example in the Lunsumio enrollment bundle when requesting Patient Foundation services. |
External - MedicationRequest: Rozlytrek |
Example for External Vendor systems. Include this prescription example in the Rozlytrek enrollment bundle when requesting BIPA services. |
External - MedicationRequest: Vabysmo |
Example for External Vendor systems. Include this prescription example in the Vabysmo enrollment bundle when requesting Patient Foundation services. |
External - Resource Example: OperationOutcome |
Successful OperationOutcome |
External - Resource Example: Organization (Practice) |
Example of Practice Organization which should be included in each enrollment bundle. |
External - Resource Example: MessageHeader |
Example of MessageHeader which contains sender.endpoint with transaction identifier appended after /enrollmentID |
External - Rozlytrek QuestionnaireResponse |
Example of Questionnaire Response for product Rozlytrek. |
External - SOT Organization example |
Example of Site of Treatment/Infusion Centre- Organization which may be included in each enrollment bundle. |
External - UAPI AS Digital Consent: Consent by RelatedPerson |
Example of a digital consent given by the RelatedPerson |
External - UAPI AS Enrollment: Actemra Subcutaneous |
Example for External Vendor systems. Use this example to send an Actemra Subcutaneous enrollment bundle to the UAPI enrollment endpoint, requesting Access Solution services. The bundle contains (Enrollment Only): BIPA SR, Prescription, Prescriber Signature (optional). |
External - UAPI AS Enrollment: Alecensa |
Example for External Vendor systems. Use this example to send an Alecensa enrollment bundle to the UAPI enrollment endpoint, requesting Access Solutions services. The bundle contains (Enrollment + Digital Consent): BIPA SR, Prescription, Digital Consent, Prescriber Signature |
External - UAPI AS Enrollment: Avastin |
Example for External Vendor systems. Use this example to send an Avastin enrollment bundle to the UAPI enrollment endpoint, requesting Access Solutions services. The bundle contains (Enrollment + Digital Consent): BIPA SR, Copay Referral SR, Digital Consent, Site of Treatment |
External - UAPI AS Enrollment: Columvi |
Example for External Vendor systems. Use this example to send an Columvi enrollment bundle to the UAPI enrollment endpoint, requesting Access Solutions services. The bundle contains (Enrollment + Digital Consent): BIPA SR, Copay Referral SR, Digital Consent, Site of Treatment |
External - UAPI AS Enrollment: Cotellic |
Example for External Vendor systems. Use this example to send a Cotellic enrollment bundle to the UAPI enrollment endpoint, requesting Access Solutions services. The bundle contains (Enrollment + Digital Consent): BIPA SR, Copay Referral SR, Prescription, Digital Consent, Prescriber Signature, 2 Diagnosis Codes |
External - UAPI AS Enrollment: Enspryng |
Example for External Vendor systems Use this example to send an Enspryng enrollment bundle to the UAPI enrollment endpoint, requesting Access Solutions services. The bundle contains (Enrollment + Digital Consent): BIPA SR, Copay Referral SR, Prescription, Digital Consent, and Site of Treatment. |
External - UAPI AS Enrollment: Erivedge |
Example for External Vendor systems. Use this example to send an Erivedge enrollment bundle to the UAPI enrollment endpoint, requesting Access Solutions services. The bundle contains (Enrollment + Digital Consent): BIPA SR, Copay Referral SR, Prescription, Digital Consent, Prescriber Signature |
External - UAPI AS Enrollment: Gazyva |
Example for External Vendor systems. Use this example to send a Gazyva enrollment bundle to the UAPI enrollment endpoint, requesting Access Solutions services. The bundle contains (Enrollment + Digital Consent): BIPA SR, Digital Consent, Site of Treatment |
External - UAPI AS Enrollment: Hemlibra |
Example for External Vendor systems. Use this example to send a Hemlibra enrollment bundle to the UAPI enrollment endpoint, requesting Access Solution services. The bundle contains (Enrollment Only): BIPA SR, Prescription, optional Prescriber Signature not included. |
External - UAPI AS Enrollment: Herceptin Hylecta |
Example for External Vendor systems. Use this example to send a Herceptin Hylecta enrollment bundle to the UAPI enrollment endpoint, requesting Access Solutions services. The bundle contains (Enrollment + Digital Consent) BIPA SR, Digital Consent |
External - UAPI AS Enrollment: Lucentis |
Example for External Vendor systems. Use this example to send a Lucentis enrollment bundle to the UAPI enrollment endpoint, requesting Access Solutions services. The bundle contains BIPA SR, Copay SR, Digital Consent |
External - UAPI AS Enrollment: Ocrevus |
Example for External Vendor systems. Use this example to send an Ocrevus enrollment bundle to the UAPI enrollment endpoint, requesting Access Solutions services. The bundle contains (Enrollment + Digital Consent): BIPA SR, Copay Referral SR, Digital Consent, and Site of Treatment. |
External - UAPI AS Enrollment: Perjeta |
Example for External Vendor systems. Use this example to send a Perjeta enrollment bundle to the UAPI enrollment endpoint, requesting Access Solutions services. The bundle contains (Enrollment + Digital Consent): BIPA SR, Copay Referral SR, Digital Consent, Site of Treatment |
External - UAPI AS Enrollment: Polivy |
Example for External Vendor systems. Use this example to send a Polivy enrollment bundle to the UAPI enrollment endpoint, requesting Access Solutions services. The bundle contains (Enrollment + Digital Consent): BIPA SR, Copay Referral SR, Digital Consent, Site of Treatment |
External - UAPI AS Enrollment: Pulmozyme |
Example for External Vendor systems. Use this example to send an Pulmozyme enrollment bundle to the UAPI enrollment endpoint, requesting Patient Foundation services. The bundle contains (Enrollment + Digital Consent): Patient Foundation SR, Prescription, Prescriber Signature, Digital Consent. |
External - UAPI AS Enrollment: Rituxan Hycela |
Example for External Vendor systems. Use this example to send a Rituxan Hycela enrollment bundle to the UAPI enrollment endpoint, requesting Access Solutions services. The bundle contains (Enrollment + Digital Consent) BIPA SR, Copay Referral SR, Digital Consent, Site of Treatment |
External - UAPI AS Enrollment: Rituxan for Immunology |
Example for External Vendor systems. Use this example to send an Rituxan for Immunology enrollment bundle to the UAPI enrollment endpoint, requesting Patient Foundation services. The bundle contains (Enrollment + Consent): Patient Foundation SR, Prescription, Prescriber Signature, Site of Treatment, Digital Consent |
External - UAPI AS Enrollment: Rituxan for Oncology |
Example for External Vendor systems. Use this example to send a Rituxan for Oncology enrollment bundle to the UAPI enrollment endpoint, requesting Access Solutions services. The bundle contains (Enrollment + Digital Consent): BIPA SR, Digital Consent, Site of Treatment, Regimen Product |
External - UAPI AS Enrollment: Rozlytrek |
Example for External Vendor systems. Use this example to send a Rozlytrek enrollment bundle to the UAPI enrollment endpoint, requesting Access Solutions services. The bundle contains (Enrollment ONLY) BIPA SR, Prescription, Prescriber Signature |
External - UAPI AS Enrollment: Susvimo |
Example for External Vendor systems. Use this example to send a Susvimo enrollment bundle to the UAPI enrollment endpoint, requesting Access Solutions services. The bundle contains (Enrollment + Digital Consent): BIPA SR, Copay Referral SR, Digital Consent, Site of Treatment |
External - UAPI AS Enrollment: Vabysmo |
Example for External Vendor systems. Use this example to send a Vabysmo enrollment bundle to the UAPI enrollment endpoint, requesting Access Solutions services. The bundle contains BIPA SR, Copay Referral SR, Digital Consent |
External - UAPI AS Enrollment: Venclexta |
Example for External Vendor systems. Use this example to send a Venclexta enrollment bundle to the UAPI enrollment endpoint, requesting Access Solutions services. The bundle contains BIPA SR, Copay Referral SR, Prescription, Digital Consent, Prescriber Signature |
External - UAPI AS Enrollment: Xolair |
Example for External Vendor systems. Use this example to send a Xolair enrollment bundle to the UAPI enrollment endpoint, requesting Access Solutions services. The bundle contains BIPA and Starter SR, Digital Consent, Prescriber Signature, Site of Treatment, Starter Prescription |
External - UAPI AS Enrollment: Evrysdi |
Example for External Vendor systems. Use this example to send a Evrysdi enrollment bundle to the UAPI enrollment endpoint, requesting Access Solutions services. The bundle contains BIPA SR, Prescription, Digital Consent, Prescriber Signature |
External - UAPI AS Enrollment: Kadcyla |
Example for External Vendor systems. Use this example to send a Kadcyla enrollment bundle to the UAPI enrollment endpoint, requesting Access Solutions services. The bundle contains (Enrollment + Digital Consent): BIPA SR, Digital Consent, Site of Treatment |
External - UAPI AS Enrollment: Phesgo |
Example for External Vendor systems. Use this example to send a Phesgo enrollment bundle to the UAPI enrollment endpoint, requesting Access Solutions services. The bundle contains (Enrollment + Digital Consent): BIPA SR, Copay Referral SR, Digital Consent, Site of Treatment |
External - UAPI AS Enrollment: Tecentriq |
Example for External Vendor systems. Use this example to send a Tecentriq enrollment bundle to the UAPI enrollment endpoint, requesting Access Solutions services. The bundle contains (Enrollment + Digital Consent): BIPA SR, Copay Referral SR, Digital Consent, Site of Treatment |
External - UAPI AS Patient Consent Only |
Example for External Vendor Systems. Use this example to submit a Patient Consent Only bundle; contains Patient Authorization Signature. |
External - UAPI AS Patient Consent: Consent for Marketing Info |
Example of a consent to opt-in for marketing info |
External - UAPI Copay Card Enrollment REQUEST 1 |
Example of copay card request bundle initiated from internal Genentech PACT/MPS system |
External - UAPI Copay Card Enrollment REQUEST 2 |
Example of copay card request bundle initiated from External Vendor System |
External - UAPI Copay Card Enrollment REQUEST 3 |
Example of request bundle initiated from External Vendor System that includes a combo therapy |
External - UAPI Copay Card Enrollment RESPONSE 1 |
Example of copay response for an APPROVED (active) enrollment. |
External - UAPI Copay Card Enrollment RESPONSE 2 |
Example of copay response for an APPROVED (active) enrollment with 2 brand ids |
External - UAPI Copay Card Enrollment RESPONSE 3 |
Example of copay response for a DENIED (cancelled) enrollment with an OperationOutcome resource |
External - UAPI Copay Explanation of Benefit in copay enrollment response |
Example of eob resource which includes important response attributes returned as a result of copay enrollment request |
External - UAPI Copay Explanation of Benefit in copay enrollment response |
Example of eob resource which includes important response attributes returned as a result of copay enrollment request |
External - UAPI Copay Operation Outcome in copay enrollment response with errors |
Example of Operation Outcome resource which includes rejection message for Copay Enrollment |
External - UAPI Copay Search Request |
Example data query message send as a request in copay search use case. Task identifiers to indicate brandId in Parameters. |
External - UAPI Copay Update Request |
Example of UAPI Copay update |
External - UAPI Copay Update Response |
Example Copay Update Response with status rejected for original copay enrollment request |
External - UAPI Copay claim upsert - bundle of claim bundles |
Example representing bundle of claim bundles which will be send to Genentech endpoint by copay vendor to insert/update Copay Claims which were adjudicated by copay vendor. |
External - UAPI Copay request-response enrollment bundle - success |
Example of successfull copay enrollment sent to Genentech from copay adjudication vendor. |
External - UAPI GPF Enrollment: Herceptin |
Example for External Vendor systems. Use this example to send an enrollment bundle to the UAPI enrollment endpoint, requesting Patient Foundation services. The bundle contains Patient Foundation Service Request, Prescription, Digital Consent, Prescriber Signature |
External - UAPI GPF Enrollment: Lunsumio |
Example for External Vendor systems. Use this example to send a Lunsumio enrollment bundle to the UAPI enrollment endpoint, requesting Patient Foundation services. The bundle contains (Enrollment + Digital Consent): Patient Foundation SR, Digital Consent, Site of Treatment, Prescriber Signature, Prescription |
External - UAPI GPF Enrollment: Itovebi |
Example for External Vendor systems. Use this example to send Itovebi enrollment bundle to the UAPI enrollment endpoint, requesting Patient Foundation services. The bundle contains (Enrollment + Digital Consent): Patient Foundation SR, Digital Consent, Prescriber Signature, Prescription. |
External - UAPI GPF Enrollment: Susvimo |
Example for External Vendor systems. Use this example to send a Susvimo enrollment bundle to the UAPI enrollment endpoint, requesting Patient Foundation services. The bundle contains (Enrollment + Digital Consent): Patient Foundation SR, Digital Consent, Prescriber Signature, Site of Treatment. Contains prescription for implant kit (initial fill/refill). |
External - UAPI Response to Copay Search request - example returning 2 matching patients. |
Example response message to Copay Search request. It returns 2 matching patients in the MultiPatient bundle |
External - UAPI Status Query REQUEST |
Example of Status Query Request bundle for BIPA and GPF enrollment |
External - UAPI Status Query RESPONSE: BIPA |
Example of Status Query Response for BIPA investigation outcome (single search) |
External - UAPI Status Query RESPONSE: GPF |
Example of Status Query Response for GPF eligibility status (single search) |
Internal - UAPI AS Enrollment for MPS Redesign biPA Bundle Before (Ocrevus) |
Example to be used by MPS Redesign (internal). This is example of a bundle which is to be sent to Universal API enrollment endpoint in order to request Access Solutions Services. |
Internal - UAPI Copay request-response combined bundle - error |
Example representing combination of request and response bundle elements which will be generated internally by UAPI and published as an event to Genentech internal MessageBus. This contains error response to coapy enrollment request. This is used for notifications to internal Genentech systems. |
Internal - UAPI Copay request-response combined bundle - success |
Example representing combination of request and response bundle elements which will be generated internally by UAPI and published as an event to Genentech internal MessageBus. This is used for notifications to internal Genentech systems. |
Internal - UAPI Query 2 |
Example data query message without full resources (identifiers in parameters instead) after the internal Genentech middletier transformations |
Internal - UAPI Status Update C&R |
Example of UAPI Status Update - C&R |
Internal - UAPI Status Update GPF |
Example of UAPI Status Update - GPF |
as-venclexta-mr | |
mr-Avastin | |
mr-Columvi | |
mr-Gazyva | |
mr-HerceptinHylecta | |
mr-Kadcyla | |
mr-Perjeta | |
mr-Perjeta1 | |
mr-Phesgo | |
mr-Phesgo1 | |
mr-Polivy | |
mr-Polivy1 | |
mr-Pulmozyme | |
mr-Regimen | |
mr-Regimen2 | |
mr-RituxanForOncology | |
mr-RituxanHycela | |
mr-RituxanHycela1 | |
mr-RituxanOncology | |
mr-Tecentriq2 | |
mr-Tecentriq3 | |
mr-Zelboraf | |
mr-Zelboraf1 | |
mr-xolair |