Fetch Clinical Note

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

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

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

Path parameters

clinicalNoteIdlongRequired

Response

This endpoint returns an object.

idlongOptional

The unique identifier of the clinical note.

typestringOptional

The type of the clinical note.

cptCodeobjectOptional

The CPT code associated with the clinical note.

createTimestampdatetimeOptional

The timestamp when the clinical note was created.

lastUpdateTimestampdatetimeOptional

The timestamp when the clinical note was last updated.

openbooleanOptional

Indicates whether the clinical note is open.

mdCodestringOptional

The MD code associated with the clinical note.

dxCodestringOptional

The DX code associated with the clinical note.

descriptionstringOptional

The description of the clinical note.

createdByobjectOptional

The user who created the clinical note.

assigneeobjectOptional

The user assigned to the clinical note.

patientobjectOptional

The patient associated with the clinical note.

activitylist of objectsOptional

List of activities associated with the clinical note.

totalTimeintegerOptional

Total time in minutes spent on the clinical note.

Path parameters

Headers

Response