POST api/v1/{practiceid}/clinical/pathologyreportworkflows/{workflowId}

Mark PathologyReports As Read

Request Information

URI Parameters

NameDescriptionTypeAdditional information
practiceid

globally unique identifier

Required
workflowId

globally unique identifier

Required

Body Parameters

Com.Healthbridge.Hhas.Clinical.Interface.Commands.MarkPathologyReportAsRead
NameDescriptionTypeAdditional information
PracticeId

globally unique identifier

None.
PathologyReportWorkflowId

globally unique identifier

None.
HighPriority

boolean

None.
NotifyPatientThatResultsNormal

boolean

None.
FollowUpAppointmentRequired

boolean

None.
FollowUpPatientCellphone

string

None.
FollowUpText

string

None.
CorrelationIds

Collection of string

None.
OriginatedSystem

string

None.

Request Formats

application/json, text/json

Sample: 
{
  "PracticeId": "4c055c33-8b11-4d2e-af0a-644df6eade3a",
  "PathologyReportWorkflowId": "be0f5c46-500e-4ff3-8d00-ac9700e96c83",
  "HighPriority": true,
  "NotifyPatientThatResultsNormal": true,
  "FollowUpAppointmentRequired": true,
  "FollowUpPatientCellphone": "sample string 3",
  "FollowUpText": "sample string 4",
  "CorrelationIds": [
    "sample string 1",
    "sample string 2"
  ],
  "OriginatedSystem": "sample string 5"
}

application/xml, text/xml

Sample: 
<MarkPathologyReportAsRead xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Com.Healthbridge.Hhas.Clinical.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 5</OriginatedSystem>
  <FollowUpAppointmentRequired>true</FollowUpAppointmentRequired>
  <FollowUpPatientCellphone>sample string 3</FollowUpPatientCellphone>
  <FollowUpText>sample string 4</FollowUpText>
  <HighPriority>true</HighPriority>
  <NotifyPatientThatResultsNormal>true</NotifyPatientThatResultsNormal>
  <PathologyReportWorkflowId>be0f5c46-500e-4ff3-8d00-ac9700e96c83</PathologyReportWorkflowId>
  <PracticeId>4c055c33-8b11-4d2e-af0a-644df6eade3a</PracticeId>
</MarkPathologyReportAsRead>

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

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": "b2dd6bad-2400-43a7-810f-5c42ec072424",
  "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>b2dd6bad-2400-43a7-810f-5c42ec072424</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>