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/inpatient-institutional.md or by requesting it with the Accept: text/markdown header.
Payerbox Docs

Inpatient Institutional

Datasets

An inpatient institutional claim is a facility bill (UB-04) for a stay with an admission and a discharge: hospital, skilled nursing, rehabilitation, psychiatric. CARIN Blue Button STU 2.1.0 profiles it twice. The financial profile carries the amounts and is what Patient Access serves. Its parent, the Basis profile, is the same claim without amounts and is what Provider Access and Payer-to-Payer serve. You deliver one pair of files; Payerbox produces both forms.

DatasetCARIN BB STU 2.1.0 target profile
claims_inpatientC4BB ExplanationOfBenefit Inpatient Institutional, served without amounts as Inpatient Institutional Basis
claims_inpatient_linesExplanationOfBenefit.item of the same profile

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

claims_inpatient

One row per inpatient claim.

Stay

The admission, the bill and the discharge. In FHIR these are supportingInfo entries, one per column, each tagged with its C4BBSupportingInfoType category.

ColumnRequiredFormat / valuesExample
claim_received_dateRecommendeddate the payer received the claim2026-02-12
admission_dateYesdate; the day the member was admitted, which may precede billable_period_start for a continuing stay2026-02-03
discharge_dateIf dischargeddate; the day the member was discharged or died. Blank for a stay still open at statement end2026-02-09
type_of_billRecommendedUB-04 FL 04, as printed on the bill AHANUBCTypeOfBill0111
point_of_originRecommendedUB-04 FL 15 AHANUBCPointOfOriginForAdmissionOrVisit1
admission_typeRecommendedUB-04 FL 14 priority of admission AHANUBCPriorityTypeOfAdmissionOrVisit1
discharge_statusRecommendedUB-04 FL 17 AHANUBCPatientDischargeStatus01
drg_codeRecommendedthe DRG the stay was grouped to, with drg_system and drg_version CMSMS3MAPAPRDRG291
drg_systemIf not MS-DRGhttp://uri.hddaccess.com/cs/apdrg AP-DRG, http://uri.hddaccess.com/cs/aprdrg APR-DRG (MS-DRG assumed when empty)
drg_versionRecommendedgrouper version the code belongs to43
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-448210
  • admission_date and discharge_date are one FHIR element, the admission period. CARIN requires the period on every inpatient claim, so admission_date is mandatory even when the bill covers only part of the stay. When a discharge_date is present, discharge_status should say how the stay ended.
  • type_of_bill is the four-character code as it appears in FL 04, with the leading zero. The three digits after it are the facility type, the bill classification and the frequency.
  • point_of_origin values differ for newborn admissions. When admission_type is 4 (newborn), send a code from the newborn point-of-origin set, and otherwise from the standard set; CARIN rejects the combination the other way around.
  • A DRG is only meaningful with its grouper: drg_code 291 is a different diagnosis group under MS-DRG than under APR-DRG. Send drg_version whenever your system holds it.
  • The NUBC code sets and the DRG groupers are licensed, so their value sets are linked to the IG rather than expanded here. Send the codes as your adjudication system holds them.

Care team

One column per role. The role is the column name, the value is the provider. Roles are 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 practitioners9999999991
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
  • On an institutional claim the billing_provider_npi from the shared columns must be an organization, the facility that billed. CARIN restricts the inpatient profile's provider to an Organization, so a row whose billing NPI resolves to a practitioner is rejected.
  • CARIN fixes who each role can be: attending, referring and primary must resolve to a Practitioner, rendering to an Organization. Operating and other operating may be either. A role whose NPI is defined in the wrong dataset is reported.

Diagnoses

An inpatient claim carries a principal diagnosis, optionally an admitting diagnosis, up to twenty-four other diagnoses and external cause of injury codes. They travel as four positionally aligned ;-separated lists; the position is the diagnosis sequence.

ColumnRequiredFormat / valuesExample
diagnosis_codesYesICD-10-CM codes, ;-separated CDCICD910CMDiagnosisCodesI50.23;N18.4;E11.22
diagnosis_typesYesprincipal, admitting, other, externalcauseofinjury, aligned with diagnosis_codes C4BBClaimInpatientInstitutionalDiagnosisTypeprincipal;other;other
diagnosis_poaRecommendedpresent-on-admission indicator per diagnosis: Y, N, U, W, 1, aligned; leave a position empty where not reported CMSPresentOnAdmissionIndicatorY;Y;N
diagnosis_code_systemIf not ICD-10-CMhttp://hl7.org/fhir/sid/icd-9-cm for stays coded before October 2015 (ICD-10-CM assumed when empty)
  • Exactly one position must be principal. Send the principal first: it makes the file readable, and the sequence numbers a member sees on the EOB start from it.
  • The same code may appear twice when it is both the admitting and the principal diagnosis. Send both positions; they are distinct entries in FHIR.

