PUT api/v2/{practiceId}/clinical/encounters/{encounterId}/communications/{communicationId}/render

Render encounter communication (stateless/pure function)

Request Information

URI Parameters

NameDescriptionTypeAdditional information
practiceId

globally unique identifier

Required
encounterId

globally unique identifier

Required
communicationId

globally unique identifier

Required

Body Parameters

Com.Healthbridge.Hhas.Clinical.Interface.ValueObjects.CommunicationRenderRequest
NameDescriptionTypeAdditional information
Encounter

Com.Healthbridge.Hhas.Clinical.Interface.ValueObjects.EncounterVo

None.
Template

Com.Healthbridge.Core.CommonDomain.Interface.ValueObjects.CommunicationTemplateVo

None.
Branch

Com.Healthbridge.Hhas.Billing.Interface.ValueObjects.ProviderBranchConfigurationVo

None.
BaseTemplate

Com.Healthbridge.Core.CommonDomain.Interface.ValueObjects.CommunicationTemplateVo

None.
PatientAllergies

Collection of string

None.
PatientAllergiesNote

string

None.
ClinicalNote

string

None.
ChronicConditions

Collection of string

None.
SurgicalHistory

Com.Healthbridge.Hhas.Clinical.Interface.ValueObjects.PatientSurgicalHistoryVo

None.

Request Formats

application/json

Sample:

An exception has occurred while using the formatter 'System.Net.Http.Formatting.JsonMediaTypeFormatter' to generate sample for media type 'application/json'. Exception message: Self referencing loop detected with type 'Com.Healthbridge.Hhas.Clinical.Interface.ValueObjects.SymptomQuestion'. Path 'Encounter.SymptomQuestions[0].Questions'.

text/json

Sample:

An exception has occurred while using the formatter 'System.Net.Http.Formatting.JsonMediaTypeFormatter' to generate sample for media type 'text/json'. Exception message: Self referencing loop detected with type 'Com.Healthbridge.Hhas.Clinical.Interface.ValueObjects.SymptomQuestion'. Path 'Encounter.SymptomQuestions[0].Questions'.

application/xml

Sample:

An exception has occurred while using the formatter 'System.Net.Http.Formatting.XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: Object graph for type 'Com.Healthbridge.Hhas.Clinical.Interface.ValueObjects.SymptomQuestion' contains cycles and cannot be serialized if reference tracking is disabled.

text/xml

Sample:

An exception has occurred while using the formatter 'System.Net.Http.Formatting.XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: Object graph for type 'Com.Healthbridge.Hhas.Clinical.Interface.ValueObjects.SymptomQuestion' contains cycles and cannot be serialized if reference tracking is disabled.

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

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>