IPrimeSuiteAPI REST API Documentation

CareGapGet

Method: POST

URI Template: https://api-test.greenwaymedical.com/Integration/RESTv1.0/PrimeSuiteAPIService/Patient/CareGapGet

Request Format: Xml or Json

Request XML Example (schema):

<?xml version="1.0" encoding="utf-16"?>
<CareGapGetRequest>
  <Credentials>
    <PrimeSuiteCredential>
      <PrimeSuiteSiteId>String Content</PrimeSuiteSiteId>
      <PrimeSuiteUserName>String Content</PrimeSuiteUserName>
      <PrimeSuiteUserPassword>String Content</PrimeSuiteUserPassword>
      <PrimeSuiteUserAlias>String Content</PrimeSuiteUserAlias>
    </PrimeSuiteCredential>
    <VendorCredential>
      <VendorLogin>String Content</VendorLogin>
      <VendorPassword>String Content</VendorPassword>
    </VendorCredential>
  </Credentials>
  <Header>
    <SourceSiteID>String Content</SourceSiteID>
    <DestinationSiteID>String Content</DestinationSiteID>
    <PrimeSuiteUserID>0</PrimeSuiteUserID>
  </Header>
  <PageNumber>0</PageNumber>
  <PageSize>0</PageSize>
  <PatientID>0</PatientID>
  <FromDate>String Content</FromDate>
  <ToDate>String Content</ToDate>
</CareGapGetRequest>

Request Json Example (schema):

Could not generate example for request. Failed with error: Specified cast is not valid.

Response Format: Xml

Response XML Example (schema):

<?xml version="1.0" encoding="utf-16"?>
<CareGapGetResponse>
  <PatientID>0</PatientID>
  <TotalRows>0</TotalRows>
  <CareGaps>
    <CareGapID>0</CareGapID>
    <CareGapTypeID>0</CareGapTypeID>
    <TypeDescription>String Content</TypeDescription>
    <Value>String Content</Value>
    <RecordedDate>0001-01-01T00:00:00</RecordedDate>
  </CareGaps>
</CareGapGetResponse>

Response Format: Json

Response Example (schema):

{
  "PatientID": 0,
  "TotalRows": 0,
  "CareGaps": [
    {
      "CareGapID": 0,
      "CareGapTypeID": 0,
      "TypeDescription": "String Content",
      "Value": "String Content",
      "RecordedDate": "0001-01-01T00:00:00"
    }
  ]
}