PUT api/v1/{practiceid}/clinical/encounters/{encounterId}/communications/{communicationId}/{indexId}

Update encounter communication with provided communication body

Request Information

URI Parameters

NameDescriptionTypeAdditional information
practiceid

globally unique identifier

Required
encounterId

globally unique identifier

Required
communicationId

globally unique identifier

Required
indexId

integer

Required

Body Parameters

Com.Healthbridge.Hhas.Clinical.Interface.Commands.UpdateEncounterCommunication
NameDescriptionTypeAdditional information
PracticeId

globally unique identifier

None.
Content

string

None.
Title

string

None.
EncounterId

globally unique identifier

None.
CommunicationId

globally unique identifier

None.
CorrelationIds

Collection of string

None.
OriginatedSystem

string

None.

Request Formats

application/json, text/json

Sample: 
{
  "PracticeId": "f70555b8-ab25-4801-a122-74e641bc3b2a",
  "Content": "sample string 2",
  "Title": "sample string 3",
  "EncounterId": "f129483d-f1e3-41a3-af27-c08ae920689b",
  "CommunicationId": "357eb7c6-1eb7-4add-a5ba-405ea9678688",
  "CorrelationIds": [
    "sample string 1",
    "sample string 2"
  ],
  "OriginatedSystem": "sample string 6"
}

application/xml, text/xml

Sample: 
<UpdateEncounterCommunication xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Com.Healthbridge.Hhas.Clinical.Interface.Commands">
  <CorrelationIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://mpsapi.healthbridge.com/platform/core/v1/command/">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </CorrelationIds>
  <OriginatedSystem xmlns="http://mpsapi.healthbridge.com/platform/core/v1/command/">sample string 6</OriginatedSystem>
  <CommunicationId>357eb7c6-1eb7-4add-a5ba-405ea9678688</CommunicationId>
  <Content>sample string 2</Content>
  <EncounterId>f129483d-f1e3-41a3-af27-c08ae920689b</EncounterId>
  <PracticeId>f70555b8-ab25-4801-a122-74e641bc3b2a</PracticeId>
  <Title>sample string 3</Title>
</UpdateEncounterCommunication>

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

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>