Smartstaff, administrator
686
edits
Changes
no edit summary
This article presents the complete list of fields involved in Service Provider integration between a SmartSimple client instance and a third party service provider.
==Field List Fields transferred to Service Provider System==
As part of our Integration services, we currently support <u>two types of transaction records</u>.
*Interpretation records - Identified by '''TypeofService''' field - set to 1.
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===
----
{| border="1" cellpadding="4"
|-
! style="color: black; background-color: #62BC43;"|Identifiers !! style="color: black; background-color: #62BC43;"|Field Name !! style="color: black; background-color: #62BC43;"|Description !! style="color: black; background-color: #62BC43;"|Field Type !! style="color: black; background-color: #62BC43;"|Acceptable Values
|-
| 1 || CaseID || Unique Identifier for Case || Numberic Numeric ||
|-
| 2 || ServiceID || Unique Identifier for Service || Numberic Numeric ||
|-
| 3 || CustomerID || Unique Identifier for SmartSimple Customer || Alpha ||
|-
| 4 || Source || Source Type || Numberic Numeric || 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
|-
! style="color: black; background-color: #62BC43;"|Referral !! style="color: black; background-color: #62BC43;"|Field Name !! style="color: black; background-color: #62BC43;"|Description !! style="color: black; background-color: #62BC43;"|Field Type !! style="color: black; background-color: #62BC43;"|Acceptable Values
|10||ReferralCity||Referral City||Alpha||
|-
|11||ReferralProvince/State||Referral Province/State||Alpha||
|-
|12||ReferralPostalCode||Referral PostalCodePostal Code||Alpha||
|-
|13||ReferralCountry||Referral Country||Alpha||
|-
|14||ReferralFileNumber||Referral FileNumberFile Number (system)||Alpha||
|-
|15||ReferralPhoneNumber||Referral Phone Number||Alpha||
|20||ClaimantLastName||Claimant Last Name||Alpha||
|-
|21||ClaimantApt/Suite||Claimant Apt/Suite||Alpha||
|-
|22||ClaimantBuzzer||Claimant Buzzer||Alpha||
|24||ClaimantCity||Claimant City||Alpha||
|-
|25||ClaimantProvince/State||Claimant Province/State||Alpha||
|-
|26||ClaimantPostalCode||Claimant PostalCodePostal Code||Alpha||
|-
|27||ClaimantCountry||Claimant Country||Alpha||
|29||ClaimantFax||Claimant Fax||Alpha||
|-
|30||ClaimFile||Claim FileNumber||Alpha||
|-
|31||DateofLoss||Dateof Date of Loss||Date/Time||YYYY-MM-DD
|-
|32||ClaimantPolicyNumber||Claimant Policy Number||Alpha||
|-
|33||ClaimantP.O.BoxClaimantPOBox||Claimant P.O. Box||Alpha||
|-
|33||Billingsameasreferral||Billing same as referral||Numeric||1=Yes;2=No<br>*Note that this section controls if the Billing section below is visible.
|-
! style="color: black; background-color: #62BC43;"|Billing !! style="color: black; background-color: #62BC43;"|Field Name !! style="color: black; background-color: #62BC43;"|Description !! style="color: black; background-color: #62BC43;"|Field Type !! style="color: black; background-color: #62BC43;"|Acceptable Values
|38||BillingCity||Billing City||Alpha||
|-
|39||BillingProvince/State||Billing Province/State||Alpha||
|-
|40||BillingPostalCode||Billing Postal Code||Alpha||
|43||BillingEmail||Billing Email||Alpha||
|-
|44||BillingP.O.BoxBillingPOBox||Billing P.O. Box||Alpha||
|-
! style="color: black; background-color: #62BC43;"|Appointment Details !! style="color: black; background-color: #62BC43;"|Field Name !! style="color: black; background-color: #62BC43;"|Description !! style="color: black; background-color: #62BC43;"|Field Type !! style="color: black; background-color: #62BC43;"|Acceptable Values
|-
|45||FaxconfirmationofappointmentFaxconfirmation||Fax confirmation of appointment||Numeric||1=Yes;2=No
|-
|46||EmailconfirmationofappointmentEmailconfirmation||Email confirmation of appointment||Numeric||1=Yes;2=No
|-
|47||PhoneconfirmationofappointmentPhoneconfirmation||Phone confirmation of appointment||Numeric||1=Yes;2=No
|-
|48||Notes||Notes||Alpha||
|-
|49||ArrangeAppointmentwithclaimantArrangeAppointment||Arrange Appointment with claimant/patient||Numeric||1=Yes;2=No
|-
|50||ConfirmAppointmentwithclaimantConfirmAppointment||Confirm Appointment with claimant/patient||Numeric||1=Yes;2=No
|-
|51||DateandTime||Date and Time of appointment||Date/Time||YYYY-MM-DDHHDD HH:MM:SS
|-
|52||Duration||Duration(Calculated in hours)||Date/TimeNumeric||hh:mme.g 3.5 (this represents 3 hours 30 minutes)
|-
|53||AppointmentLocation||Location||Alpha||
|}
===Transportation Fields===
----
{| border="1" cellpadding="4"
|-
|-
| 6 || ProtocolPassword || Protocol Password || ||
|-
| || PostTest || Testing flag used to indicate test submissions || Numeric || 1=True , 0=False
|-
! style="color: black; background-color: #62BC43;"|Referral !! style="color: black; background-color: #62BC43;"|Field Name !! style="color: black; background-color: #62BC43;"|Description !! style="color: black; background-color: #62BC43;"|Field Type !! style="color: black; background-color: #62BC43;"|Acceptable Values
|10||ReferralCity||Referral City||Alpha||
|-
|11||ReferralProvince/State||Referral Province/State||Alpha||
|-
|12||ReferralPostalCode||Referral PostalCodePostal Code||Alpha||
|-
|13||ReferralCountry||Referral Country||Alpha||
|-
|14||ReferralFileNumber||Referral FileNumberFile Number (system)||Alpha||
|-
|15||ReferralPhoneNumber||Referral Phone Number||Alpha||
|20||ClaimantLastName||Claimant Last Name||Alpha||
|-
|21||ClaimantApt/Suite||Claimant Apt/Suite||Alpha||
|-
|22||ClaimantBuzzer||Claimant Buzzer||Alpha||
|24||ClaimantCity||Claimant City||Alpha||
|-
|25||ClaimantProvince/State||Claimant Province/State||Alpha||
|-
|26||ClaimantPostalCode||Claimant PostalCodePostal Code||Alpha||
|-
|27||ClaimantCountry||Claimant Country||Alpha||
|29||ClaimantFax||Claimant Fax||Alpha||
|-
|30||ClaimFile||Claim File#||Alpha||
|-
|31||DateofLoss||Dateof Date of Loss||Date/Time||YYYY-MM-DD
|-
|32||ClaimantPolicyNumber||Claimant Policy Number||Alpha||
|-
|33||ClaimantP.O.BoxClaimantPOBox||Claimant P.O. Box||Alpha||
|-
|33||Billingsameasreferral||Billing same as referral||Numeric||1=Yes;2=No<br>*Note that this section controls if the Billing section below is visible.
|-
! style="color: black; background-color: #62BC43;"|Billing !! style="color: black; background-color: #62BC43;"|Field Name !! style="color: black; background-color: #62BC43;"|Description !! style="color: black; background-color: #62BC43;"|Field Type !! style="color: black; background-color: #62BC43;"|Acceptable Values
|38||BillingCity||Billing City||Alpha||
|-
|39||BillingProvince/State||Billing Province/State||Alpha||
|-
|40||BillingPostalCode||Billing Postal Code||Alpha||
|43||BillingEmail||Billing Email||Alpha||
|-
|44||BillingP.O.BoxBillingPOBox||Billing P.O. Box||Alpha||
|-
! style="color: black; background-color: #62BC43;"|Appointment Details !! style="color: black; background-color: #62BC43;"|Field Name !! style="color: black; background-color: #62BC43;"|Description !! style="color: black; background-color: #62BC43;"|Field Type !! style="color: black; background-color: #62BC43;"|Acceptable Values
|-
|45||FaxconfirmationofappointmentFaxconfirmation||Fax confirmation of appointment||Numeric||1=Yes;2=No
|-
|46||EmailconfirmationofappointmentEmailconfirmation||Email confirmation of appointment||Numeric||1=Yes;2=No
|-
|47||PhoneconfirmationofappointmentPhoneconfirmation||Phone confirmation of appointment||Numeric||1=Yes;2=No
|-
|48||Notes||Notes||Alpha||
|-
|49||ArrangeAppointmentwithclaimantArrangeAppointment||Arrange Appointment with claimant/patient||Numeric||1=Yes;2=No
|-
|50||ConfirmAppointmentwithclaimantConfirmAppointment||Confirm Appointment with claimant/patient||Numeric||1=Yes;2=No
|-
|51||DateandTime||Date and Time of appointment||Date/Time||YYYY-MM-DDHHDD HH:MM:SS
|-
|52||Duration||Duration(Calculated in hours)||Date/TimeNumeric||hh:mme.g 3.5 (this represents 3 hours 30 minutes)
|-
|53||AppointmentLocation||Location||Alpha||
! style="color: black; background-color: #62BC43;"|Pickup Details !! style="color: black; background-color: #62BC43;"|Field Name !! style="color: black; background-color: #62BC43;"|Description !! style="color: black; background-color: #62BC43;"|Field Type !! style="color: black; background-color: #62BC43;"|Acceptable Values
|-
|55||PickupTime||Pickup Time||Date/Time||YYYY-MM-DDHHDD HH:MM:SS
|-
|56||PickupAddressWheelchairVehicle||Pickup AddressDoes claimant require a wheelchair accessible vehicle?||AlphaNumeric||1=Yes;2=No
|-
|57||PickupCitySpecialNeeds||Pickup CityDoes claimant require special needs (e.g. Assistance)?||AlphaNumeric|| 1=Yes;2=No
|-
|58||PickupPostalCodePickupSame||Postal CodeIs Pickup Address same as Claimant Address?||Alpha|| 1=Yes;2=No
|-
|59||PickupApt/Suite||Pickup Apt/Suite||Alpha|colspan="5"| Note the fields below will be populated by SmartSimple if '''No''' is selected for the field above
|-
|6059||PickupBuzzerPickupAddress||Pickup BuzzerAddress||Alpha||
|-
|6160||PickupProvince/StatePickupCity||Pickup Province/StateCity||Alpha||
|-
|6261||PickupPhonePickupPostalCode||Pickup PhonePostal Code||Alpha||
|-
|6362||WheelchairVehiclePickupApt||Does claimant require a wheelchair accessible vehicle?Pickup Apt/Suite||NumericAlpha|| 1=Yes;2=No
|-
|63||PickupBuzzer||Pickup Buzzer||Alpha|| |-|64||SpecialNeedsPickupProvince||Pickup Province/State||Alpha|| |-|65||PickupPhone||Does claimant require special needs (e.g. Assistance)?Pickup Phone||NumericAlpha||1=Yes;2=No
|}
==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
{| 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;"|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 [http://www.hcaiinfo.ca/Health_Care_Facility_Provider/documents/appendices/AppendixCFINAL.pdf HCAI GAP Code list].
|-
| 8 || rate || Numeric ||Rate for Service.
|-
| 9 || measure ||Alpha ||Unit Measure. This list corresponds to the [http://www.hcaiinfo.ca/Health_Care_Facility_Provider/documents/appendices/AppendixFFINAL.pdf 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]]
[[Category:Integration]]
[[Category:External Services]]
