# Create a FHIR ``Patient`` and return its id

Operation ID: `connectors.zusCreatePatient`

Create a FHIR ``Patient`` and return its id. builds a FHIR ``Patient`` from the given demographics (name/birthDate/gender/address/telecom, plus the Athena OID identifier when both ids are supplied), POSTs it to ``{base}/fhir/Patient``, and returns the created id. Returns ``None`` if ``patient`` is empty or on error. ``patient`` keys (all optional): ``first_name``, ``last_name``, ``birth_date`` (``yyyy-MM-dd``), ``gender``, ``phone``, ``email``, and ``address`` (``city``, ``street``, ``state``, ``postal_code``).

## Public method

`createPatient`

Signature: `connectors.zus.createClient(config).createPatient(body)`

Return type: `Promise<ZusResponse>`

## Authentication

Classification: **AUTHENTICATED**

Schemes: `bearerAuth`

## Prerequisites

None documented.

## HTTP

`POST /connectors/zus/create-patient`

## Path parameters

None.

## Query parameters

None.

## Body parameters

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

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

## Request example

```json
{
  "account_id": "example-account_id",
  "api_url_base": "example-api_url_base",
  "athena_patient_id": "948882",
  "athena_practice_id": "1959418",
  "client_id": "example-client_id",
  "client_secret": "example-client-secret",
  "mode": "sandbox",
  "patient": {
    "address": {
      "city": "Boston",
      "postal_code": "02110",
      "state": "MA",
      "street": "123 Main St"
    },
    "birth_date": "+15555550123",
    "email": "patient@example.com",
    "first_name": "Repl",
    "gender": "male",
    "last_name": "Smoketest",
    "phone": "+15555550123"
  },
  "subject_token": "example-access-token"
}
```

## Success responses

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

## Success response examples

### 200

```json
"example-create-patient"
```

## 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 { ZusCreatePatientRequest } from "@healthcloudai/hc-sdk";
```

```ts
const body = {
  "account_id": "example-account_id",
  "api_url_base": "example-api_url_base",
  "athena_patient_id": "948882",
  "athena_practice_id": "1959418",
  "client_id": "example-client_id",
  "client_secret": "example-client-secret",
  "mode": "sandbox",
  "patient": {
    "address": {
      "city": "Boston",
      "postal_code": "02110",
      "state": "MA",
      "street": "123 Main St"
    },
    "birth_date": "+15555550123",
    "email": "patient@example.com",
    "first_name": "Repl",
    "gender": "male",
    "last_name": "Smoketest",
    "phone": "+15555550123"
  },
  "subject_token": "example-access-token"
};

const result = await connectors.zus.createClient(config).createPatient(body);
```

## cURL

```bash
curl -X POST \
  -H 'Authorization: Bearer <ACCESS_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{"account_id":"example-account_id","api_url_base":"example-api_url_base","athena_patient_id":"948882","athena_practice_id":"1959418","client_id":"example-client_id","client_secret":"example-client-secret","mode":"sandbox","patient":{"address":{"city":"Boston","postal_code":"02110","state":"MA","street":"123 Main St"},"birth_date":"+15555550123","email":"patient@example.com","first_name":"Repl","gender":"male","last_name":"Smoketest","phone":"+15555550123"},"subject_token":"example-access-token"}' \
  'https://dev-api-connectors.health.cloud/connectors/zus/create-patient'
```

## 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.