Get Encounter Attachments

GET

/api/encounter-attachments/v1/:encounter_id

GET

/api/encounter-attachments/v1/:encounter_id

1 import uuid
2 
3 from candid import CandidApiClient
4 
5 client = CandidApiClient(
6     client_id="YOUR_CLIENT_ID",
7     client_secret="YOUR_CLIENT_SECRET",
8 )
9 client.encounter_attachments.v_1.get(
10     encounter_id=uuid.UUID(
11         "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
12     ),
13 )

Try it

200Retrieved

1 [
2   {
3     "attachment_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
4     "attachment_type": "DOCUMENTATION",
5     "authed_url": "authed_url",
6     "content_type": "content_type",
7     "created_at": "2024-01-15T09:30:00Z",
8     "created_by": {
9       "user_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
10       "idp_metadata": [
11         {
12           "type": "auth_zero_metadata",
13           "auth0_id": "auth0_id"
14         },
15         {
16           "type": "auth_zero_metadata",
17           "auth0_id": "auth0_id"
18         }
19       ],
20       "user_metadata": {
21         "type": "machine_user_metadata",
22         "name": "name"
23       },
24       "primary_organization_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
25     },
26     "description": "description",
27     "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
28     "file_name": "file_name"
29   },
30   {
31     "attachment_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
32     "attachment_type": "DOCUMENTATION",
33     "authed_url": "authed_url",
34     "content_type": "content_type",
35     "created_at": "2024-01-15T09:30:00Z",
36     "created_by": {
37       "user_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
38       "idp_metadata": [
39         {
40           "type": "auth_zero_metadata",
41           "auth0_id": "auth0_id"
42         },
43         {
44           "type": "auth_zero_metadata",
45           "auth0_id": "auth0_id"
46         }
47       ],
48       "user_metadata": {
49         "type": "machine_user_metadata",
50         "name": "name"
51       },
52       "primary_organization_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
53     },
54     "description": "description",
55     "encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
56     "file_name": "file_name"
57   }
58 ]

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path Parameters

encounter_idUUIDRequired

Response

This endpoint returns a list of objects.

attachment_idUUID

attachment_typeenum

Allowed values:

authed_urlstring

content_typestring

created_atdatetime

created_byobject

descriptionstring

encounter_idUUID

file_namestring