POST api/v1/{providerId}/clinical/patient/{patientId}/sendcommunication

Helps send to patient via email medical certificate/prescription/referral

Request Information

URI Parameters

NameDescriptionTypeAdditional information
providerId

globally unique identifier

Required
patientId

globally unique identifier

Required

Body Parameters

Com.Healthbridge.Hhas.Cloud.WebRole.Models.ApiModels.ProviderCommunicationEmailVo
NameDescriptionTypeAdditional information
Subject

string

None.
Body

string

None.
Recipient

string

None.
BlindCopyRecipient

string

None.
Attachments

Collection of Com.Healthbridge.Hhas.Cloud.WebRole.Models.ApiModels.AttachmentVo

None.
BodyParams

Dictionary of string [key] and string [value]

None.

Request Formats

application/json, text/json

Sample: 
{
  "Subject": "sample string 1",
  "Body": "sample string 2",
  "Recipient": "sample string 3",
  "BlindCopyRecipient": "sample string 4",
  "Attachments": [
    {
      "Title": "sample string 1",
      "Type": "sample string 2",
      "HtmlBody": "sample string 3"
    },
    {
      "Title": "sample string 1",
      "Type": "sample string 2",
      "HtmlBody": "sample string 3"
    }
  ],
  "BodyParams": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  }
}

application/xml, text/xml

Sample: 
<ProviderCommunicationEmailVo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Com.Healthbridge.Hhas.Cloud.WebRole.Models.ApiModels">
  <Attachments>
    <AttachmentVo>
      <HtmlBody>sample string 3</HtmlBody>
      <Title>sample string 1</Title>
      <Type>sample string 2</Type>
    </AttachmentVo>
    <AttachmentVo>
      <HtmlBody>sample string 3</HtmlBody>
      <Title>sample string 1</Title>
      <Type>sample string 2</Type>
    </AttachmentVo>
  </Attachments>
  <BlindCopyRecipient>sample string 4</BlindCopyRecipient>
  <Body>sample string 2</Body>
  <BodyParams 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>
  </BodyParams>
  <Recipient>sample string 3</Recipient>
  <Subject>sample string 1</Subject>
</ProviderCommunicationEmailVo>

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 'ProviderCommunicationEmailVo'.

Response Information

Resource Description

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

boolean

None.
ResponseCode

integer

None.
ResponseMessage

string

None.
Data

boolean

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": true,
  "Links": [
    {
      "Rel": "sample string 1",
      "HRef": "sample string 2"
    },
    {
      "Rel": "sample string 1",
      "HRef": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample: 
<RestApiResultOfboolean xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Com.Healthbridge.Core.CommonDomain.Interface.ValueObjects">
  <Data>true</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>
</RestApiResultOfboolean>