For AI agents: the documentation index is at /docs/payerbox/llms.txt. A Markdown version of this page is available at /docs/payerbox/data-integration/carin-bb/outpatient-institutional.md or by requesting it with the Accept: text/markdown header.
Payerbox Docs

Outpatient Institutional

Datasets

An outpatient institutional claim is a facility bill (UB-04) for services without an overnight stay: emergency room, hospital clinic, ambulatory surgery, therapy, dialysis, observation. It is the institutional sibling of the inpatient claim and shares its UB-04 columns, minus the stay. CARIN Blue Button STU 2.1.0 profiles it twice: the financial profile with amounts for Patient Access, and its parent Basis profile without amounts for Provider Access and Payer-to-Payer. You deliver one pair of files.

DatasetCARIN BB STU 2.1.0 target profile
claims_outpatientC4BB ExplanationOfBenefit Outpatient Institutional, served without amounts as Outpatient Institutional Basis
claims_outpatient_linesExplanationOfBenefit.item of the same profile

Both files carry every column from Explanation of Benefit. This page lists what the outpatient profile adds and where it tightens a shared rule.

claims_outpatient

One row per outpatient claim.

Bill

The UB-04 fields the profile keeps for an outpatient visit. Each is a supportingInfo entry tagged with its C4BBSupportingInfoType category. There is no admission period and no DRG.

ColumnRequiredFormat / valuesExample
claim_received_dateRecommendeddate the payer received the claim2026-04-14
type_of_billRecommendedUB-04 FL 04, as printed on the bill AHANUBCTypeOfBill0131
point_of_originRecommendedUB-04 FL 15 AHANUBCPointOfOriginForAdmissionOrVisit7
admission_typeRecommendedUB-04 FL 14 priority of the visit AHANUBCPriorityTypeOfAdmissionOrVisit1
discharge_statusRecommendedUB-04 FL 17 AHANUBCPatientDischargeStatus01
medical_record_numberIf availablethe provider's medical record number on the claimMR-88213
patient_account_numberIf availablethe provider's patient account number on the claimACC-472015
  • point_of_origin and admission_type keep their inpatient names because they are the same UB-04 form locators. On an outpatient bill they describe how the visit started, and the newborn rule still applies: an admission_type of 4 requires a code from the newborn point-of-origin set.
  • The NUBC code sets are licensed, so their value sets are linked to the IG rather than expanded here.

Care team

Same roles and same columns as the inpatient claim, bound to C4BBClaimInstitutionalCareTeamRole.

ColumnRequiredFormat / valuesExample
attending_provider_npiRecommended10 digits; key from practitioners9999999991
referring_provider_npiIf available10 digits; key from practitioners
operating_provider_npiIf a procedure10 digits; key from practitioners
other_operating_provider_npiIf available10 digits; key from practitioners
rendering_provider_npiIf available10 digits; key from organizations
primary_provider_npiIf available10 digits; key from practitioners
  • billing_provider_npi must be an organization, the facility that billed. Attending, referring and primary must resolve to a Practitioner and rendering to an Organization; operating and other operating may be either.

Diagnoses

Aligned ;-separated lists, the position being the diagnosis sequence. Outpatient claims have no present-on-admission indicator, and they add one type the inpatient claim lacks: the patient's reason for the visit.

ColumnRequiredFormat / valuesExample
diagnosis_codesYesICD-10-CM codes, ;-separated CDCICD910CMDiagnosisCodesR07.9;I10;R07.9
diagnosis_typesYesprincipal, other, externalcauseofinjury, patientreasonforvisit, aligned with diagnosis_codes C4BBClaimOutpatientInstitutionalDiagnosisTypeprincipal;other;patientreasonforvisit
diagnosis_code_systemIf not ICD-10-CMhttp://hl7.org/fhir/sid/icd-9-cm for visits coded before October 2015 (ICD-10-CM assumed when empty)
  • Exactly one position must be principal, sent first. patientreasonforvisit is UB-04 FL 70 and may repeat a code already listed as principal; send both positions.
  • ICD-10-PCS procedures are not collected on outpatient claims. What was done is carried by the CPT and HCPCS codes on the lines, where the profile expects it.

Adjudication

ColumnRequiredFormat / valuesExample
benefit_payment_statusYesinnetwork, outofnetwork, other C4BBPayerBenefitPaymentStatusinnetwork
billing_network_statusRecommendedinnetwork, outofnetwork; whether the billing facility had a contract with the plan on the date of service C4BBPayerProviderNetworkStatusinnetwork
adjustment_reason_codesIf reduced or deniedCARC or RARC codes explaining the noncovered amount, ;-separated X12 CARC and RARC18
adjustment_reason_systemIf RARChttps://x12.org/codes/remittance-advice-remark-codes (CARC, https://x12.org/codes/claim-adjustment-reason-codes, assumed when empty)
  • payment_date from the shared columns is must-support here. Send it whenever the claim was paid.

Amounts

The shared amount columns apply, with the same two institutional rules as inpatient: totals are mandatory, and adjudication amounts sit either on every line or on the claim row, never both. When the lines carry no amounts, Payerbox publishes the claim row's totals as the claim-level adjudication.

Set by Payerbox

ElementValue
typeinstitutional
subTypeoutpatient
useclaim
meta.profilethe Outpatient Institutional canonical with version 2.1.0
identifier.typeuc
insurance.focaltrue on the coverage from coverage_id
careTeam.sequence, supportingInfo.sequence, diagnosis.sequencenumbered from the columns and list positions

claims_outpatient_lines

One row per revenue line. Unlike inpatient, every outpatient line carries its own date of service, and the revenue code is optional.

ColumnRequiredFormat / valuesExample
revenue_codeRecommendedUB-04 FL 42, four characters with the leading zero AHANUBCRevenueCodes0450
service_codeIf billedCPT, HCPCS or HIPPS code on the line, with service_code_system C4BBEOBInstitutionalProcedureCodes99285
service_code_systemIf service_codehttp://www.ama-assn.org/go/cpt, https://www.cms.gov/Medicare/Coding/HCPCSReleaseCodeSets, https://www.cms.gov/Medicare/Medicare-Fee-for-Service-Payment/ProspMedicareFeeSvcPmtGen/HIPPSCodes (CPT assumed when empty)
modifier_codesIf billedCPT or HCPCS modifiers, ;-separated, same system as service_code AMACPTCMSHCPCSModifiersGP
service_date_startYesdate the service on this line was rendered2026-04-02
quantityRecommendeddecimal; units or visits billed on the line1
allowed_unitsIf adjudicateddecimal; units the payer allowed1
adjustment_reason_codesIf reduced or deniedCARC or RARC codes on the line, ;-separated X12 CARC and RARC
adjustment_reason_systemIf RARCas on the claim row (CARC assumed when empty)
  • service_date_start overrides the shared "Recommended": the outpatient profile requires a date on every line, and a single date rather than a period. Leave service_date_end blank; a multi-day service is one line per day.
  • service_code keeps the institutional override: a revenue line with no CPT or HCPCS is published with the not-applicable marker CARIN provides. Since the revenue code is also optional here, a line must carry at least one of the two, or it describes nothing and is rejected.
  • The amount columns follow the claim-or-lines rule: either every line in the claim carries its amounts, or none does.

These resources are served by Patient Access with amounts, and by Provider Access and Payer-to-Payer without them.

Last updated: