PV API Service

<back to all web services

ClockwisePatientRegistrationRequest

POST the patient registration data to create a LogBook entry in PVM.

- LastName and FirstName are required and not allowed to be blank.
- Requires a passed datetime (VisitTime) for which to create the entry.
- The datetime value for VisitTime should be passed as the number of Milliseconds since Unix Epoch (Jan 1 1970 12AM UTC) which is the standard javascript format returned using the Date.prototype.getTime() method.
- TimezoneOffset represents the current timezone offset, in minutes, from UTC time as returned by the Date.prototype.getTimezoneOffset() method.
- DOB should be a date value formatted as 'YYYY-MM-DD'.
- IsWalkin, IsOnline, IsStaffAdded are required, one of which should be true.
- AppointmentId is required.
- Email is an optional field so it can be left out entirely. But if email is given it will be validated to verify format.

The following routes are available for this service:
POST, OPTIONS/Clockwise/PatientRegistration

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

<ClockwisePatientRegistrationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PV.Partner.DataModel.Clockwise">
  <Address1>String</Address1>
  <AppointmentID>0</AppointmentID>
  <CellPhone>String</CellPhone>
  <City>String</City>
  <ClinicPk>00000000-0000-0000-0000-000000000000</ClinicPk>
  <DOB>0001-01-01T00:00:00</DOB>
  <Email>String</Email>
  <FirstName>String</FirstName>
  <IsOnline>false</IsOnline>
  <IsStaffAdded>false</IsStaffAdded>
  <IsWalkin>false</IsWalkin>
  <LastName>String</LastName>
  <Phone>String</Phone>
  <PracticePk>00000000-0000-0000-0000-000000000000</PracticePk>
  <SSN>String</SSN>
  <Sex>String</Sex>
  <State>String</State>
  <TimezoneOffset>0</TimezoneOffset>
  <VisitTime>0</VisitTime>
  <Zip>String</Zip>
</ClockwisePatientRegistrationRequest>

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

<PatientRegistrationBlankResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PV.Partner.DataModel.Clockwise" />