DataService

<back to all web services

PatientGet

Requires Authentication
The following routes are available for this service:
GET/data-api/v1/{clientid}/patients/{id}
PatientGet Parameters:
NameParameterData TypeRequiredDescription
IdpathintNo
RequestBase Parameters:
NameParameterData TypeRequiredDescription
ClientIdformstringNo
PatientDto Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
FirstNameformstringNo
MiddleNameformstringNo
LastNameformstringNo
CaseTypeformstringNo
ContactInfoformPatientContactInfoNo
DemographicsformPatientDemographicsNo
ProviderformEntityReferenceNo
AppointmentformPatientAppointmentInfoNo
PatientContactInfo Parameters:
NameParameterData TypeRequiredDescription
MobileformstringNo
EmailformstringNo
PatientDemographics Parameters:
NameParameterData TypeRequiredDescription
BirthdateformDateTime?No
SexformstringNo
EntityReference Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
DisplayNameformstringNo
PatientAppointmentInfo Parameters:
NameParameterData TypeRequiredDescription
PurposeformstringNo
DateformDateTimeNo
LengthformintNo

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

HTTP + JSV

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

GET /data-api/v1/{clientid}/patients/{id} HTTP/1.1 
Host: dataservice.mychirotouch.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Id: 0,
	FirstName: String,
	MiddleName: String,
	LastName: String,
	CaseType: String,
	ContactInfo: 
	{
		Mobile: String,
		Email: String
	},
	Demographics: 
	{
		Birthdate: 0001-01-01T00:00:00,
		Sex: String
	},
	Provider: 
	{
		Id: 0,
		DisplayName: String
	},
	Appointment: 
	{
		Purpose: String,
		Date: 0001-01-01T00:00:00,
		Length: 0
	}
}