GET api/v2/clinical/patientcommunication/failed?since={since}

Return list of patient communication which failed to send (available for admins)

Request Information

URI Parameters

Name	Description	Type	Additional information
since	datetime in UTC format, e.g. 2019-05-06T08:17:00Z	date	Required

Body Parameters

None.

Response Information

Resource Description

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

Name	Type	Additional information
Id	globally unique identifier	None.
TenantId	globally unique identifier	None.
Provider	Com.Healthbridge.Hhas.Clinical.Interface.ValueObjects.ProviderVo	None.
PatientId	globally unique identifier	None.
UserId	globally unique identifier	None.
Context	string	None.
ContextId	string	None.
DeliveryType	Com.Healthbridge.Hhas.ClinicalPatientEngagement.Interface.ValueObjects.PatientCommunicationMedium	None.
Sender	string	None.
Message	string	None.
Priority	Com.Healthbridge.Hhas.ClinicalPatientEngagement.Interface.ValueObjects.PatientCommunicationPriority	None.
Destination	string	None.
BlindCopyDestination	string	None.
Subject	string	None.
Attachments	Collection of Com.Healthbridge.Hhas.ClinicalPatientEngagement.Interface.ValueObjects.CommunicationAttachment	None.
Status	Com.Healthbridge.Hhas.ClinicalPatientEngagement.Interface.ValueObjects.PatientCommunicationDeliveryStatus	None.
ScheduledDate	date	None.
SentDate	date	None.
ReceivedDate	date	None.
MediumSentReference	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Id": "bebf9f29-4724-47ae-a32a-70f8ac5c9d14",
    "TenantId": "e773458f-953c-4288-959b-402b2970bc8e",
    "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": "3869be29-45e7-414e-a667-b2757663cef8",
    "UserId": "d9bef75c-e695-4e6e-8342-3fddae64b33f",
    "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-11-21T16:52:30Z",
    "SentDate": "2025-11-21T16:52:30Z",
    "ReceivedDate": "2025-11-21T16:52:30Z",
    "MediumSentReference": "sample string 12"
  },
  {
    "Id": "bebf9f29-4724-47ae-a32a-70f8ac5c9d14",
    "TenantId": "e773458f-953c-4288-959b-402b2970bc8e",
    "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": "3869be29-45e7-414e-a667-b2757663cef8",
    "UserId": "d9bef75c-e695-4e6e-8342-3fddae64b33f",
    "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-11-21T16:52:30Z",
    "SentDate": "2025-11-21T16:52:30Z",
    "ReceivedDate": "2025-11-21T16:52:30Z",
    "MediumSentReference": "sample string 12"
  }
]

application/xml, text/xml

Sample:

<ArrayOfPatientCommunicationFollowupVo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Com.Healthbridge.Hhas.ClinicalPatientEngagement.Interface.ValueObjects">
  <PatientCommunicationFollowupVo>
    <Attachments>
      <CommunicationAttachment>
        <DocumentUrl>sample string 1</DocumentUrl>
        <FileName>sample string 2</FileName>
        <MimeType>sample string 3</MimeType>
      </CommunicationAttachment>
      <CommunicationAttachment>
        <DocumentUrl>sample string 1</DocumentUrl>
        <FileName>sample string 2</FileName>
        <MimeType>sample string 3</MimeType>
      </CommunicationAttachment>
    </Attachments>
    <BlindCopyDestination>sample string 9</BlindCopyDestination>
    <Context>sample string 4</Context>
    <ContextId>sample string 5</ContextId>
    <DeliveryType>Email</DeliveryType>
    <Destination>sample string 8</Destination>
    <Id>bebf9f29-4724-47ae-a32a-70f8ac5c9d14</Id>
    <MediumSentReference>sample string 12</MediumSentReference>
    <Message>sample string 7</Message>
    <PatientId>3869be29-45e7-414e-a667-b2757663cef8</PatientId>
    <Priority>Low</Priority>
    <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>
    </Provider>
    <ReceivedDate>2025-11-21T16:52:30.8689769+02:00</ReceivedDate>
    <ScheduledDate>2025-11-21T16:52:30.8689769+02:00</ScheduledDate>
    <Sender>sample string 6</Sender>
    <SentDate>2025-11-21T16:52:30.8689769+02:00</SentDate>
    <Status>InProgress</Status>
    <Subject>sample string 10</Subject>
    <TenantId>e773458f-953c-4288-959b-402b2970bc8e</TenantId>
    <UserId>d9bef75c-e695-4e6e-8342-3fddae64b33f</UserId>
  </PatientCommunicationFollowupVo>
  <PatientCommunicationFollowupVo>
    <Attachments>
      <CommunicationAttachment>
        <DocumentUrl>sample string 1</DocumentUrl>
        <FileName>sample string 2</FileName>
        <MimeType>sample string 3</MimeType>
      </CommunicationAttachment>
      <CommunicationAttachment>
        <DocumentUrl>sample string 1</DocumentUrl>
        <FileName>sample string 2</FileName>
        <MimeType>sample string 3</MimeType>
      </CommunicationAttachment>
    </Attachments>
    <BlindCopyDestination>sample string 9</BlindCopyDestination>
    <Context>sample string 4</Context>
    <ContextId>sample string 5</ContextId>
    <DeliveryType>Email</DeliveryType>
    <Destination>sample string 8</Destination>
    <Id>bebf9f29-4724-47ae-a32a-70f8ac5c9d14</Id>
    <MediumSentReference>sample string 12</MediumSentReference>
    <Message>sample string 7</Message>
    <PatientId>3869be29-45e7-414e-a667-b2757663cef8</PatientId>
    <Priority>Low</Priority>
    <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>
    </Provider>
    <ReceivedDate>2025-11-21T16:52:30.8689769+02:00</ReceivedDate>
    <ScheduledDate>2025-11-21T16:52:30.8689769+02:00</ScheduledDate>
    <Sender>sample string 6</Sender>
    <SentDate>2025-11-21T16:52:30.8689769+02:00</SentDate>
    <Status>InProgress</Status>
    <Subject>sample string 10</Subject>
    <TenantId>e773458f-953c-4288-959b-402b2970bc8e</TenantId>
    <UserId>d9bef75c-e695-4e6e-8342-3fddae64b33f</UserId>
  </PatientCommunicationFollowupVo>
</ArrayOfPatientCommunicationFollowupVo>

URI parameters

Headers | Add header

Body

Status

Headers

Body

GET api/v2/clinical/patientcommunication/failed?since={since}

Request Information

URI Parameters

Body Parameters

Response Information

Resource Description

Response Formats

application/json, text/json

application/xml, text/xml