Universal API Implementation Guide
1.1.19 - ci-build

Universal API Implementation Guide - Local Development build (v1.1.19). See the Directory of published versions

Table of Contents

...0 Table of Contents
...1 Home
...2 Copay Eligibility Questions
...3 Copay Mapping
...4 Copay Value Sets
...5 Enrollment
...6 Enrollment Mapping
...7 Error Handling
...8 History
...9 Message Structure
...10 Message Submission
...11 Products Specifics
...12 Questionnaire
...13 Regimen Products
...14 Search Conventions
...15 Services
...16 Status Update Mapping
...17 Systematic Queries
...18 Technical Hints
...19 Updates
...20 Use Cases
...21 Validation Rules
...22 Vendor Onboarding
....23 Artifacts Summary
....23.1 UAPI CapabilityStatement - Genentech FHIR Server
....23.2 ServiceRequestTypeSearch
....23.3 External - Alecensa Questionnaire
....23.4 External - Cotellic Copay Questionnaire
....23.5 External - Cotellic Questionnaire
....23.6 External - Herceptin Questionnaire
....23.7 External - Lucentis Questionnaire
....23.8 UAPI Bundle - AS Enrollment
....23.9 UAPI Bundle - Copay Enrollment
....23.10 UAPI Bundle - Copay Error Reconciliation
....23.11 UAPI Bundle - Copay Management
....23.12 UAPI Bundle - Copay Request-Response
....23.13 UAPI Bundle - Patient Consent Form Only Enrollment
....23.14 UAPI Bundle - Query Message
....23.15 UAPI Bundle - Query Response Message
....23.16 UAPI Bundle - Query Response Multi Patient Message
....23.17 UAPI Bundle - Search Result
....23.18 UAPI Bundle - Search Result Patient
....23.19 UAPI Bundle - Status Update
....23.20 UAPI Condition
....23.21 UAPI Consent
....23.22 UAPI Coverage
....23.23 UAPI CoverageEligibilityRequest
....23.24 UAPI CoverageEligibilityResponse
....23.25 UAPI MedicationRequest
....23.26 UAPI MessageHeader
....23.27 UAPI Organization
....23.28 UAPI Patient
....23.29 UAPI Practitioner
....23.30 UAPI Provenance
....23.31 UAPI RelatedPerson
....23.32 UAPI ServiceRequest
....23.33 UAPI # of Appeals Allowed
....23.34 UAPI Additional Documents Required
....23.35 UAPI Appeal Submission Deadline
....23.36 UAPI Coverage - Card issuance date
....23.37 UAPI Coverage Plan Year
....23.38 UAPI Coverage Reference Number
....23.39 UAPI CoverageEligibilityRequest Product
....23.40 UAPI CoverageEligibilityRequest ServiceRequestType
....23.41 UAPI CoverageEligibilityResponse Shipment Method
....23.42 UAPI CoverageEligibilityResponse Status
....23.43 UAPI Estimated Appeal TAT
....23.44 UAPI MedicationRequest Dispense Quantity Detailed Breakdown
....23.45 UAPI MedicationRequest Dispenser Instructions
....23.46 UAPI MessageHeader Timestamp
....23.47 UAPI PCP Referral Effective Date
....23.48 UAPI PCP Referral On-file?
....23.49 UAPI PCP Referral Recertification Date
....23.50 UAPI PCP Referral Required?
....23.51 UAPI Peer to Peer Available
....23.52 UAPI Practitioner Preferred Contact Method
....23.53 UAPI Practitioner Shipment Method
....23.54 UAPI PreD Est. TAT
....23.55 UAPI Prior Auth Est. TAT
....23.56 UAPI Spend Down Frequency
....23.57 UAPI Value Set - Benefit Type
....23.58 UAPI Value Set - Copay Insurance Plan Types
....23.59 UAPI Value Set - Coverage Outcome
....23.60 UAPI Value Set - Insurance Unit
....23.61 UAPI Value Set - Organization Type
....23.62 UAPI Value Set - Prescriber Contact Method
....23.63 UAPI Value Set - Prescriber Contact Time
....23.64 UAPI Value Set - Product Authorization
....23.65 UAPI Value Set - Product Name
....23.66 UAPI Value Set - Product Service
....23.67 UAPI Value Set - Service Request Type
....23.68 UAPI Value Set - Shipment Method
....23.69 UAPI Value Set - System Event Type
....23.70 UAPI Code System - Authorization-Supporting Documents Submission
....23.71 UAPI Code System - Benefit Type
....23.72 UAPI Code System - Copay assigned card type
....23.73 UAPI Code System - Copay Benefit Types
....23.74 UAPI Code System - Copay Brand ID
....23.75 UAPI Code System - Copay CRX enrollment channel
....23.76 UAPI Code System - Copay CRX enrollment status
....23.77 UAPI Code System - Copay CRX workflow selection
....23.78 UAPI Code System - Copay Enrollment Errors
....23.79 UAPI Code System - Copay Genentech processing error
....23.80 UAPI Code System - Copay Insurance Plan Types
....23.81 UAPI Code System - Copay Task input types
....23.82 UAPI Code System - Copay Task output types
....23.83 UAPI Code System - Copay Who is applying
....23.84 UAPI Code System - CoverageEligibilityRequest outcome
....23.85 UAPI Code System - Event Type
....23.86 UAPI Code System - Insurance Unit
....23.87 UAPI Code System - Prescriber Contact Methods
....23.88 UAPI Code System - Prescriber Contact Times
....23.89 UAPI Code System - Product Names
....23.90 UAPI Code System - Product/Service
....23.91 UAPI Code System - Service Request Type
....23.92 UAPI Code System - Shipment Methods
....23.93 External - Alecensa QuestionnaireResponse
....23.94 External - Copay Search Request
....23.95 External - Copay Update Request
....23.96 External - Herceptin QuestionnaireResponse
....23.97 External - MedicationRequest with dosage example
....23.98 External - MessageHeader with enrollment identifier example
....23.99 External - Operation Outcome Example
....23.100 External - Practice Organization example
....23.101 External - Rozlytrek QuestionnaireResponse
....23.102 External - SOT Organization example
....23.103 EXTERNAL - UAPI AS Digital Consent Only
....23.104 EXTERNAL - UAPI AS Enrollemnt + Digital Consent
....23.105 External - UAPI AS Enrollment biPA and copay Bundle Before (Lucentis and Susvimo)
....23.106 External - UAPI AS Enrollment biPA and starter Bundle Before (Gavreto and Prescriber sign.)
....23.107 External - UAPI AS Enrollment biPA and starter Bundle Before (Rituxan for Oncology plus regimen)
....23.108 External - UAPI AS Enrollment biPA Bundle Before
....23.109 External - UAPI AS Enrollment biPA Bundle Before (Gazyva)
....23.110 External - UAPI AS Enrollment biPA Bundle Before (Kadcyla)
....23.111 External - UAPI AS Enrollment biPA Bundle Before (Vabysmo)
....23.112 External - UAPI AS Enrollment biPA Bundle Before(BIPA)
....23.113 External - UAPI AS Enrollment biPA Bundle Before(PSF only)
....23.114 External - UAPI AS Enrollment biPA CoPay Bundle Before (Avastin)
....23.115 External - UAPI AS Enrollment biPA CoPay Bundle Before (Cotellic)
....23.116 External - UAPI AS Enrollment biPA CoPay Bundle Before (Erivedge)
....23.117 External - UAPI AS Enrollment biPA CoPay Bundle Before (Herceptin Hylecta)
....23.118 External - UAPI AS Enrollment biPA CoPay Bundle Before (Perjeta)
....23.119 External - UAPI AS Enrollment biPA CoPay Bundle Before (Phesgo)
....23.120 External - UAPI AS Enrollment biPA CoPay Bundle Before (Polivy)
....23.121 External - UAPI AS Enrollment biPA CoPay Bundle Before (Rituxan Hycela)
....23.122 External - UAPI AS Enrollment biPA CoPay Bundle Before (Rituxan Onc)
....23.123 External - UAPI AS Enrollment biPA CoPay Bundle Before (Tecentriq)
....23.124 External - UAPI AS Enrollment biPA Starter Bundle Before (Alecensa)
....23.125 External - UAPI AS Enrollment for Evrysdi(Digital Consent)
....23.126 External - UAPI AS Enrollment for Herceptin plus Perjeta combo therapy (biPA)
....23.127 External - UAPI AS Enrollment for Rozlytrek (PSF only)
....23.128 External - UAPI AS Enrollment for Susvimo(Digital Consent)
....23.129 External - UAPI AS Enrollment for Venclexta
....23.130 External - UAPI AS Enrollment GPF Bundle Before
....23.131 External - UAPI AS Enrollment GPF Bundle Before (Susvimo)
....23.132 EXTERNAL - UAPI AS Enrollment Only
....23.133 External - UAPI AS GPF Enrollment Bundle for Herceptin
....23.134 External - UAPI Copay Enrollment Bundle 1 - copayCRX from PACT
....23.135 External - UAPI Copay Enrollment Bundle 1 - copayCRX1
....23.136 External - UAPI Copay Enrollment Bundle 2 with Combo Therapy
....23.137 External - UAPI Copay Explanation of Benefit in copay enrollment response
....23.138 External - UAPI Copay Explanation of Benefit in copay enrollment response
....23.139 External - UAPI Copay Explanation of Benefit in copay enrollment response
....23.140 External - UAPI Copay Operation Outcome in copay enrollment response with errors
....23.141 External - UAPI PCF only Bundle
....23.142 External - UAPI Query 2
....23.143 External - UAPI Query Response 1
....23.144 External - UAPI Response to Copay Enrollment - rejected
....23.145 External - UAPI Response to Copay Enrollment - success
....23.146 External - UAPI Response to Copay Enrollment for 2 Brands - success
....23.147 External - UAPI Response to Copay Search request - example returning 2 matching patients.
....23.148 External - UAPI Response to Copay Update request - example with status rejected for original copay enrollment request.
....23.149 Internal - UAPI AS Enrollment Bundle After
....23.150 Internal - UAPI AS Enrollment for MPS Redesign biPA Bundle Before (Ocrevus)
....23.151 Internal - UAPI Copay request-response combined bundle - error
....23.152 Internal - UAPI Copay request-response combined bundle - success
....23.153 Internal - UAPI Query 2
....23.154 Internal - UAPI Status Update C&R
....23.155 Internal - UAPI Status Update GPF
....23.156 mr-ActemraIntravenous
....23.157 mr-ActemraSubcutaneous
....23.158 mr-Alecensa
....23.159 mr-Alecensa-strt
....23.160 mr-Avastin
....23.161 mr-Avastin-empty
....23.162 mr-Cotellic
....23.163 mr-Enspryng
....23.164 mr-Erivedge
....23.165 mr-Esbriet
....23.166 mr-Evrysdi
....23.167 mr-Evrysdi-strt
....23.168 mr-Gavreto
....23.169 mr-Gavreto-strt
....23.170 mr-Gazyva
....23.171 mr-Gazyva-empty
....23.172 mr-Hemlibra
....23.173 mr-Herceptin
....23.174 mr-Herceptin-empty
....23.175 mr-HerceptinHylecta
....23.176 mr-HerceptinHylecta-empty
....23.177 mr-Kadcyla
....23.178 mr-Kadcyla-empty
....23.179 mr-Lucentis
....23.180 mr-Lucentis-empty
....23.181 mr-Lunsumio
....23.182 mr-Ocrevus
....23.183 mr-Ocrevus1
....23.184 mr-Perjeta
....23.185 mr-Perjeta-empty
....23.186 mr-Perjeta1
....23.187 mr-Phesgo
....23.188 mr-Phesgo-empty
....23.189 mr-Phesgo1
....23.190 mr-Polivy
....23.191 mr-Polivy-empty
....23.192 mr-Polivy1
....23.193 mr-Pulmozyme
....23.194 mr-Regimen
....23.195 mr-Regimen2
....23.196 mr-RituxanForImmunology
....23.197 mr-RituxanForOncology
....23.198 mr-RituxanHycela
....23.199 mr-RituxanHycela-empty
....23.200 mr-RituxanHycela1
....23.201 mr-RituxanImmunology
....23.202 mr-RituxanOncology
....23.203 mr-RituxanOncology-empty
....23.204 mr-Rozlytrek
....23.205 mr-Rozlytrek1
....23.206 mr-Tecentriq2
....23.207 mr-Tecentriq3
....23.208 mr-Vabysmo
....23.209 mr-Vabysmo-empty
....23.210 mr-Venclexta
....23.211 mr-Venclexta2
....23.212 mr-Xeloda
....23.213 mr-Xeloda2
....23.214 mr-Xolair
....23.215 mr-Zelboraf
....23.216 mr-Zelboraf1
....23.217 Patient Foundation QuestionnaireResponse example - Herceptin
....23.218 UAPI Consent - Digital Consent - Marketing Info
....23.219 UAPI Consent - Digital Consent - Patient
....23.220 UAPI Consent - Digital Consent - RelatedPerson
....23.221 UAPI MedicationRequest with complex dispense Injectable filled Device
....23.222 UAPI MedicationRequest with complex dispense instructions
....23.223 UAPI MedicationRequest with complex dispense instructions
....23.224 UAPI MedicationRequest without dosage