# Convenience method to fill out a lab result review form with standard fields

Operation ID: `connectors.healthieFillLabResultReviewForm`

Convenience method to fill out a lab result review form with standard fields.

## Public method

`fillLabResultReviewForm`

Signature: `connectors.healthie.createClient(config).fillLabResultReviewForm(body)`

Return type: `Promise<HealthieFormResponse>`

## Authentication

Classification: **AUTHENTICATED**

Schemes: `bearerAuth`

## Prerequisites

None documented.

## HTTP

`POST /connectors/healthie/fill-lab-result-review-form`

## Path parameters

None.

## Query parameters

None.

## Body parameters

| Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
|---|---|---:|---|---|---|---:|---|
| `body` | [`HealthieFillLabResultReviewFormRequest`](../models/HealthieFillLabResultReviewFormRequest.md) | Yes |  |  |  | No |  |

Request model: [`HealthieFillLabResultReviewFormRequest`](../models/HealthieFillLabResultReviewFormRequest.md)

## Request example

```json
{
  "additional_notes": "example-additional-notes",
  "api_url": "https://example.com/resource",
  "date": "example-date",
  "did_notify_patient": "example-did-notify-patient",
  "document_pdf_file_name": "Example Name",
  "interpreting_provider": "example-interpreting-provider",
  "lab_result_form_id": "12345",
  "lab_result_info": "example-lab-result-info",
  "modality": "example-modality",
  "mode": "sandbox",
  "open_loop_url": "https://example.com/resource",
  "outreach_modality": "example-outreach-modality",
  "outreached_on_date": "example-outreached-on-date",
  "patient_id": "12345",
  "patient_name": "Example Name",
  "results_criticality": "example-results-criticality",
  "secret_key": "example-api-key",
  "shard_id": "12345"
}
```

## Success responses

| Status | Shape | Content type | Description |
|---|---|---|---|
| `200` | [`HealthieFillLabResultReviewFormResponse`](../models/HealthieFillLabResultReviewFormResponse.md) | application/json | Successful response |

## Success response examples

### 200

```json
{
  "created_at": "example-created-at",
  "form_answers": [],
  "id": "12345",
  "name": "Example Name"
}
```

## Common errors

| Status | Shape | Content type | Description |
|---|---|---|---|
| `400` | [`StandardErrorResponse`](../models/StandardErrorResponse.md) | application/json | Connector validation rejected the payload, or a required field was missing or of the wrong type. |
| `401` | [`StandardErrorResponse`](../models/StandardErrorResponse.md) | application/json | The HealthCloud bearer token is missing or invalid, or the vendor rejected the supplied connector credentials. |
| `500` | [`StandardErrorResponse`](../models/StandardErrorResponse.md) | application/json | The connector failed unexpectedly. |
| `502` | [`StandardErrorResponse`](../models/StandardErrorResponse.md) | application/json | The vendor returned an application or transport-level failure. |
| `504` | [`StandardErrorResponse`](../models/StandardErrorResponse.md) | application/json | The vendor did not respond within the connector timeout. |

## Error examples

### 400 — Invalid request

```json
{
  "error": "Invalid request"
}
```

### 401 — Authorization required

```json
{
  "error": "Authorization required"
}
```

### 500 — Internal error

```json
{
  "error": "Internal error"
}
```

### 502 — Upstream vendor error

```json
{
  "error": "Upstream vendor error"
}
```

### 504 — Upstream timeout

```json
{
  "error": "Upstream timeout"
}
```

## NodeJS / TypeScript implementation

```ts
import { HCSDK } from "@healthcloudai/hc-sdk";
import type { HealthieFillLabResultReviewFormRequest } from "@healthcloudai/hc-sdk";
```

```ts
const body = {
  "additional_notes": "example-additional-notes",
  "api_url": "https://example.com/resource",
  "date": "example-date",
  "did_notify_patient": "example-did-notify-patient",
  "document_pdf_file_name": "Example Name",
  "interpreting_provider": "example-interpreting-provider",
  "lab_result_form_id": "12345",
  "lab_result_info": "example-lab-result-info",
  "modality": "example-modality",
  "mode": "sandbox",
  "open_loop_url": "https://example.com/resource",
  "outreach_modality": "example-outreach-modality",
  "outreached_on_date": "example-outreached-on-date",
  "patient_id": "12345",
  "patient_name": "Example Name",
  "results_criticality": "example-results-criticality",
  "secret_key": "example-api-key",
  "shard_id": "12345"
};

const result = await connectors.healthie.createClient(config).fillLabResultReviewForm(body);
```

## cURL

```bash
curl -X POST \
  -H 'Authorization: Bearer <ACCESS_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{"additional_notes":"example-additional-notes","api_url":"https://example.com/resource","date":"example-date","did_notify_patient":"example-did-notify-patient","document_pdf_file_name":"Example Name","interpreting_provider":"example-interpreting-provider","lab_result_form_id":"12345","lab_result_info":"example-lab-result-info","modality":"example-modality","mode":"sandbox","open_loop_url":"https://example.com/resource","outreach_modality":"example-outreach-modality","outreached_on_date":"example-outreached-on-date","patient_id":"12345","patient_name":"Example Name","results_criticality":"example-results-criticality","secret_key":"example-api-key","shard_id":"12345"}' \
  'https://dev-api-connectors.health.cloud/connectors/healthie/fill-lab-result-review-form'
```

## Notes

None.

## Prepared Test Console scenario

No canonical scenario is currently associated.

## Real response

No approved real integration response is currently published. Unapproved candidates are never rendered as examples.