Schema library healthcare

Return a clinical-trial record from a public page.

Pass this JSON Schema and a public source URL to/extract/json. Structure public trial registry fields. Check the official source before acting on it.

Use this schema The JSON file

tabstack.ai/pricing

TEXT

MARKDOWN

LINKS

extract.tsTypeScript

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 clinical-trial record.

Clinical trial registration and status information from ClinicalTrials.gov or equivalent registry.

Field	Type	What it holds
`nct_id`	string, required	ClinicalTrials.gov NCT identifier.
`title`	string, required	Official title of the clinical trial.
`sponsor_name`	string, required	Primary sponsor organization.
`sponsor_type`	string	Type of primary sponsor.
`collaborators`	array	List of collaborating organizations.
`status`	string, required	Current recruitment status of the trial.
`phase`	string	Clinical trial phase.
`study_type`	string	Type of study design.
`conditions`	array, required	Medical conditions or diseases being studied.
`interventions`	array	Interventions being tested.
`primary_outcomes`	array	Primary outcome measures.
`enrollment_target`	number	Target number of participants.
`enrollment_actual`	number	Actual number of participants enrolled.
`start_date`	string	Study start date.
`primary_completion_date`	string	Primary completion date.
`locations`	array	Study locations.
`eligibility_min_age`	string	Minimum age for eligibility.
`eligibility_max_age`	string	Maximum age for eligibility.
`eligibility_sex`	string	Sex eligibility requirement.
`results_available`	boolean	Whether results have been posted.
`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.

Example data, not a live response.

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.

clinical.tsTypeScript

import schema from './clinical-trial.json'

const res = await client.extract.json({
  url: 'https://example.com/pricing',
  json_schema: schema,
})

tabstack extract json 'https://example.com/pricing' \
  --schema @./clinical-trial.json

Adaptation

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 schemas

Other schemas in this category.

Same category: drug formulary entry.
Same category: medical device recall.
Same category: provider directory entry.
The job rather than the object: the Extract API.