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

Onboarding

High-Level Process

This page is designed to guide you through the process of creating a FHIR bundle using the examples provided. Here, you will find comprehensive resources to help you understand the underlying business processes and the source-to-target mappings necessary for accurate data integration. Additionally, we include detailed release notes that highlight updates and changes, ensuring you stay informed and can build compliant FHIR bundles efficiently and effectively.



Onboarding Process




A. Register on Genentech Integration Marketplace (GIM)

Register to explore API catalog and to request access to APIs: Genentech Integration Marketplace (GIM)


B. Obtain Access to APIs

Information on how to access APIs are outlined on the Genentech Integration Marketplace-Support Documentation tab

C. Discover Available APIs

Detailed info on available APIs

Access Solutions (AS) & Patient Foundation (PF)
  • Enrollment into AS and PF services
  • Query status of requested services
Copay Card
  • Copay card enrollment API
  • Copay search API
  • Update API


D. Enrollment Process Overview

Understanding the enrollment process is crucial for creating FHIR bundles. Below is a high-level overview of the Access Solutions/Patient Foundation and Copay Card enrollment processes. Knowing the types of services provided by Access Solutions and the products that can be enrolled via UAPI will also be helpful.



Access Solutions/Patient Foundation Enrollment



Copay Card Enrollment




E. Review Questionnaire/QuestionnaireResponse Structure



F. Source-to-Target Mappings (STM)

Mapping- Access Solutions & Patient Foundation Enrollments
Mapping- Status Query Request and Response
Mapping- Copay Card Enrollment Request & Response



G. Validations

Validations for Access Solutions & Patient Foundation Enrollments


H. Obtain Bundle Examples from Implementation Guide

To aid in the client's creation of FHIR bundles, examples of key bundles have been created for client's to use as a starting point for their build. A list of bundle examples are located under the Artifacts Summary tab and are denoated as "External -".



Below are key examples of FHIR bundles for each of the available APIs (click each sample to expand):

Enrollment FHIR bundle


Status Query Request FHIR bundle

Once an enrollment is processed by Access Solutions or the Patient Foundation, then the client can query for a status update by submitting a Status Query Request bundle. This Status Query Request bundle example is for a patient that enrolled for a BIPA and Patient foundation service request.

Reference: Mapping- Status Query Request (Table 23.1.2)


Status Query Response FHIR bundle


Copay Card Enrollment FHIR bundle


Copay Card Response FHIR bundle


Copay Search Request & Response FHIR bundles

Purpose: Search to verify if patient is currently enrolled in Copay card program. Return current enrollment date and list of enrolled copay programs.


Copay Update FHIR bundle

Purpose: Adds an existing patient to the requesting organization's Copay program.



I. Create FHIR Bundles



J. Test API Connectiviy and FHIR Bundles

Testing Overview