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

HTTP + XML

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

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

<VisitInformationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PV.Data.DataModel.VisitAPI">
  <ClinicPk>00000000-0000-0000-0000-000000000000</ClinicPk>
  <PracticePk>00000000-0000-0000-0000-000000000000</PracticePk>
  <ServiceDate>String</ServiceDate>
</VisitInformationRequest>

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

<VisitInformationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PV.Data.DataModel.VisitAPI">
  <Practices>
    <VisitInformationPractice>
      <Clinics>
        <VisitInformationClinic>
          <ClinicName>String</ClinicName>
          <ClinicPk>00000000-0000-0000-0000-000000000000</ClinicPk>
          <Visits>
            <VisitInformation>
              <ChartPk>00000000-0000-0000-0000-000000000000</ChartPk>
              <CheckInPrintOutTime xmlns:d8p1="http://schemas.datacontract.org/2004/07/PV.API.Common.DataModel">
                <d8p1:TimezoneOffset>0</d8p1:TimezoneOffset>
                <d8p1:UnixEpochTime>0</d8p1:UnixEpochTime>
              </CheckInPrintOutTime>
              <CheckInTime xmlns:d8p1="http://schemas.datacontract.org/2004/07/PV.API.Common.DataModel">
                <d8p1:TimezoneOffset>0</d8p1:TimezoneOffset>
                <d8p1:UnixEpochTime>0</d8p1:UnixEpochTime>
              </CheckInTime>
              <CheckOutTime xmlns:d8p1="http://schemas.datacontract.org/2004/07/PV.API.Common.DataModel">
                <d8p1:TimezoneOffset>0</d8p1:TimezoneOffset>
                <d8p1:UnixEpochTime>0</d8p1:UnixEpochTime>
              </CheckOutTime>
              <ChiefComplaints>
                <VisitChiefComplaint>
                  <ChartPk>00000000-0000-0000-0000-000000000000</ChartPk>
                  <ComplaintOrder>0</ComplaintOrder>
                  <Location>String</Location>
                  <MainProblemText>String</MainProblemText>
                </VisitChiefComplaint>
              </ChiefComplaints>
              <CreatedByUserId>String</CreatedByUserId>
              <DischargeTime xmlns:d8p1="http://schemas.datacontract.org/2004/07/PV.API.Common.DataModel">
                <d8p1:TimezoneOffset>0</d8p1:TimezoneOffset>
                <d8p1:UnixEpochTime>0</d8p1:UnixEpochTime>
              </DischargeTime>
              <LogDetailPk>00000000-0000-0000-0000-000000000000</LogDetailPk>
              <LogNumber>0</LogNumber>
              <PatientBirthDate>String</PatientBirthDate>
              <PatientEmail>String</PatientEmail>
              <PatientEmailOptIn>false</PatientEmailOptIn>
              <PatientFirstName>String</PatientFirstName>
              <PatientLastName>String</PatientLastName>
              <PatientNumber>0</PatientNumber>
              <PatientSex>String</PatientSex>
              <PatientSignatureTime xmlns:d8p1="http://schemas.datacontract.org/2004/07/PV.API.Common.DataModel">
                <d8p1:TimezoneOffset>0</d8p1:TimezoneOffset>
                <d8p1:UnixEpochTime>0</d8p1:UnixEpochTime>
              </PatientSignatureTime>
              <ProviderFirstName>String</ProviderFirstName>
              <ProviderLastName>String</ProviderLastName>
              <ProviderPk>00000000-0000-0000-0000-000000000000</ProviderPk>
              <ProviderSignatureTime xmlns:d8p1="http://schemas.datacontract.org/2004/07/PV.API.Common.DataModel">
                <d8p1:TimezoneOffset>0</d8p1:TimezoneOffset>
                <d8p1:UnixEpochTime>0</d8p1:UnixEpochTime>
              </ProviderSignatureTime>
              <ProviderUserId>String</ProviderUserId>
              <ReasonForVisit>String</ReasonForVisit>
              <Status>String</Status>
              <VisitCategory>String</VisitCategory>
              <VisitStatus>String</VisitStatus>
              <VisitType>String</VisitType>
              <WebCheckInTime xmlns:d8p1="http://schemas.datacontract.org/2004/07/PV.API.Common.DataModel">
                <d8p1:TimezoneOffset>0</d8p1:TimezoneOffset>
                <d8p1:UnixEpochTime>0</d8p1:UnixEpochTime>
              </WebCheckInTime>
            </VisitInformation>
          </Visits>
        </VisitInformationClinic>
      </Clinics>
      <PracticePk>00000000-0000-0000-0000-000000000000</PracticePk>
    </VisitInformationPractice>
  </Practices>
  <ServiceDate>String</ServiceDate>
</VisitInformationResponse>