API ChartModules
Version Added: 21.4
Gets the Progress Notes for a patient, similarly to how it shows in the Chart Module. Use another API method or a query to get specific details about each object.
PatNum: Required in the URL.
Returned fields are detailed below:
ObjectType: The type of object being displayed: Appointment, Commlog, Task, Email, LabCase, Rx, or Sheet.Example Request:
GET /chartmodules/13/ProgNotes
GET /chartmodules/13/ProgNotes?Offset=100
Example Response:
[
{
"ObjectType": "Appointment",
"PrimaryKey": "147",
"Date": "12/21/2021",
"Time": "11:40a",
"DateTime": "12/21/2021 11:40:00 AM",
"Th": "",
"Surf": "",
"Dx": "",
"Description": "Appointment - 11:40 AM PA",
"note": "",
"Stat": "",
"Prov": "",
"ProvNum": "",
"Amount": "",
"ProcCode": "",
"User": "",
"Signed": "",
"Length": "0:10",
"Abbr": "",
"Clinic": "",
"ClinicNum": "3"
},
{
"ObjectType": "Procedure",
"PrimaryKey": "153",
"Date": "12/21/2021",
"Time": "",
"DateTime": "12/21/2021 12:00:00 AM",
"Th": "",
"Surf": "",
"Dx": "",
"Description": "PA",
"note": "",
"Stat": "TP",
"Prov": "Doc3",
"ProvNum": "10",
"Amount": "24.00",
"ProcCode": "D0220",
"User": "",
"Signed": "",
"Length": "",
"Abbr": "PA",
"Clinic": "Downtown Office",
"ClinicNum": "3"
},
{
"ObjectType": "Commlog",
"PrimaryKey": "122",
"Date": "02/08/2022",
"Time": "3:18p",
"DateTime": "2/8/2022 3:18:00 PM",
"Th": "",
"Surf": "",
"Dx": "",
"Description": "Comm - ApptRelated",
"note": "Confirmed upcoming appointment. Asked to arrive 15 minutes early for paperwork.",
"Stat": "",
"Prov": "",
"ProvNum": "",
"Amount": "",
"ProcCode": "",
"User": "Admin",
"Signed": "Signed",
"Length": "",
"Abbr": "",
"Clinic": "",
"ClinicNum": "0"
},
{
"ObjectType": "Task",
"PrimaryKey": "52",
"Date": "2/8/2022",
"Time": "3:25p",
"DateTime": "2/8/2022 3:25:56 PM",
"Th": "",
"Surf": "",
"Dx": "",
"Description": "Task - In List: People that will need a 1099",
"note": "Admin - Example Task Description ==Admin - 2/8/2022 3:26 PM - Notes on the task.",
"Stat": "",
"Prov": "",
"ProvNum": "",
"Amount": "",
"ProcCode": "",
"User": "",
"Signed": "",
"Length": "",
"Abbr": "",
"Clinic": "",
"ClinicNum": "0"
},
{
"ObjectType": "Email",
"PrimaryKey": "212",
"Date": "02/08/2022",
"Time": "3:22p",
"DateTime": "2/8/2022 3:22:27 PM",
"Th": "",
"Surf": "",
"Dx": "",
"Description": "Email - (unsent) Spring Newsletter",
"note": " With warmer weather upon us...",
"Stat": "",
"Prov": "",
"ProvNum": "",
"Amount": "",
"ProcCode": "",
"User": "Admin",
"Signed": "",
"Length": "",
"Abbr": "",
"Clinic": "",
"ClinicNum": "0"
},
{
"ObjectType": "Rx",
"PrimaryKey": "81",
"Date": "02/08/2022",
"Time": "",
"DateTime": "2/8/2022 12:00:00 AM",
"Th": "",
"Surf": "",
"Dx": "",
"Description": "Rx - Cephalexin 500 mg - #40 Walmart Lancaster",
"note": "",
"Stat": "",
"Prov": "HYG1",
"ProvNum": "2",
"Amount": "",
"ProcCode": "",
"User": "",
"Signed": "",
"Length": "",
"Abbr": "",
"Clinic": "",
"ClinicNum": "0"
},
{
"ObjectType": "Sheet",
"PrimaryKey": "37",
"Date": "02/08/2022",
"Time": "3:27p",
"DateTime": "2/8/2022 3:27:00 PM",
"Th": "",
"Surf": "",
"Dx": "",
"Description": "PatientLetter",
"note": "",
"Stat": "",
"Prov": "",
"ProvNum": "",
"Amount": "",
"ProcCode": "",
"User": "",
"Signed": "",
"Length": "",
"Abbr": "",
"Clinic": "",
"ClinicNum": "0"
},
etc...
]
200 OK
404 Not Found ("Patient not found")
Version Added: 22.1
Gets Patient Info for a patient, similarly to how it shows in the Chart Module. Use another API method or a query to get specific details about returned elements.
PatNum: Required in the URL.
Returned field types are detailed below:
Age: The age of the patient.Example Request:
GET /chartmodules/15/PatientInfo
Example Response:
[
{
"Field": "Age",
"Content": "42"
},
{
"Field": "ABC0",
"Content": ""
},
{
"Field": "Billing Type",
"Content": "Standard Account"
},
{
"Field": "Referred From",
"Content": ""
},
{
"Field": "Date First Visit",
"Content": "4/30/2009"
},
{
"Field": "Prov. (Pri, Sec)",
"Content": "DOC 1, HYG 1"
},
{
"Field": "Pri Ins",
"Content": "Metlife"
},
{
"Field": "Sec Ins",
"Content": ""
},
{
"Field": "Payor Types",
"Content": ""
},
{
"Field": "Problem - Diabetes",
"Content": "Type 2"
},
{
"Field": "Problem - High Blood Pressure",
"Content": ""
},
{
"Field": "Med Urgent",
"Content": ""
},
{
"Field": "Medical Summary",
"Content": ""
},
{
"Field": "Service Notes",
"Content": ""
},
{
"Field": "Medication - Acetaminophen(Aspirin)",
"Content": "One in the morning, one at night"
},
{
"Field": "Allergy - Latex",
"Content": "Induces itching"
},
{
"Field": "Pat Restrictions",
"Content": "None"
}
]