POST api/v2/{practiceId}/clinical/patientcommunication/{patientId}/send

Allow to send communication to patient via SMS or email

Request Information

URI Parameters

NameDescriptionTypeAdditional information
practiceId

globally unique identifier

Required
patientId

globally unique identifier

Required

Body Parameters

Com.Healthbridge.Hhas.ClinicalPatientEngagement.Interface.Commands.TriggerPatientCommunication
NameDescriptionTypeAdditional information
PatientCommunication

Com.Healthbridge.Hhas.ClinicalPatientEngagement.Interface.ValueObjects.PatientCommunicationFollowupVo

None.
SendNow

boolean

None.
CorrelationIds

Collection of string

None.
OriginatedSystem

string

None.

Request Formats

application/json, text/json

Sample: 
{
  "PatientCommunication": {
    "Id": "4b5d5fd2-712f-406e-bc0d-18164b602653",
    "TenantId": "12da5d30-fb42-40c9-91ef-ba683abf85d2",
    "Provider": {
      "PracticeType": "sample string 1",
      "PracticeName": "sample string 2",
      "SpecialityCode": "sample string 3",
      "SubSpecialityCode": "sample string 4",
      "PracticeNumber": "sample string 5",
      "TreatingDoctorName": "sample string 6",
      "TreatingDoctorPracticeNumber": "sample string 7",
      "DispensingDoctor": "sample string 8",
      "DispensingLicenseNumber": "sample string 9",
      "HPCSANumber": "sample string 10",
      "ContactNumber": "sample string 11",
      "Qualification": "sample string 12",
      "SpecialityDescription": "sample string 13",
      "TelephoneNumber": "sample string 14",
      "FaxNumber": "sample string 15",
      "CellphoneNumber": "sample string 16",
      "EmailAddress": "sample string 17",
      "PhysicalAddress": "sample string 18",
      "PostalAddress": "sample string 19",
      "IsLocumProvider": true
    },
    "PatientId": "b1574df6-5f43-49bc-bab3-bb661fad005e",
    "UserId": "33216e60-a538-4c5e-941f-1d4529a7524b",
    "Context": "sample string 4",
    "ContextId": "sample string 5",
    "DeliveryType": 0,
    "Sender": "sample string 6",
    "Message": "sample string 7",
    "Priority": 0,
    "Destination": "sample string 8",
    "BlindCopyDestination": "sample string 9",
    "Subject": "sample string 10",
    "Attachments": [
      {
        "DocumentUrl": "sample string 1",
        "FileName": "sample string 2",
        "MimeType": "sample string 3"
      },
      {
        "DocumentUrl": "sample string 1",
        "FileName": "sample string 2",
        "MimeType": "sample string 3"
      }
    ],
    "Status": 0,
    "ScheduledDate": "2025-04-15T12:43:54Z",
    "SentDate": "2025-04-15T12:43:54Z",
    "ReceivedDate": "2025-04-15T12:43:54Z",
    "MediumSentReference": "sample string 12"
  },
  "SendNow": true,
  "CorrelationIds": [
    "sample string 1",
    "sample string 2"
  ],
  "OriginatedSystem": "sample string 2"
}

application/xml, text/xml

