UpdatePatientDemographic

Update patient demographic information

Call example:


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

Request parameters:

Name Type Desciption
patientInfo(object)Patient information. See Patient for more details. (required).
insurances(array)List of patient insurances. Each element is Insurance data. (optional).
Notes:
  • patientInfo data is required. The list of required properties may vay per practice and/or PM/EMR system.
  • insurances data is optional.
Example of XML request:
Example of JSON request:

{
  "patientInfo": {
    "sex": "M",
    "SSN": null,
    "race": "white",
    "maritalStatus": "Married",
    "employmentStatus": "fulltime",
    "studentStatus": "",
    "preferredLanguage": "en",
    "ethnicity": "other",
    "address": {
      "addr1": "1247 Lodgeville Rd",
      "addr2": null,
      "city": "Minitown",
      "state": "MN",
      "zip": "55415",
      "zip4": null,
      "country": "us"
    },
    "contactInfo": {
      "fax": null,
      "url": null,
      "twitter": null,
      "facebook": null,
      "cellOptIn": null,
      "emailOptIn": null,
      "phone": "6125553344",
      "cell": "6125553344",
      "email": "CGG1972@hmail.com",
      "phoneExt": null,
      "home": "6125553355",
      "work": "6125553366",
      "workExt": null,
      "altPhone": null
    },
    "facilityId": null,
    "patientID": "1338554",
    "patientNbr": null,
    "last": "Testone",
    "first": "Josh",
    "middle": "",
    "birthdate": "10/10/1980"
  },
  "insurances": [
    {
      "insSeq": "1",
      "insuranceCard": {
        "frontImage": {
          "mimeType": "image/png",
          "fileName": "InsuranceCard-front.png",
          "fileSize": -1,
          "description": "Insurance Card front image",
          "content": "EFH7438743.......=="
        },
        "backImage": {
          "mimeType": "image/png",
          "fileName": "InsuranceCard-back.png",
          "fileSize": -1,
          "description": "Insurance Card back image",
          "content": "ABC7438743.......=="
        }
      },
      "carrierId": "8CCC12D6-BB3D-41D0-80B2-A462C7509EE2",
      "carrierName": "BlueCross",
      "policyNumber": "JFF132897239847",
      "groupNumber": "123456",
      "insuranceType": "vision",
      "policyHolder": {
        "sex": "F",
        "relationship": "spouse",
        "contactInfo": {
          "phone": "6125553349",
          "cell": "6125553349",
          "email": "GGG1962@hmail.com",
          "phoneExt": null,
          "home": "6125553359",
          "work": "6125553369",
          "workExt": null,
          "altPhone": null
        },
        "address": {
          "addr1": "1247 Lodgeville Rd",
          "addr2": null,
          "city": "Minitown",
          "state": "MN",
          "zip": "55415",
          "zip4": null,
          "country": "us"
        },
        "last": "Testone",
        "first": "Mary",
        "middle": null,
        "birthdate": "03/08/1965"
      }
    },
    {
      "insSeq": "2",
      "insuranceCard": null,
      "carrierId": "B9EF7B48-B3C6-419E-ACB0-1C2D1DB2B4BA",
      "carrierName": "Aethna",
      "policyNumber": "BBQ2983749",
      "groupNumber": "123456",
      "insuranceType": "medical",
      "policyHolder": {
        "sex": null,
        "relationship": "self",
        "contactInfo": {
          "phone": null,
          "cell": null,
          "email": null,
          "phoneExt": null,
          "home": null,
          "work": null,
          "workExt": null,
          "altPhone": null
        },
        "address": {
          "addr1": null,
          "addr2": null,
          "city": null,
          "state": null,
          "zip": null,
          "zip4": null,
          "country": null
        },
        "last": null,
        "first": null,
        "middle": null,
        "birthdate": null
      }
    }
  ]
}

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": "ok",
  "validation": null
}
Example of JSON payload (failed):
{
  "code": "-1",
  "description": "Incorrect request. See validation messages",
  "lang": "en",
  "validation": [
    {"id": "501", "display": "Last Name is required"}
  ]
}
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:
  • 500 - Patient Info is required
  • 501 - Last Name is required
  • 502 - First Name is required
  • 503 - Birth Date is incorrect or empty

Known Issues:

None

See Also:

API Functions, APIResponse structure