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

Oral

Datasets

An oral claim is a dental bill (ADA Dental Claim Form) from a dentist, dental group or dental clinic, coded in CDT and located on teeth, surfaces and areas of the mouth. It is built like a professional claim: adjudication happens on the lines, and the claim row carries totals. 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_oralC4BB ExplanationOfBenefit Oral, served without amounts as Oral Basis
claims_oral_linesExplanationOfBenefit.item of the same profile

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

claims_oral

One row per dental claim.

Claim

ColumnRequiredFormat / valuesExample
claim_received_dateRecommendeddate the payer received the claim2026-03-18
service_facility_npiIf not the billing provider's place10 digits; key from organizations; where the service was rendered when it is neither the billing provider nor the patient's home9999999993
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-530118
orthodontics_monthsIf orthodonticsdecimal; months of orthodontic treatment, from the ADA claim form. Send 1 when your system only holds a yes/no orthodontics flag24
prosthesis_replacementIf a prosthesistrue when the prosthesis replaces an existing one, false when it is the firsttrue
missing_tooth_numbersIf a prosthesisteeth already missing, ;-separated tooth numbers ADAUniversalNumberingSystem18;19;30
  • billing_provider_npi may resolve to a Practitioner or an Organization: a solo dentist bills under their own NPI, a group under the practice's.
  • CARIN carries the orthodontics indicator as a quantity, not a flag, so orthodontics_months is a number. prosthesis_replacement is the yes/no from the ADA form's "replacement of prosthesis" item.
  • The ADA tooth numbering and CDT procedure codes are licensed. Tooth numbers and surfaces are small enough to be expanded here; the CDT value set is linked to the IG.

Care team

One column per role, bound to C4BBClaimProfessionalAndNonClinicianCareTeamRole, the same set as professional claims.

ColumnRequiredFormat / valuesExample
rendering_provider_npiRecommended10 digits; key from practitioners; the treating dentist9999999991
rendering_provider_taxonomyIf availableNUCC taxonomy code the dentist billed under Healthcare Provider Taxonomy122300000X
referring_provider_npiIf available10 digits; key from practitioners
supervising_provider_npiIf available10 digits; key from practitioners
primary_provider_npiIf available10 digits; key from practitioners
purchased_service_provider_npiIf available10 digits; key from practitioners or organizations; a dental laboratory, for example
  • Rendering, referring, supervising and primary must resolve to a Practitioner. Purchased service may be either.

Diagnoses

Optional on dental claims, unlike every other type. When sent, they follow the professional shape: aligned ;-separated lists with principal first.

ColumnRequiredFormat / valuesExample
diagnosis_codesIf availableICD-10-CM codes, ;-separated CDCICD910CMDiagnosisCodesK02.52
diagnosis_typesIf diagnosis_codesprincipal, secondary, aligned with diagnosis_codes C4BBClaimProfessionalAndNonClinicianDiagnosisTypeprincipal
diagnosis_code_systemIf not ICD-10-CMhttp://hl7.org/fhir/sid/icd-9-cm for services before October 2015 (ICD-10-CM assumed when empty)

Adjudication

Oral is the one claim type that carries the benefit payment status at both levels and requires the rendering network status.

ColumnRequiredFormat / valuesExample
benefit_payment_statusYesinnetwork, outofnetwork, other; how the claim as a whole was paid against the member's dental benefit C4BBPayerBenefitPaymentStatusinnetwork
rendering_network_statusYesinnetwork, outofnetwork; whether the treating dentist had a contract with the plan on the date of service C4BBPayerProviderNetworkStatusinnetwork
billing_network_statusRecommendedinnetwork, outofnetwork; the same for the billing providerinnetwork
  • Each line also carries its own benefit_payment_status. The claim-level value summarizes the claim; where the lines differ, send other on the claim and the real value on each line.
  • payment_date from the shared columns is must-support here. Send it whenever the claim was paid.

Amounts

The shared amount columns on the claim row become the claim totals, which are mandatory: at least one must be filled. The oral profile has no claim-level adjudication amounts; line amounts are mandatory, see below.

Set by Payerbox

ElementValue
typeoral
useclaim
meta.profilethe Oral canonical with version 2.1.0
identifier.typeuc
insurance.focaltrue on the coverage from coverage_id
careTeam.sequence, supportingInfo.sequence, diagnosis.sequence, item.informationSequencenumbered from the columns and list positions

claims_oral_lines

One row per dental procedure. Each line names the procedure, where it was done, and which tooth, surfaces or area of the mouth it applies to.

ColumnRequiredFormat / valuesExample
service_codeYesCDT procedure code ADADentalProcedureCodeD2392
service_code_systemNohttp://www.ada.org/cdt is the only system here (assumed when empty)
modifier_codesIf billedCPT or HCPCS modifiers, ;-separated AMACPTCMSHCPCSModifiers
service_date_startYesdate the procedure was performed2026-03-12
service_date_endIf a perioddate a multi-visit procedure ended; blank otherwise
place_of_serviceYestwo-digit CMS place-of-service code CMSPlaceofServiceCodes11
tooth_numberIf a tooththe tooth the procedure was done on: 1 to 32, or A to T for primary teeth ADAUniversalNumberingSystem19
oral_cavity_areaIf an areathe area of the mouth when the procedure is not on one tooth: 00 whole mouth, 01 upper arch, 02 lower arch, 10 20 30 40 quadrants OralBodySite02
tooth_surfacesIf surfacessurfaces treated, ;-separated: M, O, I, D, B, F, L C4BBSurfaceCodesM;O
additional_tooth_numbersIf several teethfurther teeth or areas the same line covers, ;-separated, same values as tooth_number and oral_cavity_area18;20
quantityIf availabledecimal; units billed on the line1
diagnosis_sequencesIf availablepositions in the claim's diagnosis_codes this line was billed against, ;-separated1
benefit_payment_statusYesinnetwork, outofnetwork, other; how this line was paid C4BBPayerBenefitPaymentStatusinnetwork
allowed_unitsIf adjudicateddecimal; units the payer allowed1
adjustment_reason_codeIf reduced or deniedone CARC or RARC code explaining the noncovered amount X12 CARC and RARC96
adjustment_reason_systemIf RARChttps://x12.org/codes/remittance-advice-remark-codes (CARC, https://x12.org/codes/claim-adjustment-reason-codes, assumed when empty)
amount columnsYes, at least oneline-level adjudication, one column per category
  • service_code is mandatory on every line and is a CDT code, five characters starting with D. No other system is accepted; a line coded in CPT belongs on a professional claim.
  • tooth_number and oral_cavity_area are one FHIR element, the body site. Send one or the other: a filling names a tooth, a denture or a cleaning names an arch or the whole mouth. Payerbox chooses the code system from which column is filled.
  • tooth_surfaces belongs to the tooth in tooth_number. Surfaces on a line with no tooth are rejected.
  • additional_tooth_numbers covers procedures that span several teeth, such as a bitewing radiograph. The first tooth goes in tooth_number; the rest here. Each becomes an additional body-site entry linked to this line, which is how CARIN requires them to be carried.
  • benefit_payment_status and at least one amount are mandatory on every line. adjustment_reason_code is a single code, as on professional claims.

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

Last updated: