Circle V2 API Docs
    Preparing search index...
    • The single definition of "the rendered text of this chart".

      Priority order:

      1. An emr_document with a type and a body renders through EMRDocumentFormatter.
      2. A patient_chart upload renders its extracted notes/fields as JSON.
      3. Anything left over falls back to raw_document.__circle_parsed_content.parsed_text.
      4. Otherwise there is no text.

      Parsed content is a fallback rather than the first choice on purpose. For an EMR document it is a snapshot of this formatter's output taken when the document was embedded, so preferring it would serve stale text whenever a formatter changes. It earns its place covering the cases the formatter cannot: uploads whose text was extracted from a PDF, and document types the formatter throws on.

      Never throws — EMRDocumentFormatter.format throws on unsupported types and on malformed bodies, and one unrenderable document must not fail a whole batch.

      Parameters

      Returns ChartTextResolution