POST api/v1/{practiceId}/clinical/{encounterId}/communications/{patientId}/htmltopdf/capture

Generate communication reports as single PDF and capture as patient document

Request Information

URI Parameters

NameDescriptionTypeAdditional information
practiceId

practice id

 globally unique identifier

Required
encounterId

encounter id

 globally unique identifier

Required
patientId

patient id

 globally unique identifier

Required

Body Parameters

Com.Healthbridge.Hhas.Cloud.WebRole.Areas.Clinical.Model.CommunicationPdfCaptureRequest
NameDescriptionTypeAdditional information
Htmls

Array of HTML content to convert to PDF

 Collection of string

None.
Document

Patient document metadata

 Com.Healthbridge.Hhas.Clinical.Interface.ValueObjects.PatientDocumentVo

None.
ReplaceExistingDocument

Whether to replace existing document

 boolean

None.

Request Formats

application/json, text/json

Sample: 
{
  "Htmls": [
    "sample string 1",
    "sample string 2"
  ],
  "Document": {
    "DocumentId": "3fb5d719-6162-4cf4-a755-137470943b51",
    "PracticeId": "4825f92f-8110-4086-b656-4fa16a85b75f",
    "PatientId": "10cf5b88-9fb6-4fc4-8060-19a7b9c6515b",
    "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": "2026-02-05T14:24:35Z",
      "MimeType": "sample string 4",
      "FileSize": 5
    },
    "CapturedDate": "2026-02-05T14:24:35Z",
    "DocumentDate": "2026-02-05T14:24:35Z",
    "Notes": "sample string 14",
    "AdditionalData": {
      "sample string 1": "sample string 2",
      "sample string 3": "sample string 4"
    }
  },
  "ReplaceExistingDocument": true
}

application/xml, text/xml

Sample: 
<CommunicationPdfCaptureRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Com.Healthbridge.Hhas.Cloud.WebRole.Areas.Clinical.Model">
  <Document xmlns:d2p1="http://schemas.datacontract.org/2004/07/Com.Healthbridge.Hhas.Clinical.Interface.ValueObjects">
    <d2p1: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>
    </d2p1:AdditionalData>
    <d2p1:CapturedDate>2026-02-05T14:24:35.6916863+02:00</d2p1:CapturedDate>
    <d2p1:Category>sample string 8</d2p1:Category>
    <d2p1:CreatedBy>sample string 4</d2p1:CreatedBy>
    <d2p1:Description>sample string 9</d2p1:Description>
    <d2p1:DocumentDate>2026-02-05T14:24:35.6916863+02:00</d2p1:DocumentDate>
    <d2p1:DocumentId>3fb5d719-6162-4cf4-a755-137470943b51</d2p1:DocumentId>
    <d2p1:DocumentUrl>sample string 10</d2p1:DocumentUrl>
    <d2p1:FileName>sample string 5</d2p1:FileName>
    <d2p1:FileSize>7</d2p1:FileSize>
    <d2p1:MimeType>sample string 6</d2p1:MimeType>
    <d2p1:Notes>sample string 14</d2p1:Notes>
    <d2p1:PatientId>10cf5b88-9fb6-4fc4-8060-19a7b9c6515b</d2p1:PatientId>
    <d2p1:PracticeId>4825f92f-8110-4086-b656-4fa16a85b75f</d2p1:PracticeId>
    <d2p1:ThumbnailUrl>sample string 11</d2p1:ThumbnailUrl>
    <d2p1:Transcription>
      <d2p1:CreatedDate>2026-02-05T14:24:35.6916863+02:00</d2p1:CreatedDate>
      <d2p1:FileName>sample string 1</d2p1:FileName>
      <d2p1:FileSize>5</d2p1:FileSize>
      <d2p1:MimeType>sample string 4</d2p1:MimeType>
      <d2p1:TranscriptionUrl>sample string 2</d2p1:TranscriptionUrl>
    </d2p1:Transcription>
  </Document>
  <Htmls xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Htmls>
  <ReplaceExistingDocument>true</ReplaceExistingDocument>
</CommunicationPdfCaptureRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'System.Web.Http.ModelBinding.JQueryMvcFormUrlEncodedFormatter' to write type 'CommunicationPdfCaptureRequest'.

Response Information

Resource Description

Document URL

Com.Healthbridge.Core.CommonDomain.Interface.ValueObjects.RestApiResultOfSystem.String
NameDescriptionTypeAdditional information
Sucess

boolean

None.
ResponseCode

integer

None.
ResponseMessage

string

None.
Data

string

None.
Links

Collection of Com.Healthbridge.Core.CommonDomain.Interface.ValueObjects.RestApiLink

None.

Response Formats

application/json, text/json

Sample: 
{
  "Sucess": true,
  "ResponseCode": 2,
  "ResponseMessage": "sample string 3",
  "Data": "sample string 4",
  "Links": [
    {
      "Rel": "sample string 1",
      "HRef": "sample string 2"
    },
    {
      "Rel": "sample string 1",
      "HRef": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample: 
<RestApiResultOfstring xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Com.Healthbridge.Core.CommonDomain.Interface.ValueObjects">
  <Data>sample string 4</Data>
  <Links>
    <RestApiLink>
      <HRef>sample string 2</HRef>
      <Rel>sample string 1</Rel>
    </RestApiLink>
    <RestApiLink>
      <HRef>sample string 2</HRef>
      <Rel>sample string 1</Rel>
    </RestApiLink>
  </Links>
  <ResponseCode>2</ResponseCode>
  <ResponseMessage>sample string 3</ResponseMessage>
  <Sucess>true</Sucess>
</RestApiResultOfstring>