> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.joincandidhealth.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.joincandidhealth.com/_mcp/server.

# Create Encounter Supplemental Information

PUT https://api.joincandidhealth.com/api/encounter-supplemental-information/v1/{encounter_id}
Content-Type: application/json

Reference: https://docs.joincandidhealth.com/api-reference/encounter-supplemental-information/v-1/create

## Authentication

- OAuth2 — send the obtained token as `Authorization: Bearer <token>`

## Servers

- `https://api.joincandidhealth.com` (Production, default)
- `https://api-staging.joincandidhealth.com` (Staging)
- `https://sandbox-api.joincandidhealth.com` (CandidSandbox)
- `https://staging-api.joincandidhealth.com` (CandidStaging)
- `http://localhost:5050` (Local)

## Request

### Path parameters

- `encounter_id` (UUID, required)

### Body (application/json)

This endpoint expects a CreateSupplementalInformationRequest.

- `attachment_report_type_code` (enum, required)
  - Allowed values: `03`, `04`, `05`, `06`, `07`, `08`, `09`, `10`, `11`, `13`, `15`, `21`, `A3`, `A4`, `AM`, `AS`, `B2`, `B3`, `B4`, `BR`, `BS`, `BT`, `CB`, `CK`, `CT`, `D2`, `DA`, `DB`, `DG`, `DJ`, `DS`, `EB`, `HC`, `HR`, `I5`, `IR`, `LA`, `M1`, `MT`, `NN`, `OB`, `OC`, `OD`, `OE`, `OX`, `OZ`, `P4`, `P5`, `PE`, `PN`, `PO`, `PQ`, `PY`, `PZ`, `RB`, `RR`, `RT`, `RX`, `SG`, `V5`, `XP`
- `attachment_transmission_code` (enum, required)
  - Allowed values: `AA`, `BM`, `EL`, `FX`
- `attachment_inclusion` (enum, required)
  - Allowed values: `not_included`, `included_on_next_submission`, `included_on_all_submissions`
- `attachment_id` (UUID, optional)
- `attachment_control_number` (string, optional)

## Response

### 200

- `supplemental_information_id` (UUID, required)
- `attachment_report_type_code` (enum, required)
  - Allowed values: `03`, `04`, `05`, `06`, `07`, `08`, `09`, `10`, `11`, `13`, `15`, `21`, `A3`, `A4`, `AM`, `AS`, `B2`, `B3`, `B4`, `BR`, `BS`, `BT`, `CB`, `CK`, `CT`, `D2`, `DA`, `DB`, `DG`, `DJ`, `DS`, `EB`, `HC`, `HR`, `I5`, `IR`, `LA`, `M1`, `MT`, `NN`, `OB`, `OC`, `OD`, `OE`, `OX`, `OZ`, `P4`, `P5`, `PE`, `PN`, `PO`, `PQ`, `PY`, `PZ`, `RB`, `RR`, `RT`, `RX`, `SG`, `V5`, `XP`
- `attachment_transmission_code` (enum, required)
  - Allowed values: `AA`, `BM`, `EL`, `FX`
- `attachment_inclusion` (enum, required)
  - Allowed values: `not_included`, `included_on_next_submission`, `included_on_all_submissions`
- `encounter_id` (UUID, required)
- `attachment_id` (UUID, optional)
- `attachment_control_number` (string, optional)

## Errors

### 404 Entity Not Found Error

- `errorName` ("EntityNotFoundError", required)
- `content` (EntityNotFoundErrorMessage, required)

## Types

### EntityNotFoundErrorMessage

- `id` (string, required)

## Examples

**Request**

```json
{
  "attachment_report_type_code": "03",
  "attachment_transmission_code": "AA",
  "attachment_inclusion": "not_included"
}
```

**Response**

```json
{
  "supplemental_information_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
  "attachment_report_type_code": "03",
  "attachment_transmission_code": "AA",
  "attachment_inclusion": "not_included",
  "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
  "attachment_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
  "attachment_control_number": "attachment_control_number"
}
```

**SDK Code**

```python
import requests

url = "https://api.joincandidhealth.com/api/encounter-supplemental-information/v1/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"

payload = {
    "attachment_report_type_code": "03",
    "attachment_transmission_code": "AA",
    "attachment_inclusion": "not_included"
}
headers = {
    "Authorization": "<token>.",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.joincandidhealth.com/api/encounter-supplemental-information/v1/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32';
const options = {
  method: 'PUT',
  headers: {Authorization: '<token>.', 'Content-Type': 'application/json'},
  body: '{"attachment_report_type_code":"03","attachment_transmission_code":"AA","attachment_inclusion":"not_included"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.joincandidhealth.com/api/encounter-supplemental-information/v1/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"

	payload := strings.NewReader("{\n  \"attachment_report_type_code\": \"03\",\n  \"attachment_transmission_code\": \"AA\",\n  \"attachment_inclusion\": \"not_included\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "<token>.")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.joincandidhealth.com/api/encounter-supplemental-information/v1/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = '<token>.'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"attachment_report_type_code\": \"03\",\n  \"attachment_transmission_code\": \"AA\",\n  \"attachment_inclusion\": \"not_included\"\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.put("https://api.joincandidhealth.com/api/encounter-supplemental-information/v1/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
  .header("Authorization", "<token>.")
  .header("Content-Type", "application/json")
  .body("{\n  \"attachment_report_type_code\": \"03\",\n  \"attachment_transmission_code\": \"AA\",\n  \"attachment_inclusion\": \"not_included\"\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://api.joincandidhealth.com/api/encounter-supplemental-information/v1/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32', [
  'body' => '{
  "attachment_report_type_code": "03",
  "attachment_transmission_code": "AA",
  "attachment_inclusion": "not_included"
}',
  'headers' => [
    'Authorization' => '<token>.',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.joincandidhealth.com/api/encounter-supplemental-information/v1/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32");
var request = new RestRequest(Method.PUT);
request.AddHeader("Authorization", "<token>.");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"attachment_report_type_code\": \"03\",\n  \"attachment_transmission_code\": \"AA\",\n  \"attachment_inclusion\": \"not_included\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "<token>.",
  "Content-Type": "application/json"
]
let parameters = [
  "attachment_report_type_code": "03",
  "attachment_transmission_code": "AA",
  "attachment_inclusion": "not_included"
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.joincandidhealth.com/api/encounter-supplemental-information/v1/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PUT"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```