GI · LIVE

Rome IV functional heartburn

Rome IV Heartburn

Apply the Aziz 2016 Rome IV functional heartburn diagnostic criteria and return whether the published functional heartburn box holds (rome_iv_heartburn).

LIVE $0.005 USDC GET /api/calc/rome_iv_heartburn

Markdown: /docs/rome-iv-heartburn.md · Canonical: https://magentlab.com/docs/rome-iv-heartburn

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

What it computes

Apply the Aziz 2016 Rome IV functional heartburn diagnostic criteria and return whether the published functional heartburn box holds (rome_iv_heartburn).

When to use

When an agent already has the six caller-assigned Aziz 2016 Rome IV functional heartburn flags and needs whether the published box holds. magent does not prescribe PPI or read pH-impedance.

When not to use

Not a medical device.
Not a diagnosis. magent does not diagnose functional heartburn.
The caller assigns the six flags. magent does not prescribe PPI or read pH-impedance.
This tool is Aziz 2016 Rome IV functional heartburn only. Not globus. Not reflux hypersensitivity as the primary tool. Not Rome IV IBS (Mearin 2016).

Formula

rome_iv_heartburn iff burning_retrosternal_discomfort and no_relief_despite_optimal_antisecretory_therapy and not_explained_by_gerd_or_eoe and no_major_esophageal_motor_disorder and fulfilled_last_3_months and onset_at_least_6_months (Aziz 2016 Rome IV functional heartburn)

Citation

Title: Esophageal Disorders
Authors: Aziz Q, Fass R, Gyawali CP, Miwa H, Pandolfino JE, Zerbib F
Source: Gastroenterology. 2016;150(6):1368-1379
DOI: 10.1053/j.gastro.2016.02.012

Worked example

All six required flags

Given: burning_retrosternal_discomfort=truefulfilled_last_3_months=trueno_major_esophageal_motor_disorder=trueno_relief_despite_optimal_antisecretory_therapy=truenot_explained_by_gerd_or_eoe=trueonset_at_least_6_months=true

Burning retrosternal discomfort or pain is true
No relief despite optimal antisecretory therapy is true
Symptoms are not explained by GERD or eosinophilic esophagitis
No major esophageal motor disorder is true
Criteria fulfilled for the last 3 months and onset at least 6 months prior are true
rome_iv_heartburn is true

Five required flags without 6-month onset

Five required flags hold
Onset at least 6 months prior is false
rome_iv_heartburn is false

Also searched as

Rome IV functional heartburn
Aziz 2016 functional heartburn
functional heartburn Rome IV
Rome IV heartburn
esophageal functional heartburn
functional heartburn criteria
Rome IV esophageal heartburn
heartburn without GERD

Try

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

/api/calc/rome_iv_heartburn?burning_retrosternal_discomfort=true&no_relief_despite_optimal_antisecretory_therapy=true&not_explained_by_gerd_or_eoe=true&no_major_esophageal_motor_disorder=true&fulfilled_last_3_months=true&onset_at_least_6_months=true

Full URL: https://api.magentlab.com/api/calc/rome_iv_heartburn?burning_retrosternal_discomfort=true&no_relief_despite_optimal_antisecretory_therapy=true&not_explained_by_gerd_or_eoe=true&no_major_esophageal_motor_disorder=true&fulfilled_last_3_months=true&onset_at_least_6_months=true

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/rome_iv_heartburn?burning_retrosternal_discomfort=true&no_relief_despite_optimal_antisecretory_therapy=true&not_explained_by_gerd_or_eoe=true&no_major_esophageal_motor_disorder=true&fulfilled_last_3_months=true&onset_at_least_6_months=true"

Parameters

