IPrimeSuiteAPI REST API Documentation

PatientsByFlagGet

Method: POST

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

Request Format: Xml or Json

Request XML Example (schema):

<?xml version="1.0" encoding="utf-16"?>
<PatientsByFlagGetRequest>
  <Header>
    <SourceSiteID>String Content</SourceSiteID>
    <DestinationSiteID>String Content</DestinationSiteID>
    <PrimeSuiteUserID>0</PrimeSuiteUserID>
  </Header>
  <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>
  <PageSize>0</PageSize>
  <PageStart>0</PageStart>
  <IsCareProgram>false</IsCareProgram>
  <FlagIDs>0</FlagIDs>
</PatientsByFlagGetRequest>

Request Json Example (schema):

{
  "Header": {
    "SourceSiteID": "String Content",
    "DestinationSiteID": "String Content",
    "PrimeSuiteUserID": 0
  },
  "Credentials": {
    "PrimeSuiteCredential": {
      "PrimeSuiteSiteId": "String Content",
      "PrimeSuiteUserName": "String Content",
      "PrimeSuiteUserPassword": "String Content",
      "PrimeSuiteUserAlias": "String Content"
    },
    "VendorCredential": {
      "VendorLogin": "String Content",
      "VendorPassword": "String Content"
    }
  },
  "PageSize": 0,
  "PageStart": 0,
  "IsCareProgram": false,
  "FlagIDs": [
    0
  ]
}

Response Format: Xml

Response XML Example (schema):

<?xml version="1.0" encoding="utf-16"?>
<PatientsByFlagGetResponse>
  <FlagDetails>
    <FlagID>0</FlagID>
    <PatientDetails>
      <PatientID>0</PatientID>
      <FirstName>String Content</FirstName>
      <LastName>String Content</LastName>
      <DateOfBirth>String Content</DateOfBirth>
      <ActivationDate>String Content</ActivationDate>
      <InactivationDate>String Content</InactivationDate>
    </PatientDetails>
    <TotalPatientCount>0</TotalPatientCount>
    <FlagName>String Content</FlagName>
    <IsCareProgram>false</IsCareProgram>
  </FlagDetails>
</PatientsByFlagGetResponse>

Response Format: Json

Response Example (schema):

{
  "FlagDetails": [
    {
      "FlagID": 0,
      "PatientDetails": [
        {
          "PatientID": 0,
          "FirstName": "String Content",
          "LastName": "String Content",
          "DateOfBirth": "String Content",
          "ActivationDate": "String Content",
          "InactivationDate": "String Content"
        }
      ],
      "TotalPatientCount": 0,
      "FlagName": "String Content",
      "IsCareProgram": false
    }
  ]
}