POST api/v2/{providerId}/clinical/patient/{patientId}/timeline/delete

Remove patient dashboard directly any history event (mostly to handle edge cases when we need to merge duplicates, remove mistakenly added data)

Request Information

URI Parameters

NameDescriptionTypeAdditional information
providerId

from where to import

 globally unique identifier

Required
patientId

globally unique identifier

Required

Body Parameters

object

Collection of Com.Healthbridge.Hhas.Clinical.Interface.ValueObjects.PatientDashboardHistoryEventDto
NameDescriptionTypeAdditional information
DateTime

date

None.
PatientId

globally unique identifier

None.
PathologyReportId

globally unique identifier

None.
ParentReferenceId

Id of source object

 globally unique identifier

None.
ParentDescription

Friendly Name of source object

 string

None.
NotMatched

boolean

None.
Type

string

None.
ParentLineNum

integer

None.
Code

string

None.
Description

string

None.
Value

string

None.
ValueUnits

string

None.
ValueFlag

string

None.
Narrative

string

None.
Thumbnail

Thumbnail for events with graphical representation

 string

None.

Request Formats

application/json, text/json

Sample: 
[
  {
    "DateTime": "2025-04-23T22:46:08Z",
    "PatientId": "d60f598a-bc7a-4253-ab5d-e49fa2d564bd",
    "PathologyReportId": "00b4e44d-d143-4d7c-a57e-fd9d2f5025dc",
    "ParentReferenceId": "d8e53488-16f4-4622-b2c8-12d946cd8fc9",
    "ParentDescription": "sample string 4",
    "NotMatched": true,
    "Type": "sample string 6",
    "ParentLineNum": 7,
    "Code": "sample string 8",
    "Description": "sample string 9",
    "Value": "sample string 10",
    "ValueUnits": "sample string 11",
    "ValueFlag": "sample string 12",
    "Narrative": "sample string 13",
    "Thumbnail": "sample string 14"
  },
  {
    "DateTime": "2025-04-23T22:46:08Z",
    "PatientId": "d60f598a-bc7a-4253-ab5d-e49fa2d564bd",
    "PathologyReportId": "00b4e44d-d143-4d7c-a57e-fd9d2f5025dc",
    "ParentReferenceId": "d8e53488-16f4-4622-b2c8-12d946cd8fc9",
    "ParentDescription": "sample string 4",
    "NotMatched": true,
    "Type": "sample string 6",
    "ParentLineNum": 7,
    "Code": "sample string 8",
    "Description": "sample string 9",
    "Value": "sample string 10",
    "ValueUnits": "sample string 11",
    "ValueFlag": "sample string 12",
    "Narrative": "sample string 13",
    "Thumbnail": "sample string 14"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfPatientDashboardHistoryEventDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Com.Healthbridge.Hhas.Clinical.Interface.ValueObjects">
  <PatientDashboardHistoryEventDto>
    <Code>sample string 8</Code>
    <DateTime>2025-04-23T22:46:08.049196+02:00</DateTime>
    <Description>sample string 9</Description>
    <Narrative>sample string 13</Narrative>
    <NotMatched>true</NotMatched>
    <ParentDescription>sample string 4</ParentDescription>
    <ParentLineNum>7</ParentLineNum>
    <ParentReferenceId>d8e53488-16f4-4622-b2c8-12d946cd8fc9</ParentReferenceId>
    <PathologyReportId>00b4e44d-d143-4d7c-a57e-fd9d2f5025dc</PathologyReportId>
    <PatientId>d60f598a-bc7a-4253-ab5d-e49fa2d564bd</PatientId>
    <Thumbnail>sample string 14</Thumbnail>
    <Type>sample string 6</Type>
    <Value>sample string 10</Value>
    <ValueFlag>sample string 12</ValueFlag>
    <ValueUnits>sample string 11</ValueUnits>
  </PatientDashboardHistoryEventDto>
  <PatientDashboardHistoryEventDto>
    <Code>sample string 8</Code>
    <DateTime>2025-04-23T22:46:08.049196+02:00</DateTime>
    <Description>sample string 9</Description>
    <Narrative>sample string 13</Narrative>
    <NotMatched>true</NotMatched>
    <ParentDescription>sample string 4</ParentDescription>
    <ParentLineNum>7</ParentLineNum>
    <ParentReferenceId>d8e53488-16f4-4622-b2c8-12d946cd8fc9</ParentReferenceId>
    <PathologyReportId>00b4e44d-d143-4d7c-a57e-fd9d2f5025dc</PathologyReportId>
    <PatientId>d60f598a-bc7a-4253-ab5d-e49fa2d564bd</PatientId>
    <Thumbnail>sample string 14</Thumbnail>
    <Type>sample string 6</Type>
    <Value>sample string 10</Value>
    <ValueFlag>sample string 12</ValueFlag>
    <ValueUnits>sample string 11</ValueUnits>
  </PatientDashboardHistoryEventDto>
</ArrayOfPatientDashboardHistoryEventDto>

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 'PatientDashboardHistoryEventDto[]'.

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>