POST api/v2/{practiceId}/clinical/encounters/{encounterId}/followup/send

Schedule sending sms as part of visit followups for encounter

Request Information

URI Parameters

NameDescriptionTypeAdditional information
practiceId

globally unique identifier

Required
encounterId

globally unique identifier

Required

Body Parameters

Com.Healthbridge.Hhas.ClinicalPatientEngagement.Interface.Commands.SendEncounterRequireFollowupPatientSms
NameDescriptionTypeAdditional information
FollowupWithPatientRegardingVisitOutcomeId

globally unique identifier

None.
EncounterId

globally unique identifier

None.
PatientCommunication

Com.Healthbridge.Hhas.ClinicalPatientEngagement.Interface.ValueObjects.PatientCommunicationVo

None.
FollowUpReasons

Collection of string

None.
CorrelationIds

Collection of string

None.
OriginatedSystem

string

None.

Request Formats

application/json, text/json

Sample: 
{
  "FollowupWithPatientRegardingVisitOutcomeId": "ef6fd9eb-4fb4-4af1-afc4-716c8a1e823d",
  "EncounterId": "8d7afdaa-eee1-48c6-be44-267cf1e7a465",
  "PatientCommunication": {
    "PracticeId": "c874b0ac-ff05-40f9-8b38-a0b5cc44afad",
    "PatientId": "e60366db-7635-4f39-8606-c6bc90c32729",
    "PatientName": "sample string 3",
    "PatientSurname": "sample string 4",
    "PatientCellphone": "sample string 5",
    "PatientDOB": "2025-10-10T12:48:10Z",
    "FollowUpDate": "2025-10-10T12:48:10Z",
    "DoctorName": "sample string 8",
    "CommunicationText": "sample string 9"
  },
  "FollowUpReasons": [
    "sample string 1",
    "sample string 2"
  ],
  "CorrelationIds": [
    "sample string 1",
    "sample string 2"
  ],
  "OriginatedSystem": "sample string 3"
}

application/xml, text/xml

Sample: 
<SendEncounterRequireFollowupPatientSms 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 3</OriginatedSystem>
  <EncounterId>8d7afdaa-eee1-48c6-be44-267cf1e7a465</EncounterId>
  <FollowUpReasons xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </FollowUpReasons>
  <FollowupWithPatientRegardingVisitOutcomeId>ef6fd9eb-4fb4-4af1-afc4-716c8a1e823d</FollowupWithPatientRegardingVisitOutcomeId>
  <PatientCommunication xmlns:d2p1="http://mpsapi.healthbridge.com/clinical/clinical/v1/patientnotification/">
    <d2p1:CommunicationText>sample string 9</d2p1:CommunicationText>
    <d2p1:DoctorName>sample string 8</d2p1:DoctorName>
    <d2p1:FollowUpDate>2025-10-10T12:48:10.7746452+02:00</d2p1:FollowUpDate>
    <d2p1:PatientCellphone>sample string 5</d2p1:PatientCellphone>
    <d2p1:PatientDOB>2025-10-10T12:48:10.7746452+02:00</d2p1:PatientDOB>
    <d2p1:PatientId>e60366db-7635-4f39-8606-c6bc90c32729</d2p1:PatientId>
    <d2p1:PatientName>sample string 3</d2p1:PatientName>
    <d2p1:PatientSurname>sample string 4</d2p1:PatientSurname>
    <d2p1:PracticeId>c874b0ac-ff05-40f9-8b38-a0b5cc44afad</d2p1:PracticeId>
  </PatientCommunication>
</SendEncounterRequireFollowupPatientSms>

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

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": "631a048e-dd25-42dd-bd51-6a0f462572ed",
  "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>631a048e-dd25-42dd-bd51-6a0f462572ed</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>