Sample: 
<TriggerPatientCommunication xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Com.Healthbridge.Hhas.ClinicalPatientEngagement.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 2</OriginatedSystem>
  <PatientCommunication xmlns:d2p1="http://schemas.datacontract.org/2004/07/Com.Healthbridge.Hhas.ClinicalPatientEngagement.Interface.ValueObjects">
    <d2p1:Attachments>
      <d2p1:CommunicationAttachment>
        <d2p1:DocumentUrl>sample string 1</d2p1:DocumentUrl>
        <d2p1:FileName>sample string 2</d2p1:FileName>
        <d2p1:MimeType>sample string 3</d2p1:MimeType>
      </d2p1:CommunicationAttachment>
      <d2p1:CommunicationAttachment>
        <d2p1:DocumentUrl>sample string 1</d2p1:DocumentUrl>
        <d2p1:FileName>sample string 2</d2p1:FileName>
        <d2p1:MimeType>sample string 3</d2p1:MimeType>
      </d2p1:CommunicationAttachment>
    </d2p1:Attachments>
    <d2p1:BlindCopyDestination>sample string 9</d2p1:BlindCopyDestination>
    <d2p1:Context>sample string 4</d2p1:Context>
    <d2p1:ContextId>sample string 5</d2p1:ContextId>
    <d2p1:DeliveryType>Email</d2p1:DeliveryType>
    <d2p1:Destination>sample string 8</d2p1:Destination>
    <d2p1:Id>4b5d5fd2-712f-406e-bc0d-18164b602653</d2p1:Id>
    <d2p1:MediumSentReference>sample string 12</d2p1:MediumSentReference>
    <d2p1:Message>sample string 7</d2p1:Message>
    <d2p1:PatientId>b1574df6-5f43-49bc-bab3-bb661fad005e</d2p1:PatientId>
    <d2p1:Priority>Low</d2p1:Priority>
    <d2p1:Provider xmlns:d3p1="http://mpsapi.healthbridge.com/clinical/clinical/v1/encounter/">
      <d3p1:CellphoneNumber>sample string 16</d3p1:CellphoneNumber>
      <d3p1:ContactNumber>sample string 11</d3p1:ContactNumber>
      <d3p1:DispensingDoctor>sample string 8</d3p1:DispensingDoctor>
      <d3p1:DispensingLicenseNumber>sample string 9</d3p1:DispensingLicenseNumber>
      <d3p1:EmailAddress>sample string 17</d3p1:EmailAddress>
      <d3p1:FaxNumber>sample string 15</d3p1:FaxNumber>
      <d3p1:HPCSANumber>sample string 10</d3p1:HPCSANumber>
      <d3p1:IsLocumProvider>true</d3p1:IsLocumProvider>
      <d3p1:PhysicalAddress>sample string 18</d3p1:PhysicalAddress>
      <d3p1:PostalAddress>sample string 19</d3p1:PostalAddress>
      <d3p1:PracticeName>sample string 2</d3p1:PracticeName>
      <d3p1:PracticeNumber>sample string 5</d3p1:PracticeNumber>
      <d3p1:PracticeType>sample string 1</d3p1:PracticeType>
      <d3p1:Qualification>sample string 12</d3p1:Qualification>
      <d3p1:SpecialityCode>sample string 3</d3p1:SpecialityCode>
      <d3p1:SpecialityDescription>sample string 13</d3p1:SpecialityDescription>
      <d3p1:SubSpecialityCode>sample string 4</d3p1:SubSpecialityCode>
      <d3p1:TelephoneNumber>sample string 14</d3p1:TelephoneNumber>
      <d3p1:TreatingDoctorName>sample string 6</d3p1:TreatingDoctorName>
      <d3p1:TreatingDoctorPracticeNumber>sample string 7</d3p1:TreatingDoctorPracticeNumber>
    </d2p1:Provider>
    <d2p1:ReceivedDate>2025-04-15T12:43:54.9451898+02:00</d2p1:ReceivedDate>
    <d2p1:ScheduledDate>2025-04-15T12:43:54.9451898+02:00</d2p1:ScheduledDate>
    <d2p1:Sender>sample string 6</d2p1:Sender>
    <d2p1:SentDate>2025-04-15T12:43:54.9451898+02:00</d2p1:SentDate>
    <d2p1:Status>InProgress</d2p1:Status>
    <d2p1:Subject>sample string 10</d2p1:Subject>
    <d2p1:TenantId>12da5d30-fb42-40c9-91ef-ba683abf85d2</d2p1:TenantId>
    <d2p1:UserId>33216e60-a538-4c5e-941f-1d4529a7524b</d2p1:UserId>
  </PatientCommunication>
  <SendNow>true</SendNow>
</TriggerPatientCommunication>

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

Response Information

Resource Description

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

boolean

None.
ResponseCode

integer

None.
ResponseMessage

string

None.
Data

globally unique identifier

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": "d05295e1-3fb6-4d1e-bafa-e877d5c4baff",
  "Links": [
    {
      "Rel": "sample string 1",
      "HRef": "sample string 2"
    },
    {
      "Rel": "sample string 1",
      "HRef": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample: 
<RestApiResultOfguid xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Com.Healthbridge.Core.CommonDomain.Interface.ValueObjects">
  <Data>d05295e1-3fb6-4d1e-bafa-e877d5c4baff</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>
</RestApiResultOfguid>