POST api/v1/{practiceId}/clinical/{encounterId}/communications/pdf

Generate multiple report based on provided communications and save in one pdf

Request Information

URI Parameters

NameDescriptionTypeAdditional information
practiceId

practice id

 globally unique identifier

Required
encounterId

globally unique identifier

Required

Body Parameters

list of communications which should combined into one pdf

Collection of Com.Healthbridge.Hhas.Clinical.Interface.ValueObjects.CommunicationVo
NameDescriptionTypeAdditional information
CommunicationId

the unique identifier for the of the communication instance

 globally unique identifier

None.
PatientId

The Id of the patient linked to the communication

 globally unique identifier

None.
EncounterId

The Id of the encounter linked to the communication

 globally unique identifier

None.
CommunicationTemplateId

Id of the template that is used to create the communication object.

 globally unique identifier

None.
Type

Classification of the communication type

 string

None.
Title

Title

 string

None.
IncludeSignature

boolean

None.

Request Formats

application/json, text/json

Sample: 
[
  {
    "CommunicationId": "e2600660-a60d-4bce-8ba1-b2833b2c171a",
    "PatientId": "206782e6-1ee5-4121-ae5a-b9c51a7054c5",
    "EncounterId": "f7ff08f5-3534-4e1c-b5ff-e7d936e78781",
    "CommunicationTemplateId": "ffa01e5f-4c21-46e9-8dca-bf2bb055f8b5",
    "Type": "sample string 5",
    "Title": "sample string 6",
    "IncludeSignature": true
  },
  {
    "CommunicationId": "e2600660-a60d-4bce-8ba1-b2833b2c171a",
    "PatientId": "206782e6-1ee5-4121-ae5a-b9c51a7054c5",
    "EncounterId": "f7ff08f5-3534-4e1c-b5ff-e7d936e78781",
    "CommunicationTemplateId": "ffa01e5f-4c21-46e9-8dca-bf2bb055f8b5",
    "Type": "sample string 5",
    "Title": "sample string 6",
    "IncludeSignature": true
  }
]

application/xml, text/xml

Sample: 
<ArrayOfCommunication xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://mpsapi.healthbridge.com/clinical/clinical/v1/encounter/">
  <Communication>
    <CommunicationId>e2600660-a60d-4bce-8ba1-b2833b2c171a</CommunicationId>
    <CommunicationTemplateId>ffa01e5f-4c21-46e9-8dca-bf2bb055f8b5</CommunicationTemplateId>
    <EncounterId>f7ff08f5-3534-4e1c-b5ff-e7d936e78781</EncounterId>
    <IncludeSignature>true</IncludeSignature>
    <PatientId>206782e6-1ee5-4121-ae5a-b9c51a7054c5</PatientId>
    <Title>sample string 6</Title>
    <Type>sample string 5</Type>
  </Communication>
  <Communication>
    <CommunicationId>e2600660-a60d-4bce-8ba1-b2833b2c171a</CommunicationId>
    <CommunicationTemplateId>ffa01e5f-4c21-46e9-8dca-bf2bb055f8b5</CommunicationTemplateId>
    <EncounterId>f7ff08f5-3534-4e1c-b5ff-e7d936e78781</EncounterId>
    <IncludeSignature>true</IncludeSignature>
    <PatientId>206782e6-1ee5-4121-ae5a-b9c51a7054c5</PatientId>
    <Title>sample string 6</Title>
    <Type>sample string 5</Type>
  </Communication>
</ArrayOfCommunication>

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 'CommunicationVo[]'.

Response Information

Resource Description

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>