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

# Batch create patients

> Creates up to 500 patients in one request.

```python theme={null}
olira.create_patients_batch(patients: list[CreatePatientRequest]) -> PatientBatchResult
```

**Requires scope:** `api:manage-patients`

Partial success is supported — check errors alongside items.

## Parameters

<ParamField body="patients" type="list[CreatePatientRequest]" required>
  Each item follows the same shape as create\_patient (validated server-side).
</ParamField>

## Returns

`PatientBatchResult`

<ResponseField name="count" type="int">
  Number of patients processed in this request.
</ResponseField>

<ResponseField name="items" type="list[PatientBatchItem]">
  Successful creations with index and new id.
</ResponseField>

<ResponseField name="items[].index" type="int">
  Input index in the batch.
</ResponseField>

<ResponseField name="items[].id" type="str">
  New Olira patient id.
</ResponseField>

<ResponseField name="items[].source" type="str | None">
  Optional provenance hint from API.
</ResponseField>

<ResponseField name="errors" type="list[BatchError]">
  Per-row failures (index, code, message).
</ResponseField>

## Raises

| Exception         | When                                                                                                                  |
| ----------------- | --------------------------------------------------------------------------------------------------------------------- |
| `AuthError`       | HTTP 401 or 403 — invalid API key or insufficient OAuth scope for this endpoint.                                      |
| `ValidationError` | HTTP 400, 404, or 422 — malformed JSON, unknown patient, or validation failure (message includes response excerpt).   |
| `ServerError`     | HTTP 409 (e.g. conflicting external identifier) or repeated 5xx after retries; includes status\_code when applicable. |
| `RateLimitError`  | HTTP 429 — rate limited; check retry\_after (seconds).                                                                |
| `NetworkError`    | Connection timeout, DNS failure, or read error after retries.                                                         |

<RequestExample>
  ```python Python theme={null}
  import olira
  from olira import CreatePatientRequest, ExternalIdentifier

  olira.init(api_key="YOUR_API_KEY")
  result = olira.create_patients_batch(
      patients=[
          CreatePatientRequest(
              external_identifiers=[
                  ExternalIdentifier(system="epic", value="MRN-1001"),
              ],
          ),
      ],
  )
  print(result.items, result.errors)
  ```

  ```http HTTP theme={null}
  POST /v1/patients/batch
  Authorization: Bearer YOUR_API_KEY
  Content-Type: application/json

  {
    "patients": [
      {
        "external_identifiers": [{ "system": "epic", "value": "MRN-1001" }]
      }
    ]
  }
  ```
</RequestExample>

<ResponseExample>
  ```python 200 theme={null}
  PatientBatchResult(
      count=1,
      items=[
          PatientBatchItem(index=0, id="019b2f80-0000-7000-8000-000000000002", source=None),
      ],
      errors=[],
  )
  ```

  ```json 401 theme={null}
  {
    "error": true,
    "status_code": 401,
    "error_type": "authentication_error",
    "message": "Could not validate credentials",
    "details": [
      {
        "type": "authentication_error",
        "message": "Could not validate credentials"
      }
    ],
    "timestamp": "2026-05-06T12:00:00+00:00"
  }
  ```

  ```json 403 theme={null}
  {
    "error": true,
    "status_code": 403,
    "error_type": "authorization_error",
    "message": "Insufficient OAuth scope for this endpoint",
    "details": [
      {
        "type": "authorization_error",
        "message": "Insufficient OAuth scope for this endpoint"
      }
    ],
    "timestamp": "2026-05-06T12:00:00+00:00"
  }
  ```

  ```json 404 theme={null}
  {
    "error": true,
    "status_code": 404,
    "error_type": "not_found_error",
    "message": "Patient not found",
    "details": [
      {
        "type": "not_found_error",
        "message": "Patient not found"
      }
    ],
    "timestamp": "2026-05-06T12:00:00+00:00"
  }
  ```

  ```json 422 theme={null}
  {
    "error": true,
    "status_code": 422,
    "error_type": "validation_error",
    "message": "Request validation failed (1 error)",
    "details": [
      {
        "type": "missing",
        "message": "Field required",
        "field": "patient_id",
        "location": ["body", "patient_id"],
        "input_value": null
      }
    ],
    "timestamp": "2026-05-06T12:00:00+00:00"
  }
  ```

  ```json 429 theme={null}
  {
    "error": true,
    "status_code": 429,
    "error_type": "server_error",
    "message": "Rate limit exceeded",
    "details": [
      {
        "type": "rate_limit",
        "message": "Too many requests; retry after backoff"
      }
    ],
    "timestamp": "2026-05-06T12:00:00+00:00"
  }
  ```

  ```json 500 theme={null}
  {
    "error": true,
    "status_code": 500,
    "error_type": "internal_server_error",
    "message": "An internal server error occurred",
    "details": [
      {
        "type": "internal_server_error",
        "message": "An unexpected error occurred while processing your request"
      }
    ],
    "timestamp": "2026-05-06T12:00:00+00:00"
  }
  ```
</ResponseExample>