SageBridge API - CreatePortalProvider function

CreatePortalProvider

Create new Portal Provider.

Call example:


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

Request parameters:

PortalProvider element

Name	Type	Size	Desciption
providerId	(string)	36	Unique portal provider id (required).
first	(string)	50	Provider first name (required).
middle	(string)	50	Provider middle initial.
last	(string)	50	Provider last name (required).
phone	(string)	10	Provider phone.
email	(string)	50	Provider email address.
credentials	(string)	50	Provider credentials. ('MD', 'DO', 'PA', 'OD' etc).
specialty	(string)	50	Comma separated list of provider specialties.
abbreviation	(string)	50	Provider abbreviation/short code.
sex	(string)	1	Provider gender ('F', 'M' etc). Also can be specifeid as 'male'/'female'.
takingPatients	(string)		Provider is currently taking patients (0/1 or N/Y or false/true).
seekingPatients	(string)		Provider is currently seeking patients (0/1 or N/Y or false/true).
videoVisitOffered	(string)		Provider offers Video-Visits (0/1 or N/Y or false/true).
eVisitOffered	(string)		Provider offers e-Visits (0/1 or N/Y or false/true).

Notes:

providerId value must be unique per practice (required).
first and last combination must be unique per practice (required).

JSON string request example:


{
  "providerId": "33",
  "last": "Smith",
  "first": "Peter",
  "middle": "J",
  "credentials": "MD",
  "specialty": "Ophthalmology",
  "abbreviation": "DOC1",
  "sex": "M",
  "phone": "8005551212",
  "email": "provider@clinic.com",
  "takingPatients": "true",
  "seekingPatient": "false",
  "videoVisitOffered": "true",
  "evisitOffered": "true"
}

XML Example:

Response:

XML or JSON string representing APIResponse structure.

APIResponse payload element may be encrypted and delivered as Base64 string.

Response data:

Name	Type	Desciption
code	(string)	0 - operation successfull. Otherwise see description and validation data.
description	(string)	Result Descriptions
validation	(array)	List of validation errors.
validation.id	(string)	Error/Validation code. See possible validation codes below.
validation.display	(string)	Error description.

Example of JSON payload (success):

{
  "code": "0",
  "description": "Provider created successfuly",
  "validation": null
}

Example of JSON payload (failed):

{
  "code": "-1",
  "description": "Incorrect request. See validation messages",
  "lang": "en",
  "validation": [
    {"id": "306", "display": "Invalid Phone Number format"},
    {"id": "307", "display": "First Name is longer than 50 characters"}
  ]
}

Example of XML payload (success):

Example of XML payload (failed):

Possible return codes

0 - Success. Description may vary by 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.

Validation codes:

300 - Unable to process a request.
301 - Unable to parse request parameters.
302 - Provider ID is invalid or missed.
303 - Missed Last or First Name.
304 - Provider already exists.
305 - Provider already exists.
306 - Invalid format of phone number.
307 - Too long parameter value. See "display" for more details.
308 - Provider not found.
309 - Provider is not unique.

Known Issues:

None