# Build the Athena OID identifier system for a practice

Operation ID: `connectors.zusBuildAthenaIdentifierSystem`

Build the Athena OID identifier system for a practice. ``urn:oid:2.16.840.1.113883.3.564.{practiceId}``.

## Public method

`buildAthenaIdentifierSystem`

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

Return type: `Promise<ZusResponse>`

## Authentication

Classification: **AUTHENTICATED**

Schemes: `bearerAuth`

## Prerequisites

None documented.

## HTTP

`POST /connectors/zus/build-athena-identifier-system`

## Path parameters

None.

## Query parameters

None.

## Body parameters

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

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

## Request example

```json
{
  "account_id": "example-account_id",
  "api_url_base": "example-api_url_base",
  "client_id": "example-client_id",
  "client_secret": "example-client-secret",
  "mode": "sandbox",
  "practice_id": "1959418",
  "subject_token": "example-access-token"
}
```

## Success responses

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

## Success response examples

### 200

```json
"urn:oid:2.16.840.1.113883.3.564.1959418"
```

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

```ts
const body = {
  "account_id": "example-account_id",
  "api_url_base": "example-api_url_base",
  "client_id": "example-client_id",
  "client_secret": "example-client-secret",
  "mode": "sandbox",
  "practice_id": "1959418",
  "subject_token": "example-access-token"
};

const result = await connectors.zus.createClient(config).buildAthenaIdentifierSystem(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","client_id":"example-client_id","client_secret":"example-client-secret","mode":"sandbox","practice_id":"1959418","subject_token":"example-access-token"}' \
  'https://dev-api-connectors.health.cloud/connectors/zus/build-athena-identifier-system'
```

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