Introduction


This guide is for third party developers to enable patients to access their data from InPracSys.

It contains details about how a third party application can connect to InPracSys and give access to patients for requesting their data from InPracSys.

  • How to register third party application with InPracSys API.
  • How to request for patient data.
    • Request format
    • Request parameters
  • How the API will respond to data request
    • Response format
    • Response Sections
    • List of errors

The response for requested data will be in JSON format.(JSON) JavaScript Object Notation defines a set of "Resources" that represent granular clinical concepts.

The resources can be managed in isolation, or aggregated into complex documents. Technically, JSON is designed for the web; the resources are based on JSON structures, with an HTTP-based RESTful protocol where each resource has predictable URL. Wherever possible, open internet standards are used for data representation. JSON aims to simplify implementation without sacrificing information integrity. It leverages existing logical and theoretical models to provide a consistent, easy to implement, and rigorous mechanism for exchanging data between healthcare applications.

The details for CCDS section and their corresponding Data Category are as shown below

CCDS Data Element Data Category
Patient name patient
Sex patient
Date of birth patient
Race patient
Ethnicity patient
Preferred language patient
Encounters encounters
Smoking status smokingstatus
Problems problems
Medications medication
Medication allergies allergy
Laboratory test(s) laboratoryresults
Laboratory value(s)/result(s) laboratoryresults
Vital signs vitalsigns
Procedures procedure
Care team member(s) careteam
Immunizations immunization
Unique device identifier(s) for a patient's implantable device(s) device
Assessment assessment
Treatment Plan treatmentplan
Goals goal
Care plan careplan
Health concerns healthconcern

Registration


Register client with InPracSys API

Third party applications have to register at InPracSys API

The following details are required for registration :

  • Application Name
  • Company Name
  • Application URL
  • E-mail id
  • PracticeName

On successful authentication and registration with InPracSys API, an e-mail is sent to the registered e-mail address along with username, password and grant_type. This username, password and grant_type will be required to request patient data from InPracSys API

Authorization – OAUTH 2.0


Authorize

Authorizes client with passed username, password and grant_type and it will returns JSON data

JSON data contains a token, this process of granting access is known as client credentials grant type

Client Credentials

The Client Credentials grant type is used when the client is requesting access to protected resources under its control (i.e. there is no third party)

For e.g.

private Dictionary GetAccessToken()
                {
                Dictionary tokenDetails = null;
    
                using (HttpClient httpClient = new HttpClient())
                {
                    HttpContent content = new FormUrlEncodedContent(new[]
                    {
                        new KeyValuePair"username", username received in registration email),
    new KeyValuePair("password", password received in registration email),
        new KeyValuePair("grant_type","password")
            });


            httpClient.DefaultRequestHeaders.Add("Accept", "application/json");
            httpClient.DefaultRequestHeaders.Add("Accept-Language", "en-gb");
            httpClient.DefaultRequestHeaders.Add("Audience", "Any");

            
            resp.Wait(TimeSpan.FromSeconds(10));

            if (resp.IsCompleted)
            {
            if (resp.Result.Content.ReadAsStringAsync().Result.Contains("access_token"))
            {
            tokenDetails = JsonConvert.DeserializeObject>(resp.Result.Content.ReadAsStringAsync().Result);
                                    }
                            }
                        }
                            return tokenDetails;
                    }

The GetAccessToken returns a Dictionary from which we will get token for key "access_token"

URL

https://ipsemrapi.inpracsys.com/GetAccessToken

Method:

POST

Header Parameter

Accept: application/json
Accept-Language: en-gb
Audience: Any

Body Parameter

“username” = username received in registration email

“password” = password received in registration email

“grant_type” = password

Request format


URL

https://ipsemrapi.inpracsys.com/api/G8/GetPatientData

Request Method: Post

Headers:

Accept: application/json
Accept-Language: en-gb
Content-Type: application/json
Authorization: "Bearer {accessToken}"

Authorization: This is the token generated from OAuth server

Request format:

Except for End Date, data for all other fields are mandatory

{

  "PracticeName": "InPracSys" (as it appears in CMS/NPPES database),

  "Datacategory": "all",

  "PatientMRN": "xaanDL234800" (as it appears on documents from the clinic),

  "PatientFirstName": "ALICE",

  "PatientLastName": "NEWMAN",

  "PatientDateOfBirth": "05/01/1970"

  "PatientSex": "Female"

  "StartDate": "09/01/2018",

  "EndDate": "09/01/2019",

}

Request parameters


PracticeName: This represents the InPracSys practice where the patient visited for medical treatment.

Data Category List:The following Data Categories can be requested from InPracSys, provided that at-least any one of available clinical sections are included. JSON API will throw an error if the request contains a section not mentioned below, or if none are chosen

Value set for DataCategory
all
patient
careteam
allergy
medication
problems
encounters
immunization
vitalsigns
smokingstatus
procedure
laboratoryresults
device
assessment
treatmentplan
careplan
goal
healthconcern

StartDate: This represents start date filter for patient’s health data. This field is mandatory in JSON request.

EndDate: This represents end date filter for patient’s health data. This field is not mandatory in JSON request. If only start date is specified then patient health data for that particular day would be returned by JSON server.

PatientMRN: This represents patient’s medical record number.

PatientFirstName: This represents patient’s first name.

PatientLastName: This represents patient’s last name.

PatientDateOfBirth: This represents patient’s date of birth.

PatientSex: This represents patient’s gender.

Value set for Sex information to be sent to JSON server
Male
Female

Please note that in the InPracSys application API, Patient block will always contain some elements even though some of them may not be required by CCDS.

Response format


