PV API Service

<back to all web services

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

To override the Content-type in your clients HTTP Accept Header, append ?format=jsv

HTTP + JSV

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

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

{
	practicePk: 00000000000000000000000000000000,
	clinicPk: 00000000000000000000000000000000,
	clinicName: String,
	visitTime: 0,
	timezoneOffset: 0,
	isVisitTimeScheduled: False,
	clinicID: 0,
	reason: 
	{
		symptomName: String,
		checkinType: String
	},
	user: 
	{
		lastName: String,
		firstName: String,
		address1: String,
		address2: String,
		city: String,
		state: String,
		zip: String,
		email: String,
		homePhone: String,
		businessPhone: String
	},
	patient: 
	{
		previousPatient: False,
		lastName: String,
		firstName: String,
		middleInitial: String,
		dob: 0001-01-01,
		relationship: String,
		gender: String,
		email: String
	},
	insurance: 
	{
		primaryName: String,
		secondaryName: String,
		idNumber: String,
		guarantorFirstName: String,
		guarantorLastName: String,
		guarantorDOB: 0001-01-01,
		servicePhoneNumber: String
	},
	contact: 
	{
		phoneNumber: String,
		fullName: String,
		timeToArrival: 0
	}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	logNumber: 0
}