Service Provider Integration Fields

This article presents the complete list of fields involved in Service Provider integration between a SmartSimple client instance and a third party service provider.

Contents

Fields transferred to Service Provider System

As part of our Integration services, we currently support two types of transaction records.

• Interpretation records - Identified by TypeofService field - set to 1.
• Transportation records - Identified by TypeofService field - set to 2.

Referring to the list below, note that both Interpretation and Transportation records have common fields until Field #55.

In addition the Field Names specified in the tables serve as both the field names in SmartSimple and HTML control IDs when performing field mapping.

Interpretation/Translation Fields

---

Identifiers	Field Name	Description	Field Type	Acceptable Values
1	CaseID	Unique Identifier for Case	Numberic
2	ServiceID	Unique Identifier for Service	Numberic
3	CustomerID	Unique Identifier for SmartSimple Customer	Alpha
4	Source	Source Type	Numberic	10=IME , 20=Insurer
5	TypeofService	Type of Service	Numeric	1
6	ProtocolPassword	Protocol Password
	PostTest	Testing flag used to indicate test submissions	Numeric	1=True , 0=False
Referral	Field Name	Description	Field Type	Acceptable Values
7	ReferralFirstName	Referral First Name	Alpha
8	ReferralLastName	Referral Last Name	Alpha
9	ReferralAddress	Referral Address	Alpha
10	ReferralCity	Referral City	Alpha
11	ReferralProvince	Referral Province/State	Alpha
12	ReferralPostalCode	Referral Postal Code	Alpha
13	ReferralCountry	Referral Country	Alpha
14	ReferralFileNumber	Referral File Number (system)	Alpha
15	ReferralPhoneNumber	Referral Phone Number	Alpha
16	ReferralFaxNumber	Referral Fax Number	Alpha
17	ReferralEmail	Referral Email	Alpha
18	ReferralCompany	Referral Company	Alpha
Claimant	Field Name	Description	Field Type	Acceptable Values
19	ClaimantFirstName	Claimant First Name	Alpha
20	ClaimantLastName	Claimant Last Name	Alpha
21	ClaimantApt	Claimant Apt/Suite	Alpha
22	ClaimantBuzzer	Claimant Buzzer	Alpha
23	ClaimantAddress	Claimant Address	Alpha
24	ClaimantCity	Claimant City	Alpha
25	ClaimantProvince	Claimant Province/State	Alpha
26	ClaimantPostalCode	Claimant Postal Code	Alpha
27	ClaimantCountry	Claimant Country	Alpha
28	ClaimantPhone	Claimant Phone	Alpha
29	ClaimantFax	Claimant Fax	Alpha
30	ClaimFile	Claim File Number	Alpha
31	DateofLoss	Date of Loss	Date/Time	YYYY-MM-DD
32	ClaimantPolicyNumber	Claimant Policy Number	Alpha
33	ClaimantPOBox	Claimant P.O. Box	Alpha
33	Billingsameasreferral	Billing same as referral	Numeric	1=Yes;2=No *Note that this section controls if the Billing section below is visible.
Billing	Field Name	Description	Field Type	Acceptable Values
34	BillingFirstName	Billing First Name	Alpha
35	BillingLastName	Billing Last Name	Alpha
36	BillingCompany	Billing Company	Alpha
37	BillingAddress	Billing Address	Alpha
38	BillingCity	Billing City	Alpha
39	BillingProvince	Billing Province/State	Alpha
40	BillingPostalCode	Billing Postal Code	Alpha
41	BillingPhone	Billing Phone	Alpha
42	BillingFax	Billing Fax	Alpha
43	BillingEmail	Billing Email	Alpha
44	BillingPOBox	Billing P.O. Box	Alpha
Appointment Details	Field Name	Description	Field Type	Acceptable Values
45	Faxconfirmation	Fax confirmation of appointment	Numeric	1=Yes;2=No
46	Emailconfirmation	Email confirmation of appointment	Numeric	1=Yes;2=No
47	Phoneconfirmation	Phone confirmation of appointment	Numeric	1=Yes;2=No
48	Notes	Notes	Alpha
49	ArrangeAppointment	Arrange Appointment with claimant/patient	Numeric	1=Yes;2=No
50	ConfirmAppointment	Confirm Appointment with claimant/patient	Numeric	1=Yes;2=No
51	DateandTime	Date and Time of appointment	Date/Time	YYYY-MM-DD HH:MM:SS
52	Duration	Duration (Calculated in hours)	Numeric	e.g 3.5 (this represents 3 hours 30 minutes)
53	AppointmentLocation	Location	Alpha
54	TypeofAssessment	Type of Assessment	Alpha
55	Language	Language	Alpha
56	GenderofInterpreter	Gender of Interpreter	Numeric	1=Male;2=Female;3=NoPreferences