The JSON response is sent in a bundle as shown below.

                   {
  "table": [
    {
      "first_name": "ALICE",
      "last_name": "NEWMAN",
      "mid_name": "JONES",
      "ssn": "111201111",
      "dob": "19700501",
      "sex": "Female",
      "marital_status": "UNK",
      "maritalStatus_Code": "UNK",
      "race": "White",
      "suffix": "",
      "raceMnemonic": "2106-3",
      "ehnicityName": "Not Hispanic or Latino",
      "ethnicGroupCode": "2186-5",
      "language": "English",
      "languageCode": "en-US",
      "address1": "1357, AMBER DR",
      "address2": "",
      "city": "BEAVERTON",
      "state": "or",
      "zip": "97006",
      "ssn1": "",
      "mrn": "xaanDL234800",
      "home_Phone": "(555)-723-1544",
      "cell_Phone": "(555)-777-1234",
      "work_Phone": "UNK",
      "work_phone_ext": "",
      "spouse": "Matthew Newman",
      "spouse_phone": "",
      "parent": "",
      "parent_phone": "",
      "emergency_contact": "Mr Rick Holler",
      "emergency_contact_phone": "",
      "emergency_contact_address": "",
      "prev_LastName": "",
      "prev_FirstName": "ALICIA",
      "visitdate": "20150622",
      "oPhone": "",
      "roles": "",
      "pRole": "",
      "granular": "White European",
      "race2": "2108-9"
    }
  ],
  "table1": [
    {
      "eventID": 828414.0,
      "encounterSnomedCT": "699134002",
      "encounter": "Caregiver annual health check",
      "staff_title": "Dr",
      "performer": "Albert Davis",
      "performer_FirstName": "Albert",
      "performer_LastName": "Davis",
      "providerSex": "Male",
      "providerPhone": "(555)555-1002",
      "visitDate_From": "20150622100000",
      "visitDate_To": "20150622110000",
      "location": "Chicago Ridge",
      "providerSBU": "Get Well Clinic",
      "providerAddress": "2472 Rocky place",
      "providerCity": "Beaverton",
      "providerState": "or",
      "providerZip": "97006",
      "providerPhone1": "(555)555-1002",
      "ref_by": "Dr Albert Davis",
      "ref_address": "2472, Rocky place,",
      "ref_city": "Beaverton,",
      "ref_state": "or",
      "ref_zip": "97006",
      "ref_phone": "",
      "primary_doctor": "",
      "primary_address": "",
      "primary_city": "",
      "primary_state": "",
      "primary_zip": "",
      "primary_phone": "",
      "additional_doctor": "",
      "additional_address": "",
      "additional_city": "",
      "additional_state": "",
      "additional_zip": "",
      "additional_phone": "",
      "staff": "Tracy Davis",
      "staffAddress": "2472 Rocky place",
      "staffCity": "Beaverton",
      "staffState": "OR",
      "staffZip": "97006",
      "staffPhone": "(555)555-1002",
      "staff_FirstName": "Tracy",
      "staff_LastName": "Davis"
    }
  ],
  "table2": [
    {
      "substance": "Penicillin G",
      "allergy_type": "Med",
      "reaction": "Hives",
      "reactionSnomedCT": "247472004",
      "severity": "Moderate",
      "severitySnomedCT": "6736007",
      "status": "Active",
      "statusSnomedCT": "55561003",
      "rxNormID": "7980",
      "createdDate": "20150622"
    },
    {
      "substance": "Ampicillin",
      "allergy_type": "Med",
      "reaction": "Hives",
      "reactionSnomedCT": "247472004",
      "severity": "Moderate",
      "severitySnomedCT": "6736007",
      "status": "Active",
      "statusSnomedCT": "55561003",
      "rxNormID": "733",
      "createdDate": "20150622"
    }
  ],
  "table3": [
    {
      "notKnown": 0,
      "createdDate": "",
      "cuurentdate": "20191017"
    }
  ],
  "table4": [
    {
      "medicaldesc": "Tylenol (oral - tablet)",
      "dosage": "500mg",
      "instructions": "As needed",
      "quantity": "10",
      "administrationUnitCode": "C42998",
      "doseFormDescription": "TABLET",
      "routeCode": "C38288",
      "routeDescription": "ORAL",
      "pres_date_Start": "20150622",
      "pres_date_End": "",
      "xmlTablepres_date_Start": "Jun 22, 2015",
      "xmlTablepres_date_End": "",
      "rxNormID": "209459",
      "status": "Completed",
      "indications": "UNK",
      "phy_name": "Albert Davis",
      "staff_Title": "Dr",
      "first_name": "Dr",
      "last_name": "Albert",
      "performer": "Dr Albert Davis",
      "location": "Chicago Ridge",
      "providerClinic": "Chicago Ridge",
      "providerAddress": "UNK",
      "providerCity": "UNK",
      "providerState": "UNK",
      "providerZip": "UNK",
      "providerPhone": "UNK",
      "unit": "1"
    },
    {
      "medicaldesc": "cefTRIAXone (intravenous - solution)",
      "dosage": "100 MG/ML",
      "instructions": "Two times daily",
      "quantity": "30",
      "administrationUnitCode": "C42986",
      "doseFormDescription": "SOLUTION",
      "routeCode": "C38276",
      "routeDescription": "INTRAVENOUS",
      "pres_date_Start": "20150622",
      "pres_date_End": "20150630",
      "xmlTablepres_date_Start": "Jun 22, 2015",
      "xmlTablepres_date_End": "Jun 30, 2015",
      "rxNormID": "309090",
      "status": "Completed",
      "indications": "UNK",
      "phy_name": "Albert Davis",
      "staff_Title": "Dr",
      "first_name": "Dr",
      "last_name": "Albert",
      "performer": "Dr Albert Davis",
      "location": "Chicago Ridge",
      "providerClinic": "Chicago Ridge",
      "providerAddress": "UNK",
      "providerCity": "UNK",
      "providerState": "UNK",
      "providerZip": "UNK",
      "providerPhone": "UNK",
      "unit": "1"
    },
    {
      "medicaldesc": "Aranesp SingleJect (injectable - solution)",
      "dosage": "0.5 MG/ML",
      "instructions": "Once a week",
      "quantity": "4",
      "administrationUnitCode": "C42986",
      "doseFormDescription": "SOLUTION",
      "routeCode": "C38288",
      "routeDescription": "UNK",
      "pres_date_Start": "20150622",
      "pres_date_End": "",
      "xmlTablepres_date_Start": "Jun 22, 2015",
      "xmlTablepres_date_End": "",
      "rxNormID": "731241",
      "status": "Completed",
      "indications": "UNK",
      "phy_name": "Albert Davis",
      "staff_Title": "Dr",
      "first_name": "Dr",
      "last_name": "Albert",
      "performer": "Dr Albert Davis",
      "location": "Chicago Ridge",
      "providerClinic": "Chicago Ridge",
      "providerAddress": "UNK",
      "providerCity": "UNK",
      "providerState": "UNK",
      "providerZip": "UNK",
      "providerPhone": "UNK",
      "unit": "1"
    }
  ],
  "table5": [
    {
      "diagnosis_id": 1,
      "diagnosis_name": "Essential hypertension",
      "snomedCT": "59621000",
      "diagnosis_date": "20111005",
      "enddate": "",
      "stable_status": "Active",
      "stable_StatusSnomedCT": "73425007",
      "performer": "Dr Albert Davis",
      "location": "Chicago Ridge",
      "providerClinic": "Chicago Ridge",
      "providerAddress": "UNK",
      "providerCity": "UNK",
      "providerState": "UNK",
      "providerZip": "UNK",
      "providerPhone": "UNK",
      "ageAtDiagnosed": 41,
      "start_date": "10/05/2011",
      "end_date": ""
    },
    {
      "diagnosis_id": 2,
      "diagnosis_name": "Severe hypothyroidism",
      "snomedCT": "83986005",
      "diagnosis_date": "20061231",
      "enddate": "",
      "stable_status": "Active",
      "stable_StatusSnomedCT": "73425007",
      "performer": "Dr Albert Davis",
      "location": "Chicago Ridge",
      "providerClinic": "Chicago Ridge",
      "providerAddress": "UNK",
      "providerCity": "UNK",
      "providerState": "UNK",
      "providerZip": "UNK",
      "providerPhone": "UNK",
      "ageAtDiagnosed": 36,
      "start_date": "12/31/2006",
      "end_date": ""
    },
    {
      "diagnosis_id": 3,
      "diagnosis_name": "Chronic rejection of renal transplant",
      "snomedCT": "236578006",
      "diagnosis_date": "20111231",
      "enddate": "",
      "stable_status": "Active",
      "stable_StatusSnomedCT": "73425007",
      "performer": "Dr Albert Davis",
      "location": "Chicago Ridge",
      "providerClinic": "Chicago Ridge",
      "providerAddress": "UNK",
      "providerCity": "UNK",
      "providerState": "UNK",
      "providerZip": "UNK",
      "providerPhone": "UNK",
      "ageAtDiagnosed": 41,
      "start_date": "12/31/2011",
      "end_date": ""
    },
    {
      "diagnosis_id": 4,
      "diagnosis_name": "Fever",
      "snomedCT": "386661006",
      "diagnosis_date": "20150622",
      "enddate": "",
      "stable_status": "Active",
      "stable_StatusSnomedCT": "73425007",
      "performer": "Dr Albert Davis",
      "location": "Chicago Ridge",
      "providerClinic": "Chicago Ridge",
      "providerAddress": "UNK",
      "providerCity": "UNK",
      "providerState": "UNK",
      "providerZip": "UNK",
      "providerPhone": "UNK",
      "ageAtDiagnosed": 45,
      "start_date": "06/22/2015",
      "end_date": ""
    },
    {
      "diagnosis_id": 5,
      "diagnosis_name": "Overweight",
      "snomedCT": "238131007",
      "diagnosis_date": "20061231",
      "enddate": "20070601",
      "stable_status": "Completed",
      "stable_StatusSnomedCT": "73425007",
      "performer": "Dr Albert Davis",
      "location": "Chicago Ridge",
      "providerClinic": "Chicago Ridge",
      "providerAddress": "UNK",
      "providerCity": "UNK",
      "providerState": "UNK",
      "providerZip": "UNK",
      "providerPhone": "UNK",
      "ageAtDiagnosed": 36,
      "start_date": "12/31/2006",
      "end_date": "06/01/2007"
    }
  ],
  "table6": [
    {
      "diagnosis_id": 0.0,
      "diagnosis_name": "Fever",
      "snomedCT": "386661006",
      "diagnosis_date": "20150622",
      "xmlTable_Diagnosis_date": "Jun 22, 2015",
      "stable_status": 1,
      "performer": "Dr Albert Davis",
      "location": "Chicago Ridge",
      "providerClinic": "Chicago Ridge",
      "providerAddress": "UNK",
      "providerCity": "UNK",
      "providerState": "UNK",
      "providerZip": "UNK",
      "providerPhone": "UNK",
      "providerPhoneCode": "WP",
      "pfPrefix": "Dr",
      "pfFirstname": "Albert",
      "pfLastname": "Davis"
    }
  ],
  "table7": [
    {
      "configId": 27,
      "code": "88",
      "name": "INFLUENZA VIRUS VACCINE",
      "selected": 1,
      "date": "05/10/2014",
      "time": "",
      "amount": "",
      "units": "",
      "lotNumber": "NA",
      "manufacturerName": "Immuno Inc",
      "manufacturerCode": "Immuno Inc",
      "notes": "influenza, intradermal, quadrivalent, preservative free was not given - Patient rejected.",
      "status": "Completed",
      "createddate": "20150622",
      "refusal": "",
      "xmlTable_createddate": "Jun 22, 2015",
      "notes1": "influenza, intradermal, quadrivalent, preservative free was not given - Patient rejected."
    },
    {
      "configId": 36,
      "code": "166",
      "name": "influenza, intradermal, quadrivalent, preservative free",
      "selected": 1,
      "date": "06/22/2015",
      "time": "",
      "amount": "",
      "units": "",
      "lotNumber": "NA",
      "manufacturerName": "Immuno Inc",
      "manufacturerCode": "Immuno Inc",
      "notes": "influenza, intradermal, quadrivalent, preservative free was not given - Patient rejected.",
      "status": "Cancel",
      "createddate": "20150622",
      "refusal": "Immunization was not given - Patient rejected immunization",
      "xmlTable_createddate": "Jun 22, 2015",
      "notes1": "influenza, intradermal, quadrivalent, preservative free was not given - Patient rejected."
    },
    {
      "configId": 37,
      "code": "106",
      "name": "TETANUS AND DIPHTHERIA TOXOIDS",
      "selected": 1,
      "date": "",
      "time": "",
      "amount": "",
      "units": "",
      "lotNumber": "NA",
      "manufacturerName": "Immuno Inc",
      "manufacturerCode": "Immuno Inc",
      "notes": "influenza, intradermal, quadrivalent, preservative free was not given - Patient rejected.",
      "status": "Completed",
      "createddate": "20150622",
      "refusal": "",
      "xmlTable_createddate": "Jun 22, 2015",
      "notes1": "influenza, intradermal, quadrivalent, preservative free was not given - Patient rejected."
    }
  ],
  "table8": [
    {
      "componentName": "Height",
      "componentValue": "177",
      "loinC_Code": "8302-2",
      "displayName": "Height",
      "unit": "CM",
      "created_Date": "20150622",
      "observationDate": "20150622",
      "sort": 1,
      "dates": "06/22/2015"
    },
    {
      "componentName": "Weight",
      "componentValue": "88",
      "loinC_Code": "29463-7",
      "displayName": "Patient Body Weight - Measured",
      "unit": "KG",
      "created_Date": "20150622",
      "observationDate": "20150622",
      "sort": 2,
      "dates": "06/22/2015"
    },
    {
      "componentName": "BP Systolic",
      "componentValue": "145",
      "loinC_Code": "8480-6",
      "displayName": "BP Systolic",
      "unit": "mm[Hg]",
      "created_Date": "20150622",
      "observationDate": "20150622",
      "sort": 3,
      "dates": "06/22/2015"
    },
    {
      "componentName": "BP Diastolic",
      "componentValue": "88",
      "loinC_Code": "8462-4",
      "displayName": "BP Diastolic",
      "unit": "mm[Hg]",
      "created_Date": "20150622",
      "observationDate": "20150622",
      "sort": 4,
      "dates": "06/22/2015"
    },
    {
      "componentName": "Body Temperature",
      "componentValue": "38",
      "loinC_Code": "8310-5",
      "displayName": "Body Temperature",
      "unit": "Cel",
      "created_Date": "20150622",
      "observationDate": "20150622",
      "sort": 5,
      "dates": "06/22/2015"
    },
    {
      "componentName": "Heart Rate",
      "componentValue": "80",
      "loinC_Code": "8867-4",
      "displayName": "Heart Rate",
      "unit": "/min",
      "created_Date": "20150622",
      "observationDate": "20150622",
      "sort": 5,
      "dates": "06/22/2015"
    },
    {
      "componentName": "Inhaled Oxygen",
      "componentValue": "36",
      "loinC_Code": "3150-0",
      "displayName": "Inhaled Oxygen Concentration",
      "unit": "%",
      "created_Date": "20150622",
      "observationDate": "20150622",
      "sort": 5,
      "dates": "06/22/2015"
    },
    {
      "componentName": "O2",
      "componentValue": "95",
      "loinC_Code": "59408-5",
      "displayName": "O2 % BldC Oximetry",
      "unit": "%",
      "created_Date": "20150622",
      "observationDate": "20150622",
      "sort": 5,
      "dates": "06/22/2015"
    },
    {
      "componentName": "Respiratory Rate",
      "componentValue": "18",
      "loinC_Code": "9279-1",
      "displayName": "Respiratory Rate",
      "unit": "/min",
      "created_Date": "20150622",
      "observationDate": "20150622",
      "sort": 5,
      "dates": "06/22/2015"
    }
  ],
  "table9": [
    {
      "element": "Smoking",
      "smokingStatus": "Current every day smoker",
      "snomeD_CT_Codes": "449868002",
      "qtysmoke": "1 PPD or Equiv.",
      "howLongSmoke": "",
      "desciption": "Current every day smoker - 1 PPD or Equiv.",
      "effectiveDate": "20150622",
      "xmlTableEffectiveDate": "Jun 22, 2015",
      "effectiveDateLow": "20150622",
      "effectiveDateHigh": "20150622"
    }
  ],
  "table10": [
    {
      "cpt": "52330",
      "fieldName": "stent",
      "procedureName": "Stent Placement",
      "snomedCT": "103716009",
      "per_Phy": "Albert Davis",
      "per_Nur": "",
      "testDate": "20150622",
      "xmlTabletestDate": "Jun 22, 2015",
      "otherFindings": "PROCEDURE: ____ stent placement\r\nPROCEDURE IN DETAIL: After appropriate anesthesia the patient was placed in lithotomy position and double-J stent was placed. Patient tolerated the procedure well and was discharged in stable condition with instructions for stent removal.",
      "procedureDate": "06/22/2015",
      "creds": "Dr",
      "first_name": "Albert",
      "last_name": "Davis",
      "performer": "Dr Albert Davis",
      "location": "Chicago Ridge",
      "providerClinic": "Chicago Ridge",
      "providerAddress": "UNK",
      "providerCity": "UNK",
      "providerState": "UNK",
      "providerZip": "UNK",
      "providerPhone": "UNK"
    },
    {
      "cpt": "53850",
      "fieldName": "proc_53850",
      "procedureName": "Nebulizer Therapy",
      "snomedCT": "56251003",
      "per_Phy": "Albert Davis",
      "per_Nur": "",
      "testDate": "20150622",
      "xmlTabletestDate": "Jun 22, 2015",
      "otherFindings": "Nebulizer Therapy",
      "procedureDate": "06/22/2015",
      "creds": "Dr",
      "first_name": "Albert",
      "last_name": "Davis",
      "performer": "Dr Albert Davis",
      "location": "Chicago Ridge",
      "providerClinic": "Chicago Ridge",
      "providerAddress": "UNK",
      "providerCity": "UNK",
      "providerState": "UNK",
      "providerZip": "UNK",
      "providerPhone": "UNK"
    },
    {
      "cpt": "53852",
      "fieldName": "proc_53852",
      "procedureName": "Introduction of cardiac pacemaker system via vein",
      "snomedCT": "175135009",
      "per_Phy": "Albert Davis",
      "per_Nur": "",
      "testDate": "20111005",
      "xmlTabletestDate": "Oct 05, 2011",
      "otherFindings": "Introduction of cardiac pacemaker system via vein",
      "procedureDate": "10/05/2011",
      "creds": "Dr",
      "first_name": "Albert",
      "last_name": "Davis",
      "performer": "Dr Albert Davis",
      "location": "Chicago Ridge",
      "providerClinic": "Chicago Ridge",
      "providerAddress": "UNK",
      "providerCity": "UNK",
      "providerState": "UNK",
      "providerZip": "UNK",
      "providerPhone": "UNK"
    }
  ],
  "table11": [
    {
      "displayNameCode": "24357-6",
      "displayName": "Urine Analysis",
      "labSectionName": "Urine Analysis",
      "sort": 2
    }
  ],
  "table12": [
    {
      "id": 6,
      "patient_ID": 234800,
      "eventid": 828414,
      "deviceName": "Cardiac resynchronization therapy implantable pacemaker",
      "area": "Structure of subclavian vein",
      "manufacturer": "MEDTRONIC, INC.",
      "deviceID": "00643169007222",
      "version": "DTBA1QQ",
      "serialNumber": "",
      "lot": "(01)00643169007222(17)160128(21)BLC200461H",
      "snomed": "704708004",
      "snomedCtName": "Cardiac resynchronization therapy implantable pacemaker",
      "procedureDate": "09/27/2019",
      "provider": 602,
      "created_Date": "2019-09-27T07:20:21.99",
      "created_By": 1,
      "isDeleted": null,
      "modified_Date": "2019-09-27T08:18:27.86",
      "modified_By": 1,
      "staff_id": 602,
      "staff_title": "Dr",
      "first_name": "Albert",
      "last_name": "Davis",
      "mid_name": "",
      "creds": "",
      "dob": "2019-08-26T18:36:00",
      "age": null,
      "sex": "Male",
      "ssn": "",
      "address1": "2472 Rocky place",
      "address2": "Rocky place",
      "city": "Beaverton",
      "state": "or",
      "zip": "97006",
      "home_phone_area": null,
      "home_phone": "(555)555-1002",
      "work_phone_area": null,
      "work_phone": "",
      "work_phone_ext": "",
      "cell_phone_area": null,
      "cell_phone": "",
      "pager_area": null,
      "pager": "",
      "email": "",
      "sys_user": true,
      "hascalendar": false,
      "username": "ADavis",
      "passwordhash": "F0311A3F6415FC05114318B973BB23A52968ADAD",
      "salt": "ErI6Iqrb",
      "created_date1": "2019-08-26T18:36:00",
      "created_user": 1,
      "modified_date1": "2019-08-26T18:36:00",
      "modified_user": 2,
      "isactive": true,
      "office": "ALL",
      "fax": null,
      "npi": null,
      "upin": null,
      "blueid": null,
      "hL7_PV1_F7_C1_DOC_Abbrev": null,
      "license_YN": null,
      "initials": null,
      "emac": null,
      "alias": null,
      "encryptionKey": null,
      "phraseToEncrypt": null,
      "clientId": null,
      "singleSignOnCode": null,
      "userId": null,
      "singleSignOnUserIdVerify": null,
      "singlrSignOnXML": null,
      "logSingleSignOn": true,
      "clinic_Key": null,
      "license_Key": null,
      "passwordExpireDate": null,
      "useremail_hash": null,
      "isViewOnly": false,
      "vendor_id": null,
      "providerID": "Provider11",
      "spi": null,
      "service_Level": null,
      "clinic_Name": "Get Well Clinic",
      "dea": null
    }
  ],
  "table13": [
    {
      "assessment": "\tAssessment and Plan:\tThe patient was found to have fever and Dr Davis is suspecting Anemia based on the patient history. So Dr Davis asked the patient to closely monitor the temperature and blood pressure and get admitted to Community Health Hospitals if the fever does not subside within a day.\t1. Get an EKG done on 6/23/2015.\t2. Get a Chest X-Ray done on 6/23/2015 showing the Lower Respiratory Tract Structure.\t3. Take ClindAmycin 300mg three times a day as needed if pain does not subside/\t4. Schedule follow on visit with Neighborhood Physicians Practice on 7/1/2015\tOffice contact: Tracy Davis, Address: 2471, Rocky place, Beaverton, OR-97006. Tel: 555-555-1002"
    }
  ],
  "table14": [
    {
      "investigations_name": "Get an EKG done on 20190830",
      "plann": "EKG",
      "code": "34534-8",
      "codeSystemName": "LOINC",
      "startdate": "06/23/2015",
      "inv_group": "Others",
      "short": 1
    },
    {
      "investigations_name": "Urinanalysis macro (dipstick) panel",
      "plann": "Urinanalysis macro (dipstick) panel",
      "code": "24357-6",
      "codeSystemName": "LOINC",
      "startdate": "06/22/2015",
      "inv_group": "Urine",
      "short": 1
    },
    {
      "investigations_name": "Urinanalysis macro (dipstick) panel",
      "plann": "Urinanalysis macro (dipstick) panel",
      "code": "24357-6",
      "codeSystemName": "LOINC",
      "startdate": "06/29/2015",
      "inv_group": "Urine",
      "short": 1
    },
    {
      "investigations_name": "Get a Chest X-ray done on 20190830 showing the Lower Respiratory Tract Structure.",
      "plann": "Chest X-ray",
      "code": "168731009",
      "codeSystemName": "SNOMED-CT",
      "startdate": "06/23/2015",
      "inv_group": "X-Ray",
      "short": 2
    }
  ],
  "table15": [
    {
      "investigations_name": "Clindamycin 300 MG Oral Capsule",
      "code": "284215",
      "codeSystemName": "RxNorm",
      "instruction": "Take Clindamycin 300mg three times a day as needed if pain does not subside.",
      "startdate": "20190923",
      "plann": "Clindamycin 300 MG Oral Capsule 300 mg"
    }
  ],
  "table16": [
    {
      "investigations_name": "consultation",
      "plann": "Schedule follow on visit with Neighborhood Physicians Practice on 7/1/2015",
      "code": "11429006",
      "codeSystemName": "SNOMED CT",
      "startdate": "08/30/2019",
      "inv_group": "consultation",
      "short": 5
    }
  ],
  "table17": [
    {
      "snomedCT": null,
      "goal_desc": "Need to gain more energy to do regular activities",
      "dates": "Sep 23, 2019",
      "effectiveTime": "20190923"
    },
    {
      "snomedCT": null,
      "goal_desc": "Get rid of intermittent fever that is occurring every few weeks.",
      "dates": "Sep 23, 2019",
      "effectiveTime": "20190923"
    }
  ],
  "table18": [
    {
      "concern": "Documented HyperTension problem",
      "dates": "Sep 23, 2019",
      "snomedCT": "161901003"
    },
    {
      "concern": "Documented HypoThyroidism problem",
      "dates": "Sep 23, 2019",
      "snomedCT": "161901003"
    },
    {
      "concern": "Watch Weight of patient",
      "dates": "Sep 23, 2019",
      "snomedCT": "161901003"
    },
    {
      "concern": "Chronic Sickness exhibited by patient",
      "dates": "Sep 23, 2019",
      "snomedCT": "161901003"
    }
  ],
  "table19": [
    {
      "snomedCT": "161901003",
      "dates": "Sep 23, 2019",
      "observation": "Chronic Sickness exhibited by patient"
    }
  ]
}
                

