SageBridge API - GetPatientRegistrationChart function

GetPatientRegistrationChart

This function is used to retrieve recent patient registration CCD document from the patient portal.

Call example:


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

Request fields:

patientId	(string)	Unique patient id.
eventStart	(string)	Filter by "from" datetime.
eventEnd	(string)	Filter by "to" datetime.
unreadOnly	(bool)	To get only items not marked as "read" (if set to "true" then all retrieved items will be marked as "read").
itemsPerCall	(int)	To limit number of items in a response (Sophrona has its own parameter. The minimal value will be used).
base64	(bolll)	Represent generated CCD as base64 string.

Notes:

All parameters are optional. If a parameter is not provided then the default value(s) will be used.
If the itemsPerCall parameter value exceeds Sophrona specified value, then the Sophrona specified value will be used.
The unreadOnly default value is "true".
For every registration pulled, it will be marked as "read" and not included into next response if the unreadOnly value is "true".
If unreadOnly = true then eventStart and eventEnd parameters will be ignored.
If unreadOnly = false then eventStart and eventEnd parameters will be used as a timeframe to restrict a recent registration only. If a recent registration was completed outside of the specified time frame, it will not be included.
If PatientID parameter is specified, then unreadOnly, eventStart and eventEnd parameters will be ignored. Only a recent registration will be included regardless of its "new" status.
If unreadOnly parameter is set to true then all registrations for each patient included into an output will be marked as not new.
If unreadOnly parameter is set to false then "read" status will not be updated.
If base64 parameter is set to true ccdDocument field in an output data will be represented as base64 encoded string.

Request example:

JSON:

    
{
  "patientId": "",
  "eventStart": null,
  "eventEnd": null,
  "unreadOnly": false,
  "itemsPerCall": 0,
  "base64": true
}

XML:

Response

Response is a XML or JSON representation of APIResponse structure. Payload element of APIResponse is an escaped JSON or XML string representing a list of registrations.
CCD Document provided in payload examples is not real and provided for demonstration only. Format and structure of real CCD document may differ.

