PV API Service

<back to all web services

PatientSearchCollectionRequest

POST search terms to retrieve a list of basic patient data

The following routes are available for this service:
POST, OPTIONS/PatientAPI/PatientSearch/{PracticeNameOrPk}/Collection

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/PatientSearchCollectionRequest HTTP/1.1 
Host: api.practicevelocity.com 
Content-Type: application/xml
Content-Length: length

<PatientSearchCollectionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PV.Data.DataModel.PatientAPI">
  <DateOfBirth>0001-01-01T00:00:00</DateOfBirth>
  <FirstName>String</FirstName>
  <LastName>String</LastName>
  <PracticeNameOrPk>String</PracticeNameOrPk>
  <Ssn>String</Ssn>
</PatientSearchCollectionRequest>

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

<PatientSearchCollectionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PV.Data.DataModel.PatientAPI">
  <Address1>String</Address1>
  <Address2>String</Address2>
  <BirthDate>0001-01-01T00:00:00</BirthDate>
  <CellPhone>String</CellPhone>
  <City>String</City>
  <FirstName>String</FirstName>
  <HomePhone>String</HomePhone>
  <LastName>String</LastName>
  <PatNum>0</PatNum>
  <PreferredName>String</PreferredName>
  <Sex>String</Sex>
  <State>String</State>
  <Zip>String</Zip>
</PatientSearchCollectionResponse>