Request format


URL

https://ipsemrapi.inpracsys.com/api/G9/GetCcda

Request Method: Post

Headers:

Accept: application/json
Accept-Language: en-gb
Content-Type: application/json
Authorization: "Bearer {accessToken}"

Authorization: This is the token generated from OAuth server

Request format:

Except for End Date, data for all other fields are mandatory

{

  "PracticeName": "InPracSys",

  "PatientMRN": "xaanDL234800",

  "PatientFirstName": "ALICE",

  "PatientLastName": "NEWMAN",

  "PatientDateOfBirth": "05/01/1970"

  "PatientSex": "Female"

  "StartDate": "09/01/2018",

  "EndDate": "09/01/2019",

}

Request parameters


PracticeName: This represents the InPracSys practice where the patient visited for medical treatment.

PatientMRN: This represents patient’s medical record number.

PatientFirstName: This represents patient’s first name.

PatientLastName: This represents patient’s last name.

PatientDateOfBirth: This represents patient’s date of birth.

PatientSex: This represents patient’s gender.

StartDate: This represents start date filter for patient’s health data. This field is mandatory in JSON request.

EndDate: This represents end date filter for patient’s health data. This field is not mandatory in JSON request. If only start date is specified then patient health data for that particular day would be returned by JSON server.

Value set for Sex information to be sent to JSON server
Male
Female

Response format


