PV API Service

<back to all web services

VisitInformationRequest

GET a current list of patients for an entire practice or for a given clinic of a 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/VisitInformation/{ServiceDate}/{PracticePk}/{ClinicPk}
GET, OPTIONS/VisitInformation/{ServiceDate}/{PracticePk}

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/VisitInformationRequest HTTP/1.1 
Host: api.practicevelocity.com 
Content-Type: text/csv
Content-Length: length

PracticePk,ServiceDate,ClinicPk
00000000000000000000000000000000,String,00000000000000000000000000000000


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

Practices,ServiceDate
"[{practicePk:00000000000000000000000000000000,clinics:[{clinicPk:00000000000000000000000000000000,clinicName:String,visits:[{logNumber:0,logDetailPk:00000000000000000000000000000000,patientNumber:0,patientFirstName:String,patientLastName:String,patientBirthDate:String,patientSex:String,visitCategory:String,status:String,visitStatus:String,visitType:String,reasonForVisit:String,webCheckInTime:{unixEpochTime:0,timezoneOffset:0},checkInPrintOutTime:{unixEpochTime:0,timezoneOffset:0},chartPk:00000000000000000000000000000000,dischargeTime:{unixEpochTime:0,timezoneOffset:0},providerSignatureTime:{unixEpochTime:0,timezoneOffset:0},patientSignatureTime:{unixEpochTime:0,timezoneOffset:0},checkInTime:{unixEpochTime:0,timezoneOffset:0},checkOutTime:{unixEpochTime:0,timezoneOffset:0},providerPk:00000000000000000000000000000000,providerFirstName:String,providerLastName:String,providerUserId:String,patientEmail:String,patientEmailOptIn:False,createdByUserId:String,chiefComplaints:[{chartPk:00000000000000000000000000000000,mainProblemText:String,complaintOrder:0,location:String}]}]}]}]",String