MAGENT

GI · LIVE

Forrest classification of ulcer bleeding

Forrest

Return the Forrest 1974 endoscopic lesion class (ia, ib, iia, iib, iic, or iii) and published description from a caller-assigned token.

LIVE $0.005 USDC GET /api/calc/forrest

Markdown: /docs/forrest.md · Canonical: https://magentlab.com/docs/forrest

Not a medical device. Not a diagnosis, dose, or listing recommendation.

What it computes

Return the Forrest 1974 endoscopic lesion class (ia, ib, iia, iib, iic, or iii) and published description from a caller-assigned token.

When to use

When an agent already has an endoscopic Forrest class as assigned at endoscopy and needs the canonical token and 1974 lesion wording. magent does not interpret endoscopy images. Not Glasgow-Blatchford and not Rockall.

When not to use

  • Not a medical device.
  • magent does not interpret endoscopy images. The caller assigns forrest as ia, ib, iia, iib, iic, or iii.
  • This tool is Forrest 1974 lesion class only. It does not report rebleeding percentages (Forrest 1974 does not publish them). Not Glasgow-Blatchford and not Rockall.

Formula

forrest in {ia, ib, iia, iib, iic, iii} as assigned by the caller (Forrest 1974); Ia active spurting, Ib active oozing, IIa non-bleeding visible vessel, IIb adherent clot, IIc flat pigmented haematin / coffee-ground base, III clean ulcer base

Citation

Title
Endoscopy in gastrointestinal bleeding
Authors
Forrest JA, Finlayson ND, Shearman DJ
Source
Lancet. 1974;2(7877):394-397
DOI
10.1016/s0140-6736(74)91770-x

Worked example

Forrest III clean ulcer base

Given: forrest=iii

  1. forrest iii → canonical iii
  2. description is clean ulcer base / no signs of recent hemorrhage

Also searched as

  • Forrest classification
  • Forrest class
  • endoscopic stigmata of recent hemorrhage
  • ulcer bleeding Forrest
  • Forrest 1974
  • GI bleeding endoscopy class
  • Forrest Ia Ib IIa
  • stigmata of recent haemorrhage

Try

Opens the live endpoint. Unpaid browser requests show the paywall; agents should send Accept: application/json.

/api/calc/forrest?forrest=iii

Full URL: https://api.magentlab.com/api/calc/forrest?forrest=iii

Call

Expect HTTP 402 until you retry with PAYMENT-SIGNATURE. Incomplete query params return HTTP 400 before any quote or charge.

curl -i -H "Accept: application/json" "https://api.magentlab.com/api/calc/forrest?forrest=iii"

Parameters

Name Type Required Description
forrest string required Forrest 1974 endoscopic lesion class as assigned by the caller: ia (active spurting hemorrhage), ib (active oozing hemorrhage), iia (non-bleeding visible vessel), iib (adherent clot), iic (flat pigmented haematin / coffee-ground base), or iii (clean ulcer base / no signs of recent hemorrhage). Case-insensitive. magent does not interpret endoscopy images.

Bulk (POST)

POST the same path with a JSON items array. The first item is the GET unit; each additional item is $0.002. Invalid items return HTTP 400 before settlement.

POST /api/calc/forrest Max 25 unit_amount + extra_item_amount * (n - 1) extra $0.002 PREVIEW

  • 1 to 25 items. Each item uses the same keys as the GET query parameters.
  • POST of 1 item costs the same as GET. Lists longer than 25: chunk into multiple POSTs. Extra items still execute; do not pad dummy rows.
  • The first invalid item fails the whole request (index in the 400 JSON). You are not charged.
  • HTTP 200 is {count, path, items}. Each items[i] is the GET 200 body for that row.
  • Catalog misses (empty matches, found=false) stay paid 200s inside that slot.
  • x402 resource URL is this path plus n and body_sha256. Browsers that prefer text/html get the same paywall as GET; Pay retries POST with the same items.

Example request (fixture)

{
  "items": [
    {
      "forrest": "iii"
    },
    {
      "forrest": "iii"
    }
  ]
}

Open bulk paywall →

Opens a two-item fixture on the API host. Unpaid browsers get the same MetaMask paywall as GET; Pay retries POST with those items.

Example 200 (fixture)