The response is in base64 encoded format. Developer can decode this response and get the CCD in xml format.

                        {
                          "ccda": "77u/PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4NCjw/eG1sLXN0eWxlc2hlZXQgdHlwZT0ndGV4dC94c2wnIGhyZWY9J0NEQS54c2wnPz4NCjxDbGluaWNhbERvY3VtZW50IHhtbG"
                        }
                

G(8) - Sections


All – This section returns the output of the all data request as per (g)(8) - All Data Request

Request Example

JSON Request Data :

                                 {
                                    "PracticeName": "InPracSys",
                                    "DataCategory": "patient",
                                    "PatientMRN": "xaanDL234800",
                                    "PatientFirstName": "ALICE",
                                    "PatientLastName": "NEWMAN",
                                    "PatientDateOfBirth": "05/01/1970",
                                    "PatientSex": "Female",
                                    "StartDate": "09/01/2018",
                                    "EndDate": "09/01/2019",
                                 } 
                

Response Example

{
  "table": [
    {
      "first_name": "ALICE",
      "last_name": "NEWMAN",
      "mid_name": "JONES",
      "ssn": "111201111",
      "dob": "19700501",
      "sex": "Female",
      "marital_status": "UNK",
      "maritalStatus_Code": "UNK",
      "race": "White",
      "suffix": "",
      "raceMnemonic": "2106-3",
      "ehnicityName": "Not Hispanic or Latino",
      "ethnicGroupCode": "2186-5",
      "language": "English",
      "languageCode": "en-US",
      "address1": "1357, AMBER DR",
      "address2": "",
      "city": "BEAVERTON",
      "state": "or",
      "zip": "97006",
      "ssn1": "",
      "mrn": "xaanDL234800",
      "home_Phone": "(555)-723-1544",
      "cell_Phone": "(555)-777-1234",
      "work_Phone": "UNK",
      "work_phone_ext": "",
      "spouse": "Matthew Newman",
      "spouse_phone": "",
      "parent": "",
      "parent_phone": "",
      "emergency_contact": "Mr Rick Holler",
      "emergency_contact_phone": "",
      "emergency_contact_address": "",
      "prev_LastName": "",
      "prev_FirstName": "ALICIA",
      "visitdate": "20150622",
      "oPhone": "",
      "roles": "",
      "pRole": "",
      "granular": "White European",
      "race2": "2108-9"
    }
  ]
}

Medication – This section returns all the medications prescribed to the patient via the medication data category.

Request Example

JSON Request Data :

                                {
                                PracticeName: "Inpracsys",
                                DataCategory: "medication",
	                            PatientMRN: "XAANDL234800",
	                            PatientFirstName: "alice",
	                            PatientLastName : "newman",
	                            PatientDateOfBirth: "05/01/1970",
	                            PatientSex: "Female",
	                            StartDate : "06/21/2015",
	                            EndDate :"",
                                }
                            

Response Example

{
  "table": [
    {
      "first_name": "ALICE",
      "last_name": "NEWMAN",
      "mid_name": "JONES",
      "ssn": "111201111",
      "dob": "19700501",
      "sex": "Female",
      "marital_status": "UNK",
      "maritalStatus_Code": "UNK",
      "race": "White",
      "suffix": "",
      "raceMnemonic": "2106-3",
      "ehnicityName": "Not Hispanic or Latino",
      "ethnicGroupCode": "2186-5",
      "language": "English",
      "languageCode": "en-US",
      "address1": "1357, AMBER DR",
      "address2": "",
      "city": "BEAVERTON",
      "state": "or",
      "zip": "97006",
      "ssn1": "",
      "mrn": "xaanDL234800",
      "home_Phone": "(555)-723-1544",
      "cell_Phone": "(555)-777-1234",
      "work_Phone": "UNK",
      "work_phone_ext": "",
      "spouse": "Matthew Newman",
      "spouse_phone": "",
      "parent": "",
      "parent_phone": "",
      "emergency_contact": "Mr Rick Holler",
      "emergency_contact_phone": "",
      "emergency_contact_address": "",
      "prev_LastName": "",
      "prev_FirstName": "ALICIA",
      "visitdate": "20150622",
      "oPhone": "",
      "roles": "",
      "pRole": "",
      "granular": "White European",
      "race2": "2108-9"
    }
  ],
  "table1": [
    {
      "medicaldesc": "Tylenol (oral - tablet)",
      "dosage": "500mg",
      "instructions": "As needed",
      "quantity": "10",
      "administrationUnitCode": "C42998",
      "doseFormDescription": "TABLET",
      "routeCode": "C38288",
      "routeDescription": "ORAL",
      "pres_date_Start": "20150622",
      "pres_date_End": "",
      "xmlTablepres_date_Start": "Jun 22, 2015",
      "xmlTablepres_date_End": "",
      "rxNormID": "209459",
      "status": "Completed",
      "indications": "UNK",
      "phy_name": "Albert Davis",
      "staff_Title": "Dr",
      "first_name": "Dr",
      "last_name": "Albert",
      "performer": "Dr Albert Davis",
      "location": "Chicago Ridge",
      "providerClinic": "Chicago Ridge",
      "providerAddress": "UNK",
      "providerCity": "UNK",
      "providerState": "UNK",
      "providerZip": "UNK",
      "providerPhone": "UNK",
      "unit": "1"
    },
    {
      "medicaldesc": "cefTRIAXone (intravenous - solution)",
      "dosage": "100 MG/ML",
      "instructions": "Two times daily",
      "quantity": "30",
      "administrationUnitCode": "C42986",
      "doseFormDescription": "SOLUTION",
      "routeCode": "C38276",
      "routeDescription": "INTRAVENOUS",
      "pres_date_Start": "20150622",
      "pres_date_End": "20150630",
      "xmlTablepres_date_Start": "Jun 22, 2015",
      "xmlTablepres_date_End": "Jun 30, 2015",
      "rxNormID": "309090",
      "status": "Completed",
      "indications": "UNK",
      "phy_name": "Albert Davis",
      "staff_Title": "Dr",
      "first_name": "Dr",
      "last_name": "Albert",
      "performer": "Dr Albert Davis",
      "location": "Chicago Ridge",
      "providerClinic": "Chicago Ridge",
      "providerAddress": "UNK",
      "providerCity": "UNK",
      "providerState": "UNK",
      "providerZip": "UNK",
      "providerPhone": "UNK",
      "unit": "1"
    },
    {
      "medicaldesc": "Aranesp SingleJect (injectable - solution)",
      "dosage": "0.5 MG/ML",
      "instructions": "Once a week",
      "quantity": "4",
      "administrationUnitCode": "C42986",
      "doseFormDescription": "SOLUTION",
      "routeCode": "C38288",
      "routeDescription": "UNK",
      "pres_date_Start": "20150622",
      "pres_date_End": "",
      "xmlTablepres_date_Start": "Jun 22, 2015",
      "xmlTablepres_date_End": "",
      "rxNormID": "731241",
      "status": "Completed",
      "indications": "UNK",
      "phy_name": "Albert Davis",
      "staff_Title": "Dr",
      "first_name": "Dr",
      "last_name": "Albert",
      "performer": "Dr Albert Davis",
      "location": "Chicago Ridge",
      "providerClinic": "Chicago Ridge",
      "providerAddress": "UNK",
      "providerCity": "UNK",
      "providerState": "UNK",
      "providerZip": "UNK",
      "providerPhone": "UNK",
      "unit": "1"
    }
  ]
}

Allergy – This section returns the drug allergies for the patient via the allergy data category.

Request Example

JSON Request Data :

                                {
                                 PracticeName: "Inpracsys",
                                DataCategory: "allergy",
	                            PatientMRN: "XAANDL234800",
	                            PatientFirstName: "alice",
	                            PatientLastName : "newman",
	                            PatientDateOfBirth: "05/01/1970",
	                            PatientSex: "Female",
	                            StartDate : "06/21/2015",
	                            EndDate :"",    
                                }
                            

Response Example

{
  "table": [
    {
      "first_name": "ALICE",
      "last_name": "NEWMAN",
      "mid_name": "JONES",
      "ssn": "111201111",
      "dob": "19700501",
      "sex": "Female",
      "marital_status": "UNK",
      "maritalStatus_Code": "UNK",
      "race": "White",
      "suffix": "",
      "raceMnemonic": "2106-3",
      "ehnicityName": "Not Hispanic or Latino",
      "ethnicGroupCode": "2186-5",
      "language": "English",
      "languageCode": "en-US",
      "address1": "1357, AMBER DR",
      "address2": "",
      "city": "BEAVERTON",
      "state": "or",
      "zip": "97006",
      "ssn1": "",
      "mrn": "xaanDL234800",
      "home_Phone": "(555)-723-1544",
      "cell_Phone": "(555)-777-1234",
      "work_Phone": "UNK",
      "work_phone_ext": "",
      "spouse": "Matthew Newman",
      "spouse_phone": "",
      "parent": "",
      "parent_phone": "",
      "emergency_contact": "Mr Rick Holler",
      "emergency_contact_phone": "",
      "emergency_contact_address": "",
      "prev_LastName": "",
      "prev_FirstName": "ALICIA",
      "visitdate": "20150622",
      "oPhone": "",
      "roles": "",
      "pRole": "",
      "granular": "White European",
      "race2": "2108-9"
    }
  ],
  "table1": [
    {
      "substance": "Penicillin G",
      "allergy_type": "Med",
      "reaction": "Hives",
      "reactionSnomedCT": "247472004",
      "severity": "Moderate",
      "severitySnomedCT": "6736007",
      "status": "Active",
      "statusSnomedCT": "55561003",
      "rxNormID": "7980",
      "createdDate": "20150622"
    },
    {
      "substance": "Ampicillin",
      "allergy_type": "Med",
      "reaction": "Hives",
      "reactionSnomedCT": "247472004",
      "severity": "Moderate",
      "severitySnomedCT": "6736007",
      "status": "Active",
      "statusSnomedCT": "55561003",
      "rxNormID": "733",
      "createdDate": "20150622"
    }
  ]
}

Care team example - This section returns all the problems and assessments of the patient via the care team data category.

Request Example

JSON Request Data :

                                {
                                 	PracticeName: "Inpracsys",
                                    DataCategory: "careteam",
	                                PatientMRN: "XAANDL234800",
	                                PatientFirstName: "alice",
	                                PatientLastName : "newman",
	                                PatientDateOfBirth: "05/01/1970",
	                                PatientSex: "Female",
	                                StartDate : "06/21/2015",
	                                EndDate :"",
                                }
                            

Response Example