Transportation Fields

---

Identifiers	Field Name	Description	Field Type	Acceptable Values
1	CaseID	Unique Identifier for Case	Numberic
2	ServiceID	Unique Identifier for Service	Numberic
3	CustomerID	Unique Identifier for SmartSimple Customer	Alpha
4	Source	Source Type	Numberic	10=IME , 20=Insurer
5	TypeofService	Type of Service	Numeric	2
6	ProtocolPassword	Protocol Password
	PostTest	Testing flag used to indicate test submissions	Numeric	1=True , 0=False
Referral	Field Name	Description	Field Type	Acceptable Values
7	ReferralFirstName	Referral First Name	Alpha
8	ReferralLastName	Referral Last Name	Alpha
9	ReferralAddress	Referral Address	Alpha
10	ReferralCity	Referral City	Alpha
11	ReferralProvince	Referral Province/State	Alpha
12	ReferralPostalCode	Referral Postal Code	Alpha
13	ReferralCountry	Referral Country	Alpha
14	ReferralFileNumber	Referral File Number (system)	Alpha
15	ReferralPhoneNumber	Referral Phone Number	Alpha
16	ReferralFaxNumber	Referral Fax Number	Alpha
17	ReferralEmail	Referral Email	Alpha
18	ReferralCompany	Referral Company	Alpha
Claimant	Field Name	Description	Field Type	Acceptable Values
19	ClaimantFirstName	Claimant First Name	Alpha
20	ClaimantLastName	Claimant Last Name	Alpha
21	ClaimantApt	Claimant Apt/Suite	Alpha
22	ClaimantBuzzer	Claimant Buzzer	Alpha
23	ClaimantAddress	Claimant Address	Alpha
24	ClaimantCity	Claimant City	Alpha
25	ClaimantProvince	Claimant Province/State	Alpha
26	ClaimantPostalCode	Claimant Postal Code	Alpha
27	ClaimantCountry	Claimant Country	Alpha
28	ClaimantPhone	Claimant Phone	Alpha
29	ClaimantFax	Claimant Fax	Alpha
30	ClaimFile	Claim #	Alpha
31	DateofLoss	Date of Loss	Date/Time	YYYY-MM-DD
32	ClaimantPolicyNumber	Claimant Policy Number	Alpha
33	ClaimantPOBox	Claimant P.O. Box	Alpha
33	Billingsameasreferral	Billing same as referral	Numeric	1=Yes;2=No *Note that this section controls if the Billing section below is visible.
Billing	Field Name	Description	Field Type	Acceptable Values
34	BillingFirstName	Billing First Name	Alpha
35	BillingLastName	Billing Last Name	Alpha
36	BillingCompany	Billing Company	Alpha
37	BillingAddress	Billing Address	Alpha
38	BillingCity	Billing City	Alpha
39	BillingProvince	Billing Province/State	Alpha
40	BillingPostalCode	Billing Postal Code	Alpha
41	BillingPhone	Billing Phone	Alpha
42	BillingFax	Billing Fax	Alpha
43	BillingEmail	Billing Email	Alpha
44	BillingPOBox	Billing P.O. Box	Alpha
Appointment Details	Field Name	Description	Field Type	Acceptable Values
45	Faxconfirmation	Fax confirmation of appointment	Numeric	1=Yes;2=No
46	Emailconfirmation	Email confirmation of appointment	Numeric	1=Yes;2=No
47	Phoneconfirmation	Phone confirmation of appointment	Numeric	1=Yes;2=No
48	Notes	Notes	Alpha
49	ArrangeAppointment	Arrange Appointment with claimant/patient	Numeric	1=Yes;2=No
50	ConfirmAppointment	Confirm Appointment with claimant/patient	Numeric	1=Yes;2=No
51	DateandTime	Date and Time of appointment	Date/Time	YYYY-MM-DD HH:MM:SS
52	Duration	Duration (Calculated in hours)	Numeric	e.g 3.5 (this represents 3 hours 30 minutes)
53	AppointmentLocation	Location	Alpha
54	TypeofAssessment	Type of Assessment	Alpha
Pickup Details	Field Name	Description	Field Type	Acceptable Values
55	PickupTime	Pickup Time	Date/Time	YYYY-MM-DD HH:MM:SS
56	WheelchairVehicle	Does claimant require a wheelchair accessible vehicle?	Numeric	1=Yes;2=No
57	SpecialNeeds	Does claimant require special needs (e.g. Assistance)?	Numeric	1=Yes;2=No
58	PickupSame	Is Pickup Address same as Claimant Address?	Alpha	1=Yes;2=No
Note the fields below will be populated by SmartSimple if No is selected for the field above
59	PickupAddress	Pickup Address	Alpha
60	PickupCity	Pickup City	Alpha
61	PickupPostalCode	Postal Code	Alpha
62	PickupApt	Pickup Apt/Suite	Alpha
63	PickupBuzzer	Pickup Buzzer	Alpha
64	PickupProvince	Pickup Province/State	Alpha
65	PickupPhone	Pickup Phone	Alpha

