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=csv

HTTP + CSV

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

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

Practice,ServiceDate
String,String


HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

Practice,ServiceDate,ClinicSummaryRows,DashboardSettings
String,String,"[{practice:String,clinicPk:00000000000000000000000000000000,clinicName:String,totalPatients:0,inWaitingRoomCount:0,inExamCount:0,currentAverageWaitTime:0,currentMaxWaitTime:0,allMaxWaitTime:0,allAverageWaitTime:0,dischargedAverageInClinicTime:0,dischargedMaxInClinicTime:0,showOnDashboard:0,avgWaitTimeAlert:0,avgWaitTimeWarn:0,maxWaitTimeAlert:0,maxWaitTimeWarn:0,patientCurrentAlert:0,patientCurrentWarn:0}]","{patientFlowSettingID:0,practicePK:00000000000000000000000000000000,clinicPK:00000000000000000000000000000000,avgWaitTimeAlert:0,avgWaitTimeWarn:0,maxWaitTimeAlert:0,maxWaitTimeWarn:0,patientCurrentAlert:0,patientCurrentWarn:0,inExamAlert:0,inExamWarn:0,avgTotalTimeInClinicAlert:0,avgTotalTimeInClinicWarn:0,maxTotalTimeInClinicAlert:0,maxTotalTimeInClinicWarn:0,avgTimeInExamAlert:0,aveTimeInExamWarn:0,maxTimeInExamAlert:0,maxTimeInExamWarn:0}"