{
  "table": [
    {
      "first_name": "ALICE",
      "last_name": "NEWMAN",
      "mid_name": "JONES",
      "ssn": "111201111",
      "dob": "19700501",
      "sex": "Female",
      "marital_status": "UNK",
      "maritalStatus_Code": "UNK",
      "race": "White",
      "suffix": "",
      "raceMnemonic": "2106-3",
      "ehnicityName": "Not Hispanic or Latino",
      "ethnicGroupCode": "2186-5",
      "language": "English",
      "languageCode": "en-US",
      "address1": "1357, AMBER DR",
      "address2": "",
      "city": "BEAVERTON",
      "state": "or",
      "zip": "97006",
      "ssn1": "",
      "mrn": "xaanDL234800",
      "home_Phone": "(555)-723-1544",
      "cell_Phone": "(555)-777-1234",
      "work_Phone": "UNK",
      "work_phone_ext": "",
      "spouse": "Matthew Newman",
      "spouse_phone": "",
      "parent": "",
      "parent_phone": "",
      "emergency_contact": "Mr Rick Holler",
      "emergency_contact_phone": "",
      "emergency_contact_address": "",
      "prev_LastName": "",
      "prev_FirstName": "ALICIA",
      "visitdate": "20150622",
      "oPhone": "",
      "roles": "",
      "pRole": "",
      "granular": "White European",
      "race2": "2108-9"
    }
  ],
  "table1": [
    {
      "eventID": 828414.0,
      "encounterSnomedCT": "699134002",
      "encounter": "Caregiver annual health check",
      "staff_title": "Dr",
      "performer": "Albert Davis",
      "performer_FirstName": "Albert",
      "performer_LastName": "Davis",
      "providerSex": "Male",
      "providerPhone": "(555)555-1002",
      "visitDate_From": "20150622100000",
      "visitDate_To": "20150622110000",
      "location": "Chicago Ridge",
      "providerSBU": "Get Well Clinic",
      "providerAddress": "2472 Rocky place",
      "providerCity": "Beaverton",
      "providerState": "or",
      "providerZip": "97006",
      "providerPhone1": "(555)555-1002",
      "ref_by": "Dr Albert Davis",
      "ref_address": "2472, Rocky place,",
      "ref_city": "Beaverton,",
      "ref_state": "or",
      "ref_zip": "97006",
      "ref_phone": "",
      "primary_doctor": "",
      "primary_address": "",
      "primary_city": "",
      "primary_state": "",
      "primary_zip": "",
      "primary_phone": "",
      "additional_doctor": "",
      "additional_address": "",
      "additional_city": "",
      "additional_state": "",
      "additional_zip": "",
      "additional_phone": "",
      "staff": "Tracy Davis",
      "staffAddress": "2472 Rocky place",
      "staffCity": "Beaverton",
      "staffState": "OR",
      "staffZip": "97006",
      "staffPhone": "(555)555-1002",
      "staff_FirstName": "Tracy",
      "staff_LastName": "Davis"
    }
  ]
}

Problems - This section returns all the health concerns for the patient via the problems data category

Request Example

JSON Request Data :

                                {
                                 	PracticeName: "Inpracsys",
                                    DataCategory: "problems",
	                                PatientMRN: "XAANDL234800",
	                                PatientFirstName: "alice",
	                                PatientLastName : "newman",
	                                PatientDateOfBirth: "05/01/1970",
	                                PatientSex: "Female",
	                                StartDate : "06/21/2015",
	                                EndDate :"",
                                }
                            

Response Example

{
  "table": [
    {
      "first_name": "ALICE",
      "last_name": "NEWMAN",
      "mid_name": "JONES",
      "ssn": "111201111",
      "dob": "19700501",
      "sex": "Female",
      "marital_status": "UNK",
      "maritalStatus_Code": "UNK",
      "race": "White",
      "suffix": "",
      "raceMnemonic": "2106-3",
      "ehnicityName": "Not Hispanic or Latino",
      "ethnicGroupCode": "2186-5",
      "language": "English",
      "languageCode": "en-US",
      "address1": "1357, AMBER DR",
      "address2": "",
      "city": "BEAVERTON",
      "state": "or",
      "zip": "97006",
      "ssn1": "",
      "mrn": "xaanDL234800",
      "home_Phone": "(555)-723-1544",
      "cell_Phone": "(555)-777-1234",
      "work_Phone": "UNK",
      "work_phone_ext": "",
      "spouse": "Matthew Newman",
      "spouse_phone": "",
      "parent": "",
      "parent_phone": "",
      "emergency_contact": "Mr Rick Holler",
      "emergency_contact_phone": "",
      "emergency_contact_address": "",
      "prev_LastName": "",
      "prev_FirstName": "ALICIA",
      "visitdate": "20150622",
      "oPhone": "",
      "roles": "",
      "pRole": "",
      "granular": "White European",
      "race2": "2108-9"
    }
  ],
  "table1": [
    {
      "diagnosis_id": 1,
      "diagnosis_name": "Essential hypertension",
      "snomedCT": "59621000",
      "diagnosis_date": "20111005",
      "enddate": "",
      "stable_status": "Active",
      "stable_StatusSnomedCT": "73425007",
      "performer": "Dr Albert Davis",
      "location": "Chicago Ridge",
      "providerClinic": "Chicago Ridge",
      "providerAddress": "UNK",
      "providerCity": "UNK",
      "providerState": "UNK",
      "providerZip": "UNK",
      "providerPhone": "UNK",
      "ageAtDiagnosed": 41,
      "start_date": "10/05/2011",
      "end_date": ""
    },
    {
      "diagnosis_id": 2,
      "diagnosis_name": "Severe hypothyroidism",
      "snomedCT": "83986005",
      "diagnosis_date": "20061231",
      "enddate": "",
      "stable_status": "Active",
      "stable_StatusSnomedCT": "73425007",
      "performer": "Dr Albert Davis",
      "location": "Chicago Ridge",
      "providerClinic": "Chicago Ridge",
      "providerAddress": "UNK",
      "providerCity": "UNK",
      "providerState": "UNK",
      "providerZip": "UNK",
      "providerPhone": "UNK",
      "ageAtDiagnosed": 36,
      "start_date": "12/31/2006",
      "end_date": ""
    },
    {
      "diagnosis_id": 3,
      "diagnosis_name": "Chronic rejection of renal transplant",
      "snomedCT": "236578006",
      "diagnosis_date": "20111231",
      "enddate": "",
      "stable_status": "Active",
      "stable_StatusSnomedCT": "73425007",
      "performer": "Dr Albert Davis",
      "location": "Chicago Ridge",
      "providerClinic": "Chicago Ridge",
      "providerAddress": "UNK",
      "providerCity": "UNK",
      "providerState": "UNK",
      "providerZip": "UNK",
      "providerPhone": "UNK",
      "ageAtDiagnosed": 41,
      "start_date": "12/31/2011",
      "end_date": ""
    },
    {
      "diagnosis_id": 4,
      "diagnosis_name": "Fever",
      "snomedCT": "386661006",
      "diagnosis_date": "20150622",
      "enddate": "",
      "stable_status": "Active",
      "stable_StatusSnomedCT": "73425007",
      "performer": "Dr Albert Davis",
      "location": "Chicago Ridge",
      "providerClinic": "Chicago Ridge",
      "providerAddress": "UNK",
      "providerCity": "UNK",
      "providerState": "UNK",
      "providerZip": "UNK",
      "providerPhone": "UNK",
      "ageAtDiagnosed": 45,
      "start_date": "06/22/2015",
      "end_date": ""
    },
    {
      "diagnosis_id": 5,
      "diagnosis_name": "Overweight",
      "snomedCT": "238131007",
      "diagnosis_date": "20061231",
      "enddate": "20070601",
      "stable_status": "Completed",
      "stable_StatusSnomedCT": "73425007",
      "performer": "Dr Albert Davis",
      "location": "Chicago Ridge",
      "providerClinic": "Chicago Ridge",
      "providerAddress": "UNK",
      "providerCity": "UNK",
      "providerState": "UNK",
      "providerZip": "UNK",
      "providerPhone": "UNK",
      "ageAtDiagnosed": 36,
      "start_date": "12/31/2006",
      "end_date": "06/01/2007"
    }
  ]
}

Encounters - This section returns all the laboratory results of the Patient via the encounters data category.

Request Example

JSON Request Data :

                                {
                                 PracticeName: "Inpracsys",
                                DataCategory: "encounters",
	                            PatientMRN: "XAANDL234800",
	                            PatientFirstName: "alice",
	                            PatientLastName : "newman",
	                            PatientDateOfBirth: "05/01/1970",
	                            PatientSex: "Female",
	                            StartDate : "06/21/2015",
	                            EndDate :"",
                                }
                            

Response Example

{
  "table": [
    {
      "first_name": "ALICE",
      "last_name": "NEWMAN",
      "mid_name": "JONES",
      "ssn": "111201111",
      "dob": "19700501",
      "sex": "Female",
      "marital_status": "UNK",
      "maritalStatus_Code": "UNK",
      "race": "White",
      "suffix": "",
      "raceMnemonic": "2106-3",
      "ehnicityName": "Not Hispanic or Latino",
      "ethnicGroupCode": "2186-5",
      "language": "English",
      "languageCode": "en-US",
      "address1": "1357, AMBER DR",
      "address2": "",
      "city": "BEAVERTON",
      "state": "or",
      "zip": "97006",
      "ssn1": "",
      "mrn": "xaanDL234800",
      "home_Phone": "(555)-723-1544",
      "cell_Phone": "(555)-777-1234",
      "work_Phone": "UNK",
      "work_phone_ext": "",
      "spouse": "Matthew Newman",
      "spouse_phone": "",
      "parent": "",
      "parent_phone": "",
      "emergency_contact": "Mr Rick Holler",
      "emergency_contact_phone": "",
      "emergency_contact_address": "",
      "prev_LastName": "",
      "prev_FirstName": "ALICIA",
      "visitdate": "20150622",
      "oPhone": "",
      "roles": "",
      "pRole": "",
      "granular": "White European",
      "race2": "2108-9"
    }
  ],
  "table1": [
    {
      "diagnosis_id": 0.0,
      "diagnosis_name": "Fever",
      "snomedCT": "386661006",
      "diagnosis_date": "20150622",
      "xmlTable_Diagnosis_date": "Jun 22, 2015",
      "stable_status": 1,
      "performer": "Dr Albert Davis",
      "location": "Chicago Ridge",
      "providerClinic": "Chicago Ridge",
      "providerAddress": "UNK",
      "providerCity": "UNK",
      "providerState": "UNK",
      "providerZip": "UNK",
      "providerPhone": "UNK",
      "providerPhoneCode": "WP",
      "pfPrefix": "Dr",
      "pfFirstname": "Albert",
      "pfLastname": "Davis"
    }
  ]
}

immunization - This section returns all the Vital signs captured for the patient via the immunization data category.

Request Example

JSON Request Data :

                                {
                                PracticeName: "Inpracsys",
                                DataCategory: "immunization",
	                            PatientMRN: "XAANDL234800",
	                            PatientFirstName: "alice",
	                            PatientLastName : "newman",
	                            PatientDateOfBirth: "05/01/1970",
	                            PatientSex: "Female",
	                            StartDate : "06/21/2015",
	                            EndDate :"",
                                }
                            

Response Example

