Difference between revisions of "Service Provider Integration Fields"

From SmartWiki
Jump to: navigation, search
Line 286: Line 286:
 
==Field List transferred to SmartSimple==
 
==Field List transferred to SmartSimple==
  
 +
*Note that all fields are mandatory, with the exception of Notes
 +
*References is unique to each transaction
 +
*ProviderEmail field is used to send error messages via email if the record cannot be processed.
 +
 +
 +
'''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
 +
 +
 +
{| border="1" cellpadding="4"
 +
|-
 +
! style="color: black; background-color: #62BC43;"|# !! style="color: black; background-color: #62BC43;"|Field Name !! style="color: black; background-color: #62BC43;"|Field Type !! style="color: black; background-color: #62BC43;"|Comments
 +
|-
 +
| 1 || CaseID || Numeric || Unique case identifier as provided by SmartSimple when transferring the service request.
 +
|-
 +
| 2 || ServiceID || Numeric || Unique service identifier as provided by SmartSimple when transferring the service request.
 +
|-
 +
| 3 || TypeofService || Numeric || Interpretation records - set to '''1'''. Transportation records - set to '''2'''.
 +
|-
 +
| 4 || 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.
 +
|-
 +
| 5 || Source || Numeric || This represents the SmartSimple client type: 10 for IME client and 20 for Insurer client.
 +
|-
 +
| 6 || Gap Code || Alpha || Goods, Administration, and Other Codes(GAP). This list corresponds to the HCAI GAP Code list[[.
 +
|-
 +
| 7 || Rate || Numeric ||Rate for Service.
 +
|-
 +
| 8 || Measure ||Alpha ||Unit Measure. This list corresponds to the HCAI Unit Measure Code.
 +
|-
 +
| 9 ||Quantity||Numeric||Quantity
 +
|-
 +
| 10 ||Tax||Alpha||Options: Yes;No
 +
|-
 +
| 11 ||TaxType||Alpha||Options: No;HST;GST;BCST;NSST;QST
 +
|-
 +
| 12 ||Total||Numeric, two decimal||Rate*Quantity
 +
|-
 +
| 13 ||TaxAmount||Numeric, two decimal||Calculated tax amount.
 +
|-
 +
| 14 ||GrossAmount||Numeric, two decimal||[Total]+[TaxAmount]
 +
|-
 +
| 15 ||Reference||Alpha||Unique Service Provider identifier for billing transaction.
 +
|-
 +
| 16 ||ProviderName||Alpha||Name of Provider - SmartSimple will provide name to provider.
 +
|-
 +
| 17 ||ProviderEmail||Alpha||Email address of contact at service provider.
 +
|-
 +
| 18 ||Notes||Alpha||Service Provider notes for this transaction.
 +
|}
  
 
==See Also==
 
==See Also==

Revision as of 00:09, 30 March 2012

Field List 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.


Interpretation 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
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/State Referral Province/State Alpha
12 ReferralPostalCode Referral PostalCode Alpha
13 ReferralCountry Referral Country Alpha
14 ReferralFileNumber Referral FileNumber 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/Suite Claimant Apt/Suite Alpha
22 ClaimantBuzzer Claimant Buzzer Alpha
23 ClaimantAddress Claimant Address Alpha
24 ClaimantCity Claimant City Alpha
25 ClaimantProvince/State Claimant Province/State Alpha
26 ClaimantPostalCode Claimant PostalCode Alpha
27 ClaimantCountry Claimant Country Alpha
28 ClaimantPhone Claimant Phone Alpha
29 ClaimantFax Claimant Fax Alpha
30 ClaimFile Claim File Alpha
31 DateofLoss Dateof Loss Date/Time YYYY-MM-DD
32 ClaimantPolicyNumber Claimant Policy Number Alpha
33 ClaimantP.O.Box Claimant P.O. Box Alpha
33 Billingsameasreferral Billing same as referral Numeric 1=Yes;2=No
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/State 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 BillingP.O.Box Billing P.O. Box Alpha
Appointment Details Field Name Description Field Type Acceptable Values
45 Faxconfirmationofappointment Fax confirmation of appointment Numeric 1=Yes;2=No
46 Emailconfirmationofappointment Email confirmation of appointment Numeric 1=Yes;2=No
47 Phoneconfirmationofappointment Phone confirmation of appointment Numeric 1=Yes;2=No
48 Notes Notes Alpha
49 ArrangeAppointmentwithclaimant Arrange Appointment with claimant/patient Numeric 1=Yes;2=No
50 ConfirmAppointmentwithclaimant Confirm Appointment with claimant/patient Numeric 1=Yes;2=No
51 DateandTime Date and Time of appointment Date/Time YYYY-MM-DDHH:MM:SS
52 Duration Duration Date/Time hh:mm
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
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/State Referral Province/State Alpha
12 ReferralPostalCode Referral PostalCode Alpha
13 ReferralCountry Referral Country Alpha
14 ReferralFileNumber Referral FileNumber 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/Suite Claimant Apt/Suite Alpha
22 ClaimantBuzzer Claimant Buzzer Alpha
23 ClaimantAddress Claimant Address Alpha
24 ClaimantCity Claimant City Alpha
25 ClaimantProvince/State Claimant Province/State Alpha
26 ClaimantPostalCode Claimant PostalCode Alpha
27 ClaimantCountry Claimant Country Alpha
28 ClaimantPhone Claimant Phone Alpha
29 ClaimantFax Claimant Fax Alpha
30 ClaimFile Claim File Alpha
31 DateofLoss Dateof Loss Date/Time YYYY-MM-DD
32 ClaimantPolicyNumber Claimant Policy Number Alpha
33 ClaimantP.O.Box Claimant P.O. Box Alpha
33 Billingsameasreferral Billing same as referral Numeric 1=Yes;2=No
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/State 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 BillingP.O.Box Billing P.O. Box Alpha
Appointment Details Field Name Description Field Type Acceptable Values
45 Faxconfirmationofappointment Fax confirmation of appointment Numeric 1=Yes;2=No
46 Emailconfirmationofappointment Email confirmation of appointment Numeric 1=Yes;2=No
47 Phoneconfirmationofappointment Phone confirmation of appointment Numeric 1=Yes;2=No
48 Notes Notes Alpha
49 ArrangeAppointmentwithclaimant Arrange Appointment with claimant/patient Numeric 1=Yes;2=No
50 ConfirmAppointmentwithclaimant Confirm Appointment with claimant/patient Numeric 1=Yes;2=No
51 DateandTime Date and Time of appointment Date/Time YYYY-MM-DDHH:MM:SS
52 Duration Duration Date/Time hh:mm
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-DDHH:MM:SS
56 PickupAddress Pickup Address Alpha
57 PickupCity Pickup City Alpha
58 PickupPostalCode Postal Code Alpha
59 PickupApt/Suite Pickup Apt/Suite Alpha
60 PickupBuzzer Pickup Buzzer Alpha
61 PickupProvince/State Pickup Province/State Alpha
62 PickupPhone Pickup Phone Alpha
63 WheelchairVehicle Does claimant require a wheelchair accessible vehicle? Numeric 1=Yes;2=No
64 SpecialNeeds Does claimant require special needs (e.g. Assistance)? Numeric 1=Yes;2=No

Field List transferred to SmartSimple

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


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


# Field Name Field Type Comments
1 CaseID Numeric Unique case identifier as provided by SmartSimple when transferring the service request.
2 ServiceID Numeric Unique service identifier as provided by SmartSimple when transferring the service request.
3 TypeofService Numeric Interpretation records - set to 1. Transportation records - set to 2.
4 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.
5 Source Numeric This represents the SmartSimple client type: 10 for IME client and 20 for Insurer client.
6 Gap Code Alpha Goods, Administration, and Other Codes(GAP). This list corresponds to the HCAI GAP Code list[[.
7 Rate Numeric Rate for Service.
8 Measure Alpha Unit Measure. This list corresponds to the HCAI Unit Measure Code.
9 Quantity Numeric Quantity
10 Tax Alpha Options: Yes;No
11 TaxType Alpha Options: No;HST;GST;BCST;NSST;QST
12 Total Numeric, two decimal Rate*Quantity
13 TaxAmount Numeric, two decimal Calculated tax amount.
14 GrossAmount Numeric, two decimal [Total]+[TaxAmount]
15 Reference Alpha Unique Service Provider identifier for billing transaction.
16 ProviderName Alpha Name of Provider - SmartSimple will provide name to provider.
17 ProviderEmail Alpha Email address of contact at service provider.
18 Notes Alpha Service Provider notes for this transaction.

See Also

Retrieved from ‘https://wiki.smartsimple.com/index.php?title=Service_Provider_Integration_Fields&oldid=11472’