GET api/v1/{practiceId}/clinical/patientdocument/{patientId}
Get patient documents
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| practiceId |
Unique identifier of practice |
globally unique identifier |
Required |
| patientId |
Unique identifier of patient |
globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
documents collection
Collection of Com.Healthbridge.Hhas.Clinical.Interface.ValueObjects.PatientDocumentVo| Name | Description | Type | Additional information |
|---|---|---|---|
| DocumentId |
Unique document identifier |
globally unique identifier |
None. |
| PracticeId |
Context identifier (doctor id) |
globally unique identifier |
None. |
| PatientId |
Patient id |
globally unique identifier |
None. |
| CreatedBy |
User id |
string |
None. |
| FileName |
Document name |
string |
None. |
| MimeType |
Mime type |
string |
None. |
| FileSize |
File size in bytes |
integer |
None. |
| Category |
Document category |
string |
None. |
| Description |
Document description |
string |
None. |
| DocumentUrl |
Relative path to document content |
string |
None. |
| ThumbnailUrl |
Relative path to document thumbnail |
string |
None. |
| Transcription | Com.Healthbridge.Hhas.Clinical.Interface.ValueObjects.TranscriptionVo |
None. |
|
| CapturedDate |
Date when document were captured |
date |
None. |
| DocumentDate |
Document date |
date |
None. |
| Notes |
Notes captured by doctor |
string |
None. |
| AdditionalData |
Contains source specific data |
Dictionary of string [key] and string [value] |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"DocumentId": "b6b7f88c-968a-4cf4-8595-27e36e45c13c",
"PracticeId": "e2ec772c-cb99-4108-9a78-1762564922d8",
"PatientId": "e48fb0c7-3025-450b-96d5-938607886ae2",
"CreatedBy": "sample string 4",
"FileName": "sample string 5",
"MimeType": "sample string 6",
"FileSize": 7,
"Category": "sample string 8",
"Description": "sample string 9",
"DocumentUrl": "sample string 10",
"ThumbnailUrl": "sample string 11",
"Transcription": {
"FileName": "sample string 1",
"TranscriptionUrl": "sample string 2",
"CreatedDate": "2025-08-06T10:50:21Z",
"MimeType": "sample string 4",
"FileSize": 5
},
"CapturedDate": "2025-08-06T10:50:21Z",
"DocumentDate": "2025-08-06T10:50:21Z",
"Notes": "sample string 14",
"AdditionalData": {
"sample string 1": "sample string 2",
"sample string 3": "sample string 4"
}
},
{
"DocumentId": "b6b7f88c-968a-4cf4-8595-27e36e45c13c",
"PracticeId": "e2ec772c-cb99-4108-9a78-1762564922d8",
"PatientId": "e48fb0c7-3025-450b-96d5-938607886ae2",
"CreatedBy": "sample string 4",
"FileName": "sample string 5",
"MimeType": "sample string 6",
"FileSize": 7,
"Category": "sample string 8",
"Description": "sample string 9",
"DocumentUrl": "sample string 10",
"ThumbnailUrl": "sample string 11",
"Transcription": {
"FileName": "sample string 1",
"TranscriptionUrl": "sample string 2",
"CreatedDate": "2025-08-06T10:50:21Z",
"MimeType": "sample string 4",
"FileSize": 5
},
"CapturedDate": "2025-08-06T10:50:21Z",
"DocumentDate": "2025-08-06T10:50:21Z",
"Notes": "sample string 14",
"AdditionalData": {
"sample string 1": "sample string 2",
"sample string 3": "sample string 4"
}
}
]
application/xml, text/xml
Sample:
<ArrayOfPatientDocumentVo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Com.Healthbridge.Hhas.Clinical.Interface.ValueObjects">
<PatientDocumentVo>
<AdditionalData xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>sample string 1</d3p1:Key>
<d3p1:Value>sample string 2</d3p1:Value>
</d3p1:KeyValueOfstringstring>
<d3p1:KeyValueOfstringstring>
<d3p1:Key>sample string 3</d3p1:Key>
<d3p1:Value>sample string 4</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</AdditionalData>
<CapturedDate>2025-08-06T10:50:21.5236053+02:00</CapturedDate>
<Category>sample string 8</Category>
<CreatedBy>sample string 4</CreatedBy>
<Description>sample string 9</Description>
<DocumentDate>2025-08-06T10:50:21.5236053+02:00</DocumentDate>
<DocumentId>b6b7f88c-968a-4cf4-8595-27e36e45c13c</DocumentId>
<DocumentUrl>sample string 10</DocumentUrl>
<FileName>sample string 5</FileName>
<FileSize>7</FileSize>
<MimeType>sample string 6</MimeType>
<Notes>sample string 14</Notes>
<PatientId>e48fb0c7-3025-450b-96d5-938607886ae2</PatientId>
<PracticeId>e2ec772c-cb99-4108-9a78-1762564922d8</PracticeId>
<ThumbnailUrl>sample string 11</ThumbnailUrl>
<Transcription>
<CreatedDate>2025-08-06T10:50:21.5236053+02:00</CreatedDate>
<FileName>sample string 1</FileName>
<FileSize>5</FileSize>
<MimeType>sample string 4</MimeType>
<TranscriptionUrl>sample string 2</TranscriptionUrl>
</Transcription>
</PatientDocumentVo>
<PatientDocumentVo>
<AdditionalData xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>sample string 1</d3p1:Key>
<d3p1:Value>sample string 2</d3p1:Value>
</d3p1:KeyValueOfstringstring>
<d3p1:KeyValueOfstringstring>
<d3p1:Key>sample string 3</d3p1:Key>
<d3p1:Value>sample string 4</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</AdditionalData>
<CapturedDate>2025-08-06T10:50:21.5236053+02:00</CapturedDate>
<Category>sample string 8</Category>
<CreatedBy>sample string 4</CreatedBy>
<Description>sample string 9</Description>
<DocumentDate>2025-08-06T10:50:21.5236053+02:00</DocumentDate>
<DocumentId>b6b7f88c-968a-4cf4-8595-27e36e45c13c</DocumentId>
<DocumentUrl>sample string 10</DocumentUrl>
<FileName>sample string 5</FileName>
<FileSize>7</FileSize>
<MimeType>sample string 6</MimeType>
<Notes>sample string 14</Notes>
<PatientId>e48fb0c7-3025-450b-96d5-938607886ae2</PatientId>
<PracticeId>e2ec772c-cb99-4108-9a78-1762564922d8</PracticeId>
<ThumbnailUrl>sample string 11</ThumbnailUrl>
<Transcription>
<CreatedDate>2025-08-06T10:50:21.5236053+02:00</CreatedDate>
<FileName>sample string 1</FileName>
<FileSize>5</FileSize>
<MimeType>sample string 4</MimeType>
<TranscriptionUrl>sample string 2</TranscriptionUrl>
</Transcription>
</PatientDocumentVo>
</ArrayOfPatientDocumentVo>