List Clinical Notes

GET

Lists clinical notes with various filtering options including pagination, sorting, and specific attributes such as IDs, types, assignee details, creator details, patient details, and more. This endpoint supports comprehensive filtering to retrieve relevant clinical notes based on the provided criteria.

Query parameters

pageintegerOptional

The page number of the content returned.

sizeintegerOptional

The size of the page of content returned.

sort"open" or "createTimestamp"Optional

The attribute to sort on.

Allowed values: opencreateTimestamp

sortDescendingbooleanOptional

True if the sort direction should be descending.

idintegerOptional

Lists only clinical notes with the IDs provided.

openbooleanOptional

Lists only open clinical notes.

descriptionstringOptional

Lists only clinical notes with the provided description.

type"other" or "cptCode"Optional

Lists only clinical notes with the provided types.

Allowed values: othercptCode

cptCodeValuestringOptional

Lists only clinical notes with the provided CPT code values.

assigneeIdintegerOptional

Lists only clinical notes assigned to the provided assignee IDs.

assigneeNamestringOptional

Lists only clinical notes assigned to the provided assignee name.

assigneeEmailstringOptional

Lists only clinical notes assigned to the provided assignee email.

createdByIdintegerOptional

Lists only clinical notes created by the provided creator IDs.

createdByNamestringOptional

Lists only clinical notes created by the provided creator name.

createdByEmailstringOptional

Lists only clinical notes created by the provided creator email.

patientIdintegerOptional

Lists only clinical notes associated with the provided patient IDs.

patientSiteIdintegerOptional

Lists only clinical notes associated with the provided patient site IDs.

patientExternalIdentifierstringOptional

Lists only clinical notes associated with the provided patient external identifiers.

patientEmailstringOptional

Lists only clinical notes associated with the provided patient email.

patientNamestringOptional

Lists only clinical notes associated with the provided patient name.

Response

This endpoint returns an object.

contentlist of objectsOptional

The content of the page, consisting of a list of objects.

pageintegerOptional

The current page number. The first page has value 1.

sizeintegerOptional

The current page size. Default 15, maximum 250.

totalintegerOptional

The number of objects matching the request.

firstbooleanOptional

True if this is the first page, false otherwise.

lastbooleanOptional

True if this is the last page, false otherwise.

GET

1 curl https://app.impiloplatform.com/api/v3/clinical-note \
2      -H "Impilo-API-Key: <apiKey>"

200Retrieved

