GET api/v1/{practiceid}/clinical/patientdocument/byId/{documentId}

Get patient document info

Request Information

URI Parameters

NameDescriptionTypeAdditional information
practiceid

Unique identifier of practice

 globally unique identifier

Required
documentId

Unique identifier of file

 globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

documents collection

Com.Healthbridge.Hhas.Clinical.Interface.ValueObjects.PatientDocumentVo
NameDescriptionTypeAdditional 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": "d7c3b17c-b20d-4ecc-be72-31cdad4c02dc",
  "PracticeId": "b460d2a5-5205-42e1-a7fc-7bbcf8c21b65",
  "PatientId": "f1118ccc-f0b2-4144-87c6-4ae92ff2d6ee",
  "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-11-20T12:41:33Z",
    "MimeType": "sample string 4",
    "FileSize": 5
  },
  "CapturedDate": "2025-11-20T12:41:33Z",
  "DocumentDate": "2025-11-20T12:41:33Z",
  "Notes": "sample string 14",
  "AdditionalData": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  }
}

application/xml, text/xml

Sample: 
<PatientDocumentVo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Com.Healthbridge.Hhas.Clinical.Interface.ValueObjects">
  <AdditionalData xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value>sample string 4</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </AdditionalData>
  <CapturedDate>2025-11-20T12:41:33.9927244+02:00</CapturedDate>
  <Category>sample string 8</Category>
  <CreatedBy>sample string 4</CreatedBy>
  <Description>sample string 9</Description>
  <DocumentDate>2025-11-20T12:41:33.9927244+02:00</DocumentDate>
  <DocumentId>d7c3b17c-b20d-4ecc-be72-31cdad4c02dc</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>f1118ccc-f0b2-4144-87c6-4ae92ff2d6ee</PatientId>
  <PracticeId>b460d2a5-5205-42e1-a7fc-7bbcf8c21b65</PracticeId>
  <ThumbnailUrl>sample string 11</ThumbnailUrl>
  <Transcription>
    <CreatedDate>2025-11-20T12:41:33.9927244+02:00</CreatedDate>
    <FileName>sample string 1</FileName>
    <FileSize>5</FileSize>
    <MimeType>sample string 4</MimeType>
    <TranscriptionUrl>sample string 2</TranscriptionUrl>
  </Transcription>
</PatientDocumentVo>