0% found this document useful (0 votes)

7 views99 pages

Feature - API Document - Latest

Uploaded by

Waseem Mushtaq

We take content rights seriously. If you suspect this is your content, claim it here.

Available Formats

Download as PDF, TXT or read online on Scribd

0% found this document useful (0 votes)

7 views99 pages

Feature - API Document - Latest

Uploaded by

Waseem Mushtaq

We take content rights seriously. If you suspect this is your content, claim it here.

Available Formats

Download as PDF, TXT or read online on Scribd

You are on page 1/ 99

API DOCUMENT

Version No: Denali 3.1B2

Feature - API Document

TABLE OF CONTENTS

1. Introduction .............................................................................................................................. 5
2. Authentication API .................................................................................................................... 5
3. Patient Demographics API ........................................................................................................ 6
3.1. Patient Registration and Updation API ............................................................................ 6
3.2. Search Patients API ........................................................................................................ 16
4. Patient Insurance API .............................................................................................................. 19
4.1. Insurance Master Search API ......................................................................................... 19
4.2. Search Patient Insurance API ......................................................................................... 21
4.3. Add Patient Insurance API.............................................................................................. 22
4.4. Update Patient Insurance API ........................................................................................ 26
5. Patient Appointments API ...................................................................................................... 26
5.1. Location Search API ........................................................................................................ 26
5.2. Medics/Provider Search API........................................................................................... 28
5.3. Encounter/visit Type Search API .................................................................................... 30
5.4. Available appointment slots API .................................................................................... 31
5.5. Add Appointment API .................................................................................................... 34
5.6. Update Appointment API ............................................................................................... 35
5.7. Delete Appointment API ................................................................................................ 37
6. Patient Document List API ...................................................................................................... 38
6.1. Patient Document List GET API ...................................................................................... 38
6.2. Patient Document List DELETE API................................................................................. 41
6.3. Patient Document List Upload API ................................................................................. 42
6.4. Patient Document List Download API ............................................................................ 43
7. Patient Alert API ...................................................................................................................... 44
7.1. Add/Update Patient Alerts API44
7.2. Search/Delete Patient Alerts API .................................................................................. 45
8. Charge Import API ................................................................................................................... 47
9. Insurance Adjuster Master API ............................................................................................... 48
9.1. Insurance Adjuster GET API............................................................................................ 48

9.2. Insurance Adjuster POST API ......................................................................................... 50

9.3. Insurance Adjuster Update API ...................................................................................... 51
10. Attorney Master API ............................................................................................................... 52
10.1. Attorney GET API .......................................................................................................... 52
10.2. Attorney POST API........................................................................................................ 54
10.3. Attorney Update API .................................................................................................... 55
11. Case Management Master API ............................................................................................... 56
11.1. Case Management GET API .......................................................................................... 57
11.2. Case Management POST API59
11.3. Case Management Update API .................................................................................... 61
12. Assessment API ....................................................................................................................... 62
12.1. Assessment POST API ................................................................................................... 62
12.2. Assessment GET API ..................................................................................................... 65
13. Employer API ........................................................................................................................... 66
13.1. Employer GET API......................................................................................................... 66
13.2. Employer POST API....................................................................................................... 68
13.3. Employer Update API ................................................................................................... 70
13.4. Employer Delete API .................................................................................................... 71
14. Patient Encounter API ............................................................................................................. 71
14.1. Encounter GET API ....................................................................................................... 71
14.2. Encounter POST API ..................................................................................................... 73
14.3. Encounter Update API .................................................................................................. 74
15. Patient RFA API ....................................................................................................................... 75
15.1. RFA GET API .................................................................................................................. 75
15.2. RFA POST API ................................................................................................................ 77
16. Insurance Preauth API............................................................................................................. 78
16.1.Preauth GET API .............................................................................................................. 78
16.2. Preauth Post API79
16.3. Preauth Update API...................................................................................................... 80
17. Ordersheet API ........................................................................................................................ 81
17.1. Ordersheet GET API...................................................................................................... 81

17.2. Ordersheet Post API ..................................................................................................... 83

17.3. Ordersheet Test Get API .............................................................................................. 84
17.4. Patient Types Get API ................................................................................................... 87
17.5. Patient Recipient Get API88
18. Group types API ...................................................................................................................... 89
18.1. Group Types Get API .................................................................................................... 89
19. Templates API ......................................................................................................................... 91
19.1. Templates Get API ........................................................................................................ 91
20. Case Medical Provider Network API ....................................................................................... 92
20.1 Case Medical Provider Network Get API...................................................................... 92
21. Case Manager API ................................................................................................................... 94
21.1. Case Manager Get API94
21.2. Case Manager Post API ................................................................................................ 95
21.3. Case Manager Update API ........................................................................................... 97
22. Complaints API ........................................................................................................................ 98
22.1. Complaints Get API ...................................................................................................... 98

1. INTRODUCTION
This document covers the details of various APIs supported by Bizmatics for PrognoCIS EHR
and Practice Management products.
The APIs covered in this document include:
• Patient Demographics - Search/Add/Update
• Patient Insurance - Search/Add/Update
• Appointment - Search/Add/Update
• Document List - Search Patient
• Patient Alert - Search/Add/Update
• Import Charge

2. AUTHENTICATION API
HTTP Method POST
End Point:
https://{Clinic_Url}/prognocis/apis/{poolname}/authenticate
HTTP Headers
x_api_key: B!2M@T!CS
HTTP Status Code, Error/Success Codes and Error/Success Messages
Response JSON :
{
"jwt": {JWT KEY}
}

Put this Key in HTTP Headers

Token : Bearer JWT KEY
In All APis

3. PATIENT DEMOGRAPHICS API

3.1. PATIENT REGISTRATION AND UPDATION API

Patient Registration HTTP Method POST

https://{Clinic_Url}/prognocis/apis/{poolname}/patients
Request Parameters:

Required(R)/
Param Name Data Type Description
Optional(O)
Unique Patient Id at vendor side. This will
patient_ext_id O String be used as Patient Matching Criteria.
Patient External ID.
first_name R String Patient's First Name
last_name R String Patient's Last Name
middle_name O String Patient’s Middle Name
Patient's Gender. Possible values are M /
gender R String
F / U.
date_of_birth R Date Patient’s Date of Birth (non-mandatory)
Patient’s Email. (login credentials won't
email_address O String
be sent if email is blank)
This parameter value populates the Home Tel
phone_number O String
field in Prognocis
This parameter value populates the Cell
tel_cell O String Phone field in Prognocis

This parameter value populates the Work

String Tel.1 field in Prognocis
tel_work1 O

This parameter value populates the Work

String
tel_work2 O Tel.2 field in prognocis

address_line1 Patient address_line1

R String
address_line2 O String Patient address_line2
city O String Patient City
Patient state should use the two-
state R String
character (i.e AL,NYtu) USA state suffix

If not sent, we will consider as USA. And

country O String other than USA is received then it will be
considered as Non-US.
All characters should be number
zip1 R String
All characters should be number
zip2 O String

Please ensure that the UdfType field

Udf_Type R String is set to 'patient' in the request
for the Add Patient API.
Is the 'udf' field a Json Object,
which is an optional parameter?
When passing it, should it be in
udf O object
list format, including text,
number, fraction, date Time,
etc.
udf-text1 O String Strict mapping with configuration
udf-text2 O String Strict mapping with configuration
Strict mapping with configuration.
udf-date1 O String Date format MM-DD-YYYY

Strict mapping with configuration.

udf-date2 O String Date format MM-DD-YYYY

All characters should be number

Udf_number1 O integer
All characters should be number
Udf_number2 O Integer

All character should be Double for

Udf_ fraction1 O Double ex:45.05 , 2.56,etc

All character should be Double for

Udf_ fraction2 O Double ex:45.05 , 2.56,etc

All characters should be number

Amount1 O integer
All characters should be number
Amount2 O integer

Strict mapping with configuration.

dateTime1 0 String Date format MM-DD-YYYY
Ex :04-30-2024 02:06:00
Strict mapping with configuration.
dateTime2 0 String Date format MM-DD-YYYY
Ex :04-30-2024 02:06:00
Notes1 O String All character should be String
All character should be String
Notes2 O String
If sent it’ll add Provider in FrontEnd,
provider_id
O Integer else it’ll set Default provider from
property file

Note:

• Street, City, Zip1 and State are mandatory fields to add address while registering patient.
If these fields are not present, we will register a patient but won’t add address and
appropriate information will be sent in response.
• Allow text messages on cell phone is not implemented via API i.e. the Allow text messages
on cellphone checkbox remains unchecked by default.

Request JSON:
{
"first_name": "Nilesh",
"middle_name": "",
"last_name": "UniqueFemale",
"gender": "F",
"date_of_birth": "1987-08-21",
"phone_number": "3111111111",
"email_address": "[email protected]",
"pat_type": 0,
"provider_id": 41702,
"city": "Birmingham",

"address_line1": "St Lane",

"address_line2": "Opp George Street",
"state": "AL",
"country": "USA",
"zip1": "35211",
"zip2": "",
"provider_id": 238,
"Udf_Type": "Patient",
"udf": {
"text": [
"MyUDF Text8",
"MyUDF Text7",
"MyUDF Text9",
"MyUDF Text10",
"MyUDF Text11"
],
"num": [
1,
2,
3,
4
],
"date": ["05-10-2024 ",
"05-12-2024 ",
"05-28-2024 ",
"06-07-2024"
]
}

Response JSON:
e.g :

"response_codes": [

"response_code": 210,

"response_message": "Thank you! Your enrollment form has been successfully

submitted. You will receive an email and a text message with your login
credentials."

"patient_chart_no": "SCL010004946"

Patient Updation HTTP Method PUT

https://{Clinic_Url}/prognocis/apis/{poolname}/patients
Request JSON:
{
"patient_id ":12345,
"first_name": "Ajay",
"middle_name": "",
"last_name": "Unique_Male",
"gender": "M”

"date_of_birth": "1994-08-21",
"phone_number": "3111111111",
"email_address": "[email protected]",
"pat_type": 0,
"provider_id": 41702,
"city": "Birmingham",
"address_line1": "St Lane",
"address_line2": "Opp George Street",
"state": "NY",
"country": "USA",
"zip1": "35211",
"zip2": "",
"Udf_Type":"Patient",
"udf":
{
"text": [
"MyUDF Text1",
"MyUDF Text2",
"MyUDF Text3",
"MyUDF Text4",
"MyUDF Text5",
""
],
"num": [
1,
2

],
"fraction": [
1.06,
2.56,
5.06
],
"dateTime": [
"04-30-2024 02:06:00",
"05-01-2024 00:00:00"
],
"date": [
"04-30-2024 ",
"05-01-2024"
],
"amount": [
25,
100,
55,
56
]
}
}
Response JSON :
e.g :
{
"response_code": 209,

"response_message": "Patient Updated Successfully."

}
Request Params Details:

Required(R)/
Param Name Data Type Description
Optional(O)
Unique Patient Id at vendor side. This will
patient_ext_id O String be used as Patient Matching Criteria.
Patient External ID.
first_name R String Patient's First Name
last_name R String Patient's Last Name
middle_name O String Patient’s Middle Name
Patient's Gender. Possible values are M /
gender R String
F / U.
date_of_birth R Date Patient’s Date of Birth (non-mandatory)
provider_id All characters should be number
O Integer
Patient’s Email. (login credentials won't
email_address R String
be sent if email is blank)
phone_number O String Patient’s Tel. Cell Phone
pat_type R Integer All characters should be number

HTTP Status Code, Error/Success Codes and Error/Success Messages:

Error/Success
HTTP Status Code Error/Success Message
Code
If only one param says first name or last
208 400
name is sent, then.

209 200 Patient Updated Successfully.

Thank you! Your enrollment form has been

successfully submitted. You will receive an
210 200
email and a text message with your login
credentials.

Patient has been added successfully,

211 206 Partial Content however, failed to send login credentials via
email. Since email is not valid.

Invalid DOB. It should be in yyyy-MM-dd

213 400
format.

Invalid DOB. DOB should be the current date

214 400 Bad Request
or less.

215 400 Max 35 characters are allowed in First Name.

Max 35 characters are allowed in Middle

216 400
Name

217 400 Max 60 characters are allowed in Last Name.

218 400 Invalid Gender.

219 400 Invalid Phone Number.

220 400 patient_ext_id is mandatory.

221 400 First Name is mandatory.

222 400 Last Name is mandatory.

223 400 Middle Name is mandatory

224 400 Gender is mandatory

225 400 Date of birth is mandatory.

227 400 Phone Number is mandatory

226 400 Email address is mandatory.

Minimum 2 characters are required in the

228 400
first name.
Minimum 2 characters are required in the
229 400
last name.

232 400 Patient already exit with patient external id

233 400 Patient not exist with given patient id

No Patient Information provided for

234 400
updation.

Minimum 2 characters are required in the

235 400
patient type name.

Minimum 2 characters are required in the

236 400
patient type code.

Patient has been added successfully,

however, failed to send login credentials via
237 206 Partial Content
email. Since email is not valid (Duplicate
Entry). with First Name, Last Name, and DOB.

Thank you! Your enrollment form has been

successfully submitted. You will receive an
238 200
email and a text message with your login
credentials (Duplicate Entry).
239 400 Patient Alert not Added
Address Details Not Added. Please Check
240 200/206 value of Fields: street/address1, city, zip
code, state.
200 Patient Alert Added Successfully
1)patient_ext_id lenght should be upto 20
chars.
111 400
2)Invalid Field. patient_ext_id should be
unique
107 403Forbidden Processing error. Please contact support.
112 400 Unrecognized field

