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

Clinical Notes

Datasets

US Core 6.1.0 maps each USCDI data element onto a FHIR element.

Notes and reports are the one part of the feed that is not only CSV: the document itself travels as a file in the delivery, and the CSV row points at it.

delivery-2026-08-19/
  csv/
    documents.csv
    diagnostic_reports.csv
  attachments/
    DOC-0001.pdf
    DR-0771.pdf

attachment_file holds the path relative to the delivery root. The folder name and nesting are yours to choose. Put no patient details in file or folder names.

documents

One row per note. The note itself is the file; this row is its index card.

ColumnRequiredFormat / valuesExample
record_idYesyour stable key for this noteDOC-0001
patient_identifierYespatient keyMRN-4471903
type_codeYesLOINC note type, e.g. 11488-4 consult, 18842-5 discharge summary, 34117-2 history and physical, 11506-3 progress note US Core DocumentReference Type11488-4
attachment_fileYespath relative to the delivery rootattachments/DOC-0001.pdf
document_dateRecommendeddatetime2026-04-18T10:00:00-04:00
author_npiRecommended10 digits, Luhn-valid over the 80840 prefix9999999995
encounter_idIf applicableencounters keyENC-9912
is_deletedIf retractingtrue retracts this rowtrue
  • type_code has a required binding, so the note type must come from that value set. It is large, but the four codes above cover most of what a payer holds.
  • Payerbox sets the status to current and the category to clinical-note, and reads the attachment's content type and size from the stored file. None of those are columns.

diagnostic_reports

One row per report. The individual results live in labs and clinical_observations and point back with diagnostic_report_id.

ColumnRequiredFormat / valuesExample
record_idYesyour stable key for this report; result rows reference itDR-771
patient_identifierYespatient keyMRN-4471903
report_kindYeslab or notelab
statusYesregistered, partial, preliminary, final, amended, corrected, appended, cancelled, entered-in-error, unknown diagnostic-report-statusfinal
codeYesLOINC, from the value set the report_kind profile binds, with code_system24323-8 lab, 39053-4 note
category_codeRecommendedLAB, RAD and the other v2-0074 service sectionsLAB
effective_datetimeRequired once status is partial, preliminary, final, amended, corrected or appendeddatetime2026-04-18T08:40:00-04:00
issuedRequired once status is partial, preliminary, final, amended, corrected or appendeddatetime2026-04-18T12:00:00-04:00
performer_npiIf available10 digits, Luhn-valid over the 80840 prefix9999999979
attachment_fileIf availablepath relative to the delivery rootattachments/DR-0771.pdf
encounter_idIf applicableencounters keyENC-9912
is_deletedIf retractingtrue retracts this rowtrue
  • report_kind picks the profile: lab for a laboratory report, note for everything else, including radiology and pathology narratives. The two bind code to different value sets, so a lab code on a note row falls outside the binding and the reverse too. Both bindings are extensible, so the code is not rejected, but a wrong report_kind silently produces the wrong profile.
  • attachment_file carries the narrative report as a file, the same way documents does. A lab report with structured results and no narrative needs none.
  • This dataset also serves the Laboratory and Diagnostic Imaging data classes, not only Clinical Notes.
  • effective_datetime and issued are not required on a registered or cancelled report, but US Core requires both once a report has results — send them on every partial, preliminary, final, amended, corrected or appended row, or that row is rejected.

These resources are served by Patient Access, Provider Access, Payer-to-Payer, and Prior Auth.

Last updated: