UpdateReferralSource

function is used to update patient referral source.

Call example:


string result = SageBridgeAPI.executeAPICall(
"cf389659-588c-4fd9-ab9e-7c37b438905c", // security token
"UpdateReferralSource",                    
"bos5",                                 // practice Path or Tax ID
"JSON",                                 // output format (XML or JSON)
"--request parameters XML or JSON---"   // request parameters
);

Request parameters:

request parameter is JSON string representing set of fields:
patientId(string)Patient Id
patientdob(string)Patient Birth Date (for verification)
appointmentid(string)Appointment Id (if applicable)
sourceId(string)Source Id. Referral Sources can be retrieved by getReferralSources function
sourceName(string)Source Name
refProviderId(string)Referring provider Id
vipFlag(string)VIP Flag
referralComanage(string)Referral Comanage

Both patientId and patientdob parameters must be provided for validation purpose.
JSON string request example:
{
"patientId":"999888777",
"appointmentid":"appt1534",
"patientdob":"1/1/1963",
"sourceId":"123test",
"sourceName":"Sophrona test",
"details":"testing Update Patient Referral Source for non-existing patient",
"refProviderId":"provider15",
"vipFlag":"0",
"referralComanage":"C"
}

This function returns empty payoad. See APIResponse result code and description for a result of operation

Possible return values (see APIResponse )

  • 0 - Success. Description can be vary per function
  • -1 - General error. Description attribute will show more details about an error
  • -2 - Function is not supported
  • 500 - Invalid credentials provided
  • 501 - License is expired
  • 502 - License is not active
  • 503 - Token is not active or expired
  • 550 - Unknow functionName or not subscribed
  • 551 - Unknown practice
  • 552 - No Subscription found
  • 553 - Subscription is inactive or expired
  • 600 - Invalid or empty request parameters
  • 601 - No valid route found for this subscription
  • 602 - Unable to parse request parameters
This function may return other codes not listed above; they may vary by practice.

Notes:

All examples of source code and compiled version of SageBridge API can be found here.

Known Issues:

None

See Also:

API Functions, getReferralSources function, APIResponse structure