{
  "table": [
    {
      "first_name": "ALICE",
      "last_name": "NEWMAN",
      "mid_name": "JONES",
      "ssn": "111201111",
      "dob": "19700501",
      "sex": "Female",
      "marital_status": "UNK",
      "maritalStatus_Code": "UNK",
      "race": "White",
      "suffix": "",
      "raceMnemonic": "2106-3",
      "ehnicityName": "Not Hispanic or Latino",
      "ethnicGroupCode": "2186-5",
      "language": "English",
      "languageCode": "en-US",
      "address1": "1357, AMBER DR",
      "address2": "",
      "city": "BEAVERTON",
      "state": "or",
      "zip": "97006",
      "ssn1": "",
      "mrn": "xaanDL234800",
      "home_Phone": "(555)-723-1544",
      "cell_Phone": "(555)-777-1234",
      "work_Phone": "UNK",
      "work_phone_ext": "",
      "spouse": "Matthew Newman",
      "spouse_phone": "",
      "parent": "",
      "parent_phone": "",
      "emergency_contact": "Mr Rick Holler",
      "emergency_contact_phone": "",
      "emergency_contact_address": "",
      "prev_LastName": "",
      "prev_FirstName": "ALICIA",
      "visitdate": "20150622",
      "oPhone": "",
      "roles": "",
      "pRole": "",
      "granular": "White European",
      "race2": "2108-9"
    }
  ],
  "table1": [
    {
      "configId": 27,
      "code": "88",
      "name": "INFLUENZA VIRUS VACCINE",
      "selected": 1,
      "date": "05/10/2014",
      "time": "",
      "amount": "",
      "units": "",
      "lotNumber": "NA",
      "manufacturerName": "Immuno Inc",
      "manufacturerCode": "Immuno Inc",
      "notes": "influenza, intradermal, quadrivalent, preservative free was not given - Patient rejected.",
      "status": "Completed",
      "createddate": "20150622",
      "refusal": "",
      "xmlTable_createddate": "Jun 22, 2015",
      "notes1": "influenza, intradermal, quadrivalent, preservative free was not given - Patient rejected."
    },
    {
      "configId": 36,
      "code": "166",
      "name": "influenza, intradermal, quadrivalent, preservative free",
      "selected": 1,
      "date": "06/22/2015",
      "time": "",
      "amount": "",
      "units": "",
      "lotNumber": "NA",
      "manufacturerName": "Immuno Inc",
      "manufacturerCode": "Immuno Inc",
      "notes": "influenza, intradermal, quadrivalent, preservative free was not given - Patient rejected.",
      "status": "Cancel",
      "createddate": "20150622",
      "refusal": "Immunization was not given - Patient rejected immunization",
      "xmlTable_createddate": "Jun 22, 2015",
      "notes1": "influenza, intradermal, quadrivalent, preservative free was not given - Patient rejected."
    },
    {
      "configId": 37,
      "code": "106",
      "name": "TETANUS AND DIPHTHERIA TOXOIDS",
      "selected": 1,
      "date": "",
      "time": "",
      "amount": "",
      "units": "",
      "lotNumber": "NA",
      "manufacturerName": "Immuno Inc",
      "manufacturerCode": "Immuno Inc",
      "notes": "influenza, intradermal, quadrivalent, preservative free was not given - Patient rejected.",
      "status": "Completed",
      "createddate": "20150622",
      "refusal": "",
      "xmlTable_createddate": "Jun 22, 2015",
      "notes1": "influenza, intradermal, quadrivalent, preservative free was not given - Patient rejected."
    }
  ]
}

Vital Signs - This section returns smoking status of the patient via the vital signs data category.

Request Example

JSON Request Data :

                                {
                                 PracticeName: "Inpracsys",
                                DataCategory: "vitalsigns",
	                            PatientMRN: "XAANDL234800",
	                            PatientFirstName: "alice",
	                            PatientLastName : "newman",
	                            PatientDateOfBirth: "05/01/1970",
	                            PatientSex: "Female",
	                            StartDate : "06/21/2015",
	                            EndDate :"",
                                }
                            

Response Example

{
  "table": [
    {
      "first_name": "ALICE",
      "last_name": "NEWMAN",
      "mid_name": "JONES",
      "ssn": "111201111",
      "dob": "19700501",
      "sex": "Female",
      "marital_status": "UNK",
      "maritalStatus_Code": "UNK",
      "race": "White",
      "suffix": "",
      "raceMnemonic": "2106-3",
      "ehnicityName": "Not Hispanic or Latino",
      "ethnicGroupCode": "2186-5",
      "language": "English",
      "languageCode": "en-US",
      "address1": "1357, AMBER DR",
      "address2": "",
      "city": "BEAVERTON",
      "state": "or",
      "zip": "97006",
      "ssn1": "",
      "mrn": "xaanDL234800",
      "home_Phone": "(555)-723-1544",
      "cell_Phone": "(555)-777-1234",
      "work_Phone": "UNK",
      "work_phone_ext": "",
      "spouse": "Matthew Newman",
      "spouse_phone": "",
      "parent": "",
      "parent_phone": "",
      "emergency_contact": "Mr Rick Holler",
      "emergency_contact_phone": "",
      "emergency_contact_address": "",
      "prev_LastName": "",
      "prev_FirstName": "ALICIA",
      "visitdate": "20150622",
      "oPhone": "",
      "roles": "",
      "pRole": "",
      "granular": "White European",
      "race2": "2108-9"
    }
  ],
  "table1": [
    {
      "componentName": "Height",
      "componentValue": "177",
      "loinC_Code": "8302-2",
      "displayName": "Height",
      "unit": "CM",
      "created_Date": "20150622",
      "observationDate": "20150622",
      "sort": 1,
      "dates": "06/22/2015"
    },
    {
      "componentName": "Weight",
      "componentValue": "88",
      "loinC_Code": "29463-7",
      "displayName": "Patient Body Weight - Measured",
      "unit": "KG",
      "created_Date": "20150622",
      "observationDate": "20150622",
      "sort": 2,
      "dates": "06/22/2015"
    },
    {
      "componentName": "BP Systolic",
      "componentValue": "145",
      "loinC_Code": "8480-6",
      "displayName": "BP Systolic",
      "unit": "mm[Hg]",
      "created_Date": "20150622",
      "observationDate": "20150622",
      "sort": 3,
      "dates": "06/22/2015"
    },
    {
      "componentName": "BP Diastolic",
      "componentValue": "88",
      "loinC_Code": "8462-4",
      "displayName": "BP Diastolic",
      "unit": "mm[Hg]",
      "created_Date": "20150622",
      "observationDate": "20150622",
      "sort": 4,
      "dates": "06/22/2015"
    },
    {
      "componentName": "Body Temperature",
      "componentValue": "38",
      "loinC_Code": "8310-5",
      "displayName": "Body Temperature",
      "unit": "Cel",
      "created_Date": "20150622",
      "observationDate": "20150622",
      "sort": 5,
      "dates": "06/22/2015"
    },
    {
      "componentName": "Heart Rate",
      "componentValue": "80",
      "loinC_Code": "8867-4",
      "displayName": "Heart Rate",
      "unit": "/min",
      "created_Date": "20150622",
      "observationDate": "20150622",
      "sort": 5,
      "dates": "06/22/2015"
    },
    {
      "componentName": "Inhaled Oxygen",
      "componentValue": "36",
      "loinC_Code": "3150-0",
      "displayName": "Inhaled Oxygen Concentration",
      "unit": "%",
      "created_Date": "20150622",
      "observationDate": "20150622",
      "sort": 5,
      "dates": "06/22/2015"
    },
    {
      "componentName": "O2",
      "componentValue": "95",
      "loinC_Code": "59408-5",
      "displayName": "O2 % BldC Oximetry",
      "unit": "%",
      "created_Date": "20150622",
      "observationDate": "20150622",
      "sort": 5,
      "dates": "06/22/2015"
    },
    {
      "componentName": "Respiratory Rate",
      "componentValue": "18",
      "loinC_Code": "9279-1",
      "displayName": "Respiratory Rate",
      "unit": "/min",
      "created_Date": "20150622",
      "observationDate": "20150622",
      "sort": 5,
      "dates": "06/22/2015"
    }
  ]
}

Smoking Status - This section returns all the immunization details of the patient via the smoking status data category.

Request Example

JSON Request Data :

                                {
                                PracticeName: "Inpracsys",
                                DataCategory: "smokingstatus",
	                            PatientMRN: "XAANDL234800",
	                            PatientFirstName: "alice",
	                            PatientLastName : "newman",
	                            PatientDateOfBirth: "05/01/1970",
	                            PatientSex: "Female",
	                            StartDate : "06/21/2015",
	                            EndDate :"",
                                }
                            

Response Example

{
  "table": [
    {
      "first_name": "ALICE",
      "last_name": "NEWMAN",
      "mid_name": "JONES",
      "ssn": "111201111",
      "dob": "19700501",
      "sex": "Female",
      "marital_status": "UNK",
      "maritalStatus_Code": "UNK",
      "race": "White",
      "suffix": "",
      "raceMnemonic": "2106-3",
      "ehnicityName": "Not Hispanic or Latino",
      "ethnicGroupCode": "2186-5",
      "language": "English",
      "languageCode": "en-US",
      "address1": "1357, AMBER DR",
      "address2": "",
      "city": "BEAVERTON",
      "state": "or",
      "zip": "97006",
      "ssn1": "",
      "mrn": "xaanDL234800",
      "home_Phone": "(555)-723-1544",
      "cell_Phone": "(555)-777-1234",
      "work_Phone": "UNK",
      "work_phone_ext": "",
      "spouse": "Matthew Newman",
      "spouse_phone": "",
      "parent": "",
      "parent_phone": "",
      "emergency_contact": "Mr Rick Holler",
      "emergency_contact_phone": "",
      "emergency_contact_address": "",
      "prev_LastName": "",
      "prev_FirstName": "ALICIA",
      "visitdate": "20150622",
      "oPhone": "",
      "roles": "",
      "pRole": "",
      "granular": "White European",
      "race2": "2108-9"
    }
  ],
  "table1": [
    {
      "element": "Smoking",
      "smokingStatus": "Current every day smoker",
      "snomeD_CT_Codes": "449868002",
      "qtysmoke": "1 PPD or Equiv.",
      "howLongSmoke": "",
      "desciption": "Current every day smoker - 1 PPD or Equiv.",
      "effectiveDate": "20150622",
      "xmlTableEffectiveDate": "Jun 22, 2015",
      "effectiveDateLow": "20150622",
      "effectiveDateHigh": "20150622"
    }
  ]
}

procedure - This section returns the list of procedures performed for the patient via the procedure data category.

Request Example

JSON Request Data :

                                {
                                PracticeName: "Inpracsys",
                                DataCategory: "procedure",
	                            PatientMRN: "XAANDL234800",
	                            PatientFirstName: "alice",
	                            PatientLastName : "newman",
	                            PatientDateOfBirth: "05/01/1970",
	                            PatientSex: "Female",
	                            StartDate : "06/21/2015",
	                            EndDate :"",
                                }
                            