Name	Type	Required	Description
`burning_retrosternal_discomfort`	boolean	required	Burning retrosternal discomfort or pain, as assigned (Aziz 2016). true or false as assigned by the caller. magent does not examine the patient.
`no_relief_despite_optimal_antisecretory_therapy`	boolean	required	No symptom relief despite optimal antisecretory therapy, as assigned (Aziz 2016). true or false as assigned by the caller. magent does not prescribe PPI.
`not_explained_by_gerd_or_eoe`	boolean	required	Symptoms not explained by GERD or eosinophilic esophagitis, as assigned (Aziz 2016). true or false as assigned by the caller. magent does not read pH-impedance.
`no_major_esophageal_motor_disorder`	boolean	required	Absence of a major esophageal motor disorder, as assigned (Aziz 2016). true or false as assigned by the caller. magent does not interpret manometry.
`fulfilled_last_3_months`	boolean	required	Criteria fulfilled for the last 3 months, as assigned (Aziz 2016). true or false as assigned by the caller. magent does not take a history.
`onset_at_least_6_months`	boolean	required	Symptom onset at least 6 months prior to diagnosis, as assigned (Aziz 2016). true or false as assigned by the caller. magent does not take a history.

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/rome_iv_heartburn 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": [
    {
      "burning_retrosternal_discomfort": "true",
      "fulfilled_last_3_months": "true",
      "no_major_esophageal_motor_disorder": "true",
      "no_relief_despite_optimal_antisecretory_therapy": "true",
      "not_explained_by_gerd_or_eoe": "true",
      "onset_at_least_6_months": "true"
    },
    {
      "burning_retrosternal_discomfort": "true",
      "fulfilled_last_3_months": "true",
      "no_major_esophageal_motor_disorder": "true",
      "no_relief_despite_optimal_antisecretory_therapy": "true",
      "not_explained_by_gerd_or_eoe": "true",
      "onset_at_least_6_months": "true"
    }
  ]
}

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/rome_iv_heartburn",
  "items": [
    {
      "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": "Aziz Q, Fass R, Gyawali CP, Miwa H, Pandolfino JE, Zerbib F",
        "doi": "10.1053/j.gastro.2016.02.012",
        "id": "aziz-2016",
        "pmid": "27144654",
        "source": "Gastroenterology. 2016;150(6):1368-1379",
        "title": "Esophageal Disorders"
      },
      "formula": "rome_iv_heartburn",
      "formula_expression": "rome_iv_heartburn iff burning_retrosternal_discomfort and no_relief_despite_optimal_antisecretory_therapy and not_explained_by_gerd_or_eoe and no_major_esophageal_motor_disorder and fulfilled_last_3_months and onset_at_least_6_months (Aziz 2016 Rome IV functional heartburn)",
      "criteria": [
        {
          "factor": "burning_retrosternal_discomfort",
          "met": true
        },
        {
          "factor": "no_relief_despite_optimal_antisecretory_therapy",
          "met": true
        },
        {
          "factor": "not_explained_by_gerd_or_eoe",
          "met": true
        },
        {
          "factor": "no_major_esophageal_motor_disorder",
          "met": true
        },
        {
          "factor": "fulfilled_last_3_months",
          "met": true
        },
        {
          "factor": "onset_at_least_6_months",
          "met": true
        }
      ],
      "rome_iv_heartburn": true
    },
    {
      "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": "Aziz Q, Fass R, Gyawali CP, Miwa H, Pandolfino JE, Zerbib F",
        "doi": "10.1053/j.gastro.2016.02.012",
        "id": "aziz-2016",
        "pmid": "27144654",
        "source": "Gastroenterology. 2016;150(6):1368-1379",
        "title": "Esophageal Disorders"
      },
      "formula": "rome_iv_heartburn",
      "formula_expression": "rome_iv_heartburn iff burning_retrosternal_discomfort and no_relief_despite_optimal_antisecretory_therapy and not_explained_by_gerd_or_eoe and no_major_esophageal_motor_disorder and fulfilled_last_3_months and onset_at_least_6_months (Aziz 2016 Rome IV functional heartburn)",
      "criteria": [
        {
          "factor": "burning_retrosternal_discomfort",
          "met": true
        },
        {
          "factor": "no_relief_despite_optimal_antisecretory_therapy",
          "met": true
        },
        {
          "factor": "not_explained_by_gerd_or_eoe",
          "met": true
        },
        {
          "factor": "no_major_esophageal_motor_disorder",
          "met": true
        },
        {
          "factor": "fulfilled_last_3_months",
          "met": true
        },
        {
          "factor": "onset_at_least_6_months",
          "met": true
        }
      ],
      "rome_iv_heartburn": true
    }
  ]
}

Response

Field	Type	Description
`formula`	string	rome_iv_heartburn
`formula_expression`	string	Aziz 2016 Rome IV functional heartburn: burning retrosternal discomfort, no relief despite optimal antisecretory therapy, not explained by GERD or EoE, no major esophageal motor disorder, last-3-months criteria, and 6-month onset
`rome_iv_heartburn`	boolean	true only when all six required flags hold. Not a diagnosis.
`criteria`	array	Per-factor rows with factor and met for the six required flags
`citation`	object	Aziz 2016 Gastroenterology citation
`disclaimer`	string	Not-a-device notice

Example JSON

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

{
  "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": "Aziz Q, Fass R, Gyawali CP, Miwa H, Pandolfino JE, Zerbib F",
    "doi": "10.1053/j.gastro.2016.02.012",
    "id": "aziz-2016",
    "pmid": "27144654",
    "source": "Gastroenterology. 2016;150(6):1368-1379",
    "title": "Esophageal Disorders"
  },
  "formula": "rome_iv_heartburn",
  "formula_expression": "rome_iv_heartburn iff burning_retrosternal_discomfort and no_relief_despite_optimal_antisecretory_therapy and not_explained_by_gerd_or_eoe and no_major_esophageal_motor_disorder and fulfilled_last_3_months and onset_at_least_6_months (Aziz 2016 Rome IV functional heartburn)",
  "criteria": [
    {
      "factor": "burning_retrosternal_discomfort",
      "met": true
    },
    {
      "factor": "no_relief_despite_optimal_antisecretory_therapy",
      "met": true
    },
    {
      "factor": "not_explained_by_gerd_or_eoe",
      "met": true
    },
    {
      "factor": "no_major_esophageal_motor_disorder",
      "met": true
    },
    {
      "factor": "fulfilled_last_3_months",
      "met": true
    },
    {
      "factor": "onset_at_least_6_months",
      "met": true
    }
  ],
  "rome_iv_heartburn": true
}

Client errors (HTTP 400)

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

HTTP	Code	When
400	`invalid_rome_iv_heartburn`	Rome IV functional heartburn needs the Aziz 2016 esophageal heartburn flags. Returned before settlement; you are not charged.
400	`invalid_flag`	boolean clinical flags must be true or false 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

Rome IV globus — Apply the Aziz 2016 Rome IV esophageal globus diagnostic criteria and return whether the published globus box holds (rome_iv_globus).
Rome IV FD — Apply the Stanghellini 2016 Rome IV B1 functional dyspepsia criteria and return whether PDS (B1a), EPS (B1b), and the published FD box hold (rome_iv_fd).

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.