PV API Service

<back to all web services

PatientFlowRequest

GET a list of patient flow records for an entire practice or super practice. Requires a passed date (ServiceDate) to filter to the relevant date of service, this must be passed in ISO 8601 format 'YYYY-MM-DD'.

The following routes are available for this service:
GET, OPTIONS/PatientFlow/{ServiceDate}/{Practice}

To override the Content-type in your clients HTTP Accept Header, append ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /xml/reply/PatientFlowRequest HTTP/1.1 
Host: api.practicevelocity.com 
Content-Type: application/xml
Content-Length: length

<PatientFlowRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PV.Data.DataModel.PatientFlow">
  <Practice>String</Practice>
  <ServiceDate>String</ServiceDate>
</PatientFlowRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PatientFlowSummaryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PV.Data.DataModel.PatientFlow">
  <ClinicSummaryRows>
    <ClinicSummaryRow>
      <AllAverageWaitTime>0</AllAverageWaitTime>
      <AllMaxWaitTime>0</AllMaxWaitTime>
      <AvgWaitTimeAlert>0</AvgWaitTimeAlert>
      <AvgWaitTimeWarn>0</AvgWaitTimeWarn>
      <ClinicName>String</ClinicName>
      <ClinicPk>00000000-0000-0000-0000-000000000000</ClinicPk>
      <CurrentAverageWaitTime>0</CurrentAverageWaitTime>
      <CurrentMaxWaitTime>0</CurrentMaxWaitTime>
      <DischargedAverageInClinicTime>0</DischargedAverageInClinicTime>
      <DischargedMaxInClinicTime>0</DischargedMaxInClinicTime>
      <InExamCount>0</InExamCount>
      <InWaitingRoomCount>0</InWaitingRoomCount>
      <MaxWaitTimeAlert>0</MaxWaitTimeAlert>
      <MaxWaitTimeWarn>0</MaxWaitTimeWarn>
      <PatientCurrentAlert>0</PatientCurrentAlert>
      <PatientCurrentWarn>0</PatientCurrentWarn>
      <Practice>String</Practice>
      <ShowOnDashboard>0</ShowOnDashboard>
      <TotalPatients>0</TotalPatients>
    </ClinicSummaryRow>
  </ClinicSummaryRows>
  <DashboardSettings>
    <AveTimeInExamWarn>0</AveTimeInExamWarn>
    <AvgTimeInExamAlert>0</AvgTimeInExamAlert>
    <AvgTotalTimeInClinicAlert>0</AvgTotalTimeInClinicAlert>
    <AvgTotalTimeInClinicWarn>0</AvgTotalTimeInClinicWarn>
    <AvgWaitTimeAlert>0</AvgWaitTimeAlert>
    <AvgWaitTimeWarn>0</AvgWaitTimeWarn>
    <ClinicPK>00000000-0000-0000-0000-000000000000</ClinicPK>
    <InExamAlert>0</InExamAlert>
    <InExamWarn>0</InExamWarn>
    <MaxTimeInExamAlert>0</MaxTimeInExamAlert>
    <MaxTimeInExamWarn>0</MaxTimeInExamWarn>
    <MaxTotalTimeInClinicAlert>0</MaxTotalTimeInClinicAlert>
    <MaxTotalTimeInClinicWarn>0</MaxTotalTimeInClinicWarn>
    <MaxWaitTimeAlert>0</MaxWaitTimeAlert>
    <MaxWaitTimeWarn>0</MaxWaitTimeWarn>
    <PatientCurrentAlert>0</PatientCurrentAlert>
    <PatientCurrentWarn>0</PatientCurrentWarn>
    <PatientFlowSettingID>0</PatientFlowSettingID>
    <PracticePK>00000000-0000-0000-0000-000000000000</PracticePK>
  </DashboardSettings>
  <Practice>String</Practice>
  <ServiceDate>String</ServiceDate>
</PatientFlowSummaryResponse>