POST api/v2/{providerId}/clinical/patient/{patientId}/timeline/add
Add to 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
| Name | Description | Type | Additional 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| Name | Description | Type | Additional 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-10-17T06:53:30Z",
"PatientId": "7f44a68c-e0ae-4d20-b564-dceb9e5acc11",
"PathologyReportId": "833571a4-ce61-453c-8399-d3fd93f778f6",
"ParentReferenceId": "4d55d3d3-ff9b-493d-893b-4d2c431603f4",
"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-10-17T06:53:30Z",
"PatientId": "7f44a68c-e0ae-4d20-b564-dceb9e5acc11",
"PathologyReportId": "833571a4-ce61-453c-8399-d3fd93f778f6",
"ParentReferenceId": "4d55d3d3-ff9b-493d-893b-4d2c431603f4",
"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-10-17T06:53:30.5860052+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>4d55d3d3-ff9b-493d-893b-4d2c431603f4</ParentReferenceId>
<PathologyReportId>833571a4-ce61-453c-8399-d3fd93f778f6</PathologyReportId>
<PatientId>7f44a68c-e0ae-4d20-b564-dceb9e5acc11</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-10-17T06:53:30.5860052+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>4d55d3d3-ff9b-493d-893b-4d2c431603f4</ParentReferenceId>
<PathologyReportId>833571a4-ce61-453c-8399-d3fd93f778f6</PathologyReportId>
<PatientId>7f44a68c-e0ae-4d20-b564-dceb9e5acc11</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:
Response Information
Resource Description
Com.Healthbridge.Core.CommonDomain.Interface.ValueObjects.RestApiResultOfSystem.Boolean| Name | Description | Type | Additional 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>