List Clinical Notes

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.

Headers

Impilo-API-KeystringRequired

Query parameters

pageintegerOptional

The page number of the content returned.

sizeintegerOptional

The size of the page of content returned.

sortenumOptional

The attribute to sort on.

Allowed values:
sortDescendingbooleanOptional

True if the sort direction should be descending.

idlist of longsOptional

Lists only clinical notes with the IDs provided.

openbooleanOptional

Lists only open clinical notes.

descriptionstringOptional

Lists only clinical notes with the provided description.

typelist of enumsOptional

Lists only clinical notes with the provided types.

Allowed values:
cptCodeValuelist of stringsOptional

Lists only clinical notes with the provided CPT code values.

assigneeIdlist of longsOptional

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.

createdByIdlist of longsOptional

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.

patientIdlist of longsOptional

Lists only clinical notes associated with the provided patient IDs.

patientSiteIdlist of longsOptional

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

patientExternalIdentifierlist of stringsOptional

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

OK

contentlist of objectsOptional

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

firstbooleanOptional

True if this is the first page, false otherwise.

lastbooleanOptional

True if this is the last page, false otherwise.

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.