Schema library healthcare
Return a provider-directory entry from a public page.
Pass this JSON Schema and a public source URL to/extract/json. Structure public provider and directory fields. 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 provider-directory entry.
Healthcare provider profile from an insurance network directory or physician finder.
| Field | Type | What it holds |
|---|---|---|
npi | string | National Provider Identifier (NPI). |
provider_type | string, required | Type of healthcare provider. |
first_name | string, required | Provider's first name. |
last_name | string, required | Provider's last name. |
credentials | array | Professional credentials (e.g., MD, DO, PhD). |
specialty_primary | string, required | Primary medical specialty. |
specialty_secondary | array | Secondary specialties or subspecialties. |
gender | string | Provider's gender. |
languages | array | Languages spoken by the provider. |
accepting_new_patients | boolean | Whether the provider is accepting new patients. |
telehealth_available | boolean | Whether telehealth appointments are available. |
accepting_medicaid | boolean | Whether the provider accepts Medicaid. |
accepting_medicare | boolean | Whether the provider accepts Medicare. |
group_practice_name | string | Name of the group practice or medical group. |
hospital_affiliations | array | Hospitals where the provider has admitting privileges. |
address_street | string | Street address of the practice. |
address_city | string, required | City of the practice. |
address_state | string, required | State of the practice. |
address_zip | string | ZIP code of the practice. |
latitude | number | Latitude coordinate of the practice. |
longitude | number | Longitude coordinate of the practice. |
phone | string | Practice phone number. |
website | string | Practice website URL. |
insurances_accepted | array | Insurance plans accepted. |
review_rating | number | Average patient review rating. |
review_count | number | Total number of patient reviews. |
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 './provider-directory-entry.json'
const res = await client.extract.json({
url: 'https://example.com/pricing',
json_schema: schema,
})tabstack extract json 'https://example.com/pricing' \
--schema @./provider-directory-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: drug formulary entry.
- Same category: medical device recall.
- The job rather than the object: the Extract API.