PV API Service

HCAPatientRegistrationRequest

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

- 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'.

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

HTTP + XML

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

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

<HCAPatientRegistrationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PV.Partner.DataModel.HCAWebCheckIn">
  <ClinicID>0</ClinicID>
  <ClinicName>String</ClinicName>
  <ClinicPk>00000000-0000-0000-0000-000000000000</ClinicPk>
  <Contact>
    <FullName>String</FullName>
    <PhoneNumber>String</PhoneNumber>
    <TimeToArrival>0</TimeToArrival>
  </Contact>
  <Insurance>
    <GuarantorDOB>0001-01-01T00:00:00</GuarantorDOB>
    <GuarantorFirstName>String</GuarantorFirstName>
    <GuarantorLastName>String</GuarantorLastName>
    <IdNumber>String</IdNumber>
    <PrimaryName>String</PrimaryName>
    <SecondaryName>String</SecondaryName>
    <ServicePhoneNumber>String</ServicePhoneNumber>
  </Insurance>
  <IsVisitTimeScheduled>false</IsVisitTimeScheduled>
  <Patient>
    <DOB>0001-01-01T00:00:00</DOB>
    <Email>String</Email>
    <FirstName>String</FirstName>
    <Gender>String</Gender>
    <LastName>String</LastName>
    <MiddleInitial>String</MiddleInitial>
    <PreviousPatient>false</PreviousPatient>
    <Relationship>String</Relationship>
  </Patient>
  <PracticePk>00000000-0000-0000-0000-000000000000</PracticePk>
  <Reason>
    <CheckinType>String</CheckinType>
    <SymptomName>String</SymptomName>
  </Reason>
  <TimezoneOffset>0</TimezoneOffset>
  <User>
    <Address1>String</Address1>
    <Address2>String</Address2>
    <BusinessPhone>String</BusinessPhone>
    <City>String</City>
    <Email>String</Email>
    <FirstName>String</FirstName>
    <HomePhone>String</HomePhone>
    <LastName>String</LastName>
    <State>String</State>
    <Zip>String</Zip>
  </User>
  <VisitTime>0</VisitTime>
</HCAPatientRegistrationRequest>

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

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