1 {
2   "content": [
3     {
4       "id": 88,
5       "type": "cptCode",
6       "cptCode": {
7         "value": "99457",
8         "displayAs": "CPT 99457"
9       },
10       "createTimestamp": "2024-07-04T00:00:00Z",
11       "lastUpdateTimestamp": "2024-07-14T00:00:00Z",
12       "open": true,
13       "mdCode": "md-123",
14       "dxCode": "dx-123",
15       "description": "This is a clinical note.",
16       "createdBy": {
17         "id": 1772,
18         "firstName": "John",
19         "lastName": "Doe",
20         "email": "user_1772@example.com"
21       },
22       "assignee": {
23         "id": 100,
24         "firstName": "John",
25         "lastName": "Doe",
26         "email": "user_100@example.com"
27       },
28       "patient": {
29         "id": 456,
30         "externalIdentifier": "external-identifier-123",
31         "firstName": "John",
32         "lastName": "Doe",
33         "dateOfBirth": "1987-09-13",
34         "email": "email@example.com",
35         "phoneNumber": "111-222-3333",
36         "archived": true,
37         "address": {
38           "lineOne": "1234 Market Street",
39           "lineTwo": "Suite 110",
40           "city": "Philadelphia",
41           "state": "PA",
42           "zipCode": "19137",
43           "country": "USA"
44         },
45         "sex": "unknown"
46       },
47       "activity": [
48         {
49           "createTimestamp": "2024-07-04T00:00:00Z",
50           "comment": "Activity comment 1",
51           "minutesSpent": 2,
52           "createdBy": {
53             "id": 4,
54             "firstName": "John",
55             "lastName": "Doe",
56             "email": "user_4@example.com"
57           }
58         },
59         {
60           "createTimestamp": "2024-07-04T00:00:00Z",
61           "comment": "Activity comment 2",
62           "minutesSpent": 4,
63           "createdBy": {
64             "id": 8,
65             "firstName": "John",
66             "lastName": "Doe",
67             "email": "user_8@example.com"
68           }
69         },
70         {
71           "createTimestamp": "2024-07-04T00:00:00Z",
72           "comment": "Activity comment 3",
73           "minutesSpent": 6,
74           "createdBy": {
75             "id": 12,
76             "firstName": "John",
77             "lastName": "Doe",
78             "email": "user_12@example.com"
79           }
80         },
81         {
82           "createTimestamp": "2024-07-04T00:00:00Z",
83           "comment": "Activity comment 4",
84           "minutesSpent": 8,
85           "createdBy": {
86             "id": 16,
87             "firstName": "John",
88             "lastName": "Doe",
89             "email": "user_16@example.com"
90           }
91         }
92       ],
93       "totalTime": 20
94     },
95     {
96       "id": 89,
97       "type": "other",
98       "createTimestamp": "2024-07-04T00:00:00Z",
99       "lastUpdateTimestamp": "2024-07-14T00:00:00Z",
100       "open": true,
101       "mdCode": "md-123",
102       "dxCode": "dx-123",
103       "description": "This is a clinical note.",
104       "createdBy": {
105         "id": 1772,
106         "firstName": "John",
107         "lastName": "Doe",
108         "email": "user_1772@example.com"
109       },
110       "assignee": {
111         "id": 100,
112         "firstName": "John",
113         "lastName": "Doe",
114         "email": "user_100@example.com"
115       },
116       "patient": {
117         "id": 456,
118         "externalIdentifier": "external-identifier-123",
119         "firstName": "John",
120         "lastName": "Doe",
121         "dateOfBirth": "1987-09-13",
122         "email": "email@example.com",
123         "phoneNumber": "111-222-3333",
124         "archived": true,
125         "address": {
126           "lineOne": "1234 Market Street",
127           "lineTwo": "Suite 110",
128           "city": "Philadelphia",
129           "state": "PA",
130           "zipCode": "19137",
131           "country": "USA"
132         },
133         "sex": "unknown"
134       },
135       "activity": [
136         {
137           "createTimestamp": "2024-07-04T00:00:00Z",
138           "comment": "Activity comment 1",
139           "minutesSpent": 2,
140           "createdBy": {
141             "id": 4,
142             "firstName": "John",
143             "lastName": "Doe",
144             "email": "user_4@example.com"
145           }
146         },
147         {
148           "createTimestamp": "2024-07-04T00:00:00Z",
149           "comment": "Activity comment 2",
150           "minutesSpent": 4,
151           "createdBy": {
152             "id": 8,
153             "firstName": "John",
154             "lastName": "Doe",
155             "email": "user_8@example.com"
156           }
157         },
158         {
159           "createTimestamp": "2024-07-04T00:00:00Z",
160           "comment": "Activity comment 3",
161           "minutesSpent": 6,
162           "createdBy": {
163             "id": 12,
164             "firstName": "John",
165             "lastName": "Doe",
166             "email": "user_12@example.com"
167           }
168         },
169         {
170           "createTimestamp": "2024-07-04T00:00:00Z",
171           "comment": "Activity comment 4",
172           "minutesSpent": 8,
173           "createdBy": {
174             "id": 16,
175             "firstName": "John",
176             "lastName": "Doe",
177             "email": "user_16@example.com"
178           }
179         }
180       ],
181       "totalTime": 20
182     }
183   ],
184   "page": 1,
185   "size": 2,
186   "total": 4,
187   "first": true,
188   "last": false
189 }

Built with

1	curl https://app.impiloplatform.com/api/v3/clinical-note \
2	-H "Impilo-API-Key: <apiKey>"

