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

Table of Contents

.. 0 Table of Contents
... 1 Home
... 2 Changes
... 3 Combo Therapies
... 4 Copay Eligibility Questions
... 5 Copay Mapping
... 6 Copay Value Sets
... 7 Enrollment
... 8 Enrollment Mapping
... 9 Error Handling
... 10 History
... 11 Message Structure
... 12 Message Submission
... 13 Onboarding
... 14 Products Specifics
... 15 Questionnaire
... 16 Regimen Products
... 17 Release 2024 August 5
... 18 Release 2024 Dec 13
... 19 Release 2024 July
... 20 Release 2024 June 14
... 21 Release 2024 June 28
... 22 Release 2024 May 17
... 23 Release 2024 May 3
... 24 Release 2024 May 31
... 25 Release 2024 Nov 15
... 26 Release 2024 Nov 29
... 27 Release 2024 Oct 11
... 28 Release 2024 Oct 18
... 29 Release 2024 Oct 29
... 30 Release 2024 Oct 4
... 31 Release 2024 Sept 25
... 32 Release 2025 Apr
... 33 Release 2025 Feb 14
... 34 Release 2025 Feb 28
... 35 Release 2025 Jan 31
... 36 Release 2025 Jul 03
... 37 Release 2025 Oct
... 38 Release 2026 APR
... 39 Release 2026 Feb 06
... 40 Release 2026 Jun 12
... 41 Release 2026 Jun 18
... 42 Release 2026 MAR
... 43 Release 2026 May 01
... 44 Release 2026 May 15
... 45 Release 2026 May 29
... 46 Release Q 42025
... 47 Search Conventions
... 48 Services
... 49 Status Update Mapping
... 50 Systematic Queries
... 51 Technical Hints
... 52 Testing
... 53 Updates
... 54 Use Cases
... 55 Validation Rules
... 56 Artifacts Summary
.... 56.1 UAPI CapabilityStatement - Genentech FHIR Server
.... 56.2 ServiceRequestTypeSearch
.... 56.3 External - Alecensa Questionnaire
.... 56.4 External - Cotellic Copay Questionnaire
.... 56.5 External - Cotellic Questionnaire
.... 56.6 External - Herceptin Questionnaire
.... 56.7 External - Lucentis Questionnaire
.... 56.8 UAPI Bundle - AS Enrollment
.... 56.9 UAPI Bundle - Copay Enrollment
.... 56.10 UAPI Bundle - Copay Error Reconciliation
.... 56.11 UAPI Bundle - Copay Management
.... 56.12 UAPI Bundle - Copay Request-Response
.... 56.13 UAPI Bundle - Patient Consent Form Only Enrollment
.... 56.14 UAPI Bundle - Query Message
.... 56.15 UAPI Bundle - Query Response Message
.... 56.16 UAPI Bundle - Query Response Multi Patient Message
.... 56.17 UAPI Bundle - Search Result
.... 56.18 UAPI Bundle - Search Result Patient
.... 56.19 UAPI Bundle - Status Update
.... 56.20 UAPI Condition
.... 56.21 UAPI Consent
.... 56.22 UAPI Coverage
.... 56.23 UAPI CoverageEligibilityRequest
.... 56.24 UAPI CoverageEligibilityResponse
.... 56.25 UAPI MedicationRequest
.... 56.26 UAPI MessageHeader
.... 56.27 UAPI Organization
.... 56.28 UAPI Patient
.... 56.29 UAPI Practitioner
.... 56.30 UAPI Provenance
.... 56.31 UAPI RelatedPerson
.... 56.32 UAPI ServiceRequest
.... 56.33 Exact ContactPoint Extension
.... 56.34 UAPI # of Appeals Allowed
.... 56.35 UAPI Additional Documents Required
.... 56.36 UAPI Appeal Submission Deadline
.... 56.37 UAPI BI - Benefits Summary
.... 56.38 UAPI BI - Billing Instructions
.... 56.39 UAPI BI - Specialty Pharmacy
.... 56.40 UAPI Coverage - Card issuance date
.... 56.41 UAPI Coverage Plan Year
.... 56.42 UAPI Coverage Reference Number
.... 56.43 UAPI CoverageEligibilityRequest Product
.... 56.44 UAPI CoverageEligibilityRequest ServiceRequestType
.... 56.45 UAPI CoverageEligibilityResponse Shipment Method
.... 56.46 UAPI CoverageEligibilityResponse Status
.... 56.47 UAPI Estimated Appeal TAT
.... 56.48 UAPI MedicationRequest Dispense Quantity Detailed Breakdown
.... 56.49 UAPI MedicationRequest Dispenser Instructions
.... 56.50 UAPI MessageHeader Timestamp
.... 56.51 UAPI PCP Referral Effective Date
.... 56.52 UAPI PCP Referral On-file?
.... 56.53 UAPI PCP Referral Recertification Date
.... 56.54 UAPI PCP Referral Required?
.... 56.55 UAPI Peer to Peer Available
.... 56.56 UAPI Practitioner Preferred Contact Method
.... 56.57 UAPI Practitioner Shipment Method
.... 56.58 UAPI PreD Est. TAT
.... 56.59 UAPI Prior Auth Est. TAT
.... 56.60 UAPI Spend Down Frequency
.... 56.61 UAPI Value Set - Benefit Type
.... 56.62 UAPI Value Set - Copay Adjudication Categories
.... 56.63 UAPI Value Set - Copay Insurance Plan Types
.... 56.64 UAPI Value Set - Coverage Outcome
.... 56.65 UAPI Value Set - Insurance Unit
.... 56.66 UAPI Value Set - Organization Type
.... 56.67 UAPI Value Set - PreDetermination
.... 56.68 UAPI Value Set - Prescriber Contact Method
.... 56.69 UAPI Value Set - Prescriber Contact Time
.... 56.70 UAPI Value Set - Product Authorization
.... 56.71 UAPI Value Set - Product JCode
.... 56.72 UAPI Value Set - Product Name
.... 56.73 UAPI Value Set - Product Service
.... 56.74 UAPI Value Set - Regimen Product Name
.... 56.75 UAPI Value Set - Service Request Type
.... 56.76 UAPI Value Set - Shipment Method
.... 56.77 UAPI Value Set - Specialty Pharmacy
.... 56.78 UAPI Value Set - System Event Type
.... 56.79 UAPI Code System - Authorization-Supporting Documents Submission
.... 56.80 UAPI Code System - Benefit Type
.... 56.81 UAPI Code System - Copay Adjudication Category
.... 56.82 UAPI Code System - Copay assigned card type
.... 56.83 UAPI Code System - Copay Benefit Types
.... 56.84 UAPI Code System - Copay Brand ID
.... 56.85 UAPI Code System - Copay Claim Status
.... 56.86 UAPI Code System - Copay Claim Supporting Information Category
.... 56.87 UAPI Code System - Copay CRX enrollment channel
.... 56.88 UAPI Code System - Copay CRX enrollment status
.... 56.89 UAPI Code System - Copay CRX workflow selection
.... 56.90 UAPI Code System - Copay Enrollment Errors
.... 56.91 UAPI Code System - Copay Genentech processing error
.... 56.92 UAPI Code System - Copay Insurance Plan Types
.... 56.93 UAPI Code System - Copay Payment Type
.... 56.94 UAPI Code System - Copay Task input types
.... 56.95 UAPI Code System - Copay Task output types
.... 56.96 UAPI Code System - Copay Who is applying
.... 56.97 UAPI Code System - CoverageEligibilityRequest outcome
.... 56.98 UAPI Code System - Event Type
.... 56.99 UAPI Code System - Insurance Unit
.... 56.100 UAPI Code System - PreDetermination
.... 56.101 UAPI Code System - Prescriber Contact Methods
.... 56.102 UAPI Code System - Prescriber Contact Times
.... 56.103 UAPI Code System - Product JCode
.... 56.104 UAPI Code System - Product Names
.... 56.105 UAPI Code System - Product/Service
.... 56.106 UAPI Code System - Regimen Product Names
.... 56.107 UAPI Code System - Service Request Type
.... 56.108 UAPI Code System - Shipment Methods
.... 56.109 UAPI Code System - Specialty Pharmacy
.... 56.110 as-venclexta-mr
.... 56.111 External - Alecensa QuestionnaireResponse
.... 56.112 External - Herceptin Hylecta QuestionnaireResponse
.... 56.113 External - Medication Request: Actemra Intravenous
.... 56.114 External - Medication Request: Actemra Subcutaneous
.... 56.115 External - Medication Request: Enspryng
.... 56.116 External - Medication Request: Evrysdi
.... 56.117 External - Medication Request: Hemlibra
.... 56.118 External - Medication Request: Itovebi
.... 56.119 External - Medication Request: Ocrevus
.... 56.120 External - Medication Request: Ocrevus Zunovo - GPF
.... 56.121 External - Medication Request: Ocrevus Zunovo - Starter
.... 56.122 External - Medication Request: Pulmozyme
.... 56.123 External - Medication Request: Rituxan for Immunology
.... 56.124 External - Medication Request: Tecentriq Hybreza
.... 56.125 External - MedicationRequest: Alecensa
.... 56.126 External - MedicationRequest: Cotellic
.... 56.127 External - MedicationRequest: Erivedge
.... 56.128 External - MedicationRequest: Herceptin
.... 56.129 External - MedicationRequest: Lucentis
.... 56.130 External - MedicationRequest: Lunsumio
.... 56.131 External - MedicationRequest: Rozlytrek
.... 56.132 External - MedicationRequest: Vabysmo
.... 56.133 External - Resource Example: OperationOutcome 
.... 56.134 External - Resource Example: Organization (Practice)
.... 56.135 External - Resource Example:  MessageHeader
.... 56.136 External - Rozlytrek QuestionnaireResponse
.... 56.137 External - SOT Organization example
.... 56.138 External - UAPI AS Digital Consent: Consent by RelatedPerson
.... 56.139 External - UAPI AS Enrollment: Actemra Subcutaneous
.... 56.140 External - UAPI AS Enrollment: Alecensa
.... 56.141 External - UAPI AS Enrollment: Avastin
.... 56.142 External - UAPI AS Enrollment: Columvi
.... 56.143 External - UAPI AS Enrollment: Cotellic
.... 56.144 External - UAPI AS Enrollment: Enspryng
.... 56.145 External - UAPI AS Enrollment: Erivedge
.... 56.146 External - UAPI AS Enrollment: Gazyva
.... 56.147 External - UAPI AS Enrollment: Hemlibra
.... 56.148 External - UAPI AS Enrollment: Herceptin Hylecta
.... 56.149 External - UAPI AS Enrollment: Lucentis
.... 56.150 External - UAPI AS Enrollment: Ocrevus
.... 56.151 External - UAPI AS Enrollment: Perjeta
.... 56.152 External - UAPI AS Enrollment: Polivy
.... 56.153 External - UAPI AS Enrollment: Pulmozyme
.... 56.154 External - UAPI AS Enrollment: Rituxan for Immunology
.... 56.155 External - UAPI AS Enrollment: Rituxan for Oncology
.... 56.156 External - UAPI AS Enrollment: Rituxan Hycela
.... 56.157 External - UAPI AS Enrollment: Rozlytrek
.... 56.158 External - UAPI AS Enrollment: Susvimo
.... 56.159 External - UAPI AS Enrollment: Vabysmo
.... 56.160 External - UAPI AS Enrollment: Venclexta
.... 56.161 External - UAPI AS Enrollment: Xolair
.... 56.162 External - UAPI AS Enrollment: Evrysdi
.... 56.163 External - UAPI AS Enrollment: Kadcyla
.... 56.164 External - UAPI AS Enrollment: Phesgo
.... 56.165 External - UAPI AS Enrollment: Tecentriq
.... 56.166 External - UAPI AS Patient Consent Only
.... 56.167 External - UAPI AS Patient Consent: Consent for Marketing Info
.... 56.168 External - UAPI Copay Card Enrollment REQUEST 1
.... 56.169 External - UAPI Copay Card Enrollment REQUEST 2
.... 56.170 External - UAPI Copay Card Enrollment REQUEST 3
.... 56.171 External - UAPI Copay Card Enrollment REQUEST 4
.... 56.172 External - UAPI Copay Card Enrollment REQUEST 5
.... 56.173 External - UAPI Copay Card Enrollment REQUEST 6
.... 56.174 External - UAPI Copay Card Enrollment RESPONSE 1
.... 56.175 External - UAPI Copay Card Enrollment RESPONSE 2
.... 56.176 External - UAPI Copay Card Enrollment RESPONSE 3
.... 56.177 External - UAPI Copay claim upsert - bundle of claim bundles
.... 56.178 External - UAPI Copay Explanation of Benefit in copay enrollment response
.... 56.179 External - UAPI Copay Explanation of Benefit in copay enrollment response
.... 56.180 External - UAPI Copay Operation Outcome in copay enrollment response with errors
.... 56.181 External - UAPI Copay request-response enrollment bundle - success
.... 56.182 External - UAPI Copay Search Request
.... 56.183 External - UAPI Copay Update Request
.... 56.184 External - UAPI Copay Update Response
.... 56.185 External - UAPI GPF Enrollment: Herceptin
.... 56.186 External - UAPI GPF Enrollment: Lunsumio
.... 56.187 External - UAPI GPF Enrollment: Itovebi
.... 56.188 External - UAPI GPF Enrollment: Susvimo
.... 56.189 External - UAPI Response to Copay Search request - example returning 2 matching patients.
.... 56.190 External - UAPI Status Query REQUEST
.... 56.191 External - UAPI Status Query RESPONSE:  BIPA
.... 56.192 External - UAPI Status Query RESPONSE:  GPF
.... 56.193 Internal - UAPI AS Enrollment for MPS Redesign biPA Bundle Before (Ocrevus)
.... 56.194 Internal - UAPI Copay request-response combined bundle - error
.... 56.195 Internal - UAPI Copay request-response combined bundle - success
.... 56.196 Internal - UAPI Query 2
.... 56.197 Internal - UAPI Status Update C&R
.... 56.198 Internal - UAPI Status Update GPF
.... 56.199 mr-Avastin
.... 56.200 mr-Columvi
.... 56.201 mr-Gazyva
.... 56.202 mr-HerceptinHylecta
.... 56.203 mr-Kadcyla
.... 56.204 mr-Perjeta
.... 56.205 mr-Perjeta1
.... 56.206 mr-Phesgo
.... 56.207 mr-Phesgo1
.... 56.208 mr-Polivy
.... 56.209 mr-Polivy1
.... 56.210 mr-Pulmozyme
.... 56.211 mr-Regimen
.... 56.212 mr-Regimen2
.... 56.213 mr-RituxanForOncology
.... 56.214 mr-RituxanHycela
.... 56.215 mr-RituxanHycela1
.... 56.216 mr-RituxanOncology
.... 56.217 mr-Tecentriq2
.... 56.218 mr-Tecentriq3
.... 56.219 mr-xolair
.... 56.220 mr-Zelboraf
.... 56.221 mr-Zelboraf1