POST api/v2/{practiceId}/clinical/ampath/results-by-patient

Endpoint to request pathology results from Ampath for a specific patient. Please Note: Implementation follows Dischem proxy pattern to overcome Ampath IP whitelist limitation. Ampath only allows requests from whitelisted static IPs; Florence WebRole provides this. All business logic stays on the caller side - this is a simple authenticated HTTP proxy.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
practiceId

globally unique identifier

Required

Body Parameters

Com.Healthbridge.Hhas.Cloud.WebRole.Areas.Clinical.Model.AmpathResultsRequest
NameDescriptionTypeAdditional information
IdentificationNumber

string

None.
Surname

string

None.
ConsentGiven

boolean

None.
Doctor

string

None.
FromDate

string

None.
ToDate

string

None.
IncludePDF

boolean

None.
ReportType

string

None.

Request Formats

application/json, text/json

Sample: 
{
  "IdentificationNumber": "sample string 1",
  "Surname": "sample string 2",
  "ConsentGiven": true,
  "Doctor": "sample string 4",
  "FromDate": "sample string 5",
  "ToDate": "sample string 6",
  "IncludePDF": true,
  "ReportType": "sample string 8"
}

application/xml, text/xml

Sample: 
<AmpathResultsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Com.Healthbridge.Hhas.Cloud.WebRole.Areas.Clinical.Model">
  <ConsentGiven>true</ConsentGiven>
  <Doctor>sample string 4</Doctor>
  <FromDate>sample string 5</FromDate>
  <IdentificationNumber>sample string 1</IdentificationNumber>
  <IncludePDF>true</IncludePDF>
  <ReportType>sample string 8</ReportType>
  <Surname>sample string 2</Surname>
  <ToDate>sample string 6</ToDate>
</AmpathResultsRequest>

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

Response Information

Resource Description

Com.Healthbridge.Core.CommonDomain.Interface.ValueObjects.RestApiResultOfCom.Healthbridge.Hhas.Cloud.WebRole.Areas.Clinical.Model.AmpathResultsResponse
NameDescriptionTypeAdditional information
Sucess

boolean

None.
ResponseCode

integer

None.
ResponseMessage

string

None.
Data

Com.Healthbridge.Hhas.Cloud.WebRole.Areas.Clinical.Model.AmpathResultsResponse

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": {
    "error": "sample string 1",
    "batchNo": "sample string 2",
    "latestResult": "sample string 3",
    "hasMoreResults": true,
    "allSpecimensComplete": true,
    "pathologyReports": {
      "Encoding": "sample string 1",
      "xml": "sample string 2"
    },
    "pathologyReportPDFs": [
      {
        "messageId": 1,
        "pdf": "sample string 2"
      },
      {
        "messageId": 1,
        "pdf": "sample string 2"
      }
    ]
  },
  "Links": [
    {
      "Rel": "sample string 1",
      "HRef": "sample string 2"
    },
    {
      "Rel": "sample string 1",
      "HRef": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample: 
<RestApiResultOfAmpathResultsResponserckf4lLM xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Com.Healthbridge.Core.CommonDomain.Interface.ValueObjects">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/Com.Healthbridge.Hhas.Cloud.WebRole.Areas.Clinical.Model" />
  <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>
</RestApiResultOfAmpathResultsResponserckf4lLM>