Response Example

{
  "table": [
    {
      "first_name": "ALICE",
      "last_name": "NEWMAN",
      "mid_name": "JONES",
      "ssn": "111201111",
      "dob": "19700501",
      "sex": "Female",
      "marital_status": "UNK",
      "maritalStatus_Code": "UNK",
      "race": "White",
      "suffix": "",
      "raceMnemonic": "2106-3",
      "ehnicityName": "Not Hispanic or Latino",
      "ethnicGroupCode": "2186-5",
      "language": "English",
      "languageCode": "en-US",
      "address1": "1357, AMBER DR",
      "address2": "",
      "city": "BEAVERTON",
      "state": "or",
      "zip": "97006",
      "ssn1": "",
      "mrn": "xaanDL234800",
      "home_Phone": "(555)-723-1544",
      "cell_Phone": "(555)-777-1234",
      "work_Phone": "UNK",
      "work_phone_ext": "",
      "spouse": "Matthew Newman",
      "spouse_phone": "",
      "parent": "",
      "parent_phone": "",
      "emergency_contact": "Mr Rick Holler",
      "emergency_contact_phone": "",
      "emergency_contact_address": "",
      "prev_LastName": "",
      "prev_FirstName": "ALICIA",
      "visitdate": "20150622",
      "oPhone": "",
      "roles": "",
      "pRole": "",
      "granular": "White European",
      "race2": "2108-9"
    }
  ],
  "table1": [
    {
      "cpt": "52330",
      "fieldName": "stent",
      "procedureName": "Stent Placement",
      "snomedCT": "103716009",
      "per_Phy": "Albert Davis",
      "per_Nur": "",
      "testDate": "20150622",
      "xmlTabletestDate": "Jun 22, 2015",
      "otherFindings": "PROCEDURE: ____ stent placement\r\nPROCEDURE IN DETAIL: After appropriate anesthesia the patient was placed in lithotomy position and double-J stent was placed. Patient tolerated the procedure well and was discharged in stable condition with instructions for stent removal.",
      "procedureDate": "06/22/2015",
      "creds": "Dr",
      "first_name": "Albert",
      "last_name": "Davis",
      "performer": "Dr Albert Davis",
      "location": "Chicago Ridge",
      "providerClinic": "Chicago Ridge",
      "providerAddress": "UNK",
      "providerCity": "UNK",
      "providerState": "UNK",
      "providerZip": "UNK",
      "providerPhone": "UNK"
    },
    {
      "cpt": "53850",
      "fieldName": "proc_53850",
      "procedureName": "Nebulizer Therapy",
      "snomedCT": "56251003",
      "per_Phy": "Albert Davis",
      "per_Nur": "",
      "testDate": "20150622",
      "xmlTabletestDate": "Jun 22, 2015",
      "otherFindings": "Nebulizer Therapy",
      "procedureDate": "06/22/2015",
      "creds": "Dr",
      "first_name": "Albert",
      "last_name": "Davis",
      "performer": "Dr Albert Davis",
      "location": "Chicago Ridge",
      "providerClinic": "Chicago Ridge",
      "providerAddress": "UNK",
      "providerCity": "UNK",
      "providerState": "UNK",
      "providerZip": "UNK",
      "providerPhone": "UNK"
    },
    {
      "cpt": "53852",
      "fieldName": "proc_53852",
      "procedureName": "Introduction of cardiac pacemaker system via vein",
      "snomedCT": "175135009",
      "per_Phy": "Albert Davis",
      "per_Nur": "",
      "testDate": "20111005",
      "xmlTabletestDate": "Oct 05, 2011",
      "otherFindings": "Introduction of cardiac pacemaker system via vein",
      "procedureDate": "10/05/2011",
      "creds": "Dr",
      "first_name": "Albert",
      "last_name": "Davis",
      "performer": "Dr Albert Davis",
      "location": "Chicago Ridge",
      "providerClinic": "Chicago Ridge",
      "providerAddress": "UNK",
      "providerCity": "UNK",
      "providerState": "UNK",
      "providerZip": "UNK",
      "providerPhone": "UNK"
    }
  ]
}

Laboratory Results - This section returns all the patient implant details via the laboratory results data category.

Request Example

JSON Request Data :

                                {
                                PracticeName: "Inpracsys",
                                DataCategory: "laboratoryresults",
	                            PatientMRN: "XAANDL234800",
	                            PatientFirstName: "alice",
	                            PatientLastName : "newman",
	                            PatientDateOfBirth: "05/01/1970",
	                            PatientSex: "Female",
	                            StartDate : "06/21/2015",
	                            EndDate :"",
                                }
                            

Response Example

{
  "table": [
    {
      "first_name": "ALICE",
      "last_name": "NEWMAN",
      "mid_name": "JONES",
      "ssn": "111201111",
      "dob": "19700501",
      "sex": "Female",
      "marital_status": "UNK",
      "maritalStatus_Code": "UNK",
      "race": "White",
      "suffix": "",
      "raceMnemonic": "2106-3",
      "ehnicityName": "Not Hispanic or Latino",
      "ethnicGroupCode": "2186-5",
      "language": "English",
      "languageCode": "en-US",
      "address1": "1357, AMBER DR",
      "address2": "",
      "city": "BEAVERTON",
      "state": "or",
      "zip": "97006",
      "ssn1": "",
      "mrn": "xaanDL234800",
      "home_Phone": "(555)-723-1544",
      "cell_Phone": "(555)-777-1234",
      "work_Phone": "UNK",
      "work_phone_ext": "",
      "spouse": "Matthew Newman",
      "spouse_phone": "",
      "parent": "",
      "parent_phone": "",
      "emergency_contact": "Mr Rick Holler",
      "emergency_contact_phone": "",
      "emergency_contact_address": "",
      "prev_LastName": "",
      "prev_FirstName": "ALICIA",
      "visitdate": "20150622",
      "oPhone": "",
      "roles": "",
      "pRole": "",
      "granular": "White European",
      "race2": "2108-9"
    }
  ],
  "table1": [
    {
      "displayNameCode": "24357-6",
      "displayName": "Urine Analysis",
      "labSectionName": "Urine Analysis",
      "sort": 2
    }
  ]
}

device - This section returns the patient's plan of care via the device data category.

Request Example

JSON Request Data :

                                {
                                PracticeName: "Inpracsys",
                                DataCategory: "device",
	                            PatientMRN: "XAANDL234800",
	                            PatientFirstName: "alice",
	                            PatientLastName : "newman",
	                            PatientDateOfBirth: "05/01/1970",
	                            PatientSex: "Female",
	                            StartDate : "06/21/2015",
	                            EndDate :"",
                                }
                            

Response Example

{
  "table": [
    {
      "first_name": "ALICE",
      "last_name": "NEWMAN",
      "mid_name": "JONES",
      "ssn": "111201111",
      "dob": "19700501",
      "sex": "Female",
      "marital_status": "UNK",
      "maritalStatus_Code": "UNK",
      "race": "White",
      "suffix": "",
      "raceMnemonic": "2106-3",
      "ehnicityName": "Not Hispanic or Latino",
      "ethnicGroupCode": "2186-5",
      "language": "English",
      "languageCode": "en-US",
      "address1": "1357, AMBER DR",
      "address2": "",
      "city": "BEAVERTON",
      "state": "or",
      "zip": "97006",
      "ssn1": "",
      "mrn": "xaanDL234800",
      "home_Phone": "(555)-723-1544",
      "cell_Phone": "(555)-777-1234",
      "work_Phone": "UNK",
      "work_phone_ext": "",
      "spouse": "Matthew Newman",
      "spouse_phone": "",
      "parent": "",
      "parent_phone": "",
      "emergency_contact": "Mr Rick Holler",
      "emergency_contact_phone": "",
      "emergency_contact_address": "",
      "prev_LastName": "",
      "prev_FirstName": "ALICIA",
      "visitdate": "20150622",
      "oPhone": "",
      "roles": "",
      "pRole": "",
      "granular": "White European",
      "race2": "2108-9"
    }
  ],
  "table1": [
    {
      "id": 6,
      "patient_ID": 234800,
      "eventid": 828414,
      "deviceName": "Cardiac resynchronization therapy implantable pacemaker",
      "area": "Structure of subclavian vein",
      "manufacturer": "MEDTRONIC, INC.",
      "deviceID": "00643169007222",
      "version": "DTBA1QQ",
      "serialNumber": "",
      "lot": "(01)00643169007222(17)160128(21)BLC200461H",
      "snomed": "704708004",
      "snomedCtName": "Cardiac resynchronization therapy implantable pacemaker",
      "procedureDate": "09/27/2019",
      "provider": 602,
      "created_Date": "2019-09-27T07:20:21.99",
      "created_By": 1,
      "isDeleted": null,
      "modified_Date": "2019-09-27T08:18:27.86",
      "modified_By": 1,
      "staff_id": 602,
      "staff_title": "Dr",
      "first_name": "Albert",
      "last_name": "Davis",
      "mid_name": "",
      "creds": "",
      "dob": "2019-08-26T18:36:00",
      "age": null,
      "sex": "Male",
      "ssn": "",
      "address1": "2472 Rocky place",
      "address2": "Rocky place",
      "city": "Beaverton",
      "state": "or",
      "zip": "97006",
      "home_phone_area": null,
      "home_phone": "(555)555-1002",
      "work_phone_area": null,
      "work_phone": "",
      "work_phone_ext": "",
      "cell_phone_area": null,
      "cell_phone": "",
      "pager_area": null,
      "pager": "",
      "email": "",
      "sys_user": true,
      "hascalendar": false,
      "username": "ADavis",
      "passwordhash": "F0311A3F6415FC05114318B973BB23A52968ADAD",
      "salt": "ErI6Iqrb",
      "created_date1": "2019-08-26T18:36:00",
      "created_user": 1,
      "modified_date1": "2019-08-26T18:36:00",
      "modified_user": 2,
      "isactive": true,
      "office": "ALL",
      "fax": null,
      "npi": null,
      "upin": null,
      "blueid": null,
      "hL7_PV1_F7_C1_DOC_Abbrev": null,
      "license_YN": null,
      "initials": null,
      "emac": null,
      "alias": null,
      "encryptionKey": null,
      "phraseToEncrypt": null,
      "clientId": null,
      "singleSignOnCode": null,
      "userId": null,
      "singleSignOnUserIdVerify": null,
      "singlrSignOnXML": null,
      "logSingleSignOn": true,
      "clinic_Key": null,
      "license_Key": null,
      "passwordExpireDate": null,
      "useremail_hash": null,
      "isViewOnly": false,
      "vendor_id": null,
      "providerID": "Provider11",
      "spi": null,
      "service_Level": null,
      "clinic_Name": "Get Well Clinic",
      "dea": null
    }
  ]
}

assessment - This section returns the patient's care team members via the assessment data category.

Request Example

