Schema library healthcare
Return a drug-formulary entry from a public page.
Pass this JSON Schema and a public source URL to/extract/json. Normalize public formulary fields and plan context. Check the official source before acting on it.
TEXT
MARKDOWN
LINKS
const res = await client.extract.json({
url: 'https://example.com/pricing',
json_schema: {
type: 'object',
properties: {
plan: { type: 'string' },
price: { type: 'number' },
},
},
})res = client.extract.json(
url='https://example.com/pricing',
json_schema={
'type': 'object',
'properties': {
'plan': {'type': 'string'},
'price': {'type': 'number'},
},
},
)tabstack extract json https://example.com/pricing \
--schema '{"type":"object","properties":{"plan":{"type":"string"},"price":{"type":"number"}}}'What it captures
Fields in this drug-formulary entry.
A drug entry from a health insurance plan formulary, including tier, coverage requirements, and pricing.
| Field | Type | What it holds |
|---|---|---|
drug_name_brand | string | Brand name of the drug. |
drug_name_generic | string, required | Generic (INN) name of the drug. |
ndc | string | National Drug Code (NDC). |
manufacturer | string | Drug manufacturer. |
drug_class | string | Pharmacological drug class. |
dosage_forms | array | Available dosage forms, strengths, and routes. |
formulary_tier | string | Formulary tier which determines cost-sharing. |
prior_auth_required | boolean | Whether prior authorization is required. |
quantity_limits | object | Quantity limits on coverage. |
step_therapy_required | boolean | Whether step therapy (fail-first) is required. |
plan_name | string | Name of the insurance plan. |
plan_year | number | Plan year for this formulary. |
retail_price_30day | number | Retail pharmacy price for a 30-day supply in USD. |
mail_order_price_90day | number | Mail order price for a 90-day supply in USD. |
generic_available | boolean | Whether a generic equivalent is available. |
black_box_warning | boolean | Whether the drug carries an FDA black box warning. |
controlled_substance_schedule | string | DEA controlled substance schedule if applicable. |
page_title | string | Title of the source page. Tabstack auto-fills this from page metadata when left empty. |
favicon | string | Favicon URL of the source page. Tabstack auto-fills this from page metadata when left empty. |
Example
Inspect and validate the response shape.
The example below is generated from the schema to demonstrate its structure. Edit the object or paste a real response to validate it in your browser.
What it checks
Pass or fail, and the first reason why.
Whether the text parses as JSON, whether the top level is an object, and whether each field the schema requires is present at the declared type. A null is allowed anywhere. Every key you ask for is present. A field the page does not state can come back null, empty, a placeholder number, or a guessed value. Validate values, not just keys.
Usage
Send the schema with your source URL.
The schema travels with the request rather than living on your account, so the same call can send a trimmed version for one page and the full one for another. Every key you ask for is present. A field the page does not state can come back null, empty, a placeholder number, or a guessed value. Validate values, not just keys.
import schema from './drug-formulary-entry.json'
const res = await client.extract.json({
url: 'https://example.com/pricing',
json_schema: schema,
})tabstack extract json 'https://example.com/pricing' \
--schema @./drug-formulary-entry.jsonAdaptation
Make the schema match your application.
The schema is a starting point, not a guarantee that every source page contains every field. Three things are worth doing before you write one into your system, and the schema-authoring guide covers the rest.
Remove what you do not need
A shorter schema is a smaller response and fewer fields to handle.
Describe the ambiguous ones
A description tells Extract what to look for when a label could mean two things.
Validate before you store
Check the returned object against the schema rather than trusting it.
Related
Related schemas
Other schemas in this category.
- Same category: clinical trial.
- Same category: medical device recall.
- Same category: provider directory entry.
- The job rather than the object: the Extract API.