SageBridge API - GetPatientChartCategory function

GetPatientChartCategory

Used to retrieve some categories from a patient's chart for a patient previously authorized by GetPatientToken call.

Call example:


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

security token in this call must be a patient authorization token obtained previously by calling GetPatientToken function for a particular patient.

Request parameters:

dateFrom	(string)	Chart date from.
dateTo	(string)	Chart date to.
categories	(string)	Comma separated list of categories to be retrieved from a chart(s). See Chart Categories values below.
includeXml	(string)	Boolean flag to include CCD document.

Notes:

If both dateFrom and dateTo are not specified then this function will return all known data.
If categories parameter is empty, then this function will return all categories.

Json request example:

{
  "dateFrom": "1/1/2017",
  "dateTo": "7/1/2017",
  "categories":"1,2,4,5,6",
  "includeXml":"false"  
}

Response:

XML or JSON string representing APIResponse structure.

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

Payload JSON Response Examples:

{
  
  "patientInfo": {
    "patientId": "e2015CEHRTalice",
    "names": {
      "Prefix": null,
      "Given": "Alice",
      "Middle": "Jones",
      "Family": "Newman",
      "Suffix": null
    },
    "sex": {
      "code": "F",
      "displayName": "Female",
      "codeSystem": "2.16.840.1.113883.5.1"
    },
    "birthDate": "1970-05-01",
    "race": {
      "code": "2106-3",
      "displayName": "Caucasian White",
      "codeSystem": "2.16.840.1.113883.6.238"
    },
    "raceSecond": {
      "code": "2108-9",
      "displayName": "European",
      "codeSystem": "2.16.840.1.113883.6.238"
    },
    "ethnicity": {
      "code": "2186-5",
      "displayName": "Not Hispanic / Not Latino",
      "codeSystem": "2.16.840.1.113883.6.238"
    },
    "preferredLanguage": "en"
  },
  "problems": [
    {
      "EncounterId": "29710281-087E-44AB-8797-FA4193157AAA",
      "DiagnosisCode": "59621000",
      "Description": "Essential hypertension",
      "Eye": null,
      "EncounterDiagnosis": false,
      "TimeframeDescription": null,
      "StartTs": "\/Date(1444017600000)\/",
      "EndTs": null
    },
    {
      "EncounterId": "29710281-087E-44AB-8797-FA4193157AAA",
      "DiagnosisCode": "386661006",
      "Description": "Febrile",
      "Eye": null,
      "EncounterDiagnosis": true,
      "TimeframeDescription": null,
      "StartTs": "\/Date(1434945600000)\/",
      "EndTs": null
    },
    {
      "EncounterId": "29710281-087E-44AB-8797-FA4193157AAA",
      "DiagnosisCode": "236578006",
      "Description": "Chronic allograft nephropathy",
      "Eye": null,
      "EncounterDiagnosis": false,
      "TimeframeDescription": null,
      "StartTs": "\/Date(1325307600000)\/",
      "EndTs": null
    },
    {
      "EncounterId": "29710281-087E-44AB-8797-FA4193157AAA",
      "DiagnosisCode": "238131007",
      "Description": "Overweight",
      "Eye": null,
      "EncounterDiagnosis": false,
      "TimeframeDescription": "2007?",
      "StartTs": "\/Date(1167541200000)\/",
      "EndTs": "\/Date(1180670400000)\/"
    },
    {
      "EncounterId": "29710281-087E-44AB-8797-FA4193157AAA",
      "DiagnosisCode": "83986005",
      "Description": "Severe hypothyroidism",
      "Eye": null,
      "EncounterDiagnosis": false,
      "TimeframeDescription": null,
      "StartTs": "\/Date(1167541200000)\/",
      "EndTs": null
    }
  ],
  "labTests": [
    {
      "Id": "B5837E93-896B-4590-BF11-6FF0AB59B212",
      "EncounterId": "29710281-087E-44AB-8797-FA4193157AAA",
      "TestTs": "\/Date(1434945600000)\/",
      "LocationName": "Value Labs",
      "ContactFirstName": null,
      "ContactLastName": null,
      "ContactMiddleInitial": null,
      "Phone": "555-666-1002",
      "StreetAddress": "2474 Rocky place",
      "StreetAddressLine2": null,
      "City": "Beaverton",
      "State": "OR",
      "Zip": "97006",
      "Country": "USA",
      "Code": "24357-6",
      "ShortName": "UA Dipstick Pnl Ur",
      "LongCommonName": "Urinalysis macro (dipstick) panel - Urine",
      "System": "Urine"
    }
  ],
  "labResults": [
    {
      "Id": "A3A6936D-CC86-49CC-8F9A-B0B793AFCEDC",
      "Value": "YELLOW",
      "UnitOfMeasure": null,
      "ReferenceRange": "YELLOW",
      "ResultDateTs": "\/Date(1434945600000)\/",
      "Code": "5778-6",
      "ShortName": "Color Ur",
      "LongCommonName": "Color of Urine",
      "System": "Urine",
      "DisplayValue": "YELLOW"
    },
    {
      "Id": "C379AB43-A260-4D19-8959-8E5F6081649C",
      "Value": "CLEAR",
      "UnitOfMeasure": null,
      "ReferenceRange": "CLEAR",
      "ResultDateTs": "\/Date(1434945600000)\/",
      "Code": "5767-9",
      "ShortName": "Appearance Ur",
      "LongCommonName": "Appearance of Urine",
      "System": "Urine",
      "DisplayValue": "CLEAR"
    },
    {
      "Id": "5093C0C0-D933-4B1A-9741-9D71BD083017",
      "Value": "1.015",
      "UnitOfMeasure": null,
      "ReferenceRange": "1.005-1.030",
      "ResultDateTs": "\/Date(1434945600000)\/",
      "Code": "5811-5",
      "ShortName": "Sp Gr Ur Strip",
      "LongCommonName": "Specific gravity of Urine by Test strip",
      "System": "Urine",
      "DisplayValue": "1.015"
    },
    {
      "Id": "89907C37-17C1-4EA0-97BE-B95DF98E52B4",
      "Value": "5.0",
      "UnitOfMeasure": "[pH]",
      "ReferenceRange": "5.0-8.0",
      "ResultDateTs": "\/Date(1434945600000)\/",
      "Code": "5803-2",
      "ShortName": "pH Ur Strip",
      "LongCommonName": "pH of Urine by Test strip",
      "System": "Urine",
      "DisplayValue": "5.0 [pH]"
    },
    {
      "Id": "4B52E082-5439-4EC2-A4E3-1849DA526AE8",
      "Value": "50",
      "UnitOfMeasure": "mg/dl",
      "ReferenceRange": "Negative",
      "ResultDateTs": "\/Date(1434945600000)\/",
      "Code": "5792-7",
      "ShortName": "Glucose Ur Strip-mCnc",
      "LongCommonName": "Glucose [Mass/volume] in Urine by Test strip",
      "System": "Urine",
      "DisplayValue": "50 mg/dl"
    },
    {
      "Id": "A3F4F040-13B7-4E97-9544-FCE385D8E5CD",
      "Value": "Negative",
      "UnitOfMeasure": null,
      "ReferenceRange": "Negative",
      "ResultDateTs": "\/Date(1434945600000)\/",
      "Code": "5797-6",
      "ShortName": "Ketones Ur Strip-mCnc",
      "LongCommonName": "Ketones [Mass/volume] in Urine by Test strip",
      "System": "Urine",
      "DisplayValue": "Negative"
    },
    {
      "Id": "AB8B1E72-B342-4B37-A737-F13FE18C3AA1",
      "Value": "100",
      "UnitOfMeasure": "mg/dl",
      "ReferenceRange": "Negative",
      "ResultDateTs": "\/Date(1434945600000)\/",
      "Code": "5804-0",
      "ShortName": "Prot Ur Strip-mCnc",
      "LongCommonName": "Protein [Mass/volume] in Urine by Test strip",
      "System": "Urine",
      "DisplayValue": "100 mg/dl"
    }
  ],
  "vitalSigns": [
    {
      "Id": "146E538D-2ACC-4CB3-9A22-4D08FDEFEC42",
      "EncounterId": "29710281-087E-44AB-8797-FA4193157AAA",
      "Code": "9279-1",
      "Name": "Respiratory Rate",
      "Value": "18",
      "UnitOfMeasure": "/min",
      "DisplayValue": "18 /min"
    },
    {
      "Id": "92819421-6485-4ACB-90BD-AF5A6F7EF1F7",
      "EncounterId": "29710281-087E-44AB-8797-FA4193157AAA",
      "Code": "8310-5",
      "Name": "Body Temperature",
      "Value": "38",
      "UnitOfMeasure": "Cel",
      "DisplayValue": "38 Cel"
    },
    {
      "Id": "BF486CA6-8B0C-44B1-A3C8-7D5EFDB66082",
      "EncounterId": "29710281-087E-44AB-8797-FA4193157AAA",
      "Code": "3150-0",
      "Name": "Inhaled Oxygen Concentration",
      "Value": "36",
      "UnitOfMeasure": "%",
      "DisplayValue": "36 %"
    },
    {
      "Id": "DE7BEEEC-8A86-4C83-AD90-DCDCB4D8FFD2",
      "EncounterId": "29710281-087E-44AB-8797-FA4193157AAA",
      "Code": "59408-5",
      "Name": "O2% BldC Oximetry",
      "Value": "95",
      "UnitOfMeasure": "%",
      "DisplayValue": "95 %"
    },
    {
      "Id": "EBC190AB-4A63-4CDD-984D-05CEA2DC93C6",
      "EncounterId": "29710281-087E-44AB-8797-FA4193157AAA",
      "Code": "8867-4",
      "Name": "Heart Rate",
      "Value": "80",
      "UnitOfMeasure": "/min",
      "DisplayValue": "80 /min"
    },
    {
      "Id": "0CDC5B75-ED10-49E1-88F7-C963E6AE97FA",
      "EncounterId": "29710281-087E-44AB-8797-FA4193157AAA",
      "Code": "8480-6",
      "Name": "Blood Presure Systolic",
      "Value": "145",
      "UnitOfMeasure": "mm[Hg]",
      "DisplayValue": "145 mm[Hg]"
    },
    {
      "Id": "AC7A536D-764D-4EEE-B11C-BAEC2546A88C",
      "EncounterId": "29710281-087E-44AB-8797-FA4193157AAA",
      "Code": "8462-4",
      "Name": "Blood Pressure Diastolic",
      "Value": "88",
      "UnitOfMeasure": "mm[Hg]",
      "DisplayValue": "88 mm[Hg]"
    },
    {
      "Id": "B619CECA-53FD-4417-BE19-B6CE7386A003",
      "EncounterId": "29710281-087E-44AB-8797-FA4193157AAA",
      "Code": "29463-7",
      "Name": "Weight",
      "Value": "88",
      "UnitOfMeasure": "kg",
      "DisplayValue": "88 kg"
    },
    {
      "Id": "3E6B7AA3-D6E6-4AAD-8C25-EF14FBE4F459",
      "EncounterId": "29710281-087E-44AB-8797-FA4193157AAA",
      "Code": "8302-2",
      "Name": "Height",
      "Value": "177",
      "UnitOfMeasure": "cm",
      "DisplayValue": "177 cm"
    }
  ],
  "assessment": null,
  "goals": [
    {
      "Uid": "001EBB62-87DF-4192-81B0-D35B82280DCB",
      "EncounterId": "29710281-087E-44AB-8797-FA4193157AAA",
      "Value": null,
      "Description": "Get rid of intermittent fever that is occurring every few weeks. ",
      "StartTs": "\/Date(1434945600000)\/",
      "EndTs": null
    },
    {
      "Uid": "B8447932-BE09-481B-A82F-4466574DB7FE",
      "EncounterId": "29710281-087E-44AB-8797-FA4193157AAA",
      "Value": null,
      "Description": "Need to gain more energy to do regular activities",
      "StartTs": "\/Date(1434945600000)\/",
      "EndTs": null
    }
  ],
  "carePlans": null,
  "smokingHistory": [
    {
      "Id": "336820171012122310",
      "StartTs": "\/Date(1483246800000)\/",
      "EndTs": "\/Date(-62135578800000)\/",
      "ValueCodeSystem": "2.16.840.1.113883.6.96",
      "StatusCode": "449868002",
      "StatusName": "Current every day smoker",
      "StatusDescription": "Smokes tobacco daily (finding)",
      "CodeCode": "72166-2",
      "CodeSystem": "2.16.840.1.113883.6.1",
      "CodeSystemName": null,
      "DisplayName": "Tobacco smoking status NHIS"
    }
  ],
  "socialHistory": [
    {
      "Id": "",
      "StartTs": "\/Date(10382400000)\/",
      "EndTs": "\/Date(-62135578800000)\/",
      "ValueCodeSystem": "2.16.840.1.113883.5.1",
      "StatusCode": "F",
      "StatusName": "F",
      "StatusDescription": "Birth Sex",
      "CodeCode": "76689-9",
      "CodeSystem": "2.16.840.1.113883.6.1",
      "CodeSystemName": null,
      "DisplayName": "Sex Assigned At Birth"
    }
  ],
  "procedures": [
    {
      "Id": "A6E3C4F4-E0C4-46F6-9382-CC3AF0AEC74E",
      "EncounterId": "29710281-087E-44AB-8797-FA4193157AAA",
      "Eye": null,
      "TimeframeTs": "\/Date(1317787200000)\/",
      "TimeframeDescription": "Fall 2011",
      "Status": "Completed",
      "LocationId": "AC49B0F6-C645-4441-B30D-7A19CF50F762",
      "ExternalLocationId": null,
      "LocationName": "Community Health Hospitals",
      "ContactFirstName": null,
      "ContactLastName": null,
      "ContactMiddleInitial": null,
      "Phone": "555-555-1003",
      "StreetAddress": "3525 Newberry Ave",
      "StreetAddressLine2": null,
      "City": "Beaverton",
      "State": "OR",
      "Zip": "97006",
      "Country": "USA",
      "Code": "175135009",
      "ListName": "Introduction of cardiac pacemaker system via vein (procedure)",
      "LongDescription": "Introduction of cardiac pacemaker system via vein (procedure)",
      "RegistrationDisplay": "False",
      "TargetSiteCode": "9454009",
      "TargetSiteName": "Structure of subclavian vein"
    },
    {
      "Id": "D0E449FC-1247-486E-8B3C-A4A6172F1263",
      "EncounterId": "29710281-087E-44AB-8797-FA4193157AAA",
      "Eye": null,
      "TimeframeTs": "\/Date(1434945600000)\/",
      "TimeframeDescription": null,
      "Status": "Completed",
      "LocationId": "0613B537-A62B-44E5-B1D9-DF9AB8BC5961",
      "ExternalLocationId": null,
      "LocationName": "Neighborhood Physicians Practice",
      "ContactFirstName": "Tracy",
      "ContactLastName": "Davis",
      "ContactMiddleInitial": "",
      "Phone": "555-555-1002",
      "StreetAddress": "2472 Rocky place",
      "StreetAddressLine2": null,
      "City": "Beaverton",
      "State": "OR",
      "Zip": "97006",
      "Country": "USA",
      "Code": "56251003",
      "ListName": "Nebulizer therapy (procedure)",
      "LongDescription": "Nebulizer therapy (procedure)",
      "RegistrationDisplay": "False",
      "TargetSiteCode": "82094008",
      "TargetSiteName": "Larynx, trachea, bronchi and lungs, CS"
    }
  ],
  "providers": [
    {
      "ProviderId": "87AAFF56-C9D2-42BB-9387-870DFBE925DE",
      "FirstName": "Albert",
      "LastName": "Davis",
      "MiddleInitial": "",
      "Credentials": "MD",
      "Specialty": "Ophthalmology",
      "TypeId": 1,
      "TypeName": "Referring Provider"
    },
    {
      "ProviderId": "87AAFF56-C9D2-42BB-9387-870DFBE925DE",
      "FirstName": "Albert",
      "LastName": "Davis",
      "MiddleInitial": "",
      "Credentials": "MD",
      "Specialty": "Ophthalmology",
      "TypeId": 3,
      "TypeName": "Author / Legal Authenticator"
    },
    {
      "ProviderId": "87AAFF56-C9D2-42BB-9387-870DFBE925DE",
      "FirstName": "Albert",
      "LastName": "Davis",
      "MiddleInitial": "",
      "Credentials": "MD",
      "Specialty": "Ophthalmology",
      "TypeId": 4,
      "TypeName": "Information Recipient"
    },
    {
      "ProviderId": "87AAFF56-C9D2-42BB-9387-870DFBE925DE",
      "FirstName": "Albert",
      "LastName": "Davis",
      "MiddleInitial": "",
      "Credentials": "MD",
      "Specialty": "Ophthalmology",
      "TypeId": 2,
      "TypeName": "Care Team Provider"
    },
    {
      "ProviderId": "0F5403BE-6068-491D-BCCB-6E7B25B2206D",
      "FirstName": "Tracy",
      "LastName": "Davis",
      "MiddleInitial": "",
      "Credentials": "",
      "Specialty": null,
      "TypeId": 2,
      "TypeName": "Care Team Provider"
    }
  ],
  "conserns": [
    {
      "Observation": "Chronic Sickness exhibited by patient",
      "Description": "Documented HyperTension problem",
      "StartTs": "\/Date(1434945600000)\/",
      "EndTs": null
    },
    {
      "Observation": "Chronic Sickness exhibited by patient",
      "Description": "Documented HypoThyroidism problem",
      "StartTs": "\/Date(1434945600000)\/",
      "EndTs": null
    },
    {
      "Observation": "Chronic Sickness exhibited by patient",
      "Description": "Watch Weight of patient",
      "StartTs": "\/Date(1434945600000)\/",
      "EndTs": null
    }
  ],
  "allergies": [
    {
      "Code": "733",
      "Name": "Ampicillin",
      "DiagnosisCode": "419511003",
      "Diagnosis": "Drug sensitivity",
      "Reaction": "Weal",
      "ReactionCode": "247472004",
      "Severity": "Moderate",
      "StarTime": "\/Date(326779200000)\/",
      "FirstRecorded": "\/Date(1507825390573)\/",
      "EncounterId": "29710281-087E-44AB-8797-FA4193157AAA"
    },
    {
      "Code": "7980",
      "Name": "Penicillin G",
      "DiagnosisCode": "419511003",
      "Diagnosis": "Drug sensitivity",
      "Reaction": "Weal",
      "ReactionCode": "247472004",
      "Severity": "Moderate",
      "StarTime": "\/Date(326779200000)\/",
      "FirstRecorded": "\/Date(1507825390573)\/",
      "EncounterId": "29710281-087E-44AB-8797-FA4193157AAA"
    }
  ],
  "immunizations": [
    {
      "Code": "106",
      "ImmunizationName": "DTaP, 5 pertussis antigens",
      "ImmunizationNote": "",
      "CodeSystemName": "CVX - CDC",
      "Description": "Tetanus",
      "AdministeredTs": "\/Date(1325653200000)\/",
      "AdministeredTimeframe": "1/4/2012",
      "Status": "Completed",
      "LotNumber": "2",
      "ManufacturerName": "Immuno, Inc.",
      "Notes": "n/a"
    },
    {
      "Code": "166",
      "ImmunizationName": "influenza, intradermal, quadrivalent, preservative free",
      "ImmunizationNote": "",
      "CodeSystemName": "CVX - CDC",
      "Description": "Flu",
      "AdministeredTs": "\/Date(1434945600000)\/",
      "AdministeredTimeframe": "6/22/2015",
      "Status": "Cancelled",
      "LotNumber": "",
      "ManufacturerName": "Immuno, Inc.",
      "Notes": "Not given"
    }
  ],
  "devices": [
    {
      "DeviceName": "Pacemaker",
      "UniqueDeviceId": "(01)00643169007222(17)160128(21)BLC200461H",
      "AssigningAuthority": "FDA",
      "ScopingEntity": "FDA",
      "Eye": null,
      "DeviceCodeId": 75445,
      "StartTs": "\/Date(-62135578800000)\/",
      "EndTs": "\/Date(-62135578800000)\/",
      "Area": "Subclavian Vein",
      "TargetSiteCode": "9454009",
      "TargetSiteName": "Structure of subclavian vein",
      "Code": "706004007",
      "ListName": "Implantable cardiac pacemaker",
      "LongDescription": "Implantable cardiac pacemaker (physical object)"
    }
  ],
  "medications": [
    {
      "Id": "6A9A308B-E526-4A17-AFB6-0837D7A8A181",
      "SourceEncounterId": null,
      "Code": "309090",
      "Name": "ceftriaxone (as ceftriaxone sodium) 10 GM per 100 ML Injectable Solution",
      "Eye": null,
      "Dosage": "1 unit",
      "Frequency": "two times daily",
      "Route": "INTRAVENOUS",
      "RouteCode": "C38276",
      "TimeframeStarted": null,
      "StartTs": "\/Date(1434945600000)\/",
      "EndTs": "\/Date(1435636800000)\/",
      "DosageNumeric": 1
    },
    {
      "Id": "929687E0-0A1F-4E70-8956-29FD5B900616",
      "SourceEncounterId": null,
      "Code": "731241",
      "Name": "Aranesp 0.5 MG per 1 ML Prefilled Syringe",
      "Eye": null,
      "Dosage": "1 unit",
      "Frequency": "once a week",
      "Route": "INTRAMUSCULAR",
      "RouteCode": "C28161",
      "TimeframeStarted": null,
      "StartTs": "\/Date(1434945600000)\/",
      "EndTs": null,
      "DosageNumeric": 1
    },
    {
      "Id": "7C2D7AA9-BCF3-4592-9E54-8EE436A5D241",
      "SourceEncounterId": null,
      "Code": "209459",
      "Name": "Tylenol 500 MG Oral Tablet",
      "Eye": null,
      "Dosage": "1 unit",
      "Frequency": "as needed",
      "Route": "ORAL",
      "RouteCode": "C38288",
      "TimeframeStarted": "For 10 days",
      "StartTs": "\/Date(1434945600000)\/",
      "EndTs": null,
      "DosageNumeric": 1
    }
  ],
  "chartXml": "--- XML string representing CCD document ---"
}

Payload XML Response Examples:

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