{
  "count": 2,
  "path": "/api/calc/forrest",
  "items": [
    {
      "description": "Clean ulcer base / no signs of recent hemorrhage",
      "disclaimer": "Not a medical device. Deterministic published-formula or published-code output for autonomous agents. A licensed clinician remains responsible for patient care and billing submissions.",
      "citation": {
        "authors": "Forrest JA, Finlayson ND, Shearman DJ",
        "doi": "10.1016/s0140-6736(74)91770-x",
        "id": "forrest-1974",
        "pmid": "4136718",
        "source": "Lancet. 1974;2(7877):394-397",
        "title": "Endoscopy in gastrointestinal bleeding"
      },
      "formula": "forrest",
      "formula_expression": "forrest in {ia, ib, iia, iib, iic, iii} as assigned by the caller (Forrest 1974); Ia active spurting, Ib active oozing, IIa non-bleeding visible vessel, IIb adherent clot, IIc flat pigmented haematin / coffee-ground base, III clean ulcer base",
      "criteria": [
        {
          "factor": "ia",
          "met": false
        },
        {
          "factor": "ib",
          "met": false
        },
        {
          "factor": "iia",
          "met": false
        },
        {
          "factor": "iib",
          "met": false
        },
        {
          "factor": "iic",
          "met": false
        },
        {
          "factor": "iii",
          "met": true
        }
      ],
      "forrest": "iii"
    },
    {
      "description": "Clean ulcer base / no signs of recent hemorrhage",
      "disclaimer": "Not a medical device. Deterministic published-formula or published-code output for autonomous agents. A licensed clinician remains responsible for patient care and billing submissions.",
      "citation": {
        "authors": "Forrest JA, Finlayson ND, Shearman DJ",
        "doi": "10.1016/s0140-6736(74)91770-x",
        "id": "forrest-1974",
        "pmid": "4136718",
        "source": "Lancet. 1974;2(7877):394-397",
        "title": "Endoscopy in gastrointestinal bleeding"
      },
      "formula": "forrest",
      "formula_expression": "forrest in {ia, ib, iia, iib, iic, iii} as assigned by the caller (Forrest 1974); Ia active spurting, Ib active oozing, IIa non-bleeding visible vessel, IIb adherent clot, IIc flat pigmented haematin / coffee-ground base, III clean ulcer base",
      "criteria": [
        {
          "factor": "ia",
          "met": false
        },
        {
          "factor": "ib",
          "met": false
        },
        {
          "factor": "iia",
          "met": false
        },
        {
          "factor": "iib",
          "met": false
        },
        {
          "factor": "iic",
          "met": false
        },
        {
          "factor": "iii",
          "met": true
        }
      ],
      "forrest": "iii"
    }
  ]
}

Response

Field Type Description
formula string forrest
formula_expression string Published Forrest 1974 class rule
forrest string Canonical lowercase class: ia, ib, iia, iib, iic, or iii
description string 1974 lesion wording for that class
criteria array Per-class rows with factor (ia, ib, iia, iib, iic, iii) and met; exactly one is met
citation object Forrest 1974 Lancet citation
disclaimer string Not-a-device notice

Example JSON

Machine form of the same example. Frozen fixture. Not a live lookup.

{
  "description": "Clean ulcer base / no signs of recent hemorrhage",
  "disclaimer": "Not a medical device. Deterministic published-formula or published-code output for autonomous agents. A licensed clinician remains responsible for patient care and billing submissions.",
  "citation": {
    "authors": "Forrest JA, Finlayson ND, Shearman DJ",
    "doi": "10.1016/s0140-6736(74)91770-x",
    "id": "forrest-1974",
    "pmid": "4136718",
    "source": "Lancet. 1974;2(7877):394-397",
    "title": "Endoscopy in gastrointestinal bleeding"
  },
  "formula": "forrest",
  "formula_expression": "forrest in {ia, ib, iia, iib, iic, iii} as assigned by the caller (Forrest 1974); Ia active spurting, Ib active oozing, IIa non-bleeding visible vessel, IIb adherent clot, IIc flat pigmented haematin / coffee-ground base, III clean ulcer base",
  "criteria": [
    {
      "factor": "ia",
      "met": false
    },
    {
      "factor": "ib",
      "met": false
    },
    {
      "factor": "iia",
      "met": false
    },
    {
      "factor": "iib",
      "met": false
    },
    {
      "factor": "iic",
      "met": false
    },
    {
      "factor": "iii",
      "met": true
    }
  ],
  "forrest": "iii"
}

Client errors (HTTP 400)

Invalid params return 400 without charge. Shared HTTP 402 and 503 meanings: Payments.

HTTP Code When
400 invalid_forrest forrest must be ia, ib, iia, iib, iic, or iii (Forrest 1974). Returned before settlement; you are not charged.
400 invalid_items POST body must be a JSON object with only an items array Returned before settlement; you are not charged.
400 invalid_item_count items must be an array of 1 to 25 objects Returned before settlement; you are not charged.
400 invalid_item each items entry must be a JSON object Returned before settlement; you are not charged.

Related tools

  • Glasgow-Blatchford score — Compute the Blatchford 2000 Glasgow-Blatchford score from urea, haemoglobin, systolic BP, heart rate, and four clinical flags.
  • Pre-endoscopy Rockall — Compute the Rockall 1996 pre-endoscopy (admission) score from age, heart rate, systolic blood pressure, and caller-assigned comorbidity after acute upper gastrointestinal haemorrhage.

Payment

Unpaid requests return HTTP 402 even if query parameters or POST items are missing or invalid, so CDP and agents can index the path. After a PAYMENT-SIGNATURE, invalid params return HTTP 400 JSON before settlement. magent does not charge. Fix the params, then request a new 402 quote for that complete URL. Catalog misses (empty matches, found=false) are valid paid 200s. Unpaid valid requests return HTTP 402 with a base64 PAYMENT-REQUIRED header. HTTP 503 is not a new quote: retry the same PAYMENT-SIGNATURE. Full handshake and shared payment errors: Payments. Stdio MCP: /docs/mcp.

Guarantees

  • HTTP 402 is unpaid, including a missing query. After PAYMENT-SIGNATURE, invalid parameters return HTTP 400 before settlement. You are not charged. HTTP 402 never includes the tool JSON.
  • exact: settlement finishes before the tool (paymentFlow upfront). batch-settlement: verify/deposit before the tool; chargedCumulativeAmount commits after HTTP 2xx. Uncertain or failed settlement fails closed (HTTP 503). Retry the same PAYMENT-SIGNATURE.
  • HTTP 402 is unpaid only. Do not sign a second authorization because of a 503.
  • Execution is timeout-bounded and concurrency-capped.
  • Calculator inputs are stored encrypted for allowlisted operators (Magent Console). They are not in public logs, SSH lookups, catalog, or rollups. Request logs store path without query.