Procedures

Inpatient procedures are ICD-10-PCS, one per position, aligned like the diagnoses.

ColumnRequiredFormat / valuesExample
procedure_codesIf anyICD-10-PCS codes, ;-separated CMSICD910PCSProcedureCodes4A023N7;B211YZZ
procedure_typesIf anyprincipal, other, aligned with procedure_codes C4BBClaimProcedureTypeprincipal;other
procedure_datesRecommendeddates, aligned; the day each procedure was performed2026-05-12;2026-05-12
procedure_code_systemIf not ICD-10-PCShttp://www.cms.gov/Medicare/Coding/ICD9 for ICD-9-CM volume 3 (ICD-10-PCS, http://www.cms.gov/Medicare/Coding/ICD10, assumed when empty)

Adjudication

The claim-level adjudication decisions that are not amounts.

ColumnRequiredFormat / valuesExample
benefit_payment_statusYesinnetwork, outofnetwork, other; how the claim was paid against the member's benefits C4BBPayerBenefitPaymentStatusinnetwork
billing_network_statusRecommendedinnetwork, outofnetwork; whether the billing facility had a contract with the plan on the admission date C4BBPayerProviderNetworkStatusinnetwork
adjustment_reason_codesIf reduced or deniedCARC or RARC codes explaining the noncovered amount, ;-separated X12 CARC and RARC242
adjustment_reason_systemIf RARChttps://x12.org/codes/remittance-advice-remark-codes (CARC, https://x12.org/codes/claim-adjustment-reason-codes, assumed when empty)
  • benefit_payment_status is mandatory on every inpatient claim. It answers how the member's benefits were applied, and can differ from billing_network_status: an out-of-network facility paid at in-network benefits for an emergency is outofnetwork for the provider and innetwork for the benefit.
  • payment_date from the shared columns is must-support here. Send it whenever the claim was paid.

Amounts

The shared amount columns apply, with two inpatient rules.

  • Totals are mandatory: at least one amount column on the claim row must be filled. Send every total your system holds; submitted_amount, eligible_amount, benefit_amount, paid_to_provider_amount and paid_by_patient_amount are the ones members look for.
  • CARIN allows an institutional claim to carry its adjudication amounts either on the lines or on the claim, never both. Fill the amount columns on the lines when your system adjudicates line by line. Leave every line amount blank when the claim was priced as a whole, as with a DRG payment, and Payerbox publishes the claim row's totals as the claim-level adjudication too. A delivery with amounts on both the claim row and its lines is rejected.

Set by Payerbox

These profile elements have no column. Payerbox fixes them from the dataset or derives them from other columns.

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

claims_inpatient_lines

One row per revenue line. Every line carries a revenue code; a procedure code is present only where the facility billed one.

ColumnRequiredFormat / valuesExample
revenue_codeYesUB-04 FL 42, four characters with the leading zero AHANUBCRevenueCodes0120
service_codeIf billedCPT, HCPCS or HIPPS code on the line, with service_code_system C4BBEOBInstitutionalProcedureCodes80053
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 AMACPTCMSHCPCSModifiers26
quantityRecommendeddecimal; units, days or visits billed on the line6
allowed_unitsIf adjudicateddecimal; units the payer allowed6
adjustment_reason_codesIf reduced or deniedCARC or RARC codes on the line, ;-separated X12 CARC and RARC97
adjustment_reason_systemIf RARCas on the claim row (CARC assumed when empty)
  • service_code overrides the shared rule that every line needs one. Room and board, operating room time and most ancillary revenue lines carry no CPT or HCPCS. On such a line Payerbox fills the profile's mandatory procedure element with the not-applicable marker CARIN provides for exactly this case.
  • service_date_start and service_date_end from the shared columns are optional here; the stay's dates live on the claim row. Send them where a line has its own dates, such as a single-day procedure inside a longer stay.
  • quantity is what the facility billed, allowed_units what the payer allowed. Both are plain numbers; a room and board line for a six-day stay has quantity 6.
  • The amount columns follow the claim-or-lines rule above: 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: