> ## Documentation Index
> Fetch the complete documentation index at: https://docs.readyhealth.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Document Field Schema

To ensure consistency in the structured output of document scans, there are common attributes that are returned with each document type. In addition, depending on the document type, there are additional attributes that are critical to understanding the document data.

Below is a summarization of supported fields that are returned per document type. Within each field group object, there may be `extra_fields` included beyond the fields listed to be more comprehensive. Do not rely on these `extra_fields` being consistently available. If a specific field is required but not listed below, please contact us.

### Field Structure

Each extracted field follows this standard pattern:

```
fieldName: {
  key: string,      // Field identifier
  value: string,    // Extracted value
  confidence: int   // Confidence score (0-100)
}
```

There will always be the `category` and `type` also presented within the field object:

```
document_category: {
  value: string,    // Extracted value
  confidence: int   // Confidence score (0-100)
}
```

```
document_type: {
  value: string,    // Extracted value
  confidence: int   // Confidence score (0-100)
}
```

## View and Manage Document Schemas

From the Configurations and Schema tab in the Admin Dashboard, the document schema setup can be managed.

<Frame>
  <img src="https://mintcdn.com/readyhealth/_AHt-M-JbM2cHYbv/images/schema_example.png?fit=max&auto=format&n=_AHt-M-JbM2cHYbv&q=85&s=394f4202a8f67873634ef198d5df9a1d" width="3004" height="1770" data-path="images/schema_example.png" />
</Frame>

## Examples

### `tuberculosis.skin_test`

<ResponseField name="personal_data">
  <Expandable title="fields">
    <ResponseField name="first_name" />

    <ResponseField name="middle_name" />

    <ResponseField name="last_name" />

    <ResponseField name="date_of_birth" />

    <ResponseField name="extra_fields" />
  </Expandable>
</ResponseField>

<ResponseField name="issuer">
  <Expandable title="fields">
    <ResponseField name="name" />

    <ResponseField name="street_address" />

    <ResponseField name="city" />

    <ResponseField name="state" />

    <ResponseField name="zipcode" />

    <ResponseField name="phone_number" />

    <ResponseField name="email" />

    <ResponseField name="fax" />

    <ResponseField name="extra_fields" />
  </Expandable>
</ResponseField>

<ResponseField name="signature">
  <Expandable title="fields">
    <ResponseField name="is_signed" />

    <ResponseField name="name" />

    <ResponseField name="role" />

    <ResponseField name="extra_fields" />
  </Expandable>
</ResponseField>

<ResponseField name="tuberculosis_skin_test">
  <Expandable title="fields">
    <ResponseField name="result">
      One of `positive` or `negative`
    </ResponseField>

    <ResponseField name="test_date" />

    <ResponseField name="report_date" />

    <ResponseField name="clinician" />

    <ResponseField name="extra_fields" />
  </Expandable>
</ResponseField>