3.2. SEARCH PATIENTS API

This endpoint is used to search for patients based on First Name, Last Name, Email etc.
HTTP Method GET
https://{Clinic_Url}/prognocis/apis/{poolname}/patients

Request Parameters:
Request:
{
"first_name":"John",
"last_name":"Dummy",
"date_of_birth":"1987-08-19",
"Phone_number":"1234567",
"email_address":"[email protected]"
"gender":"M"
© Copyright 2024, Bizmatics, Inc. 2429 Military Road, Suite 300, Niagara Falls, NY 14304
16
Feature - API Document

"pat_type": 34748,
"patient_chart_no": "SCL010004921",
"patient_ext_id": "Test025123"
}
This will return a List of Matching Patients.

Response:

"totalRecords": 1,

"pageNumber": 1,

"numberOfRecords": 1,

"totalPages": 1,

"content": [

"email": "",

"patient_ext_id": "EXT123",

"first_name": "Jane",

"middle_name": "",

"last_name": "Doe",

"gender": "F",

"date_of_birth": "1982-01-01",

"phone_number": "",

"email_address": "",

"pat_type": 0,

"patient_chart_no": "SCL24528",

"patient_id": 210767,

"provider_id": 41702,

"status": "AC"

Returns 100 records in one response. If there are more than 100 records, then it returns next
page indicator.
First lists exact match and remaining records after that.
Note: A provider_id in Response section has been added in the Search Patients API.

Request Params Details:

Required(R)/
Param Name Data Type Description
Optional(O)
Patients First Name (At least 2
first_name O String
characters required)
Patients Last Name (At least 2
last_name O String characters required)

Patients Gender
gender O String
date_of_birth O Date Patients Date of Birth
email_address O String Patients Email.
phone_number O String Patients Tel. Cell Phone

HTTP Status Code, Error/Success Codes and Error/Success Messages:

Error/Success Code HTTP Status Code Error/Success Message

200 Return matching result
213 400 Invalid DOB. It should be in yyyy-MM-dd format.
Minimum 2 characters are required in the first
228 400
name.

Minimum 2 characters are required in the last

229 400
name
112 400 Unrecognized field
110 200 No record found
107 403Forbidden Processing error. Please contact support.

4. PATIENT INSURANCE API

To add/update patient Insurance an insurance master id is required.

4.1. INSURANCE MASTER SEARCH API

HTTP Method GET
https://{clinic_url}/prognocis/apis/{poolname}/insurance/search
{
"insurance_id": 1234,
"company_name": "Third Party Insurance",
"ext_id": "SSS",
"carrier": "IMA35",
"AR_group_name": "Commercial",
"claim_filing_code": "CI",
"address_line1": "PO BOX 5240",
"address_line2": "",
"city": "Kingston",
"state": "New York",
"zip_code": "12345"
}

Response JSON
[
{
"insurance_id": 318,
"company_name": " Third Party Insurance ",
"carrier": "SSS",
"ext_id": "IMA35",
"main_insurance": "",
"AR_group_name": "Commercial",

"claim_filing_code": "CI",
"claim_filing_name": " Third Party Insurance ",
"address_line1": "PO BOX 5645",
"address_line2": "",
"city": "Kingston",
"state": "New York",
"zip_code": "12345"
}
]

Request Params Details:

Required(R)/
Param Name Data Type Description
Optional(O)
insurance_id O numeric Patients Insurance Id
Patients First Name (At least 2
company_name O String
characters required)
Patients Last Name (At least 2
address_line1 O String
characters required)
address_line2 O String Patients Gender
city O Date Patients Date of Birth
state O String Patients Email.
zip_code O numeric Patients Tel. Cell Phone

HTTP Status Code, Error/Success Codes and Error/Success Messages:

Error/Success HTTP Status

Error/Success Message
Code Code
200 Return matching result
112 400 Unrecognized field
602 200 Insurance Record is not found
605 200 Minimum 2 characters are required in Address Line 1
Minimum 2 characters are required in the company
609 200
name
610 200 Minimum 2 characters are required in Address Line 2
107 403 Processing error. Please contact support.

4.2. SEARCH PATIENT INSURANCE API

HTTP Method GET
https://{clinic_url}/prognocis/apis/{poolname}/patients/insurance
Request JSON
{
"patient_id": 117,
"subscriber_id": "ASDFASDFASDF"
}

Response JSON
[
{
"patient_insurance_id": 18,
"insurance_name": "Gallagher Bassett",
"plan_type": "CHAMP",
"plan_name": "PNAME",
"group_no": "G02",
"group_name": "GNAME",
"subscriber_id": "4564645",
"start_date": "2021-01-01 00:00:00.0",
"expiry_date": "2021-12-12 00:00:00.0",
"status": "1"
}
]

Request Details:

Required(R)/
Param Name Data Type Description
Optional(O)
Patients First Name (At least 2
company_name O String
character required)
Patients Last Name (At least 2
address_line1 O String
character required)
address_line2 O String Patients Gender
patient_id R numeric All character Should be number.
Patients' subscriber_id
subscriber_id O String

Response Codes:

Error/Success Code HTTP Status Code Error/Success Message

200 Return matching result
112 400 Unrecognized field
602 200 Insurance Record is not found
605 200 Minimum 2 characters are required in Address Line 1
Minimum 2 characters are required in the company
609 200
name
610 200 Minimum 2 characters are required in Address Line 2
-103 200 Processing error. Please contact support.

4.3. ADD PATIENT INSURANCE API

HTTP Method POST
https://{clinic_url}/prognocis/apis/{poolname}/patients/insurance
{
"patient_id": 2,
"master_insurance_id": 3,
"insurance_external_id": "",
"patient_insurance_type": "MEDICARE",

"plan_no": "P564",
"plan_name": "PNAME",
"group_no": "G020",
"group_name": "GNAME",
"subscriber_id": "214564645",
"start_date": "2021-01-01",
"expiry_date": "2021-12-15",
"status": "1",
"subs_relation": "Parent",
"subs_fname": "",
"subs_mname": "",
"subs_lname": "",
"subs_dob": "",
"subs_add_line1": "AAA",
"subs_add_line2": "BBB",
"subs_add_city": "CCC",
"subs_add_state": "",
"subs_add_zip": "1452",
"subs_add_zip2": "1235",
"copay" : 1,
"classified_as":99,
"employment_status" : 7069,
"medicare_sec_code" : 41
}

Response JSON
{
"patient_insurance_id": 185942,
"message": "Insurance Added Successfully."
}
Request Details:

Required(R)/Opt
Param Name Data Type Description
ional(O)
patient_id R Numeric Patient Id
Numeric Master insurance id
master_insurance_id R (received from master
insurance search)
insurance_external_id O String
patient_insurance_type O String Plan Type (insurance Type)
plan_no O String Plan Number
plan_name O String Plan Name
group_no O String Group Number
group_name O String Group Name
subscriber_id R String Subscriber Id
start_date O Date Start Date
expiry_date O Date Expiry Date
status O String Status
subs_relation O String Relation with the Subscriber
subs_fname O String First Name
subs_mname O String Middle Name
subs_lname O String Last Name
subs_dob O Date Date of Birth
subs_add_line1 O String Address Line 1
subs_add_line2 O String Address Line 2
subs_add_city O String City
subs_add_state O String State
subs_add_zip O String Zip Code
subs_add_zip2 O String Zip Code 2
1 - Healthcare
classified_as O int 60 - DMERC
70 - MotorAcc

80 - PersonalAcc
90 - WorkerComp
99 - Attorney

Response Codes:

Error/Success HTTP Status

Error/Success Message
Code Code
203 200 Failed to add Insurances
604 400 Subscriber Id Should Not Null
607 400 Invalid Start Date
608 400 Invalid Expiry Date
Plan Type should be less than or equal to 10
611 400
Character
Plan Number should be less than or equal to 20
612 400
Character
Plan Name should be less than or equal to 50
613 400
Character
Group Number should be less than or equal to 20
614 400
Character
Group Name should be less than or equal to 50
615 400
Character
Subscriber Relation should be less than or equal to
616 400
30 Character
Subscriber First Name should be less than or equal
617 400
to 50 Character
Subscriber Middle Name should be less than or
618 400
equal to 35 Character
Subscriber Last Name should be less than or equal to
619 400
35 Character
620 400 Invalid Subscriber DOB
Subscriber Address Line 1 should be less than or
621 400
equal to 100 Character
Subscriber Address Line 2 should be less than or
622 400
equal to 100 Character
Subscriber Address Zip should be less than or equal
623 400
to 10 Character
Subscriber Address Zip 2 should be less than or
624 400
equal to 10 Character
625 400 Invalid Plan Type
626 400 Invalid Copay Type

627 400 Invalid Classified as Type

628 400 Invalid Subscriber Employment Status
629 400 Invalid Subscriber Relation
630 400 Invalid Medicare Secondary Code

4.4. UPDATE PATIENT INSURANCE API

This API will update the insurance for a patient.
HTTP Method PUT
End Point : https://{Clinic_Url}/prognocis/apis/{poolname}/patients/insurance
Request JSON
{
"patient_insurance_id": 44
// Rest all fields are same as POST i.e. add insurance
}
Response JSON:
{
"message": "Patient Insurance Updated Successfully."
}

Request Details:

Param Name Required(R)/Optional(O) Data Type Description

patient_insurance_id R Integer patient_insurance_id

5. PATIENT APPOINTMENTS API

5.1. LOCATION SEARCH API
This API will return a list of locations based on request parameters passed.

HTTP Method GET

End Point : https://{Clinic_Url}/prognocis/apis/{poolname}/locations
E.g :
https://{clinic_url}/prognocis/apis/{poolname}/locations

Request
{
"location_id": 10,
"location_name": "Brentwood",
"location_code": "BRENTWOOD1"
}
Response
[
{
"location_id" : 2,
"location_name" : "West Bay Clinic",
"location_code" : "CL"
},
{
"location_id" : 3,
"location_name" : "Location 5",
"location_code" : "DASC"
}
]

Request Params Details:

Required(R)/Opt
Param Name Data Type Description
ional(O)
location_id O Integer Location id
String Location Name (At least 2
location_name O
characters required)
Location Code (At least 2
location_code O String
characters required)

HTTP Status Code, Error/Success Codes and Error/Success Messages:

Error/Success Code HTTP Status Code Error/Success Message

107 200 Processing error. Please contact support.
110 200 No record found
At least 2 characters are required in the location
408 400
code.
At least 2 characters are required in the location
409 400
name.

5.2. MEDICS/PROVIDER SEARCH API

This API will return a list of medics based on request parameters passed.
HTTP Method GET
End Point: https://{Clinic_Url}/prognocis/apis/{poolname}/providers
Request
{
"first_name": "Lauren",
"last_name": "Hunter",
"types": ["ST","DR"]
}
Response
[
{

"first_name": "Lauren",
"last_name": "Hunter",
"type": "DR",
"provider_id": 128,
"provider_name": "Lauren Hunter, D.C."
}
]

Request Details:

Required(R)/Opti
Param Name Data Type Description
onal(O)
first_name O String Medics first name
last_name O String Medics last name
Comma separated medics ex:
["ST","DR"]

Possible values:
DR - Doctor
types O String ST - staff
MA-Medical assistant
RN - Nurse
BL - Biller
RS – Resource
RD – referring provider

Response Codes:

Error/Success Code HTTP Status Code Error/Success Message

107 200 Processing error. Please contact
support.
110 200 No record found

410 400 Minimum 2 characters are required in

the encounter type name.

411 400 Minimum 2 characters are required in

the encounter type code.

5.3. ENCOUNTER/VISIT TYPE SEARCH API

This API will return a list of encounters based on request parameters passed. The visit type is
required for searching appointment slot and taking appointment.
HTTP Method GET
End Point : https://{Clinic_Url}/prognocis/apis/{poolname}/enctypes
E.g :
https://{clinic_url}/prognocis/apis/{poolname}/enctypes
Request
{
"enc_type_code" : "CA",
"enc_name" : "OFF"
}
Response
[
{
" enc_type_id" : 20236,
"enc_type_code" : "0D",
"enc_name" : "Test enc type 0"
},
{

" enc_type_id" : 20217,

"enc_type_code" : "11",
"enc_name" : "Test 1 New Enc Type Home Page"
},
]

Request Details:

Required(R)/
Param Name Data Type Description
Optional(O)
enc_type_code O String Encounter type code
Encounter type name (At least 2
enc_name O String
characters required)

Response Codes:

Error/Success HTTP Status

Error/Success Message
Code Code
107 200 Processing error. Please contact support.
110 200 No record found
Minimum 2 characters are required in the encounter
410 400
type name.
Minimum 2 characters are required in the encounter
411 400
type code.

5.4. AVAILABLE APPOINTMENT SLOTS API

This API will return a list of available slots for Providers for a Date.
HTTP Method GET
End Point : https://{Clinic_Url}/prognocis/apis/{poolname}/appts/available_slots
E.g: https://{clinic_url}/prognocis/apis/{poolname}/appts/available_slots
Request:
{

"page_no": 1,
"provider_ids": [128, 146, 149],
"location_ids": [2, 4],
"enc_type_ids": [5, 58],
"start_date": "2021-10-21",
"end_date": "2021-10-21",
"start_time" : "00:00:00",
"end_time" : "23:50:00"
}
Response:
[
{
"provider_id" : 41672,
"start_time" : "2021-08-18T23:30:00",
"end_time" : "2021-08-18T23:45:00",
"available_enc_types" : [ {
"available_enc_type_id" : "5"
}],
"location_id" : "CL"
},
{
"provider_id" : 128,
"start_time" : "2021-08-18T00:00:00",
"end_time" : "2021-08-18T00:15:00",
"available_enc_types" : [{
"available_enc_type_id" : "20244"

}, {
"available_enc_type_id" : "102"
}, {
"available_enc_type_id" : "20231"
}],
"location_id" : "CL"
}
]

Request Details:

Required(R)/Opt
Param Name Data Type Description
ional(O)
Provider Id - Can have multiple
Provider_ids O int values or ALL or blank. If blank we
will consider ALL.
Start date (If not provided, then
start_date O String
today’s date will be considered).
End date. Currently equals to
end_date O String start_date and we are working on
providing multi-days support.
Start time in minutes. If not present
start_time O String
then we will consider 00 mins.
End time in minutes If not present
end_time O String
then we will consider the whole day.
location_ids O int
enc_type_ids O int
Page Number. If not present then by
page_no O Integer
default 1 will be considered.

Response Codes:

Error/Success Code HTTP Status Code Error/Success Message

100 200 Return matching result
110 200 No record found
-102 200 Invalid start and end date

402 400 Invalid Provider id

107 500 Processing error. Please contact support.
403 400 Provider id not found.
Start time is greater than or equal to end
405 400
time.
412 400 Start date cannot be less than today's date.
413 400 End date cannot be less than the start date.

5.5. ADD APPOINTMENT API

HTTP Method POST
END Point
https://{clinic_name}/prognocis/apis/{poolname}/appts/appointments
Request JSON:
{
"visit_type" : 5,
"reason" : "Test Reason",
"location_id" : 4,
"provider_id" : 128,
"patient_id" : "SCL00140",
"start_time" : "2022-01-25T09:00:00",
"duration" : 15
}
Response JSON:
{
"appointment_id": 5273486,
"message": "Appointment Booked successfully.",
"successful": "true"
}

Request Fields:

Required(R)/Optio
Param Name Data Type Description
nal(O)

Provider Id - Can have multiple

Provider_ids O int values or ALL or blank. If blank,
we will consider ALL.

Start date (If not provided, then

start_date O String
today’s date will be considered).
End date. Currently equals to
end_date O String start_date and we are working
on providing multi-days support.
Start time in minutes. If not
start_time O String present, then we will consider
00 mins.
End time in minutes If not
end_time O String present then we will consider
the whole day.
location_ids O int
patient_id R String Patient Id

5.6. UPDATE APPOINTMENT API

HTTP Method PUT
END Point = https://{clinic_name}/prognocis/apis/{poolname}/appts/appointments

Request JSON:
{
"appointment_id": “5272366”,
"visit_type": 5,
"reason": "New Reson For Change at 20_05",
"location_id": 2,

"provider_id": 10583,
"patient_id": "258949",
"start_time": "2024-06-03T04:00:00",
"duration": 120
}
Response JSON:
{
"Updated_app_id": 5273341,
"message": "Appoinment updated successfully",
"successful": "true"
}

Note:

• The Updated Appointment service returns a response with updated_app_id, which

includes the rescheduled AppointmentId.
Request Fields:

Required(R)/Optio
Param Name Data Type Description
nal(O)

provider_id O Int Provider Id - value or blank. If

blank, we will consider Default
provider_Id.

start_time O String Start date (If not provided, then

today’s date will be considered).
Format – yyyy-mm-
ddThh:mm:ss

location_id O String Appointment booked location

duration O Int Duration of Appointment

appointment_id R String Appointment ID of patient

patient_id R String Patient ID

reason O String Reason of Visit

visit_type O String Visit / Encounter Type

5.7. DELETE APPOINTMENT API

HTTP Method Delete
END Point = https://{clinic_name}/prognocis/apis/{poolname}/appts/appointments
Request JSON:
{
"appointment_id": “5818”
}
Response JSON:
{
"message": "Appointment Deleted Successfully."
}
Request Fields:

Required(R)/Optio
Param Name Data Type Description
nal(O)

appointment_id R String Appointment ID of patient

Note:

• Update Appointment API needs patient_id and appointment_id of the patient.

• Delete Appointment API needs only appointment_id of Appointment booked for the
patient.
• The Updated Appointment service returns a response with updated_app_id, which
includes the rescheduled Appointment_Id.

6. PATIENT DOCUMENT LIST API

6.1. PATIENT DOCUMENT LIST GET API
HTTP Method GET
https://{clinic_url}/prognocis/apis/{poolname}/patients/documentlist
Request JSON
{
"patient_id": 2,
"from_date": "2021-07-07",
"upto_date": "2022-01-10",
"document_type":
["BIL","CANREQA","CCD","CHGREQD","CRA","DFD","ENC","EXN","FHR","LDA","LIA","LOB","
LRB","MCINTERFC","N2N","NEWCCD","ODA","OPA","PA","PFD","PIC","PMR","PNB","PRA","
RDA","REFNOTE","RFA","RFL","RRB","RREQD","SCN","SFN"]
}
Response JSON
[
{
"document_id": 217,
"patient_id": 2,
"document_date": "2021-07-07 00:00:00.0",
"dcmnt_type": "PNB",
"document_type_name": "Progress Notes",
"document_subject": "",

"document_catagory_name": ""
},
{
"document_id": 218,
"patient_id": 2,
"document_date": "2021-07-07 00:00:00.0",
"dcmnt_type": "SCN",
"document_type_name": "Procedure Forms",
"document_subject": "",
"document_catagory_name": "PT - Plan and Recommendation"
}
]

Request Fields:

Required(R)/Opt
Param Name Data Type Description
ional(O)
patient_id R String Template Type . Details below
from_date O String Case No
upto_date O String Alert text
Document type to search. Ex:
document_type O String
["PRA","RDA"]

Response Fields:

Param Name Data Type Description

document_id Integer Document Id
patient_id String Document Name
document_date String Document Date
dcmnt_type String Document Type
document_type_name String Name of the Document
document_subject String Document Subject
document_catagory_name String Document Category

Error codes:

Error/Success HTTP Status

Error/Success Message
Code Code
108 200 Mandatory fields are missing
112 400 Unrecognized field
110 200 No record found

Type of documents:

Sr. No Document Code Document Type

1 LOB Letters Out
2 PNB Progress Notes
3 PMR Patient Messages
4 LIA Letters In
5 LRB Lab Results
6 RRB Radiology Results
7 CRA Consult Response
8 PRA Procedure Result
9 OPA Old Progress Notes
10 ENC Encounter Attachments
11 SFN Clinic Forms
12 SCN Procedure Forms
13 BIL Billing Attachments
14 EXN Progress Notes Report
15 RREQD Progress note - Refill request
16 CCD Continuity of Care Documents(CCD)
17 PA Portal Attachments
18 N2N Clinical Message
19 LDA Legal Documents
20 ODA Other Documents
21 CHGREQD Denied Change Request
22 CANREQD Denied Cancel Request
23 CANREQA Approved Cancel Request
24 MCINTERFC Machine Interface

6.2. PATIENT DOCUMENT LIST DELETE API

HTTP Method DELETE
https://{clinic_url}/prognocis/apis/{poolname}/patients/documentlist
Request JSON

{
"patient_id" :145258,
"document_id": 179926
}
Response JSON

{
"response_message": " DOCUMENT DELETED SUCCESSFULLY."
}

Request Fields:

Required(R)/Opt
Param Name Data Type Description
ional(O)
patient_id R Integer Patient Id
document_id R Integer Document Id

Error codes:

Error/Success HTTP Status

Error/Success Message
Code Code
108 200 Mandatory fields are missing
112 400 Unrecognized field
110 200 No record found
108 200 Missing Fileds Error
116 200 Invalid Value
111 200 Invalid Field

6.3. PATIENT DOCUMENT LIST UPLOAD API

HTTP Method POST
https://{clinic_url}/prognocis/apis/{poolname}/patients/documentlist/upload
Request JSON

{
"patient_id":145258,
"category_id": 21430,
"description": "test @@@@ file",
"file_name":"test123.txt"
}
Response JSON

{
"document_id": 180328,
"message": "Document uploded successfully."
}

Request Fields:

Required(R)/Opt
Param Name Data Type Description
ional(O)
patient_id R Integer Patient ID
category_id": O Integer Category ID
description O String File Description
file_name R String File Name

Response Fields:

Param Name Data Type Description

document_id Integer Document Id

Error codes:

Error/Success HTTP Status

Error/Success Message
Code Code
108 200 Mandatory fields are missing
112 400 Unrecognized field

110 200 No record found

108 200 Missing Fields Error
116 200 Invalid Value

6.4. PATIENT DOCUMENT LIST DOWNLOAD API

HTTP Method GET
https://{clinic_url}/prognocis/apis/{poolname}/patients/documentlist/Download
Request JSON

{
"document_ids": [180328]
}
Response JSON

[
{
"document_id": 180328,
"file_path": "P:/IPM_DOC_LIST/180328_2023-07-25.txt"
}
]

Request Fields:

Required(R)/Opt
Param Name Data Type Description
ional(O)
document_ids R Integer[] Document Ids

Response Fields:

Param Name Data Type Description

document_id Integer Document Id
file_path String File path

Error codes:

Error/Success HTTP Status

Error/Success Message
Code Code
108 200 Mandatory fields are missing
112 400 Unrecognized field
110 200 No record found
108 200 Missing Fields Error
116 200 Invalid Value

7. PATIENT ALERT API

7.1. ADD/UPDATE PATIENT ALERTS API
HTTP Method POST
https://{clinic_url}/prognocis/apis/{poolname}/patients/alerts

Request JSON:
POST request to add Alert and PUT request to update Alerts
{
"patient_id":12345,
"alert_text":"alert content",
"effective_date":"2021-01-01",
"upto_date":”2021-01-01”,
"show_alert_on": ["A","E"]"
}
Response JSON

{
“alert_id”: 12345
}

Update Alert
HTTP Method PUT

Request JSON:
{
"alert_id": 5,
"alert_text": "test avinash update",
"from_date": "01-01-2021",
"upto_date": "12-31-2021",
"show_alert_on": ["A","B", "E"]
}
Response JSON
{
"message": "Patient Alert Updated Successfully"
}

Request Params Details:

Required(R)/Opti
Param Name Data Type Description
onal(O)
patient_id R String Patient Id

alert_text R String Alert text

effective_date O String Effective date for an alert, if not

set we will consider it as todays
date
upto_date O String Upto date for an alert
show_alert_on O String Show alert on A – Appointment,
E-Encounter B - Billing

delete_alert O Numeric Send 1 to delete an existing alert

7.2. SEARCH/DELETE PATIENT ALERTS API

HTTP Method GET

Search/Get Alert API:

https://{clinic_url}/prognocis/apis/{polname}/patients/alerts

Request JSON:

{
"patient_id": 117
}
Response JSON
[
{
"alert_id": 2,
"alert_text": "ABCD ABCD",
"from_date": "2021-01-01 00:00:00.0",
"upto_date": "2021-12-31 00:00:00.0",
"show_alert_on": [
"A",
"E",
"B"
]
}
]
HTTP Method DELETE
Delete Alert API:

https://{clinic_url}/prognocis/apis/{polname}/patients/alerts

Request JSON:

{
"alert_id":3811
}

Response JSON
{
"message": "Alert Deleted Successfully"
}

Error codes:

Error/Success HTTP Status

Error/Success Message
Code Code
239 400 Error occurred in adding patient alert
112 400 Unrecognized field
108 200 Missing Fields Error
116 200 Invalid Value

8. CHARGE IMPORT API

https://{Clinic_Url}//prognocis/apis/{poolname}/enc/charge
Request JSON:
{
"appt_id":12311,
"patient_id":1234,
"diagnosis_codes": ["M05.1",
"M94.1",
"B36.3",
"B71.1"],
"procedure_codes":[ { "cpt_code":"99213", "cpt_description":"xxxxxx",
"snomed_code":11429006, "icd_codes":["M05.1","M94.1"], "modifier":["1P","23","27"],
"billable_units":1 },
{
"cpt_code":"99241",
"cpt_description":"yyyyy",
"snomed_code":11429006,
"icd_codes":["B36.3","B71.1"],
"modifier":["11","23"],

"billable_units": 1
}
],
"progress_note":{ "file_base64":"DKFKDKGJFGUIUEJNDNJMGOTRKFJDFJSSJFKJKFGKFG == ",
"file_extension":"pdf"
}
}

Request Params Details:

Required(R)/Op
Param Name Data Type Description
tional(O)
appt_id R Numeric Appointment Id
patient_id R String Patient Id
cpt_code R String Procedure code
cpt_description O String Procedure code description
snomed_code O String SNOMED code associated with
the procedure code
icd_codes O String ICD code assigned to procedure
code
modifier O String Procedure code Modifiers
billable_units O Numeric Numeric Billable units
progress_note O String Progress notes in the base64
format
file_extension O String File extension

9. INSURANCE ADJUSTER MASTER API

9.1. INSURANCE ADJUSTER GET API
HTTP Method GET
https://{clinic_url}/prognocis/apis/{poolname}/adjuster
Request JSON
{
"adjuster_id": 2901,
"adjuster_name": "Test Adjuster"
}
Response JSON

[
{
"page_no": 1,
"total_pages": 30,
"no_of_records": 100,
"total_records": 2935,
"details": [
{
"adjuster_id": 2901,
"adjuster_name": " Test Adjuster ",
"insurance_name": "State Fund",
"adjuster_address": {
"line1": "",
"line2": "",
"city": "",
"state": "California",
"country": "USA",
"zip": "",
"zip2": "",
"tel_cell": "",
"tel_home": "",
"tel_work1": "123456789",
"tel_work2": "",
"fax": "",
"email": "",
"non_US": false
}
]
]

Request Fields

Required(R)/O
Param Name Data Type Description
ptional(O)
adjuster_id O Integer Adjuster Id
adjuster_name O String Adjuster name

Response Fields:

Param Name Data Type Description

adjuster_id Integer Adjuster ID

adjuster_name String Adjuster Name
insurance_name String Insurance Name
adjuster_address String Adjuster Address

Error codes:

Error/Success Code HTTP Status Code Error/Success Message

108 200 Mandatory fields are missing
112 400 Unrecognized field
110 200 No record found
114 200 Minimum Characters Required

9.2. INSURANCE ADJUSTER POST API

HTTP Method POST
https://{clinic_url}/prognocis/apis/{poolname}/adjuster
Request JSON
{
"adjuster_name": "Dummy Adjuster",
"insurance_name": "Dummy",
"adjuster_address": {
"line1": "ABC",
"city": "PQR",
"state": "CA",
"zip": "",
"tel_work1": "",
"non_US": false
}
}
Response JSON
{
"response_code": 117,
"response_message": "Record Added Successfully",
"adjuster_id": 2969
}

Request Fields:

Required(R)/O
Param Name Data Type Description
ptional(O)
adjuster_name R String Adjuster name
insurance_name O String Insurance Name
adjuster_address O String Adjuster Address

Error codes:

Error/Success Code HTTP Status Code Error/Success Message

108 200 Mandatory fields are missing
112 400 Unrecognized field
108 200 Missing Fileds Error
107 200 Processing Error

9.3. INSURANCE ADJUSTER UPDATE API

HTTP Method PUT
https://{clinic_url}/prognocis/apis/{poolname}/adjuster
Request JSON
{
"adjuster_id": 2969,
"adjuster_name": "Dummy Adjuster",
"insurance_name": "Dummy",
"adjuster_address": {
"line1": "ABC",
"city": "PQR",
"state": "CA",
"zip": "",
"tel_work1": "",
"non_US": false
}
}
Response JSON
{
"response_code": 118,

"response_message": "Record Updated Successfully "

}

Request Fields:

Required(R)/O
Param Name Data Type Description
ptional(O)
adjuster_id R Integer Adjuster Id
adjuster_name R String Adjuster name
insurance_name O String Insurance Name
adjuster_address O String Adjuster Address

Error codes:

Error/Success Code HTTP Status Code Error/Success Message

108 200 Mandatory fields are missing
112 400 Unrecognized field
108 200 Missing Fileds Error
107 200 Processing Error

10. ATTORNEY MASTER API

10.1. ATTORNEY GET API
HTTP Method GET
https://{clinic_url}/prognocis/apis/{poolname}/attorney
Request JSON
{
"attorney_id": 10,
"law_firm": "Test Law Group",
"contact_person": "test test"
}
Response JSON
{
"page_no": 1,
"total_pages": 1,
"details": [
© Copyright 2024, Bizmatics, Inc. 2429 Military Road, Suite 300, Niagara Falls, NY 14304
52
Feature - API Document

{
"active": true,
"attorney_id": 10,
"law_firm": " Test Law Group ",
"contact_person": " test test ",
"attorney_address": {
"line1": " test test ",
"line2": "",
"city": " test test ",
"state": "California",
"country": "USA",
"zip": "96067",
"zip2": "2283",
"tel_cell": "",
"tel_home": "",
"tel_work1": "1234567489 x ",
"tel_work2": "",
"fax": "12345678 x ",
"email": "[email protected]",
"non_US": false
}
}
]
}

Request Fields:

Required(R)/O
Param Name Data Type Description
ptional(O)
attorney_id O Integer Attorney Id
law_firm O String Law Firm Name
contact_person O String Contact Person Name

Response Fields:

Param Name Data Type Description

attorney_id Integer Attorney Id
law_firm String Law Firm Name
contact_person String Contact Person Name
attorney_address String Attorney Address

Error codes:

Error/Success Code HTTP Status Code Error/Success Message

108 200 Mandatory fields are missing
112 400 Unrecognized field
110 200 No record found
114 200 Minimum Characters Required

10.2. ATTORNEY POST API

HTTP Method POST
https://{clinic_url}/prognocis/apis/{poolname}/attorney
Request JSON
{
"law_firm": " Test Law Group ",
"contact_person": " test test ",
"attorney_address": {
"line1": " test test ",
"line2": "",
"city": " test test ",
"state": "California",
"country": "USA",
"zip": "96067",
"zip2": "2283",
"tel_cell": "",
"tel_home": "",
"tel_work1": "1234567489 x ",
"tel_work2": "",
"fax": "12345678 x ",
"email": "[email protected]",
"non_US": false
}
}
Response JSON
{
"response_code": 117,
"response_message": "Record Added Successfully",

"attorney_id": 10154
}

Request Fields:

Required(
Param Name R)/Option Data Type Description
al(O)
law_firm R String Law Firm Name
contact_person R String Contact Person Name
attorney_address O String Attorney Address

Error codes:

Error/Success Code HTTP Status Code Error/Success Message

108 200 Mandatory fields are missing
112 400 Unrecognized field
108 200 Missing Fileds Error
107 200 Processing Error

10.3. ATTORNEY UPDATE API

HTTP Method PUT
https://{clinic_url}/prognocis/apis/{poolname}/attorney
Request JSON
{
"law_firm": " Test Law Group ",
"attorney_id": 10154,
"contact_person": " test test ",
"attorney_address": {
"line1": " test test ",
"line2": "",
"city": " test test ",
"state": "California",

"country": "USA",
"zip": "96067",
"zip2": "2283",
"tel_cell": "",
"tel_home": "",
"tel_work1": "1234567489 x ",
"tel_work2": "",
"fax": "12345678 x ",
"email": "[email protected]",
"non_US": false
}
}

Response JSON
{
"response_code": 118,
"response_message": "Record Updated Successfully "
}

Request Fields

Required(R)/
Param Name Data Type Description
Optional(O)
attorney_id R Integer Attorney Id
law_firm O String Law Firm Name
contact_person O String Contact Person Name
attorney_address O String Attorney Address

Error codes:

Error/Success Code HTTP Status Code Error/Success Message

108 200 Mandatory fields are missing
112 400 Unrecognized field
108 200 Missing Fileds Error
107 200 Processing Error

11. CASE MANAGEMENT MASTER API

11.1. CASE MANAGEMENT GET API

HTTP Method GET
https://{clinic_url}/prognocis/apis/{poolname}/case
Request JSON
{
"patient_id": 242922,
"case_id": 11025
}
Response JSON
{
"page_no": 1,
"total_pages": 1,
"no_of_records": 1,
"total_records": 1,
"details": [
{
"case_id": 11025,
"case_no": "98884",
"patient_id": 242922,
"patient_chart_no": "SCL35017",
"case_provider_id": 41731,
"injury_date": "2022-08-01",
"body_parts": "",
"unable_to_work_from": "",
"unable_to_work_upto": "",
"hosp_from_date": "",
"hosp_upto_date": "",
"place_of_accident": "",
"state_of_accident": "CO",
"similar_illness_from": "",
"initial_treatment_date": "",
"case_description": "",
"external_id": "",
"claim_number": "",
"qme_panel_number": "",
"lien_on_file": false,
"lien_notes": "",
"amount_approved": 0.0,
"billed_amount": 0.0,

"visits_approved": 0,
"visits_used": 1,
"case_status": "Open",
"case_closed_date": "",
"case_close_notes": "",
"primary_insurance_details": {
"patient_insurance_id": 164278,
"master_insurance_id": 148,
"classified_as": 1,
"classified_as_text": "Healthcare"
},
"patient_contacts": {}
}
]
}

Request Fields:

Required(R)/O
Param Name Data Type Description
ptional(O)
patient_id R Integer Patient Id
case_id O Integer Case Id

Response Fields:

Param Name Data Type Description

case_id Integer Case Id

case_no Integer Case Number
patient_id Integer Patient Id
patient_chart_no String Patient chart number
case_provider_id Integer Case provider Id
injury_date String Date of Injury
body_parts String Body Areas
unable_to_work_from String Unable to Work From Date
unable_to_work_upto String Unable to Work Upto Date
hosp_from_date String Hospitalization From Date
hosp_upto_date String Hospitalization Upto Date
place_of_accident String Place of Accident
state_of_accident String State of Accident

similar_illness_from String First Date of Similar Illness

initial_treatment_date String Initial Treatment Date
case_description String Case Description
external_id String External Id
claim_number String Claim Number
qme_panel_number String QME Panel
lien_on_file Boolean Bool Lien
lien_notes String Lien Notes
amount_approved Double Approved Amount
billed_amount Double Billed Amount
visits_approved Integer Visits Amount
visits_used Integer Visits Used
case_status String Case Status
case_closed_date String Case Closed Date
case_close_notes String Case Closed Notes
primary_insurance_detail String Primary Insurance Detail
patient_insurance_id Integer Primary Insurance ID
master_insurance_id Integer Master Insurance ID
classified_as Integer Classified as
classified_as_text String Classified as test
patient_contacts String Patients Contacts

Error codes:

Error/Success Code HTTP Status Code Error/Success Message

108 200 Mandatory fields are missing
112 400 Unrecognized field
110 200 No record found
107 200 Processing Error

11.2. CASE MANAGEMENT POST API

HTTP Method POST
https://{clinic_url}/prognocis/apis/{poolname}/case
Request JSON
{
"patient_id": "242922",

"case_no": "CASE 344",

"case_provider_id": "41731",
"injury_date": "2022-01-01",
"body_parts": "Left Hand, Right Hand",
"unable_to_work_from": "2022-01-02",
"unable_to_work_upto": "2022-01-03",
"hosp_from_date": "2022-01-04",
"hosp_upto_date": "2022-01-05",
"place_of_accident": "On Road",
"state_of_accident": "LA",
"similar_illness_from": "2022-01-06",
"initial_treatment_date": "2022-01-07",
"disability_status_id": "",
"case_description": "Dummy Case",
"external_id": "ABCD1234",
"pri_ins_id": "164278",
"pri_ins_attorney_id": "",
"pri_ins_adjuster_id": "",
"sec_ins_id": "",
"patient_attorney_id": "",
"patient_adjuster_id": 5,
"case_manager_id": 12,
"other_case_contact_one_id": 13,
"other_case_contact_two_id": 5,
"employer_id": "",
"employer_job_id": "",
"claim_number": "ABCD1111",
"qme_panel_number": "PQRS2222",
"lien_on_file": true,
"lien_notes": "Dummy Lien Notes",
"amount_approved": 10.00,
"billed_amount": 5.00,
"visits_approved": 2,
"mpn_id": "",
"case_status": "Closed",
"case_closed_date": "2022-04-01",
"case_close_notes": "Test Case Close Notes"
}
Response JSON
{
"case_id": 11027,

"message": "Case Added Successfully.."

}

11.3. CASE MANAGEMENT UPDATE API

HTTP Method PUT
https://{clinic_url}/prognocis/apis/{poolname}/case
Request JSON
{
"case_id": 11027,
"patient_id": "242922",
"case_no": "CASE 344",
"case_provider_id": "41731",
"injury_date": "2022-01-01",
"body_parts": "Left Hand, Right Hand",
"unable_to_work_from": "2022-01-02",
"unable_to_work_upto": "2022-01-03",
"hosp_from_date": "2022-01-04",
"hosp_upto_date": "2022-01-05",
"place_of_accident": "On Road",
"state_of_accident": "LA",
"similar_illness_from": "2022-01-06",
"initial_treatment_date": "2022-01-07",
"disability_status_id": "",
"case_description": "Dummy Case",
"external_id": "ABCD1234",
"pri_ins_id": "164278",
"pri_ins_attorney_id": "",
"pri_ins_adjuster_id": "",
"sec_ins_id": "",
"patient_attorney_id": "",
"patient_adjuster_id": 5,
"case_manager_id": 12,
"other_case_contact_one_id": 13,
"other_case_contact_two_id": 5,
"employer_id": "",
"employer_job_id": "",
"claim_number": "ABCD1111",
"qme_panel_number": "PQRS2222",

"lien_on_file": true,
"lien_notes": "Dummy Lien Notes",
"amount_approved": 10.00,
"billed_amount": 5.00,
"visits_approved": 2,
"mpn_id": "",
"case_status": "Closed",
"case_closed_date": "2022-04-01",
"case_close_notes": "Test Case Close Notes"
}

Response JSON
{
"message": "Case Updated Successfully."
}

HTTP Method DELETE

https://{clinic_url}/prognocis/apis/{poolname}/case
Request JSON
{
"case_id": 11027
}

Response JSON
{
"message": "Case Deleted Successfully."
}

12. ASSESSMENT API

12.1. ASSESSMENT POST API
HTTP Method POST
https://{clinic_url}/prognocis/apis/{poolname}/assessment

Request JSON
{
{
"patient_id": 232738,
"encounter_id": 360161,
"icd_details": [
{
"description": "Arthritis of ankle, left, degenerative (From API)",
"icd10_code": "M19.072",
"billable": true
}
],
"cpt_details": [
{
"code": "99213",
"description": "CPT Added From API",
"units": "1",
"icd10_codes": [
"M19.072",
"M51.35"
],
"modifiers": [
"1P",
"23"
]
}
],
"hcpc_details": [
{
"code": "G8972",
"description": "Amb Service Outside State Per Mile Transport",
"units": "1",
"icd10_codes": [
"M19.072",
"M51.35"
],
"modifiers": [
"1P",
"23",
"27"
]

}
],
"snomed_details": []
}
}

Response JSON
{
"icd_ids": [
385528
],
"cpt_ids": [
244929
],
"hcpc_ids": [
244929
],
"snomed_ids": []
}

Request Fields:

Required(R)/O
Param Name Data Type Description
ptional(O)
patient_id R Integer Patient Id
encounter_id R Integer Encounter Id
icd_details O String[] ICD Details
cpt_details O String[] CPT Details
hcpc_details O String[] HCPC Details
snomed_details O String[] SNOMED Details

Response Fields:

Param Name Data Type Description

icd_ids Integer[] ICD Ids
cpt_ids Integer[] CPT Ids
hcpc_ids Integer[] HCPC Ids
snomed_ids Integer[] SNOMED Ids

Error codes:

Error/Success Code HTTP Status Code Error/Success Message

108 200 Mandatory fields are missing
112 400 Unrecognized field
110 200 No record found
114 200 Minimum Characters Required

12.2. ASSESSMENT GET API

HTTP Method GET
https://{clinic_url}/prognocis/apis/{poolname}/assessment
Request JSON
{
"patient_id": 232738,
"encounter_id": 360161
}
Response JSON
{
"icd_details": [
{
"id": 385525,
"description": "Acute mid back pain",
"icd10_code": "M54.9",
"primary": true,
"billable": true
}
],
"cpt_details": [
{
"id": 36434,
"type": "CPT",
"description": "Office/outpatient Visit Est",
"code": "99213",
"units": 1,
"icd10_codes": [
"715.97",
"722.51"
],
"icd_ids": [
© Copyright 2024, Bizmatics, Inc. 2429 Military Road, Suite 300, Niagara Falls, NY 14304
65
Feature - API Document

"57661",
"58021"
],
"rvu": ""
}
],
"snomed_details": []
}

Request Fields:

Required(R)/O
Param Name Data Type Description
ptional(O)
patient_id R Integer Patient Id
encounter_id R Integer Encounter Id

13. EMPLOYER API

13.1. EMPLOYER GET API
HTTP Method GET
https://{clinic_url}/prognocis/apis/{poolname}/employer
Request JSON

{
"employer_name": " Test Employer "
}

Response JSON
{
"page_no": 1,
"total_pages": 1,
"details": [
{
"employer_id": 1,
"employer_name": "Test Employer",
"address": {
"line1": "ADDRESS LINE 1",

"line2": "ADDRESS LINE 2",

"city": "Decatur",
"state": "Alabama",
"country": "USA",
"zip": "12345",
"zip2": "1234",
"tel_cell": "",
"tel_home": "",
"tel_work1": "",
"tel_work2": "",
"fax": "",
"email": "",
"non_US": false
},
"employer_feesch_type_id": "7112",
"employer_invoice_freq_unit": "M",
"employer_bool_invoice_byemail": "0",
"employer_payment_days": 0,
"employer_fee_percent": "100.00",
"employer_invoice_group": "P",
"employer_pn_send_mode": "0"
}
]
}

Request Fields:

Required(R)/O
Param Name Data Type Description
ptional(O)
employer_name O String Employer Name

Response Fields:

Param Name Data Type Description

employer_id Integer Employer Id
employer_name String Employer Name
address String Employer Address
employer_feesch_type_id String Fee Schedule Type Id
employer_invoice_freq_unit String Freq Week / Month
employer_bool_invoice_byemail String Send Invoice By Email
employer_payment_days Integer Standard Payment Days

employer_fee_percent String Percentage Of Fee Schedule

employer_invoice_group String Patient/Charge/DOS
employer_pn_send_mode String Progress Notes Send Mode

Error codes:

Error/Success Code HTTP Status Code Error/Success Message

108 200 Mandatory fields are missing
112 400 Unrecognized field
110 200 No record found
114 200 Minimum Characters Required

13.2. EMPLOYER POST API

HTTP Method POST
https://{clinic_url}/prognocis/apis/{poolname}/employer
Request JSON

{
"employer_name":"Dummy Dummy",
"employer_first_name" : "Dummy",
"employer_last_name" : "Employer",
"employer_ext_id":"ABCD1234",
"employer_designation": "Software Tester DB",
"employer_notes" : "xyz",
"employer_bool_inactive": 0,
"employer_bool_enctype" : 0,
"employer_bool_jobno" : 0,
"employer_bool_patient" : 0,
"employer_bool_dept" : 0,
"employer_im_id": "2",
"employer_policy_number": "440015",
"employer_business_type": "Software Business",
"employer_ftin" : "8600",
"employer_supported_enctypes" : "0D",
"address" : {
"line1" : "Appt. No 1",
"line2" : "Suit No. 2",
"city" : "Merryland",

"state" : "CA",
"zip" : "54321",
"zip2" : "1234",
"tel_cell" : "123456789",
"tel_home" : "123456789",
"tel_work1" : "1234567892",
"tel_work2" : "123456789”,
"fax" : 123456789,
"email" : "[email protected]"
}
}

Response JSON
{
"response_code": 117,
"response_message": "Record Added Successfully",
"employer_id": 10345
}

Request Fields

Param Name Data Type Description

employer_name String Employer Name
employer_first_name String Employer First Name
employer_last_name String Employer Last Name
employer_ext_id String External ID
employer_designation String Contact Designation
employer_notes String Employer Notes
employer_bool_inactive Integer Flag to indicate Active/Inactive
employer_bool_enctype Integer Invoice Enc Type Wise
employer_bool_jobno Integer Invoice Job No Wise
employer_bool_patient Integer Invoice Patient Wise
employer_bool_dept Integer Invoice Dept Wise
employer_im_id String Employers Insurance Company Id
employer_policy_number String Policy Number
employer_business_type String Employer Business Type
employer_ftin String Federal Tax Id
employer_supported_enctypes String Supported Encounter Types
address String[] Employer Address

13.3. EMPLOYER UPDATE API

HTTP Method PUT
https://{clinic_url}/prognocis/apis/{poolname}/employer
Request JSON

{
"employer_id": 10345,
"employer_name":"Dummy Dummy",
"employer_first_name" : "Dummy",
"employer_last_name" : "Employer",
"employer_ext_id":"ABCD1234",
"employer_designation": "Software Tester DB",
"employer_notes" : "xyz",
"employer_bool_inactive": 0,
"employer_bool_enctype" : 0,
"employer_bool_jobno" : 0,
"employer_bool_patient" : 0,
"employer_bool_dept" : 0,
"employer_im_id": "2",
"employer_policy_number": "440015",
"employer_business_type": "Software Business",
"employer_ftin" : "8600",
"employer_supported_enctypes" : "0D",
"address" : {
"line1" : "Appt. No 1",
"line2" : "Suit No. 2",
"city" : "Merryland",
"state" : "CA",
"zip" : "54321",
"zip2" : "1234",
"tel_cell" : "9876543214",
"tel_home" : "9876543213",
"tel_work1" : "9876543212",
"tel_work2" : "9876543211",
"fax" : 9876543210,
"email" : "[email protected]"
}
}

Response JSON
{
"response_code": 118,
"response_message": "Record Updated Successfully "
}

13.4. EMPLOYER DELETE API

HTTP Method Delete
https://{clinic_url}/prognocis/apis/{poolname}/employer
Request JSON

{
"employer_id": 10345
}
Response JSON
{
"message": "Employer Deleted Successfully."
}

14. PATIENT ENCOUNTER API

14.1. ENCOUNTER GET API
HTTP Method Get
https://{clinic_url}/prognocis/apis/{poolname}/enc
Request JSON

{
"patient_id": 232738
}
Response JSON
{
"page_no": 1,
"total_pages": 1,

"no_of_records": 19,
"total_records": 19,
"details": [
{
"encounter_id": 349357,
"patient_id": 232738,
"patient_chart_no": "SCL34856",
"patient_name": "tesat 44, amey 44",
"encounter_date": "2023-02-24",
"visit_type_code": "03",
"visit_type_name": "Simple Enc Type",
"attending_provider_id": 41731,
"attending_provider_name": "Ansari Adeela",
"reason_for_visit": "test",
"status": "Closed",
"case_id": "",
"case_no": "",
"location_id": 2,
"location_code": "CL"
}
]
}
Request Fields:

Required(R)/O
Param Name Data Type Description
ptional(O)
patient_id R Integer Patient Id

Response Fields

Param Name Data Type Description

encounter_id Integer Encounter Id
patient_id Integer Patient Id
patient_chart_no String Patient Chart No
patient_name String Patient Name
encounter_date String Encounter Date
visit_type_code String Visit Type Code
visit_type_name String Visit Type Name
attending_provider_id Integer Attending Provider Id
attending_provider_name String Attending Provider Name
reason_for_visit String Reason For Visit

status String Status of Encounter

case_id String Case Id
case_no String Case No
location_id Integer Location Id
location_code String Location Code

Error codes:

Error/Success Code HTTP Status Code Error/Success Message

108 200 Mandatory fields are missing
112 400 Unrecognized field
110 200 No record found
108 200 Missing Fileds Error
116 200 Invalid Value
111 200 Invalid Field
107 200 Processing Error

14.2. ENCOUNTER POST API

HTTP Method POST
https://{clinic_url}/prognocis/apis/{poolname}/enc
Request JSON

{
"patient_id": 232738,
"encounter_date": "2023-07-27",
"encounter_time_hrs": 10,
"encounter_time_mins": 45,
"attending_provider_id": 41731,
"supervising_provider_id": 41731,
"rendering_provider_id": 41731,
"attending_clinical_staff_id": "",
"visit_type_code": "03",
"referred_by_provider_id": "",
"appointment_location_code": "CL",
"case_no": "",
"pri_ins_id": 164275,
"sec_ins_id": 164275,
"reason_for_visit": "Test Reason",
"major_reason_id": 2,

"toc_visit_status_id": 3
}
Response JSON
{
"response_code": 117,
"response_message": "Record Added Successfully",
"encounter_id": 360164
}
Request Fields:

Param Name Data Type Description

patient_id Integer Patient Id
encounter_date String Encounter Date
visit_type_code String Visit Type Code
attending_provider_id Integer Attending Provider Id
reason_for_visit String Reason For Visit
encounter_time_hrs Integer Encounter Time in Hrs
encounter_time_mins Integer Encounter Time in Mins
supervising_provider_id Integer Supervising Provider Id
rendering_provider_id Integer Rendering Provider Id
attending_clinical_staff_id String Attending Clinical Staff Id
referred_by_provider_id String Referred By Provider Id
appointment_location_code String Appointment Location Code
case_no String Case No
pri_ins_id Integer Primary Insurance ID
sec_ins_id Integer Secondary Insurance ID
major_reason_id Integer Major Reason Id
toc_visit_status_id Integer Transition of Care visit ID

14.3. ENCOUNTER UPDATE API

HTTP Method PUT
https://{clinic_url}/prognocis/apis/{poolname}/enc
Request JSON

{
"encounter_id": 360164,
"patient_id": 232738,
"encounter_date": "2023-07-27",

"encounter_time_hrs": 10,
"encounter_time_mins": 45,
"attending_provider_id": 41731,
"supervising_provider_id": 41731,
"rendering_provider_id": 41731,
"attending_clinical_staff_id": "",
"visit_type_code": "03",
"referred_by_provider_id": "",
"appointment_location_code": "CL",
"case_no": "",
"pri_ins_id": 164275,
"sec_ins_id": 164275,
"reason_for_visit": "Test Reason",
"major_reason_id": 2,
"toc_visit_status_id": 3
}
Response JSON
{
"response_code": 118,
"response_message": "Record Updated Successfully "
}

15. PATIENT RFA API

15.1. RFA GET API
HTTP Method Get
https://{clinic_url}/prognocis/apis/{poolname}/rfa

Request JSON

{
"preauth_number": "RFA00896"
}

[
{
"patient_id": 232738,
"patient_chart_no": "SCL34856",
"case_id": "",
"case_no": "",
"preauth_encounter_id": "360107",
"rfah_id": 20908,
"preauth_number": "RFA00896",
"date_of_service": "2023-07-03",
"preauth_type": "",
"preauth_status": "Open",
"notes": "",
"location_id": 2,
"location_code": "CL",
"test_details": [
{
"test_id": 34717,
"test_name": "Ankle (R) X-ray",
"test_type": "RL",
"test_response_status": "Unprocessed",
"reference": "RAD0001265",
"reason": "",
"icd_codes": [
"M54.9",
"F31.9",
"F41.1"
],
"other_info": "",
"notes": ""
}
]
}
]

Request Fields:

Required(R)/
Param Name Data Type Description
Optional(O)
preauth_number R String Preauth Number

Response Fields:

Param Name Data Type Description

patient_id Integer Patient Id
patient_chart_no String Patient Chart No
case_id String Case Id
case_no String Case No
preauth_encounter_id String Preauth Encounter Id
rfah_id Integer Rfah Id
preauth_number String Preauth Number
date_of_service String Date Of Service
preauth_type String Preauth Type
preauth_status String Preauth Status
notes String Notes
location_id Integer Location Id
location_code String Location Code
test_details String Test Details

Error codes:

Error/Success Code HTTP Status Code Error/Success Message

108 200 Mandatory fields are missing
112 400 Unrecognized field
110 200 No record found
114 200 Minimum Characters Required

15.2. RFA POST API

HTTP Method POST
https://{clinic_url}/prognocis/apis/{poolname}/rfa
Request JSON

{
"preauth_number": "RFA00896"
}

Response JSON

16. INSURANCE PREAUTH API

16.1. PREAUTH GET API
HTTP Method GET
https://{clinic_url}/prognocis/apis/{poolname}/insurance/preauth
Request JSON

{
"patient_id": 189753
}

Response JSON

{
"page_no": 1,
"total_pages": 1,
"details": [
{
"patient_insurance_id": 164268,
"preauth_id": 10269,
"preauth_number": "12121212",
"charge_code": "0001M",
"from_date": "2023-05-01",
"upto_date": "2023-05-31",
"no_of_visits": 2,
"comments": "Dummy Notes"
}
]
}

Request Fields:

Required(R)/
Param Name Data Type Description
Optional(O)
patient_id R Integer Patient Id

Response Fields:

Param Name Data Type Description

patient_insurance_id Integer Patient Insurance Id
preauth_id Integer Preauth Id
preauth_number String Preauth Number
charge_code String Charge Code
from_date String From Date
upto_date String Upto Date
no_of_visits Integer No Of Visits
comments String Comments

Error codes:

Error/Success Code HTTP Status Code Error/Success Message

108 200 Mandatory fields are missing
112 400 Unrecognized field
110 200 No record found
114 200 Minimum Characters Required

16.2. PREAUTH POST API

HTTP Method POST
https://{clinic_url}/prognocis/apis/{poolname}/insurance/preauth
Request JSON

{
"patient_id": 189753,
"patient_insurance_id": 164268,
"preauth_number":"RFA00825",
"from_date":"2023-07-28"
}

Response JSON

{
"response_code": 117,
"response_message": "Record Added Successfully",
"preauth_id": 10270
}

Request Fields:

Required(R)/
Param Name Data Type Description
Optional(O)
patient_id R Integer Patient Id
patient_insurance_id R Integer Patient Insurance Id
preauth_number R String Preauth Number
from_date R String From Date

Response Fields:

Param Name Data Type Description

preauth_id Integer Preauth Id

Error codes:

Error/Success Code HTTP Status Code Error/Success Message

108 200 Mandatory fields are missing
112 400 Unrecognized field
110 200 No record found
114 200 Minimum Characters Required

16.3. PREAUTH UPDATE API

HTTP Method PUT
https://{clinic_url}/prognocis/apis/{poolname}/insurance/preauth
Request JSON

{
"preauth_id": 10270,
"patient_id": 189753,
"patient_insurance_id": 164268,
"preauth_number": "RFA00825",
"charge_code": "0001M",
"from_date": "2023-07-28",
"upto_date": "2023-08-28",
"no_of_visits": 2,
"comments": "Test"

Response JSON

{
"response_code": 118,
"response_message": "Record Updated Successfully "
}

17. ORDERSHEET API

17.1. ORDERSHEET GET API
HTTP Method GET
https://{clinic_url}/prognocis/apis/{poolname}/insurance/ordersheet

Request JSON

{
"patient_id": 232738,
"encounter_id": 360161
}

Response JSON

{
"page_no": 1,
"total_pages": 1,
"no_of_records": 1,
"total_records": 1,
"details": [
{
"encounter_id": 360161,
"order_id": 79088,
"order_number": "",
"test_id": 11299,

"test_type": "LB",
"icd_ids": "",
"vendor_id": 20302,
"order_status": "Selected"
}
]
}

Request Fields:

Required(R)/
Param Name Data Type Description
Optional(O)
patient_id R Integer Patient Id
encounter_id O Integer Encounter Id

Response Fields:

Param Name Data Type Description

encounter_id Integer Encounter Id
order_id Integer Order Id
order_number String Order Number
test_id Integer Test Id
test_type String Test Type
icd_ids String Icd Ids
vendor_id Integer Vendor Id
order_status String Order Status

Error codes:

Error/Success Code HTTP Status Code Error/Success Message

108 200 Mandatory fields are missing
112 400 Unrecognized field
110 200 No record found
114 200 Minimum Characters Required

17.2. ORDERSHEET POST API

HTTP Method POST
https://{clinic_url}/prognocis/apis/{poolname}/insurance/ordersheet

Request JSON

{
"patient_id": 232738,
"encounter_id": 360161,
"test_details": [
{
"test_id": 11299,
"test_type": "LB",
"vendor_id": 20302
}
]
}

Response JSON

{
"response_code": 117,
"response_message": ""
}

Request Fields:

Required(R)/
Param Name Data Type Description
Optional(O)
patient_id R Integer Patient Id
encounter_id R Integer Encounter Id
test_id R Integer Test ID
test_type R String Test Type
vendor_id O Integer Vendor Id

17.3. ORDERSHEET TEST GET API

HTTP Method Get
https://{clinic_url}/prognocis/apis/{poolname}/insurance/ordersheet/tests

Request JSON

{
"test_types": ["LB", "RL", "CO", "PR"]
}
Response JSON

{
"page_no": 1,
"total_pages": 66,
"no_of_records": 100,
"total_records": 6537,
"details": [
{
"test_id": 26,
"test_name": "'",
"test_type": "CO",
"speciality_name": "0089X8944W"
},
{
"test_id": 36328,
"test_name": "** 73235",
"test_type": "LB",
"test_category": "lng_Tests_HL7_Result_Test",
"test_code": "LB36328"
},
{
"test_id": 38271,
"test_name": "** 73235",
"test_type": "LB",
"test_category": "lng_Tests_HL7_Result_Test",
"test_code": "LB38271"
}
]
}
© Copyright 2024, Bizmatics, Inc. 2429 Military Road, Suite 300, Niagara Falls, NY 14304
84
Feature - API Document

Request Fields:

Required(R)/
Param Name Data Type Description
Optional(O)
test_types R String[] Test Types

Response Fields:

Param Name Data Type Description

test_id Integer Test Id
test_name String Test Name
test_type String Test Type
test_category String Test Category
test_code String Test Code
speciality_name String Speciality Name

Error codes:

Error/Success Code HTTP Status Code Error/Success Message

108 200 Mandatory fields are missing
112 400 Unrecognized field
110 200 No record found
114 200 Minimum Characters Required

HTTP Method Get

https://{clinic_url}/prognocis/apis/{poolname}/insurance/ordersheet/vendor
Request JSON

{
"vendor_types": ["LB"]
}
Response JSON

{
"page_no": 1,
"total_pages": 1,
"no_of_records": 18,

"total_records": 18,
"details": [
{
"vendor_id": 20306,
"vendor_name": "'disc",
"vendor_type": "LB"
},
{
"vendor_id": 20305,
"vendor_name": "a'b'c'def",
"vendor_type": "LB"
}
]
}

Request Fields:

Required(R)/
Param Name Data Type Description
Optional(O)
vendor_types R String[] Vendor Types

Response Fields:

Param Name Data Type Description

vendor_id Integer Vendor id
vendor_name String Vendor name
vendor_type String Vendor type

Error codes:

Error/Success Code HTTP Status Code Error/Success Message

108 200 Mandatory fields are missing
112 400 Unrecognized field
110 200 No record found
114 200 Minimum Characters Required

17.4. PATIENT TYPES GET API

HTTP Method Get
https://{clinic_url}/prognocis/apis/{poolname}/insurance/ordersheet/pattypes
Request JSON

{
"name": "FD",
"code": "PG85071",
"id": 85071
}

Response JSON

[
{

"name": "FD",
"code": "PG85071",
"id": 85071
}
]
Request Fields:

Required(R)/
Param Name Data Type Description
Optional(O)
name O String Patient type name
code O String Patient type code
id O Integer Patient type id

Response Fields:

Param Name Data Type Description

name String Patient type name
code String Patient type code
id Integer Patient type id

Error codes:

Error/Success Code HTTP Status Code Error/Success Message

108 200 Mandatory fields are missing
112 400 Unrecognized field
110 200 No record found
114 200 Minimum Characters Required

17.5. PATIENT RECIPIENT GET API

HTTP Method Get
https://{clinic_url}/prognocis/apis/{poolname}/insurance/ordersheet/patients/recipient
Request JSON

{
"patient_id": 232738,
"encounter_id": 360161
}

Response JSON

[
{
"id": "50",
"type": "Patient Employer Department",
"name": "'Employer Unspecified",
"address": {
"line1": "",
"line2": "",
"city": "",
"state": "Missouri",
"country": "USA",
"zip": "",
"zip2": "",
"tel_cell": "",
"tel_home": "",
"tel_work1": "",
"tel_work2": "",

"fax": "",
"email": "",
"non_US": false
}
}
]

Request Fields:

Required(R)/
Param Name Data Type Description
Optional(O)
patient_id R Integer Patient Id
encounter_id R Integer Encounter Id

Response Fields:

Param Name Data Type Description

id String Recipient Id
type String Recipient type
name String Recipient Name
address String[] Recipient Address

Error codes:

Error/Success Code HTTP Status Code Error/Success Message

108 200 Mandatory fields are missing
112 400 Unrecognized field
110 200 No record found
114 200 Minimum Characters Required

18. GROUP TYPES API

18.1. GROUP TYPES GET API
HTTP Method Get
https://{clinic_url}/prognocis/apis/{poolname}/insurance/ordersheet/grouptypes
Request JSON

{
"type_code": "DF"
}

Response JSON

"totalRecords": 30,
"pageNumber": 1,
"numberOfRecords": 30,
"totalPages": 1,
"content": [{
"id": "978",
"type_code": "DF",
"name": "As Needed",
"code": "PRN"
},
{
"id": "979",
"type_code": "DF",
"name": "Five Times Daily ",
"code": "5xDAILY"
}
]
}

Request Fields:

Required(R)/
Param Name Data Type Description
Optional(O)
type_code R String Group Type Code

Response Fields:

Param Name Data Type Description

id String Recipient Id
type String Recipient type
name String Recipient Name
address String[] Recipient Address

Error codes:

Error/Success Code HTTP Status Code Error/Success Message

108 200 Mandatory fields are missing
112 400 Unrecognized field
110 200 No record found
114 200 Minimum Characters Required

19. TEMPLATES API

19.1. TEMPLATES GET API
HTTP Method Get
https://{clinic_url}/prognocis/apis/{poolname}/templates
Request JSON

{
"document_template_type":"TR"
}

Response JSON

[
{
"document_id": 43236,
"document_name": "*New Patient WC"
},
{
"document_id": 43262,
"document_name": "AC_PN"
},
{
"document_id": 43261,
"document_name": "consult prints format"
}
]

Request Fields:

Required(R)/
Param Name Data Type Description
Optional(O)
document_template
R String Document Template Type
_type

Response Fields:

Param Name Data Type Description

document_id integer Document ID
document_name String Document Name

Error codes:

Error/Success Code HTTP Status Code Error/Success Message

108 200 Mandatory fields are missing
112 400 Unrecognized field

20. CASE MEDICAL PROVIDER NETWORK API

20.1. CASE MEDICAL PROVIDER NETWORK GET API
HTTP Method Get
https://{clinic_url}/prognocis/apis/{poolname}/case/mpn
Request JSON

{
"mpn_id":2411,
"mpn_code": 10,
"mpn_applicant": "FBO Marin General and Novato Community Hospital"
}

Response JSON

{
"totalRecords": 1,

"pageNumber": 1,
"numberOfRecords": 1,
"totalPages": 1,
"content": [
{
"mpn_code": 10,
"mpn_applicant": "FBO Marin General and Novato Community Hospital",
"mpn_address": "166 Hillside Ave. Mill Valley, CA 94941",
"mpn_type": "Self-Insured Employer",
"mpn_name": "Mezzo Forte Medical Provider Network",
"mpn_approval_date": "2005/01/31",
"mpn_website": "",
"mpn_status": "W"
}
]
}

Request Fields:

Required(R)/
Param Name Data Type Description
Optional(O)
mpn_id O integer MPN ID
mpn_code O integer MPN CODE
mpn_applicant O String MPN APPLICANT

Response Fields:

Param Name Data Type Description

mpn_code integer Mpn Code
mpn_applicant String Mpn Applicant
mpn_address String Mpn Address
mpn_type String Mpn Type
mpn_name String Mpn Name
mpn_approval_date String Mpn Approval Date
mpn_website String Mpn Website
mpn_status String Mpn Status

Error codes:

Error/Success Code HTTP Status Code Error/Success Message

112 400 Unrecognized field

110 200 No record found

21. CASE MANAGER API

21.1. CASE MANAGER GET API
HTTP Method Get
https://{clinic_url}/prognocis/apis/{poolname}/casemanager
Request JSON

{
"id": 1,
"name": "DASC",
"category": "DASC"
}

Response JSON

{
"page_no": 1,
"total_pages": 1,
"details":
[
"id": 1,
"name": "DASC",
"category": "DASC",
"address":
{
"line1": "ADDRESS LINE 1",
"line2": "ADDRESS LINE 2",
"city": "Decatur",
"state": "Alabama",
"country": "USA",
"zip": "12345",
"zip2": "1234",
"tel_cell": "",
"tel_home": "",
"tel_work1": "",

"tel_work2": "",
"fax": "113-323-2323",
"email": "",
"non_US": false
}
]
}

Request Fields:

Required(R)/
Param Name Data Type Description
Optional(O)
id O integer MPN ID
name O String MPN CODE
category O String MPN APPLICANT

Response Fields:

Param Name Data Type Description

id integer Address ID
name String Address Name
category String Address Category
address String[] Address Details

Error codes:

Error/Success Code HTTP Status Code Error/Success Message

112 400 Unrecognized field
110 200 No record found

21.2. CASE MANAGER POST API

HTTP Method Post
https://{clinic_url}/prognocis/apis/{poolname}/casemanager
Request JSON

{
"name": "AMEY",
"category": "AMEY",
"address": {
"line1": "ADDRESS LINE 1",
"line2": "ADDRESS LINE 2",
"city": "Parkview",
"state": "AP",
"country": "USA",
"zip": "12345",
"zip2": "1234",
"tel_cell": "",
"tel_home": "",
"tel_work1": "",
"tel_work2": "",
"fax": "113-323-2323",
"email": "",
"non_US": false
}
}

Response JSON

{
"response_code": 117,
"response_message": "Record Added Successfully",
"id": 62
}

Request Fields:

Required(R)/
Param Name Data Type Description
Optional(O)
name R String Address Name
category O String Address Category
address R String[] Address Details

Response Fields:

Param Name Data Type Description

id integer Address ID

Error codes:

Error/Success Code HTTP Status Code Error/Success Message

108 200 Mandatory fields are missing
112 400 Unrecognized field
110 200 No record found
114 200 Minimum Characters Required

21.3. CASE MANAGER UPDATE API

HTTP Method PUT
https://{clinic_url}/prognocis/apis/{poolname}/casemanager
Request JSON

{
"id": 62
"name": "AMEY",
"category": "AMEY",
"address": {
"line1": "ADDRESS LINE 1",
"line2": "ADDRESS LINE 2",
"city": "Parkview",
"state": "AP",
"country": "USA",
"zip": "12345",
"zip2": "1234",
"tel_cell": "",
"tel_home": "",
"tel_work1": "",
"tel_work2": "",
"fax": "113-323-2323",
"email": "",
"non_US": false
}

Response JSON

{
"response_code": 118,
"response_message": "Record Updated Successfully "
}

22. COMPLAINTS API

22.1. COMPLAINTS GET API
HTTP Method Get
https://{clinic_url}/prognocis/apis/{poolname}/complaints
Request JSON

{
"complaint_id": 467
}

Response JSON

{
"page_no": 1,
"total_pages": 1,
"no_of_records": 1,
"total_records": 1,
"details":
[
{
"complaint_id": 467,
"complaint_name": "!@$*(){}:?/;'|[]\\",
"complaint_classification": "Cardiologist",
"complaint_icd_code": "",
"complaint_snomed_code": "",

"complaint_icd10_code": ""
}
]
}

Request Fields:

Required(R)/
Param Name Data Type Description
Optional(O)
complaint_id O integer Complaint Id

Response Fields:

Param Name Data Type Description

complaint_id integer Complaint Id
complaint_name String Complaint Name
complaint_classification String Complaint Classification
complaint_icd_code String Complaint Icd Code
complaint_snomed_code String Complaint Snomed Code
complaint_icd10_code String Complaint Icd10 Code

Error codes:

Error/Success Code HTTP Status Code Error/Success Message

112 400 Unrecognized field
110 200 No record found

Intrusion Detection Honeypots
From Everand
Intrusion Detection Honeypots
Chris Sanders
3/5 (2)
Aquaponic Design Plans Everything You Needs to Know: Everything You Need to Know from Backyard to Profitable Business
From Everand
Aquaponic Design Plans Everything You Needs to Know: Everything You Need to Know from Backyard to Profitable Business
David H Dudley
No ratings yet
Coffee Break Python Workbook
100% (1)
Coffee Break Python Workbook
284 pages
TMF646 Appointment API Specification R19.0.0 Fixed
No ratings yet
TMF646 Appointment API Specification R19.0.0 Fixed
52 pages
Error Messages CC 220107007331804 PDF
No ratings yet
Error Messages CC 220107007331804 PDF
146 pages
insurance
No ratings yet
insurance
4 pages
Gray Hat Hacking the Ethical Hacker's
From Everand
Gray Hat Hacking the Ethical Hacker's
Çağatay Şanlı
5/5 (1)
Blog Smarter, Not Harder: SEO, Blogging, and AI Strategies to Skyrocket Your Traffic
From Everand
Blog Smarter, Not Harder: SEO, Blogging, and AI Strategies to Skyrocket Your Traffic
Jay Nans
No ratings yet
CAN Bus for Beginners: A Practical Guide to Automotive Networking
From Everand
CAN Bus for Beginners: A Practical Guide to Automotive Networking
Mohamad Charara
No ratings yet
Software Patterns Made Easy
From Everand
Software Patterns Made Easy
Justice Nanhou
No ratings yet
Mastering Windows Automation with AHK 2.0
From Everand
Mastering Windows Automation with AHK 2.0
John Nunez
No ratings yet
Securing ChatGPT: Best Practices for Protecting Sensitive Data in AI Language Models
From Everand
Securing ChatGPT: Best Practices for Protecting Sensitive Data in AI Language Models
Matthew C. Smith
No ratings yet
Web Video Business
From Everand
Web Video Business
MUHAMMAD NUR WAHID ANUAR
No ratings yet
Content Creation Revolution with chatGPT
From Everand
Content Creation Revolution with chatGPT
Maria Cowen
No ratings yet
Cybersecurity for Executives: A Guide to Protecting Your Business
From Everand
Cybersecurity for Executives: A Guide to Protecting Your Business
Matthew C. Smith
No ratings yet
Manuallllll
No ratings yet
Manuallllll
81 pages
Viral Ipod Video
From Everand
Viral Ipod Video
MUHAMMAD NUR WAHID ANUAR
No ratings yet
Plain JavaScript: Learning the Front-End
From Everand
Plain JavaScript: Learning the Front-End
Roger Beans-Rivet
No ratings yet
10K Blueprint
From Everand
10K Blueprint
Cian O Farrell
5/5 (2)
API integration
No ratings yet
API integration
5 pages
AI-Powered Productivity
From Everand
AI-Powered Productivity
Asma Asfour
No ratings yet
Provider Search ICD v7
No ratings yet
Provider Search ICD v7
11 pages
ChatGPT for Business: Strategies for Success
From Everand
ChatGPT for Business: Strategies for Success
Matthew C. Smith
No ratings yet
Mastering Python Advanced Concepts and Practical Applications
From Everand
Mastering Python Advanced Concepts and Practical Applications
Aissa Younes
No ratings yet
University Physician Associates - UPA
No ratings yet
University Physician Associates - UPA
35 pages
Accounting
No ratings yet
Accounting
4 pages
bse-starmfv2-api_V0.9.12
No ratings yet
bse-starmfv2-api_V0.9.12
283 pages
Integration Specification Document V5.0.0
No ratings yet
Integration Specification Document V5.0.0
23 pages
Unlocking Statistics for the Social Sciences
From Everand
Unlocking Statistics for the Social Sciences
Norma Sinclair
No ratings yet
Nextgen_user_manual-Billing_30012024
No ratings yet
Nextgen_user_manual-Billing_30012024
37 pages
Composite Pay Api - 1.18
No ratings yet
Composite Pay Api - 1.18
60 pages
Thrymr Effort Estimation Dec2023 Apr2024
No ratings yet
Thrymr Effort Estimation Dec2023 Apr2024
2 pages
EH ProjectPlan 28
No ratings yet
EH ProjectPlan 28
40 pages
Qualys Was API User Guide
No ratings yet
Qualys Was API User Guide
376 pages
Dashboard Story
No ratings yet
Dashboard Story
5 pages
AcumaticaERP IntegrationDevelopmentGuide
No ratings yet
AcumaticaERP IntegrationDevelopmentGuide
255 pages
The Linux Terminal for Advanced Users - The Command Line Made Easy: First Edition
From Everand
The Linux Terminal for Advanced Users - The Command Line Made Easy: First Edition
Michael Basler
No ratings yet
VMA Terms Guide (1)
No ratings yet
VMA Terms Guide (1)
2 pages
BlockChain for Beginners
From Everand
BlockChain for Beginners
Matthew Smith
No ratings yet
Machine Learning With Python Programming : 2023 A Beginners Guide
From Everand
Machine Learning With Python Programming : 2023 A Beginners Guide
James Harrison
2/5 (1)
The Future of Learning: Revolutionizing Education Through Generative AI: AI Books, #11
From Everand
The Future of Learning: Revolutionizing Education Through Generative AI: AI Books, #11
Mohammad
No ratings yet
A1 Group 2 ISD
No ratings yet
A1 Group 2 ISD
54 pages
4 - APIM - Development - Policy Studio - Lab - From policy to API
No ratings yet
4 - APIM - Development - Policy Studio - Lab - From policy to API
27 pages
Basics of OAuth Securely Connecting Your Applications
From Everand
Basics of OAuth Securely Connecting Your Applications
A. Scholtens
No ratings yet
Home Health Administrator Overview Training Manual: July 2021
No ratings yet
Home Health Administrator Overview Training Manual: July 2021
51 pages
The IPhone 12 Pro Photography User Guide: Your Guide For Smartphone Photography For Taking Pictures Like A Pro Even As A Beginner
From Everand
The IPhone 12 Pro Photography User Guide: Your Guide For Smartphone Photography For Taking Pictures Like A Pro Even As A Beginner
Wendy Hills
No ratings yet
The Ultimate Career Toolkit : A Step-by-Step Guide to Landing Your Dream Job
From Everand
The Ultimate Career Toolkit : A Step-by-Step Guide to Landing Your Dream Job
Ebenezer Edem Zuh
No ratings yet
Business English Writing: Effective Business Writing Tips and Will Help You Write Better and More Effectively at Work
From Everand
Business English Writing: Effective Business Writing Tips and Will Help You Write Better and More Effectively at Work
Mary G. Lewis
No ratings yet
User Manual
No ratings yet
User Manual
164 pages
Aquaponics Design Plans, Construction, Operation, and Income: Organic Food
From Everand
Aquaponics Design Plans, Construction, Operation, and Income: Organic Food
David H Dudley
No ratings yet
User Manual
No ratings yet
User Manual
165 pages
3 - APIM - Development - API Manager and Policy Studio
No ratings yet
3 - APIM - Development - API Manager and Policy Studio
34 pages
FE Mechanical Exam Prep Complete Study Guide for the Fundamentals of Engineering with Practice Questions and Proven Strategies to Conquer the Exam
From Everand
FE Mechanical Exam Prep Complete Study Guide for the Fundamentals of Engineering with Practice Questions and Proven Strategies to Conquer the Exam
Tony Boyd
No ratings yet
Userms Manual
No ratings yet
Userms Manual
169 pages
SAP API Management
No ratings yet
SAP API Management
7 pages
Trading Mastery: Unleashing Financial Potential in the Modern Markets Innovative Strategies, Prudent Approaches, and Insider insights for Mastering the Art of Trading
From Everand
Trading Mastery: Unleashing Financial Potential in the Modern Markets Innovative Strategies, Prudent Approaches, and Insider insights for Mastering the Art of Trading
GEORGE L . BROWN
No ratings yet
Initiate A Request Along With Attachment by Consuming BMC Digital Workplace Catalog REST API
No ratings yet
Initiate A Request Along With Attachment by Consuming BMC Digital Workplace Catalog REST API
7 pages
الملحق الفني
No ratings yet
الملحق الفني
25 pages
Integrating AllosHIS With BC-365
No ratings yet
Integrating AllosHIS With BC-365
12 pages
Aquaponics How to do Everything from Backyard to Profitable Business: from BACKYARD to PROFITABLE BUSINESS
From Everand
Aquaponics How to do Everything from Backyard to Profitable Business: from BACKYARD to PROFITABLE BUSINESS
David H Dudley
No ratings yet
Lab 3 Ai
No ratings yet
Lab 3 Ai
5 pages
Sub Ledger Accounting - Technical Perspective PDF
No ratings yet
Sub Ledger Accounting - Technical Perspective PDF
11 pages
HPC Computer Engg Sem 8 Notes
No ratings yet
HPC Computer Engg Sem 8 Notes
36 pages
46pfl5507k 12 Fhi Eng
No ratings yet
46pfl5507k 12 Fhi Eng
4 pages
Application of Federated Learning For Smart Agricu
No ratings yet
Application of Federated Learning For Smart Agricu
13 pages
Lesson 7
No ratings yet
Lesson 7
33 pages
Vasu Resume PDF
No ratings yet
Vasu Resume PDF
2 pages
Tachonet: Software Requirements Specification
No ratings yet
Tachonet: Software Requirements Specification
56 pages
EMR4 - CAN - BUS - Specification - Ver02 - 34
No ratings yet
EMR4 - CAN - BUS - Specification - Ver02 - 34
73 pages
Embedded Linux Design & Development: With Beagle Bone Black Expansion Board
No ratings yet
Embedded Linux Design & Development: With Beagle Bone Black Expansion Board
3 pages
Customer Onboarding - Private Cloud - TP1 Welcome and introduction
No ratings yet
Customer Onboarding - Private Cloud - TP1 Welcome and introduction
59 pages
W1 C2 Student Worksheet KEY
No ratings yet
W1 C2 Student Worksheet KEY
3 pages
Signserver Manual 1 0 sRC1
No ratings yet
Signserver Manual 1 0 sRC1
18 pages
Rubrik CDM Version 6.0 Cloud Cluster Setup Guide (Rev. A6)
No ratings yet
Rubrik CDM Version 6.0 Cloud Cluster Setup Guide (Rev. A6)
65 pages
Exp 5 ANEKA Cloud Platform Study
No ratings yet
Exp 5 ANEKA Cloud Platform Study
10 pages
CS3351 Digital Principles and Computer Organization
No ratings yet
CS3351 Digital Principles and Computer Organization
55 pages
M.E. CSE UPDATED
No ratings yet
M.E. CSE UPDATED
1 page
Analyzing Malicious Documents Cheat Sheet
No ratings yet
Analyzing Malicious Documents Cheat Sheet
7 pages
Unit-3 Python
No ratings yet
Unit-3 Python
29 pages
CS504 Short Notes: Want To Read All 40 Pages?
No ratings yet
CS504 Short Notes: Want To Read All 40 Pages?
1 page
IT402 Module 2 Updated
No ratings yet
IT402 Module 2 Updated
41 pages
UPGRADE GUIDE - Sap Enable Now 3
No ratings yet
UPGRADE GUIDE - Sap Enable Now 3
6 pages
AVR1927 XMEGA-A1 Xplained Getting Started Guide
No ratings yet
AVR1927 XMEGA-A1 Xplained Getting Started Guide
17 pages
315319-OPERATING SYSTEM
No ratings yet
315319-OPERATING SYSTEM
6 pages
L3 - Modeling With UML - Use Case
No ratings yet
L3 - Modeling With UML - Use Case
28 pages
Cómo Escribir Un Ensayo de Explicación de Poema
100% (1)
Cómo Escribir Un Ensayo de Explicación de Poema
5 pages
Arun Kumar.K 12yrs Resume
No ratings yet
Arun Kumar.K 12yrs Resume
5 pages
HOSPITAL MANAGEMENT - Final Report
No ratings yet
HOSPITAL MANAGEMENT - Final Report
75 pages