JSON payload:

    
{
  "registrations": [
    {
      "registrationTime": "2020-05-12 10:15",
      "patientInfo": {
        "patientID": "pt123",
        "patientNbr": "pt123",
        "last": "Galt",
        "first": "John",
        "middle": "",
        "birthdate": "1970-07-08"
      },
      "ccdDocument": "\u003c?xml version=\"1.0\"?\u003e\r\n\u003c?xml-stylesheet type=\"text/xsl\" href=\"CDA.xsl\"?\u003e\r\n\u003cClinicalDocument xmlns=\"urn:hl7-org:v3\" xmlns:voc=\"urn:hl7-org:v3/voc\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:schemaLocation=\"urn:hl7-org:v3 CDA.xsd\"\u003e\r\n\t\u003c!-- \r\n********************************************************\r\n  CDA Header\r\n********************************************************\r\n--\u003e\r\n\t\u003c!-- TODO: Need to get report title definition--\u003e\r\n\t\u003ctitle\u003eSage Portal Patient Profile\u003c/title\u003e\r\n\t\u003c!-- TODO: effective time is the time of the submission by the patient--\u003e\r\n\t\u003ceffectiveTime value=\"20070318\"/\u003e\r\n\t\u003clanguageCode code=\"en-US\"/\u003e\r\n\t\u003crecordTarget\u003e\r\n\t\t\u003cpatientRole\u003e\r\n\t\t\t\u003cpatient\u003e\r\n\t\t\t\t\u003cname\u003e\r\n\t\t\t\t\t\u003c!-- TODO: Patient last/first below--\u003e\r\n\t\t\t\t\t\u003cgiven\u003eLast Name\u003c/given\u003e\r\n\t\t\t\t\t\u003cfamily\u003eFirst Name\u003c/family\u003e\r\n\t\t\t\t\u003c/name\u003e\r\n\t\t\t\t\u003cadministrativeGenderCode code=\"M\" codeSystem=\"2.16.840.1.113883.5.1\"/\u003e\r\n\t\t\t\t\u003cbirthTime value=\"19740322\"/\u003e\r\n\t\t\t\u003c/patient\u003e\r\n\t\t\u003c/patientRole\u003e\r\n\t\u003c/recordTarget\u003e\r\n\t\u003cauthor\u003e\r\n\t\t\u003ctime value=\"2000040714\"/\u003e\r\n\t\t\u003cassignedAuthor\u003e\r\n\t\t\t\u003cassignedPerson\u003e\r\n\t\t\t\t\u003cname\u003e\r\n\t\t\t\t\t\u003c!-- TODO: Patient last/first below--\u003e\r\n\t\t\t\t\u003cgiven\u003eLast Name\u003c/given\u003e\r\n\t\t\t\t\u003cfamily\u003eFirst Name\u003c/family\u003e\r\n\t\t\t\u003c/name\u003e\r\n\t\t\u003c/assignedPerson\u003e\r\n\t\u003c/assignedAuthor\u003e\r\n\u003c/author\u003e\r\n\u003ccomponent\u003e\r\n\t\u003cstructuredBody\u003e\r\n\t\t\u003c!-- \r\n********************************************************\r\n  History of Present Illness section\r\n********************************************************\r\n--\u003e\r\n\t\t\u003ccomponent\u003e\r\n\t\t\t\u003csection\u003e\r\n\t\t\t\t\u003ccode code=\"10164-2\" codeSystem=\"2.16.840.1.113883.6.1\" codeSystemName=\"LOINC\"/\u003e\r\n\t\t\t\t\u003ctitle\u003eChief Complaint\u003c/title\u003e\r\n\t\t\t\t\u003ctext\u003e\r\n\t\t\t\t\t\u003ccontent\u003e\r\n\t\t\t\t\t\t\u003c!-- TODO: Add Chief Complaint Text Here--\u003e\r\n\t\t\t\t\t\tThis is a sample chief complaint.\r\n\t\t\t\t\t\u003c/content\u003e\r\n\t\t\t\t\u003c/text\u003e\r\n\t\t\t\u003c/section\u003e\r\n\t\t\u003c/component\u003e\r\n\t\t\u003c!-- \r\n********************************************************\r\n  Medical Allergies\r\n********************************************************\r\n--\u003e\r\n\t\t\u003ccomponent\u003e\r\n\t\t\t\u003csection\u003e\r\n\t\t\t\t\u003ccode code=\"10155-0\" codeSystem=\"2.16.840.1.113883.6.1\" codeSystemName=\"LOINC\"/\u003e\r\n\t\t\t\t\u003ctitle\u003eMedical Allergies\u003c/title\u003e\r\n\t\t\t\t\u003ctext\u003e\r\n\t\t\t\t\t\u003clist\u003e\r\n\t\t\t\t\t\t\u003c!-- TODO: Add each allergy as a list item here--\u003e\r\n\t\t\t\t\t\t\t\u003citem\u003ePenicillin - Hives\u003c/item\u003e\r\n\t\t\t\t\t\t\t\u003citem\u003eAspirin - Wheezing\u003c/item\u003e\r\n\t\t\t\t\t\t\t\u003citem\u003eCodeine - Itching and nausea\u003c/item\u003e\r\n\t\t\t\t\t\t\u003c/list\u003e\r\n\t\t\t\t\t\u003c/text\u003e\t\t\t\t\t\r\n\t\t\t\t\u003c/section\u003e\r\n\t\t\t\u003c/component\u003e\r\n\r\n\t\t\t\u003c!-- \r\n********************************************************\r\n  Medications section\r\n********************************************************\r\n--\u003e\r\n\t\t\t\u003ccomponent\u003e\r\n\t\t\t\t\u003csection\u003e\r\n\t\t\t\t\t\u003ccode code=\"10160-0\" codeSystem=\"2.16.840.1.113883.6.1\" codeSystemName=\"LOINC\"/\u003e\r\n\t\t\t\t\t\u003ctitle\u003eMedications\u003c/title\u003e\r\n\t\t\t\t\t\u003ctext\u003e\r\n\t\t\t\t\t\t\u003clist\u003e\r\n\t\t\t\t\t\t\t\u003c!-- TODO: Add each medication as a list item here--\u003e\r\n\t\t\t\t\t\t\u003citem\u003eTheodur 200mg BID\u003c/item\u003e\r\n\t\t\t\t\t\t\u003citem\u003eProventil inhaler 2puffs QID PRN\u003c/item\u003e\r\n\t\t\t\t\t\u003c/list\u003e\r\n\t\t\t\t\u003c/text\u003e\r\n\t\t\t\u003c/section\u003e\r\n\t\t\u003c/component\u003e\r\n\r\n\t\t\u003c!-- \r\n********************************************************\r\n  Family History section\r\n********************************************************\r\n--\u003e\r\n\t\t\u003ccomponent\u003e\r\n\t\t\t\u003csection\u003e\r\n\t\t\t\t\u003ccode code=\"10157-2\" codeSystem=\"2.16.840.1.113883.6.1\" codeSystemName=\"LOINC\"/\u003e\r\n\t\t\t\t\u003ctitle\u003eFamily history\u003c/title\u003e\r\n\t\t\t\t\u003ctext\u003e\r\n\t\t\t\t\t\u003clist\u003e\r\n\t\t\t\t\t\t\u003c!-- TODO: Add each family history row as a list item here--\u003e\r\n\t\t\t\t\t\t\t\u003citem\u003eFather - still living - thyroid cancer.\u003c/item\u003e\r\n\t\t\t\t\t\t\t\u003citem\u003eMother - died at 67 - car accident.\u003c/item\u003e\r\n\t\t\t\t\t\t\u003c/list\u003e\r\n\t\t\t\t\t\u003c/text\u003e\t\t\t\t\t\r\n\t\t\t\t\u003c/section\u003e\r\n\t\t\t\u003c/component\u003e\r\n\t\t\t\u003c!-- \r\n********************************************************\r\n  Problem and Surgical History section\r\n********************************************************\r\n--\u003e\r\n\t\t\t\u003ccomponent\u003e\r\n\t\t\t\t\u003csection\u003e\r\n\t\t\t\t\t\u003ccode code=\"10153-2\" codeSystem=\"2.16.840.1.113883.6.1\" codeSystemName=\"LOINC\"/\u003e\r\n\t\t\t\t\t\u003ctitle\u003e Problem and Surgical History\u003c/title\u003e\r\n\t\t\t\t\t\u003ctext\u003e\r\n\t\t\t\t\t\t\u003clist\u003e\r\n\t\t\t\t\t\t\t\u003c!-- TODO: add items from problem and surgery history here--\u003e\r\n\t\t\t\t\t\t\u003citem\u003eAsthma\u003c/item\u003e\r\n\t\t\t\t\t\t\u003citem\u003eHigh blood pressure : father\u003c/item\u003e\r\n\t\t\t\t\t\t\u003citem\u003eHeart attack\u003c/item\u003e\r\n\t\t\t\t\t\u003c/list\u003e\r\n\t\t\t\t\u003c/text\u003e\r\n\t\t\t\u003c/section\u003e\r\n\t\t\u003c/component\u003e\r\n\t\t\u003c!-- \r\n********************************************************\r\n  Hospitalization History section\r\n********************************************************\r\n--\u003e\r\n\t\t\u003ccomponent\u003e\r\n\t\t\t\u003csection\u003e\r\n\t\t\t\t\u003ccode code=\"11336-5\" codeSystem=\"2.16.840.1.113883.6.1\" codeSystemName=\"LOINC\"/\u003e\r\n\t\t\t\t\u003ctitle\u003eHospitalization History\u003c/title\u003e\r\n\t\t\t\t\u003ctext\u003e\r\n\t\t\t\t\t\u003clist\u003e\r\n\t\t\t\t\t\t\u003c!-- TODO: Add each hospitalization history row as a list item here--\u003e\r\n\t\t\t\t\t\t\t\u003citem\u003eSt. Paul - Chest Pain - 2004\u003c/item\u003e\r\n\t\t\t\t\t\t\t\u003citem\u003eSt. Paul - Broken Arm - 1999\u003c/item\u003e\t\t\t\t\t\t\t\r\n\t\t\t\t\t\t\u003c/list\u003e\r\n\t\t\t\t\t\u003c/text\u003e\r\n\t\t\t\t\u003c/section\u003e\r\n\t\t\t\u003c/component\u003e\r\n\t\t\t\u003c!-- \r\n********************************************************\r\n  Social History section\r\n********************************************************\r\n--\u003e\r\n\t\t\t\u003ccomponent\u003e\r\n\t\t\t\t\u003csection\u003e\r\n\t\t\t\t\t\u003ccode code=\"29762-2\" codeSystem=\"2.16.840.1.113883.6.1\" codeSystemName=\"LOINC\"/\u003e\r\n\t\t\t\t\t\u003ctitle\u003eSocial History\u003c/title\u003e\r\n\t\t\t\t\t\u003ctext\u003e\r\n\t\t\t\t\t\t\u003clist\u003e\r\n\t\t\t\t\t\t\t\u003c!-- TODO: add social history items here--\u003e\r\n\t\t\t\t\t\t\t\u003citem\u003eSmoking :: 1 PPD, 5 years.  Quit 2 years ago.\u003c/item\u003e\r\n\t\t\t\t\t\t\t\u003citem\u003eAlcohol :: No\u003c/item\u003e\r\n\t\t\t\t\t\t\u003c/list\u003e\r\n\t\t\t\t\t\u003c/text\u003e\t\t\t\t\t\r\n\t\t\t\t\u003c/section\u003e\r\n\t\t\t\u003c/component\u003e\r\n\t\u003c/structuredBody\u003e\r\n\t\u003c/component\u003e\r\n\u003c/ClinicalDocument\u003e\r\n"
    },
    {
      "registrationTime": "2020-05-12 15:30",
      "patientInfo": {
        "patientID": "pt124",
        "patientNbr": "pt124",
        "last": "Pistol",
        "first": "Peter",
        "middle": "",
        "birthdate": "1985-05-12"
      },
      "ccdDocument": "\u003c?xml version=\"1.0\"?\u003e\r\n\u003c?xml-stylesheet type=\"text/xsl\" href=\"CDA.xsl\"?\u003e\r\n\u003cClinicalDocument xmlns=\"urn:hl7-org:v3\" xmlns:voc=\"urn:hl7-org:v3/voc\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:schemaLocation=\"urn:hl7-org:v3 CDA.xsd\"\u003e\r\n\t\u003c!-- \r\n********************************************************\r\n  CDA Header\r\n********************************************************\r\n--\u003e\r\n\t\u003c!-- TODO: Need to get report title definition--\u003e\r\n\t\u003ctitle\u003eSage Portal Patient Profile\u003c/title\u003e\r\n\t\u003c!-- TODO: effective time is the time of the submission by the patient--\u003e\r\n\t\u003ceffectiveTime value=\"20070318\"/\u003e\r\n\t\u003clanguageCode code=\"en-US\"/\u003e\r\n\t\u003crecordTarget\u003e\r\n\t\t\u003cpatientRole\u003e\r\n\t\t\t\u003cpatient\u003e\r\n\t\t\t\t\u003cname\u003e\r\n\t\t\t\t\t\u003c!-- TODO: Patient last/first below--\u003e\r\n\t\t\t\t\t\u003cgiven\u003eLast Name\u003c/given\u003e\r\n\t\t\t\t\t\u003cfamily\u003eFirst Name\u003c/family\u003e\r\n\t\t\t\t\u003c/name\u003e\r\n\t\t\t\t\u003cadministrativeGenderCode code=\"M\" codeSystem=\"2.16.840.1.113883.5.1\"/\u003e\r\n\t\t\t\t\u003cbirthTime value=\"19740322\"/\u003e\r\n\t\t\t\u003c/patient\u003e\r\n\t\t\u003c/patientRole\u003e\r\n\t\u003c/recordTarget\u003e\r\n\t\u003cauthor\u003e\r\n\t\t\u003ctime value=\"2000040714\"/\u003e\r\n\t\t\u003cassignedAuthor\u003e\r\n\t\t\t\u003cassignedPerson\u003e\r\n\t\t\t\t\u003cname\u003e\r\n\t\t\t\t\t\u003c!-- TODO: Patient last/first below--\u003e\r\n\t\t\t\t\u003cgiven\u003eLast Name\u003c/given\u003e\r\n\t\t\t\t\u003cfamily\u003eFirst Name\u003c/family\u003e\r\n\t\t\t\u003c/name\u003e\r\n\t\t\u003c/assignedPerson\u003e\r\n\t\u003c/assignedAuthor\u003e\r\n\u003c/author\u003e\r\n\u003ccomponent\u003e\r\n\t\u003cstructuredBody\u003e\r\n\t\t\u003c!-- \r\n********************************************************\r\n  History of Present Illness section\r\n********************************************************\r\n--\u003e\r\n\t\t\u003ccomponent\u003e\r\n\t\t\t\u003csection\u003e\r\n\t\t\t\t\u003ccode code=\"10164-2\" codeSystem=\"2.16.840.1.113883.6.1\" codeSystemName=\"LOINC\"/\u003e\r\n\t\t\t\t\u003ctitle\u003eChief Complaint\u003c/title\u003e\r\n\t\t\t\t\u003ctext\u003e\r\n\t\t\t\t\t\u003ccontent\u003e\r\n\t\t\t\t\t\t\u003c!-- TODO: Add Chief Complaint Text Here--\u003e\r\n\t\t\t\t\t\tThis is a sample chief complaint.\r\n\t\t\t\t\t\u003c/content\u003e\r\n\t\t\t\t\u003c/text\u003e\r\n\t\t\t\u003c/section\u003e\r\n\t\t\u003c/component\u003e\r\n\t\t\u003c!-- \r\n********************************************************\r\n  Medical Allergies\r\n********************************************************\r\n--\u003e\r\n\t\t\u003ccomponent\u003e\r\n\t\t\t\u003csection\u003e\r\n\t\t\t\t\u003ccode code=\"10155-0\" codeSystem=\"2.16.840.1.113883.6.1\" codeSystemName=\"LOINC\"/\u003e\r\n\t\t\t\t\u003ctitle\u003eMedical Allergies\u003c/title\u003e\r\n\t\t\t\t\u003ctext\u003e\r\n\t\t\t\t\t\u003clist\u003e\r\n\t\t\t\t\t\t\u003c!-- TODO: Add each allergy as a list item here--\u003e\r\n\t\t\t\t\t\t\t\u003citem\u003ePenicillin - Hives\u003c/item\u003e\r\n\t\t\t\t\t\t\t\u003citem\u003eAspirin - Wheezing\u003c/item\u003e\r\n\t\t\t\t\t\t\t\u003citem\u003eCodeine - Itching and nausea\u003c/item\u003e\r\n\t\t\t\t\t\t\u003c/list\u003e\r\n\t\t\t\t\t\u003c/text\u003e\t\t\t\t\t\r\n\t\t\t\t\u003c/section\u003e\r\n\t\t\t\u003c/component\u003e\r\n\r\n\t\t\t\u003c!-- \r\n********************************************************\r\n  Medications section\r\n********************************************************\r\n--\u003e\r\n\t\t\t\u003ccomponent\u003e\r\n\t\t\t\t\u003csection\u003e\r\n\t\t\t\t\t\u003ccode code=\"10160-0\" codeSystem=\"2.16.840.1.113883.6.1\" codeSystemName=\"LOINC\"/\u003e\r\n\t\t\t\t\t\u003ctitle\u003eMedications\u003c/title\u003e\r\n\t\t\t\t\t\u003ctext\u003e\r\n\t\t\t\t\t\t\u003clist\u003e\r\n\t\t\t\t\t\t\t\u003c!-- TODO: Add each medication as a list item here--\u003e\r\n\t\t\t\t\t\t\u003citem\u003eTheodur 200mg BID\u003c/item\u003e\r\n\t\t\t\t\t\t\u003citem\u003eProventil inhaler 2puffs QID PRN\u003c/item\u003e\r\n\t\t\t\t\t\u003c/list\u003e\r\n\t\t\t\t\u003c/text\u003e\r\n\t\t\t\u003c/section\u003e\r\n\t\t\u003c/component\u003e\r\n\r\n\t\t\u003c!-- \r\n********************************************************\r\n  Family History section\r\n********************************************************\r\n--\u003e\r\n\t\t\u003ccomponent\u003e\r\n\t\t\t\u003csection\u003e\r\n\t\t\t\t\u003ccode code=\"10157-2\" codeSystem=\"2.16.840.1.113883.6.1\" codeSystemName=\"LOINC\"/\u003e\r\n\t\t\t\t\u003ctitle\u003eFamily history\u003c/title\u003e\r\n\t\t\t\t\u003ctext\u003e\r\n\t\t\t\t\t\u003clist\u003e\r\n\t\t\t\t\t\t\u003c!-- TODO: Add each family history row as a list item here--\u003e\r\n\t\t\t\t\t\t\t\u003citem\u003eFather - still living - thyroid cancer.\u003c/item\u003e\r\n\t\t\t\t\t\t\t\u003citem\u003eMother - died at 67 - car accident.\u003c/item\u003e\r\n\t\t\t\t\t\t\u003c/list\u003e\r\n\t\t\t\t\t\u003c/text\u003e\t\t\t\t\t\r\n\t\t\t\t\u003c/section\u003e\r\n\t\t\t\u003c/component\u003e\r\n\t\t\t\u003c!-- \r\n********************************************************\r\n  Problem and Surgical History section\r\n********************************************************\r\n--\u003e\r\n\t\t\t\u003ccomponent\u003e\r\n\t\t\t\t\u003csection\u003e\r\n\t\t\t\t\t\u003ccode code=\"10153-2\" codeSystem=\"2.16.840.1.113883.6.1\" codeSystemName=\"LOINC\"/\u003e\r\n\t\t\t\t\t\u003ctitle\u003e Problem and Surgical History\u003c/title\u003e\r\n\t\t\t\t\t\u003ctext\u003e\r\n\t\t\t\t\t\t\u003clist\u003e\r\n\t\t\t\t\t\t\t\u003c!-- TODO: add items from problem and surgery history here--\u003e\r\n\t\t\t\t\t\t\u003citem\u003eAsthma\u003c/item\u003e\r\n\t\t\t\t\t\t\u003citem\u003eHigh blood pressure : father\u003c/item\u003e\r\n\t\t\t\t\t\t\u003citem\u003eHeart attack\u003c/item\u003e\r\n\t\t\t\t\t\u003c/list\u003e\r\n\t\t\t\t\u003c/text\u003e\r\n\t\t\t\u003c/section\u003e\r\n\t\t\u003c/component\u003e\r\n\t\t\u003c!-- \r\n********************************************************\r\n  Hospitalization History section\r\n********************************************************\r\n--\u003e\r\n\t\t\u003ccomponent\u003e\r\n\t\t\t\u003csection\u003e\r\n\t\t\t\t\u003ccode code=\"11336-5\" codeSystem=\"2.16.840.1.113883.6.1\" codeSystemName=\"LOINC\"/\u003e\r\n\t\t\t\t\u003ctitle\u003eHospitalization History\u003c/title\u003e\r\n\t\t\t\t\u003ctext\u003e\r\n\t\t\t\t\t\u003clist\u003e\r\n\t\t\t\t\t\t\u003c!-- TODO: Add each hospitalization history row as a list item here--\u003e\r\n\t\t\t\t\t\t\t\u003citem\u003eSt. Paul - Chest Pain - 2004\u003c/item\u003e\r\n\t\t\t\t\t\t\t\u003citem\u003eSt. Paul - Broken Arm - 1999\u003c/item\u003e\t\t\t\t\t\t\t\r\n\t\t\t\t\t\t\u003c/list\u003e\r\n\t\t\t\t\t\u003c/text\u003e\r\n\t\t\t\t\u003c/section\u003e\r\n\t\t\t\u003c/component\u003e\r\n\t\t\t\u003c!-- \r\n********************************************************\r\n  Social History section\r\n********************************************************\r\n--\u003e\r\n\t\t\t\u003ccomponent\u003e\r\n\t\t\t\t\u003csection\u003e\r\n\t\t\t\t\t\u003ccode code=\"29762-2\" codeSystem=\"2.16.840.1.113883.6.1\" codeSystemName=\"LOINC\"/\u003e\r\n\t\t\t\t\t\u003ctitle\u003eSocial History\u003c/title\u003e\r\n\t\t\t\t\t\u003ctext\u003e\r\n\t\t\t\t\t\t\u003clist\u003e\r\n\t\t\t\t\t\t\t\u003c!-- TODO: add social history items here--\u003e\r\n\t\t\t\t\t\t\t\u003citem\u003eSmoking :: 1 PPD, 5 years.  Quit 2 years ago.\u003c/item\u003e\r\n\t\t\t\t\t\t\t\u003citem\u003eAlcohol :: No\u003c/item\u003e\r\n\t\t\t\t\t\t\u003c/list\u003e\r\n\t\t\t\t\t\u003c/text\u003e\t\t\t\t\t\r\n\t\t\t\t\u003c/section\u003e\r\n\t\t\t\u003c/component\u003e\r\n\t\u003c/structuredBody\u003e\r\n\t\u003c/component\u003e\r\n\u003c/ClinicalDocument\u003e\r\n"
    },
    {
      "registrationTime": "2020-05-12 11:00",
      "patientInfo": {
        "patientID": "pt125",
        "patientNbr": "pt125",
        "last": "Silver",
        "first": "Mary",
        "middle": "",
        "birthdate": "1963-08-12"
      },
      "ccdDocument": "\u003c?xml version=\"1.0\"?\u003e\r\n\u003c?xml-stylesheet type=\"text/xsl\" href=\"CDA.xsl\"?\u003e\r\n\u003cClinicalDocument xmlns=\"urn:hl7-org:v3\" xmlns:voc=\"urn:hl7-org:v3/voc\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:schemaLocation=\"urn:hl7-org:v3 CDA.xsd\"\u003e\r\n\t\u003c!-- \r\n********************************************************\r\n  CDA Header\r\n********************************************************\r\n--\u003e\r\n\t\u003c!-- TODO: Need to get report title definition--\u003e\r\n\t\u003ctitle\u003eSage Portal Patient Profile\u003c/title\u003e\r\n\t\u003c!-- TODO: effective time is the time of the submission by the patient--\u003e\r\n\t\u003ceffectiveTime value=\"20070318\"/\u003e\r\n\t\u003clanguageCode code=\"en-US\"/\u003e\r\n\t\u003crecordTarget\u003e\r\n\t\t\u003cpatientRole\u003e\r\n\t\t\t\u003cpatient\u003e\r\n\t\t\t\t\u003cname\u003e\r\n\t\t\t\t\t\u003c!-- TODO: Patient last/first below--\u003e\r\n\t\t\t\t\t\u003cgiven\u003eLast Name\u003c/given\u003e\r\n\t\t\t\t\t\u003cfamily\u003eFirst Name\u003c/family\u003e\r\n\t\t\t\t\u003c/name\u003e\r\n\t\t\t\t\u003cadministrativeGenderCode code=\"M\" codeSystem=\"2.16.840.1.113883.5.1\"/\u003e\r\n\t\t\t\t\u003cbirthTime value=\"19740322\"/\u003e\r\n\t\t\t\u003c/patient\u003e\r\n\t\t\u003c/patientRole\u003e\r\n\t\u003c/recordTarget\u003e\r\n\t\u003cauthor\u003e\r\n\t\t\u003ctime value=\"2000040714\"/\u003e\r\n\t\t\u003cassignedAuthor\u003e\r\n\t\t\t\u003cassignedPerson\u003e\r\n\t\t\t\t\u003cname\u003e\r\n\t\t\t\t\t\u003c!-- TODO: Patient last/first below--\u003e\r\n\t\t\t\t\u003cgiven\u003eLast Name\u003c/given\u003e\r\n\t\t\t\t\u003cfamily\u003eFirst Name\u003c/family\u003e\r\n\t\t\t\u003c/name\u003e\r\n\t\t\u003c/assignedPerson\u003e\r\n\t\u003c/assignedAuthor\u003e\r\n\u003c/author\u003e\r\n\u003ccomponent\u003e\r\n\t\u003cstructuredBody\u003e\r\n\t\t\u003c!-- \r\n********************************************************\r\n  History of Present Illness section\r\n********************************************************\r\n--\u003e\r\n\t\t\u003ccomponent\u003e\r\n\t\t\t\u003csection\u003e\r\n\t\t\t\t\u003ccode code=\"10164-2\" codeSystem=\"2.16.840.1.113883.6.1\" codeSystemName=\"LOINC\"/\u003e\r\n\t\t\t\t\u003ctitle\u003eChief Complaint\u003c/title\u003e\r\n\t\t\t\t\u003ctext\u003e\r\n\t\t\t\t\t\u003ccontent\u003e\r\n\t\t\t\t\t\t\u003c!-- TODO: Add Chief Complaint Text Here--\u003e\r\n\t\t\t\t\t\tThis is a sample chief complaint.\r\n\t\t\t\t\t\u003c/content\u003e\r\n\t\t\t\t\u003c/text\u003e\r\n\t\t\t\u003c/section\u003e\r\n\t\t\u003c/component\u003e\r\n\t\t\u003c!-- \r\n********************************************************\r\n  Medical Allergies\r\n********************************************************\r\n--\u003e\r\n\t\t\u003ccomponent\u003e\r\n\t\t\t\u003csection\u003e\r\n\t\t\t\t\u003ccode code=\"10155-0\" codeSystem=\"2.16.840.1.113883.6.1\" codeSystemName=\"LOINC\"/\u003e\r\n\t\t\t\t\u003ctitle\u003eMedical Allergies\u003c/title\u003e\r\n\t\t\t\t\u003ctext\u003e\r\n\t\t\t\t\t\u003clist\u003e\r\n\t\t\t\t\t\t\u003c!-- TODO: Add each allergy as a list item here--\u003e\r\n\t\t\t\t\t\t\t\u003citem\u003ePenicillin - Hives\u003c/item\u003e\r\n\t\t\t\t\t\t\t\u003citem\u003eAspirin - Wheezing\u003c/item\u003e\r\n\t\t\t\t\t\t\t\u003citem\u003eCodeine - Itching and nausea\u003c/item\u003e\r\n\t\t\t\t\t\t\u003c/list\u003e\r\n\t\t\t\t\t\u003c/text\u003e\t\t\t\t\t\r\n\t\t\t\t\u003c/section\u003e\r\n\t\t\t\u003c/component\u003e\r\n\r\n\t\t\t\u003c!-- \r\n********************************************************\r\n  Medications section\r\n********************************************************\r\n--\u003e\r\n\t\t\t\u003ccomponent\u003e\r\n\t\t\t\t\u003csection\u003e\r\n\t\t\t\t\t\u003ccode code=\"10160-0\" codeSystem=\"2.16.840.1.113883.6.1\" codeSystemName=\"LOINC\"/\u003e\r\n\t\t\t\t\t\u003ctitle\u003eMedications\u003c/title\u003e\r\n\t\t\t\t\t\u003ctext\u003e\r\n\t\t\t\t\t\t\u003clist\u003e\r\n\t\t\t\t\t\t\t\u003c!-- TODO: Add each medication as a list item here--\u003e\r\n\t\t\t\t\t\t\u003citem\u003eTheodur 200mg BID\u003c/item\u003e\r\n\t\t\t\t\t\t\u003citem\u003eProventil inhaler 2puffs QID PRN\u003c/item\u003e\r\n\t\t\t\t\t\u003c/list\u003e\r\n\t\t\t\t\u003c/text\u003e\r\n\t\t\t\u003c/section\u003e\r\n\t\t\u003c/component\u003e\r\n\r\n\t\t\u003c!-- \r\n********************************************************\r\n  Family History section\r\n********************************************************\r\n--\u003e\r\n\t\t\u003ccomponent\u003e\r\n\t\t\t\u003csection\u003e\r\n\t\t\t\t\u003ccode code=\"10157-2\" codeSystem=\"2.16.840.1.113883.6.1\" codeSystemName=\"LOINC\"/\u003e\r\n\t\t\t\t\u003ctitle\u003eFamily history\u003c/title\u003e\r\n\t\t\t\t\u003ctext\u003e\r\n\t\t\t\t\t\u003clist\u003e\r\n\t\t\t\t\t\t\u003c!-- TODO: Add each family history row as a list item here--\u003e\r\n\t\t\t\t\t\t\t\u003citem\u003eFather - still living - thyroid cancer.\u003c/item\u003e\r\n\t\t\t\t\t\t\t\u003citem\u003eMother - died at 67 - car accident.\u003c/item\u003e\r\n\t\t\t\t\t\t\u003c/list\u003e\r\n\t\t\t\t\t\u003c/text\u003e\t\t\t\t\t\r\n\t\t\t\t\u003c/section\u003e\r\n\t\t\t\u003c/component\u003e\r\n\t\t\t\u003c!-- \r\n********************************************************\r\n  Problem and Surgical History section\r\n********************************************************\r\n--\u003e\r\n\t\t\t\u003ccomponent\u003e\r\n\t\t\t\t\u003csection\u003e\r\n\t\t\t\t\t\u003ccode code=\"10153-2\" codeSystem=\"2.16.840.1.113883.6.1\" codeSystemName=\"LOINC\"/\u003e\r\n\t\t\t\t\t\u003ctitle\u003e Problem and Surgical History\u003c/title\u003e\r\n\t\t\t\t\t\u003ctext\u003e\r\n\t\t\t\t\t\t\u003clist\u003e\r\n\t\t\t\t\t\t\t\u003c!-- TODO: add items from problem and surgery history here--\u003e\r\n\t\t\t\t\t\t\u003citem\u003eAsthma\u003c/item\u003e\r\n\t\t\t\t\t\t\u003citem\u003eHigh blood pressure : father\u003c/item\u003e\r\n\t\t\t\t\t\t\u003citem\u003eHeart attack\u003c/item\u003e\r\n\t\t\t\t\t\u003c/list\u003e\r\n\t\t\t\t\u003c/text\u003e\r\n\t\t\t\u003c/section\u003e\r\n\t\t\u003c/component\u003e\r\n\t\t\u003c!-- \r\n********************************************************\r\n  Hospitalization History section\r\n********************************************************\r\n--\u003e\r\n\t\t\u003ccomponent\u003e\r\n\t\t\t\u003csection\u003e\r\n\t\t\t\t\u003ccode code=\"11336-5\" codeSystem=\"2.16.840.1.113883.6.1\" codeSystemName=\"LOINC\"/\u003e\r\n\t\t\t\t\u003ctitle\u003eHospitalization History\u003c/title\u003e\r\n\t\t\t\t\u003ctext\u003e\r\n\t\t\t\t\t\u003clist\u003e\r\n\t\t\t\t\t\t\u003c!-- TODO: Add each hospitalization history row as a list item here--\u003e\r\n\t\t\t\t\t\t\t\u003citem\u003eSt. Paul - Chest Pain - 2004\u003c/item\u003e\r\n\t\t\t\t\t\t\t\u003citem\u003eSt. Paul - Broken Arm - 1999\u003c/item\u003e\t\t\t\t\t\t\t\r\n\t\t\t\t\t\t\u003c/list\u003e\r\n\t\t\t\t\t\u003c/text\u003e\r\n\t\t\t\t\u003c/section\u003e\r\n\t\t\t\u003c/component\u003e\r\n\t\t\t\u003c!-- \r\n********************************************************\r\n  Social History section\r\n********************************************************\r\n--\u003e\r\n\t\t\t\u003ccomponent\u003e\r\n\t\t\t\t\u003csection\u003e\r\n\t\t\t\t\t\u003ccode code=\"29762-2\" codeSystem=\"2.16.840.1.113883.6.1\" codeSystemName=\"LOINC\"/\u003e\r\n\t\t\t\t\t\u003ctitle\u003eSocial History\u003c/title\u003e\r\n\t\t\t\t\t\u003ctext\u003e\r\n\t\t\t\t\t\t\u003clist\u003e\r\n\t\t\t\t\t\t\t\u003c!-- TODO: add social history items here--\u003e\r\n\t\t\t\t\t\t\t\u003citem\u003eSmoking :: 1 PPD, 5 years.  Quit 2 years ago.\u003c/item\u003e\r\n\t\t\t\t\t\t\t\u003citem\u003eAlcohol :: No\u003c/item\u003e\r\n\t\t\t\t\t\t\u003c/list\u003e\r\n\t\t\t\t\t\u003c/text\u003e\t\t\t\t\t\r\n\t\t\t\t\u003c/section\u003e\r\n\t\t\t\u003c/component\u003e\r\n\t\u003c/structuredBody\u003e\r\n\t\u003c/component\u003e\r\n\u003c/ClinicalDocument\u003e\r\n"
    }
  ]
}

Direct links to anoter examples of payload:

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

Known Issues:

None