CreatePatient

function is used to create a patient within a practice's PM or EMR system.

Call example:


string result = SageBridgeAPI.executeAPICall(
"cf389659-588c-4fd9-ab9e-7c37b438905c", // security token
"CreatePatient",                    
"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 Patient data.

Notes:
  • It will perform look-up for a patient on remote system (remote PM or EMR) before creating a patient. If the patient already exists it won't create another one. Instead, it will retrieve patient information together with patientId value.
  • Insurance and guarantor elements are not used in this request and must be set to NULL.
  • This function ignores insurance and guarantor input parameters in Patient data and will not populate them in a response object.


JSON string request example:
Get patient info for existing patient:
{
"last":"Pistol",
"first":"Peter",
"middle":"",
"birthdate":"01/01/1965",
"sex":"M",
"SSN":null,
"race":null,
"maritalStatus":"S",
"preferredLanguage":"en",
"ethnicity":null,
"address":
	{
	"addr1":"1 Park Ave",
	"addr2":"Unit 203",
	"city":"Sunny Town",
	"state":"IL",
	"zip":"09111",
	"country":"us"
	},
"contactInfo":
	{
	"phone":"8005551212",
	"phoneExt":null,"cell":null,
	"fax":"8005551313",
	"email":"some@dadada.net"
	}
}

Response:

XML or JSON string representing APIResponse structure.

APIResponse payload element may be encrypted and delivered as Base64 string.
This function returns payload with Patient data reflecting all values from the input parameters. In addition it will have the patientId field populated.

Call example (C#):

For the source code of working example see testCreatePatient() method in SageBridgeApiCallExecutor class of SageBrige.API.Tester project can be downloaded here.

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, APIResponse structure, Patient structure