Field List transferred to SmartSimple

• Note that all fields are mandatory, with the exception of notes
• reference is unique to each transaction
• provideremail field is used to send error messages via email if the record cannot be processed.

Sample Error Messages

---

The following messages will be generated by SmartSimple and sent by E-Mail

• Empty field or incorrect field type
• Invalid provider name, case, or service ID
• Invalid field value
• Invalid Provider Key during submission

#	Field Name	Field Type	Description
1	providerkey	Alpha	Unique authentication key provided by SmartSimple.
2	caseid	Numeric	Unique case identifier as provided by SmartSimple when transferring the service request.
3	serviceid	Numeric	Unique service identifier as provided by SmartSimple when transferring the service request.
4	typeofservice	Numeric	Interpretation records - set to 1. Transportation records - set to 2.
5	client	String	SmartSimple Client Identifier as provided by SmartSimple when transferring the service request. NOTE this is not the client/patient identified - but the SmartSimple customer identified.
6	source	Numeric	This represents the SmartSimple client type: 10 for IME client and 20 for Insurer client.
7	gapcode	Alpha	Goods, Administration, and Other Codes(GAP). This list corresponds to the HCAI GAP Code list.
8	rate	Numeric	Rate for Service.
9	measure	Alpha	Unit Measure. This list corresponds to the HCAI Unit Measure Codes.
10	quantity	Numeric	Quantity
11	tax	Alpha	Options: Yes;No
12	taxtype	Alpha	Options: No;HST;GST;BCST;NSST;QST
13	total	Numeric, two decimal	Rate*Quantity
14	taxamt	Numeric, two decimal	Calculated tax amount.
15	grossamt	Numeric, two decimal	[Total]+[TaxAmount]
16	reference	Alpha	Unique Service Provider identifier for billing transaction.
17	confirmationnum	Alpha	Optional confirmation number provided to SmartSimple when service request is sent to provider
18	provider	Alpha	Name of the Service Provider
19	provideremail	Alpha	Email address of contact at service provider.
20	notes	Alpha	Service Provider notes for this transaction.

See Also

• Service Provider Integration