1	{
2	"content": [
3	{
4	"id": 88,
5	"type": "cptCode",
6	"cptCode": {
7	"value": "99457",
8	"displayAs": "CPT 99457"
9	},
10	"createTimestamp": "2024-07-04T00:00:00Z",
11	"lastUpdateTimestamp": "2024-07-14T00:00:00Z",
12	"open": true,
13	"mdCode": "md-123",
14	"dxCode": "dx-123",
15	"description": "This is a clinical note.",
16	"createdBy": {
17	"id": 1772,
18	"firstName": "John",
19	"lastName": "Doe",
20	"email": "user_1772@example.com"
21	},
22	"assignee": {
23	"id": 100,
24	"firstName": "John",
25	"lastName": "Doe",
26	"email": "user_100@example.com"
27	},
28	"patient": {
29	"id": 456,
30	"externalIdentifier": "external-identifier-123",
31	"firstName": "John",
32	"lastName": "Doe",
33	"dateOfBirth": "1987-09-13",
34	"email": "email@example.com",
35	"phoneNumber": "111-222-3333",
36	"archived": true,
37	"address": {
38	"lineOne": "1234 Market Street",
39	"lineTwo": "Suite 110",
40	"city": "Philadelphia",
41	"state": "PA",
42	"zipCode": "19137",
43	"country": "USA"
44	},
45	"sex": "unknown"
46	},
47	"activity": [
48	{
49	"createTimestamp": "2024-07-04T00:00:00Z",
50	"comment": "Activity comment 1",
51	"minutesSpent": 2,
52	"createdBy": {
53	"id": 4,
54	"firstName": "John",
55	"lastName": "Doe",
56	"email": "user_4@example.com"
57	}
58	},
59	{
60	"createTimestamp": "2024-07-04T00:00:00Z",
61	"comment": "Activity comment 2",
62	"minutesSpent": 4,
63	"createdBy": {
64	"id": 8,
65	"firstName": "John",
66	"lastName": "Doe",
67	"email": "user_8@example.com"
68	}
69	},
70	{
71	"createTimestamp": "2024-07-04T00:00:00Z",
72	"comment": "Activity comment 3",
73	"minutesSpent": 6,
74	"createdBy": {
75	"id": 12,
76	"firstName": "John",
77	"lastName": "Doe",
78	"email": "user_12@example.com"
79	}
80	},
81	{
82	"createTimestamp": "2024-07-04T00:00:00Z",
83	"comment": "Activity comment 4",
84	"minutesSpent": 8,
85	"createdBy": {
86	"id": 16,
87	"firstName": "John",
88	"lastName": "Doe",
89	"email": "user_16@example.com"
90	}
91	}
92	],
93	"totalTime": 20
94	},
95	{
96	"id": 89,
97	"type": "other",
98	"createTimestamp": "2024-07-04T00:00:00Z",
99	"lastUpdateTimestamp": "2024-07-14T00:00:00Z",
100	"open": true,
101	"mdCode": "md-123",
102	"dxCode": "dx-123",
103	"description": "This is a clinical note.",
104	"createdBy": {
105	"id": 1772,
106	"firstName": "John",
107	"lastName": "Doe",
108	"email": "user_1772@example.com"
109	},
110	"assignee": {
111	"id": 100,
112	"firstName": "John",
113	"lastName": "Doe",
114	"email": "user_100@example.com"
115	},
116	"patient": {
117	"id": 456,
118	"externalIdentifier": "external-identifier-123",
119	"firstName": "John",
120	"lastName": "Doe",
121	"dateOfBirth": "1987-09-13",
122	"email": "email@example.com",
123	"phoneNumber": "111-222-3333",
124	"archived": true,
125	"address": {
126	"lineOne": "1234 Market Street",
127	"lineTwo": "Suite 110",
128	"city": "Philadelphia",
129	"state": "PA",
130	"zipCode": "19137",
131	"country": "USA"
132	},
133	"sex": "unknown"
134	},
135	"activity": [
136	{
137	"createTimestamp": "2024-07-04T00:00:00Z",
138	"comment": "Activity comment 1",
139	"minutesSpent": 2,
140	"createdBy": {
141	"id": 4,
142	"firstName": "John",
143	"lastName": "Doe",
144	"email": "user_4@example.com"
145	}
146	},
147	{
148	"createTimestamp": "2024-07-04T00:00:00Z",
149	"comment": "Activity comment 2",
150	"minutesSpent": 4,
151	"createdBy": {
152	"id": 8,
153	"firstName": "John",
154	"lastName": "Doe",
155	"email": "user_8@example.com"
156	}
157	},
158	{
159	"createTimestamp": "2024-07-04T00:00:00Z",
160	"comment": "Activity comment 3",
161	"minutesSpent": 6,
162	"createdBy": {
163	"id": 12,
164	"firstName": "John",
165	"lastName": "Doe",
166	"email": "user_12@example.com"
167	}
168	},
169	{
170	"createTimestamp": "2024-07-04T00:00:00Z",
171	"comment": "Activity comment 4",
172	"minutesSpent": 8,
173	"createdBy": {
174	"id": 16,
175	"firstName": "John",
176	"lastName": "Doe",
177	"email": "user_16@example.com"
178	}
179	}
180	],
181	"totalTime": 20
182	}
183	],
184	"page": 1,
185	"size": 2,
186	"total": 4,
187	"first": true,
188	"last": false
189	}