For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Contact Sales
DocsAPI reference
DocsAPI reference
  • API Reference
        • GETGet Encounter Supplemental Information
        • PUTCreate Encounter Supplemental Information
        • PATCHUpdate Encounter Supplemental Information
        • DELDelete Encounter Supplemental Information
Contact Sales
LogoLogo
API ReferenceEncounter Supplemental InformationV1

Get Encounter Supplemental Information

GET
/api/encounter-supplemental-information/v1/:encounter_id
GET
/api/encounter-supplemental-information/v1/:encounter_id
$curl https://api.joincandidhealth.com/api/encounter-supplemental-information/v1/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32 \
>     -H "Authorization: Bearer <token>"
200Retrieved
1[
2  {
3    "supplemental_information_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
4    "attachment_report_type_code": "03",
5    "attachment_transmission_code": "BM",
6    "attachment_inclusion": "not_included",
7    "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
8    "attachment_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
9    "attachment_control_number": "attachment_control_number"
10  },
11  {
12    "supplemental_information_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
13    "attachment_report_type_code": "03",
14    "attachment_transmission_code": "BM",
15    "attachment_inclusion": "not_included",
16    "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
17    "attachment_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
18    "attachment_control_number": "attachment_control_number"
19  }
20]
Was this page helpful?
Previous

Create Encounter Supplemental Information

Next
Built with

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

encounter_idUUIDRequired

Response

This endpoint returns a list of objects.
supplemental_information_idUUID
attachment_report_type_codeenum
attachment_transmission_codeenum
Allowed values:
attachment_inclusionenum
Allowed values:
encounter_idUUID
attachment_idUUID
attachment_control_numberstring