JSON Request Data :

                                {
                                PracticeName: "Inpracsys",
                                DataCategory: "assessment",
	                            PatientMRN: "XAANDL234800",
	                            PatientFirstName: "alice",
	                            PatientLastName : "newman",
	                            PatientDateOfBirth: "05/01/1970",
	                            PatientSex: "Female",
	                            StartDate : "06/21/2015",
	                            EndDate :"",
                                }
                            

Response Example


      "spouse": "Matthew Newman",
      "spouse_phone": "",
      "parent": "",
      "parent_phone": "",
      "emergency_contact": "Mr Rick Holler",
      "emergency_contact_phone": "",
      "emergency_contact_address": "",
      "prev_LastName": "",
      "prev_FirstName": "ALICIA",
      "visitdate": "20150622",
      "oPhone": "",
      "roles": "",
      "pRole": "",
      "granular": "White European",
      "race2": "2108-9"
    }
  ],
  "table1": [
    {
      "assessment": "Assessment and Plan:The patient was found to have fever and Dr Davis is suspecting Anemia based on the patient history. 
        So Dr Davis asked the patient to closely monitor the temperature and blood pressure and get admitted to Community Health 
        Hospitals if the fever does not subside within a day. 1. Get an EKG done on 6/23/2015. 2. Get a Chest X-Ray done on 6/23/2015 
showing the Lower Respiratory Tract Structure. 3. Take ClindAmycin 300mg three times a day as needed if pain does not subside 4.
     Schedule follow on visit with Neighborhood Physicians Practice on 7/1/2015 
    Office contact: Tracy Davis, Address: 2471, Rocky place, Beaverton, OR-97006. Tel: 555-555-1002"
    }
  ]
}

treatmentplan - This section returns all the goals advised to the patient via the treatment plan data category.

Request Example

JSON Request Data :

                                {
                                 	PracticeName: "Inpracsys",
                                    DataCategory: "treatmentplan",
	                                PatientMRN: "XAANDL234800",
	                                PatientFirstName: "alice",
	                                PatientLastName : "newman",
	                                PatientDateOfBirth: "05/01/1970",
	                                PatientSex: "Female",
	                                StartDate : "06/21/2015",
	                                EndDate :"",
                                }
                            

Response Example

{
  "table": [
    {
      "first_name": "ALICE",
      "last_name": "NEWMAN",
      "mid_name": "JONES",
      "ssn": "111201111",
      "dob": "19700501",
      "sex": "Female",
      "marital_status": "UNK",
      "maritalStatus_Code": "UNK",
      "race": "White",
      "suffix": "",
      "raceMnemonic": "2106-3",
      "ehnicityName": "Not Hispanic or Latino",
      "ethnicGroupCode": "2186-5",
      "language": "English",
      "languageCode": "en-US",
      "address1": "1357, AMBER DR",
      "address2": "",
      "city": "BEAVERTON",
      "state": "or",
      "zip": "97006",
      "ssn1": "",
      "mrn": "xaanDL234800",
      "home_Phone": "(555)-723-1544",
      "cell_Phone": "(555)-777-1234",
      "work_Phone": "UNK",
      "work_phone_ext": "",
      "spouse": "Matthew Newman",
      "spouse_phone": "",
      "parent": "",
      "parent_phone": "",
      "emergency_contact": "Mr Rick Holler",
      "emergency_contact_phone": "",
      "emergency_contact_address": "",
      "prev_LastName": "",
      "prev_FirstName": "ALICIA",
      "visitdate": "20150622",
      "oPhone": "",
      "roles": "",
      "pRole": "",
      "granular": "White European",
      "race2": "2108-9"
    }
  ],
  "table1": [
    {
      "investigations_name": "Get an EKG done on 20190830",
      "plann": "EKG",
      "code": "34534-8",
      "codeSystemName": "LOINC",
      "startdate": "06/23/2015",
      "inv_group": "Others",
      "short": 1
    },
    {
      "investigations_name": "Urinanalysis macro (dipstick) panel",
      "plann": "Urinanalysis macro (dipstick) panel",
      "code": "24357-6",
      "codeSystemName": "LOINC",
      "startdate": "06/22/2015",
      "inv_group": "Urine",
      "short": 1
    },
    {
      "investigations_name": "Urinanalysis macro (dipstick) panel",
      "plann": "Urinanalysis macro (dipstick) panel",
      "code": "24357-6",
      "codeSystemName": "LOINC",
      "startdate": "06/29/2015",
      "inv_group": "Urine",
      "short": 1
    },
    {
      "investigations_name": "Get a Chest X-ray done on 20190830 showing the Lower Respiratory Tract Structure.",
      "plann": "Chest X-ray",
      "code": "168731009",
      "codeSystemName": "SNOMED-CT",
      "startdate": "06/23/2015",
      "inv_group": "X-Ray",
      "short": 2
    }
  ],
  "table2": [
    {
      "investigations_name": "Clindamycin 300 MG Oral Capsule",
      "code": "284215",
      "codeSystemName": "RxNorm",
      "instruction": "Take Clindamycin 300mg three times a day as needed if pain does not subside.",
      "startdate": "20190923",
      "plann": "Clindamycin 300 MG Oral Capsule 300 mg"
    }
  ],
  "table3": [
    {
      "investigations_name": "consultation",
      "plann": "Schedule follow on visit with Neighborhood Physicians Practice on 7/1/2015",
      "code": "11429006",
      "codeSystemName": "SNOMED CT",
      "startdate": "08/30/2019",
      "inv_group": "consultation",
      "short": 5
    }
  ]
}

careplan - This section returns all the patient's current assessments via the care plan data category.

Request Example

JSON Request Data :

                                {
                                PracticeName: "Inpracsys",
                                DataCategory: "careplan",
	                            PatientMRN: "XAANDL234800",
	                            PatientFirstName: "alice",
	                            PatientLastName : "newman",
	                            PatientDateOfBirth: "05/01/1970",
	                            PatientSex: "Female",
	                            StartDate : "06/21/2015",
	                            EndDate :"",
                                }
                            

Response Example

{
  "table": [
    {
      "first_name": "ALICE",
      "last_name": "NEWMAN",
      "mid_name": "JONES",
      "ssn": "111201111",
      "dob": "19700501",
      "sex": "Female",
      "marital_status": "UNK",
      "maritalStatus_Code": "UNK",
      "race": "White",
      "suffix": "",
      "raceMnemonic": "2106-3",
      "ehnicityName": "Not Hispanic or Latino",
      "ethnicGroupCode": "2186-5",
      "language": "English",
      "languageCode": "en-US",
      "address1": "1357, AMBER DR",
      "address2": "",
      "city": "BEAVERTON",
      "state": "or",
      "zip": "97006",
      "ssn1": "",
      "mrn": "xaanDL234800",
      "home_Phone": "(555)-723-1544",
      "cell_Phone": "(555)-777-1234",
      "work_Phone": "UNK",
      "work_phone_ext": "",
      "spouse": "Matthew Newman",
      "spouse_phone": "",
      "parent": "",
      "parent_phone": "",
      "emergency_contact": "Mr Rick Holler",
      "emergency_contact_phone": "",
      "emergency_contact_address": "",
      "prev_LastName": "",
      "prev_FirstName": "ALICIA",
      "visitdate": "20150622",
      "oPhone": "",
      "roles": "",
      "pRole": "",
      "granular": "White European",
      "race2": "2108-9"
    }
  ]
}

Health Concern - This section returns the patient's lab orders via the health concern data category.

Request Example

JSON Request Data :

                                {
                                 	PracticeName: "Inpracsys",
                                    DataCategory: "healthconcern",
	                                PatientMRN: "XAANDL234800",
	                                PatientFirstName: "alice",
	                                PatientLastName : "newman",
	                                PatientDateOfBirth: "05/01/1970",
	                                PatientSex: "Female",
	                                StartDate : "06/21/2015",
	                                EndDate :"",
                                }
                            

Response Example

{
  "table": [
    {
      "first_name": "ALICE",
      "last_name": "NEWMAN",
      "mid_name": "JONES",
      "ssn": "111201111",
      "dob": "19700501",
      "sex": "Female",
      "marital_status": "UNK",
      "maritalStatus_Code": "UNK",
      "race": "White",
      "suffix": "",
      "raceMnemonic": "2106-3",
      "ehnicityName": "Not Hispanic or Latino",
      "ethnicGroupCode": "2186-5",
      "language": "English",
      "languageCode": "en-US",
      "address1": "1357, AMBER DR",
      "address2": "",
      "city": "BEAVERTON",
      "state": "or",
      "zip": "97006",
      "ssn1": "",
      "mrn": "xaanDL234800",
      "home_Phone": "(555)-723-1544",
      "cell_Phone": "(555)-777-1234",
      "work_Phone": "UNK",
      "work_phone_ext": "",
      "spouse": "Matthew Newman",
      "spouse_phone": "",
      "parent": "",
      "parent_phone": "",
      "emergency_contact": "Mr Rick Holler",
      "emergency_contact_phone": "",
      "emergency_contact_address": "",
      "prev_LastName": "",
      "prev_FirstName": "ALICIA",
      "visitdate": "20150622",
      "oPhone": "",
      "roles": "",
      "pRole": "",
      "granular": "White European",
      "race2": "2108-9"
    }
  ],
  "table1": [
    {
      "concern": "Documented HyperTension problem",
      "dates": "Sep 23, 2019",
      "snomedCT": "161901003"
    },
    {
      "concern": "Documented HypoThyroidism problem",
      "dates": "Sep 23, 2019",
      "snomedCT": "161901003"
    },
    {
      "concern": "Watch Weight of patient",
      "dates": "Sep 23, 2019",
      "snomedCT": "161901003"
    },
    {
      "concern": "Chronic Sickness exhibited by patient",
      "dates": "Sep 23, 2019",
      "snomedCT": "161901003"
    }
  ],
  "table2": [
    {
      "snomedCT": "161901003",
      "dates": "Sep 23, 2019",
      "observation": "Chronic Sickness exhibited by patient"
    }
  ]
}

List of exceptions and exception handling methods and messages.



Severity Exception
Content: 
{
message: "The user or system was not able to be authenticated"
}
Reason Invalid or empty client id or if there is no linkup with requested practice 
Severity Exception
Content: 
{
message: "Authorization has been denied for this request."
}
Reason Incase of invalid “token” 
Requested patient not found
Severity Exception
Content: 
{
message: "Patient not found"                                                          
}
Reason Incorrect PatientMRN, PatientFirstName, PatientLastName, PatientRace, PatientZip 
Severity Exception
Severity Exception
Content: 
{
message: "Missing input values."
}
Reason Null or Empty DataCategory or StartDate or PatientMRN or PatientFirstName or PatientLastName or PatientLastName or PatientRace or PatientZip
The request contains invalid data for Start Date or End Date
Severity Exception
Content: 
{ 
message: "The request contains invalid data for Start Date, End Date"
}
Reason Incorrect or invalid start date or end date or section requested
Start date should not be greater than end date
Severity Exception
Code: 
{
message: "Start date should not be greater than end date"
}
Reason If start date is greater than end date of the requested filters