Fetch Clinical Note

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

1 { 2 "activity": [ 3 { 4 "comment": "Activity comment 1", 5 "createTimestamp": "2024-07-04T00:00:00Z", 6 "createdBy": { 7 "email": "user_4@example.com", 8 "firstName": "John", 9 "id": 4, 10 "lastName": "Doe" 11 }, 12 "minutesSpent": 2 13 }, 14 { 15 "comment": "Activity comment 2", 16 "createTimestamp": "2024-07-04T00:00:00Z", 17 "createdBy": { 18 "email": "user_8@example.com", 19 "firstName": "John", 20 "id": 8, 21 "lastName": "Doe" 22 }, 23 "minutesSpent": 4 24 }, 25 { 26 "comment": "Activity comment 3", 27 "createTimestamp": "2024-07-04T00:00:00Z", 28 "createdBy": { 29 "email": "user_12@example.com", 30 "firstName": "John", 31 "id": 12, 32 "lastName": "Doe" 33 }, 34 "minutesSpent": 6 35 }, 36 { 37 "comment": "Activity comment 4", 38 "createTimestamp": "2024-07-04T00:00:00Z", 39 "createdBy": { 40 "email": "user_16@example.com", 41 "firstName": "John", 42 "id": 16, 43 "lastName": "Doe" 44 }, 45 "minutesSpent": 8 46 } 47 ], 48 "assignee": { 49 "email": "user_100@example.com", 50 "firstName": "John", 51 "id": 100, 52 "lastName": "Doe" 53 }, 54 "createTimestamp": "2024-07-04T00:00:00Z", 55 "createdBy": { 56 "email": "user_1772@example.com", 57 "firstName": "John", 58 "id": 1772, 59 "lastName": "Doe" 60 }, 61 "description": "This is a clinical note.", 62 "dxCode": "dx-123", 63 "id": 99, 64 "lastUpdateTimestamp": "2024-07-14T00:00:00Z", 65 "mdCode": "md-123", 66 "open": true, 67 "patient": { 68 "firstName": "John", 69 "lastName": "Doe", 70 "address": { 71 "city": "Philadelphia", 72 "country": "USA", 73 "lineOne": "1234 Market Street", 74 "state": "PA", 75 "zipCode": "19137", 76 "lineTwo": "Suite 110" 77 }, 78 "dateOfBirth": "1987-09-13", 79 "email": "email@example.com", 80 "externalIdentifier": "external-identifier-123", 81 "id": 456, 82 "phoneNumber": "111-222-3333", 83 "sex": "unknown" 84 }, 85 "totalTime": 20, 86 "type": "pcm" 87 }

Fetches details of a specific clinical note by its unique ID.

Path parameters

clinicalNoteIdlongRequired

Response

activitylist of objects or null

List of activities associated with the clinical note.

assigneeobject or null

The user assigned to the clinical note.

cptCodeobject or null

The CPT code associated with the clinical note.

createTimestampstring or nullformat: "date-time"

The timestamp when the clinical note was created.

createdByobject or null

The user who created the clinical note.

descriptionstring or null

The description of the clinical note.

dxCodestring or null

The DX code associated with the clinical note.

idlong or null

The unique identifier of the clinical note.

lastUpdateTimestampstring or nullformat: "date-time"

The timestamp when the clinical note was last updated.

mdCodestring or null

The MD code associated with the clinical note.

openboolean or null

Indicates whether the clinical note is open.

patientobject or null

The patient associated with the clinical note.

totalTimeinteger or null

Total time in minutes spent on the clinical note.

typeenum or null

The type of the clinical note.

Allowed values:

Path parameters

Headers

Response