Patient V2 APIs

POST Communicator Batch - Patient /v2/api/Patient/CommunicatorBatchPatient/

Description: Returns all patient data for the given PGID/OID combination.

Request Information

Parameter	Type	Max-Length	Required	Description
OID	Integer	-	Required	Office ID
PAGEINDEX	Integer	-	Required	Page Index Number (1000 record per page)
INCLUDEINSURANCE	boolean	-	Optional	To Include Current Patient Insurance

                                    
{  
   "Successful":true,
   "Data":{  
      "PatientInfo":[  
         {  
            "P":"200",
            "O":"101",
            "PID":"1001",
            "RID":"1501",
            "CNO":"CHRT07",
            "FN":"John",
            "LN":"Doe",
            "MI":"B",
            "AD":"151 Kalmus Dr",
            "AD2":"Street A156",
            "CT":"Costa Mesa",
            "ST":"CA",
            "ZP":"92626",
            "BD":"04/15/1980",
            "EM":"john.doe@gmail.com",
            "SX":"M",             
            "FV":"04/18/2017",
            "LV":"04/18/2017",
            "RFTY":"DOC",
            "RETRP":"",
            "HP":"85452789999",
            "WP":"67845311888",
            "CP":"71467777444",
            "PPRSID":"235",
            "AC":"True",
            "ISCD":"True",
            "ISAE":"True",
            "ISAS":"True",
            "PTY":"Cash, Collection",
            "CBY":"ADAM.JACK",
            "CBO":"12/02/2004T22:33:00",
            "MBY":"09/12/2017T23:50:00",
            "MBO":"ADMA.JACK",
            "Insurance": [
              {
                "PID": "583",
                "PRIMORSEC": "P",
                "INSID": "2121",
                "GRPNO": "000",
                "PLNID": "176",
                "PLNTY": "Denti-cal",
                "ANNIVDATE": "2018-01-01T00:00:00",
                "CARNAME": "Denti Cal",
                "CARAD1": "765 intel ave",
                "CARAD2": "#244",
                "CARCITY": "sacramento",
                "CARSTATE": "CA",
                "CARZIP": "92627",
                "CARPAYERID": "gggjj",
                "CARTY": "1",
                "CARPHONE": "0",
                "INDDEDUCT": 50,
                "INDDEDUCTREM": 0,
                "FAMDEDUCT": 50,
                "FAMDEDUCTREM": 0,
                "INDMAX": 50,
                "INDMAXREM": 36,
                "FAMMAX": 50,
                "FAMMAXREM": 36,
                "INDORTHOMAX": 50,
                "INDORTHOREM": 50,
                "SUBFNAME": "Chun",
                "SUBLNAME": "Allie",
                "SUBAD1": "Asdf",
                "SUBAD2": "",
                "SUBCITY": "Asdf",
                "SUBSTATE": "AA",
                "SUBZIP": "10001",
                "RELTOSUB": "",
                "SUBGENDER": "F",
                "SUBBDAY": "1967-05-29T00:00:00"
              },
              {
                "PID": "583",
                "PRIMORSEC": "S",
                "INSID": "2122",
                "GRPNO": "111",
                "PLNID": "256",
                "PLNTY": "Indemnity",
                "ANNIVDATE": "2017-01-01T00:00:00",
                "CARNAME": "Ae Insurance Company",
                "CARAD1": "123 Villa Sienna",
                "CARAD2": "",
                "CARCITY": "Irvine",
                "CARSTATE": "CA",
                "CARZIP": "92627",
                "CARPAYERID": "06126",
                "CARTY": "1",
                "CARPHONE": "0",
                "INDDEDUCT": 0,
                "INDDEDUCTREM": 0,
                "FAMDEDUCT": 0,
                "FAMDEDUCTREM": 0,
                "INDMAX": 1500,
                "INDMAXREM": 1493.6,
                "FAMMAX": 99999,
                "FAMMAXREM": 99992.6,
                "INDORTHOMAX": 1500,
                "INDORTHOREM": 1500,
                "SUBFNAME": "Chun",
                "SUBLNAME": "Allie",
                "SUBAD1": "Asdf",
                "SUBAD2": "",
                "SUBCITY": "Asdf",
                "SUBSTATE": "AA",
                "SUBZIP": "10001",
                "RELTOSUB": "",
                "SUBGENDER": "F",
                "SUBBDAY": "1967-05-29T00:00:00"
              }
            ],
            "ResposibleParty":[
              {  
                "RID":"1501",
                "RPTY":"CA",
                "AD":"559  MAPLEWOOD AVE",
                "AD2":"",
                "CT":"STRUTHERS",
                "ST":"OH",
                "ZP":"44471",
                "FN":"John",
                "LN":"Kerry",
                "HP":"85452789999",
                "WP":"67845311888",
                "CP":"71467777444",
                "EM": "john.doe@hotmail.com",
                "SX": "F",
                "BD": "02/29/2000"
              }
            ]
        }
      ],
      "TotalRecords":"1659",
      "Message":""
   },
   "Exception":null,
   "ResponseCode":200
}

POST Communicator Batch - Appointment /v2/api/Patient/CommunicatorBatchAppointment/

Description: Returns all appointment data for the given PGID/OID combination.

Request Information

Parameter	Type	Max-Length	Required	Description
OID	Integer	-	Required	Office ID
PAGEINDEX	Integer	-	Required	Page Index Number (1000 record per page)
INCLUDENONHOMEOFFICETRANSACTIONS	boolean	-	Optional	To Include Appointments Outside Current Office
INCLUDEAPPTCODES	boolean	-	Optional	To Include Current Patient Insurance

                                    
    {  
   "Successful":true,
   "Data":{  
      "Appointment":[  
               {  
                  "APID":"4578",
                  "PID":"1001",
                  "ISNP":"False",
                  "OPID":"101",
                  "OPN":"op1",
                  "ATY": "Appointment",
                  "O":"1",
                  "OSID": "DSMILE",
                  "APD":"04/24/2017",
                  "PDR":"195",
                  "SID": "HYG1",
                  "FN": "JOE",
                  "LN": "SMITH",
                  "HP": "5559829003",
                  "WP": "5550928231",
                  "CP": "5553879283",
                  "EM": "test@planetdds.com",
                  "APS":"Valid",
                  "ISC":"False",
                  "ISM":"False",
                  "ISP":"False",
                  "ISN":"False",
                  "ISASAP": false,
                  "WSKPT": 1,
                  "APN":"Need follow up in 2 weeks",
                  "APL":"10",
                  "FEE":68.00,
                  "CBO":"04/24/2017T00:49:00",
                  "CBY":"ADAM.JACK",
                  "MBO":"",
                  "MBY":"",
                  "Codes": [
                    {
                        "CD": "D0180",
                        "DES": "Compsve Perio Eval New/Est Pat"
                    }
                  ]
               }
            ]
      
      },
      "TotalRecords":"1659",
      "Message":""
   },
   "Exception":null,
   "ResponseCode":200
}

POST Communicator Batch - Ledger /v2/api/Patient/CommunicatorBatchLedger/

Description: Returns all ledger data for the given PGID/OID combination.

Request Information

Parameter	Type	Max-Length	Required	Description
OID	Integer	-	Required	Office ID
PAGEINDEX	Integer	-	Required	Page Index Number (1000 record per page)
INCLUDENONHOMEOFFICETRANSACTIONS	boolean	-	Optional	To Include Ledger Records Outside Current Office

                                    
    {  
   "Successful":true,
   "Data":{  
        "Ledger":[  
            {  
                "PID":"1001",
                "RID":"1501",
                "LEID":"27490",
                "LTY":"C",
                "LTY2":"I",
                "CID":"123",
                "TD":"06/29/2017",
                "AMT":"220.0000",
                "CD":"D7140",
                "DES":"Extract Erupted Th/Expsed Root",
                "PRDUR":"",
                "PRPDR":"101",
                "PREPAT":"20.0000",
                "PREINS":"200.0000",
                "APID":"100",
                "TTH":  "1",
                "SURF": "M"
            }
        ],
        "TotalRecords":"1659",
        "Message":""
   },
   "Exception":null,
   "ResponseCode":200
}

POST Communicator Batch - Treatment Plan /v2/api/Patient/CommunicatorBatchTreatPlan/

Description: Returns all treatment plan data for the given PGID/OID combination.

Request Information

Parameter	Type	Max-Length	Required	Description
OID	Integer	-	Required	Office ID
PAGEINDEX	Integer	-	Required	Page Index Number (1000 record per page)
INCLUDENONHOMEOFFICETRANSACTIONS	boolean	-	Optional	To Include Treatment Plans Outside Current Office

                                    
    {  
   "Successful":true,
   "Data":{  
      "TXPlans": [
              {
                "PID": "583",
                "TXS": "U",
                "O": "106",
                "TXPID": "5696",
                "TXPN": "1",
                "TXPHASE": "1",
                "TXORDRID": "1",
                "TXPRPDT": "08/05/2018T00:00:00",
                "TXPREAUTHDT": "08/05/2018T00:00:00",
                "TXSTRTDT": "08/05/2018T00:00:00",
                "TXFD": "08/05/2018T00:00:00",
                "PDR": "206",
                "CD": "D0210",
                "ADACD": "D0210",
                "DES": "Intraoral Complete Incl Bwings",
                "TXDUR": "0",
                "ISSCHD": "False",
                "TXSCHD": "08/05/2018T00:00:00",
                "ISC": "False",
                "FEE": 50,
                "TXSP": "RAHUL",
                "ESTINS": 25,
                "ESTPAT": 25
              }
            ],
      "TotalRecords":"1659",
      "Message":""
   },
   "Exception":null,
   "ResponseCode":200
}

POST Communicator Batch - Patient Recall /v2/api/Patient/CommunicatorBatchRecall/

Description: Returns all patient recall data for the given PGID/OID combination.

Request Information

Parameter	Type	Max-Length	Required	Description
OID	Integer	-	Required	Office ID
PAGEINDEX	Integer	-	Required	Page Index Number (1000 record per page)
INCLUDENONHOMEOFFICETRANSACTIONS	boolean	-	Optional	To Include Recalls Outside Current Office

                                    
    {  
   "Successful":true,
   "Data":{  
      "Recall":[  
               {  
                  "PID":"1001",
                  "CD":"D7140",
                  "RCUNT": "mm",
                  "RCINT": 12,
                  "RDT":"10/17/2016",
                  "SCHDT": "",
                  "SCHTM": "",
                  "RR":"Follow up"
               }
            ],
      "TotalRecords":"1659",
      "Message":""
   },
   "Exception":null,
   "ResponseCode":200
}

POST Communicator Delta - Patient /v2/api/Patient/CommunicatorDeltaPatient/

Description: Returns all patient data for the given PGID/OID combination.

Request Information

Parameter	Type	Value	Max-Length	Required	Description
OID	Integer		-	Required	Office ID
INCLUDEINSURANCE	boolean		-	Optional	To Include Current Patient Insurance

                                    
{  
   "Successful":true,
   "Data":{  
      "PatientInfo":[  
         {  
            "RS":"Modified",
            "P":"200",
            "O":"101",
            "PID":"1001",
            "RID":"1501",
            "CNO":"CHRT07",
            "FN":"John",
            "LN":"Doe",
            "MI":"B",
            "AD":"151 Kalmus Dr",
            "AD2":"Street A156",
            "CT":"Costa Mesa",
            "ST":"CA",
            "ZP":"92626",
            "BD":"04/15/1980",
            "EM":"john.doe@gmail.com",
            "SX":"M",             
            "FV":"04/18/2017",
            "LV":"04/18/2017",
            "RFTY":"DOC",
            "RETRP":"",
            "HP":"85452789999",
            "WP":"67845311888",
            "CP":"71467777444",
            "PPRSID":"235",
            "AC":"True",
            "ISCD":"True",
            "ISAE":"True",
            "ISAS":"True",
            "PTY":"Cash, Collection",
            "CBY":"ADAM.JACK",
            "CBO":"12/02/2004T22:33:00",
            "MBY":"09/12/2017T23:50:00",
            "MBO":"ADMA.JACK",
            "Insurance": [
              {
                "PID": "583",
                "PRIMORSEC": "P",
                "INSID": "2121",
                "GRPNO": "000",
                "PLNID": "176",
                "PLNTY": "Denti-cal",
                "ANNIVDATE": "2018-01-01T00:00:00",
                "CARNAME": "Denti Cal",
                "CARAD1": "765 intel ave",
                "CARAD2": "#244",
                "CARCITY": "sacramento",
                "CARSTATE": "CA",
                "CARZIP": "92627",
                "CARPAYERID": "gggjj",
                "CARTY": "1",
                "CARPHONE": "0",
                "INDDEDUCT": 50,
                "INDDEDUCTREM": 0,
                "FAMDEDUCT": 50,
                "FAMDEDUCTREM": 0,
                "INDMAX": 50,
                "INDMAXREM": 36,
                "FAMMAX": 50,
                "FAMMAXREM": 36,
                "INDORTHOMAX": 50,
                "INDORTHOREM": 50,
                "SUBFNAME": "Chun",
                "SUBLNAME": "Allie",
                "SUBAD1": "Asdf",
                "SUBAD2": "",
                "SUBCITY": "Asdf",
                "SUBSTATE": "AA",
                "SUBZIP": "10001",
                "RELTOSUB": "",
                "SUBGENDER": "F",
                "SUBBDAY": "1967-05-29T00:00:00"
              },
              {
                "PID": "583",
                "PRIMORSEC": "S",
                "INSID": "2122",
                "GRPNO": "111",
                "PLNID": "256",
                "PLNTY": "Indemnity",
                "ANNIVDATE": "2017-01-01T00:00:00",
                "CARNAME": "Ae Insurance Company",
                "CARAD1": "123 Villa Sienna",
                "CARAD2": "",
                "CARCITY": "Irvine",
                "CARSTATE": "CA",
                "CARZIP": "92627",
                "CARPAYERID": "06126",
                "CARTY": "1",
                "CARPHONE": "0",
                "INDDEDUCT": 0,
                "INDDEDUCTREM": 0,
                "FAMDEDUCT": 0,
                "FAMDEDUCTREM": 0,
                "INDMAX": 1500,
                "INDMAXREM": 1493.6,
                "FAMMAX": 99999,
                "FAMMAXREM": 99992.6,
                "INDORTHOMAX": 1500,
                "INDORTHOREM": 1500,
                "SUBFNAME": "Chun",
                "SUBLNAME": "Allie",
                "SUBAD1": "Asdf",
                "SUBAD2": "",
                "SUBCITY": "Asdf",
                "SUBSTATE": "AA",
                "SUBZIP": "10001",
                "RELTOSUB": "",
                "SUBGENDER": "F",
                "SUBBDAY": "1967-05-29T00:00:00"
              }
            ],
            "ResposibleParty":[
              {  
                "RID":"1501",
                "RPTY":"CA",
                "AD":"559  MAPLEWOOD AVE",
                "AD2":"",
                "CT":"STRUTHERS",
                "ST":"OH",
                "ZP":"44471",
                "FN":"John",
                "LN":"Kerry",
                "HP":"85452789999",
                "WP":"67845311888",
                "CP":"71467777444",
                "EM": "john.doe@hotmail.com",
                "SX": "F",
                "BD": "02/29/2000"
              }
            ]
        }
      ],
      "TotalRecords":"1659",
      "Message":""
   },
   "Exception":null,
   "ResponseCode":200
}

POST Communicator Delta - Appointment /v2/api/Patient/CommunicatorDeltaAppointment/

Description: Returns all appointment data for the given PGID/OID combination.

Request Information

Parameter	Type	Max-Length	Required	Description
OID	Integer	-	Required	Office ID
INCLUDEAPPTCODES	boolean	-	Optional	To Include Current Patient Insurance
INCLUDENONHOMEOFFICETRANSACTIONS	boolean	-	Optional	To Include Appointments Outside Current Office

                                    
    {  
   "Successful":true,
   "Data":{  
      "Appointment":[  
               {  
                  "RS":"Modified",
                  "APID":"4578",
                  "PID":"1001",
                  "ISNP":"False",
                  "OPID":"101",
                  "FN": "JOE",
                  "LN": "SMITH",
                  "HP": "5551982809",
                  "WP": "5559827221",
                  "CP": "5553230999",
                  "EM": "test@denticon.com",
                  "OPN":"op1",
                  "ATY": "Appointment",
                  "O":"1",
                  "OSID":"OD",
                  "APD":"04/24/2017",
                  "PDR":"195",
                  "SID":"HYG1",
                  "APS":"Valid",
                  "ISC":"False",
                  "ISM":"False",
                  "ISP":"False",
                  "ISN":"False",
                  "ISASAP": false,
                  "WSKPT": 1,
                  "APN":"Need follow up in 2 weeks",
                  "APL":"10",
                  "FEE":68.00,
                  "CBO":"04/24/2017T00:49:00",
                  "CBY":"ADAM.JACK",
                  "MBO":"",
                  "MBY":"",
                  "Codes": [
                    {
                        "CD": "D0180",
                        "DES": "Compsve Perio Eval New/Est Pat"
                    }
                  ]
               }
       ],
      "TotalRecords":"1659",
      "Message":""
   },
   "Exception":null,
   "ResponseCode":200
}

POST Communicator Delta - Ledger /v2/api/Patient/CommunicatorDeltaLedger/

Description: Returns all ledger data for the given PGID/OID combination.

Request Information

Parameter	Type	Value	Max-Length	Required	Description
OID	Integer		-	Required	Office ID
INCLUDENONHOMEOFFICETRANSACTIONS	boolean		-	Optional	To Include Ledger Records Outside Current Office

                                    
    {  
   "Successful":true,
   "Data":{  
        "Ledger":[  
            {  
                "RS":"Modified",
                "PID":"1001",
                "RID":"1501",
                "LEID":"27490",
                "LTY":"C",
                "LTY2":"I",
                "CID":"123",
                "TD":"06/29/2017",
                "AMT":"220.0000",
                "CD":"D7140",
                "DES":"Extract Erupted Th/Expsed Root",
                "PRDUR":"",
                "PRPDR":"101",
                "PREPAT":"20.0000",
                "PREINS":"200.0000",
                "APID":"100",
                "TTH":  "1",
                "SURF": "M"
            }
        ],
        "TotalRecords":"1659",
        "Message":""
   },
   "Exception":null,
   "ResponseCode":200
}

POST Communicator Delta - Treatment Plan /v2/api/Patient/CommunicatorDeltaTreatPlan/

Description: Returns all treatment plan data for the given PGID/OID combination.

Request Information

Parameter	Type	Value	Max-Length	Required	Description
OID	Integer		-	Required	Office ID
INCLUDENONHOMEOFFICETRANSACTIONS	boolean		-	Optional	To Include Treatment Plans Outside Current Office

                                    
    {  
   "Successful":true,
   "Data":{  
      "TXPlans": [
              {
                "RS":"Modified",
                "PID": "583",
                "TXS": "U",
                "O": "106",
                "TXPID": "5696",
                "TXPN": "1",
                "TXPHASE": "1",
                "TXORDRID": "1",
                "TXPRPDT": "08/05/2018T00:00:00",
                "TXPREAUTHDT": "08/05/2018T00:00:00",
                "TXSTRTDT": "08/05/2018T00:00:00",
                "TXFD": "08/05/2018T00:00:00",
                "PDR": "206",
                "CD": "D0210",
                "ADACD": "D0210",
                "DES": "Intraoral Complete Incl Bwings",
                "TXDUR": "0",
                "ISSCHD": "False",
                "TXSCHD": "08/05/2018T00:00:00",
                "ISC": "False",
                "FEE": 50,
                "TXSP": "RAHUL",
                "ESTINS": 25,
                "ESTPAT": 25              
              }
            ],
      "TotalRecords":"1659",
      "Message":""
   },
   "Exception":null,
   "ResponseCode":200
}

POST Communicator Delta - Patient Recall /v2/api/Patient/CommunicatorDeltaRecall/

Description: Returns all patient recall data for the given PGID/OID combination.

Request Information

Parameter	Type	Value	Max-Length	Required	Description
OID	Integer		-	Required	Office ID
INCLUDENONHOMEOFFICETRANSACTIONS	boolean		-	Optional	To Include Recalls Outside Current Office

                                    
    {  
   "Successful":true,
   "Data":{  
      "Recall":[  
               {  
                  "RS":"Modified",
                  "PID":"1001",
                  "CD":"D7140",
                  "RCUNT": "mm",
                  "RCINT": 12,
                  "RDT":"10/17/2016",
                  "SCHDT": "",
                  "SCHTM": "",
                  "RR":"Follow up"
               }
            ],
      "TotalRecords":"1659",
      "Message":""
   },
   "Exception":null,
   "ResponseCode":200
}

POST Delta - Patient /v2/api/Patient/DeltaPatient/

Description: Returns all patient data modified between the time range specified for the given PGID/OID combination.

Request Information

Parameter	Type	Max-Length	Required	Description
OID	Integer	-	Required	Office ID
PAGEINDEX	Integer	-	Required	Page Index Number (1000 record per page)
INCLUDEINSURANCE	boolean	-	Optional	To Include Current Patient Insurance
FROMDATE	Date	-	Required	Last Modified Date (MM/DD/YYYY)
FROMTIME	Time	-	Optional	Time (HH:MM) in 24 hr format
TODATE	Date	-	Required	Last Modified Date (MM/DD/YYYY)
TOTIME	Time	-	Optional	Time (HH:MM) in 24 hr format

                                    
{  
   "Successful":true,
   "Data":{  
      "PatientInfo":[  
         {  
            "RS":"Modified",
            "P":"200",
            "O":"101",
            "PID":"1001",
            "RID":"1501",
            "CNO":"CHRT07",
            "FN":"John",
            "LN":"Doe",
            "MI":"B",
            "AD":"151 Kalmus Dr",
            "AD2":"Street A156",
            "CT":"Costa Mesa",
            "ST":"CA",
            "ZP":"92626",
            "BD":"04/15/1980",
            "EM":"john.doe@gmail.com",
            "SX":"M",             
            "FV":"04/18/2017",
            "LV":"04/18/2017",
            "RFTY":"DOC",
            "RETRP":"",
            "HP":"85452789999",
            "WP":"67845311888",
            "CP":"71467777444",
            "PPRSID":"235",
            "AC":"True",
            "ISCD":"True",
            "ISAE":"True",
            "ISAS":"True",
            "PTY":"Cash, Collection",
            "CBY":"ADAM.JACK",
            "CBO":"12/02/2004T22:33:00",
            "MBY":"09/12/2017T23:50:00",
            "MBO":"ADMA.JACK",
            "Insurance": [
              {
                "PID": "583",
                "PRIMORSEC": "P",
                "INSID": "2121",
                "GRPNO": "000",
                "PLNID": "176",
                "PLNTY": "Denti-cal",
                "ANNIVDATE": "2018-01-01T00:00:00",
                "CARNAME": "Denti Cal",
                "CARAD1": "765 intel ave",
                "CARAD2": "#244",
                "CARCITY": "sacramento",
                "CARSTATE": "CA",
                "CARZIP": "92627",
                "CARPAYERID": "gggjj",
                "CARTY": "1",
                "CARPHONE": "0",
                "INDDEDUCT": 50,
                "INDDEDUCTREM": 0,
                "FAMDEDUCT": 50,
                "FAMDEDUCTREM": 0,
                "INDMAX": 50,
                "INDMAXREM": 36,
                "FAMMAX": 50,
                "FAMMAXREM": 36,
                "INDORTHOMAX": 50,
                "INDORTHOREM": 50,
                "SUBFNAME": "Chun",
                "SUBLNAME": "Allie",
                "SUBAD1": "Asdf",
                "SUBAD2": "",
                "SUBCITY": "Asdf",
                "SUBSTATE": "AA",
                "SUBZIP": "10001",
                "RELTOSUB": "",
                "SUBGENDER": "F",
                "SUBBDAY": "1967-05-29T00:00:00"
              },
              {
                "PID": "583",
                "PRIMORSEC": "S",
                "INSID": "2122",
                "GRPNO": "111",
                "PLNID": "256",
                "PLNTY": "Indemnity",
                "ANNIVDATE": "2017-01-01T00:00:00",
                "CARNAME": "Ae Insurance Company",
                "CARAD1": "123 Villa Sienna",
                "CARAD2": "",
                "CARCITY": "Irvine",
                "CARSTATE": "CA",
                "CARZIP": "92627",
                "CARPAYERID": "06126",
                "CARTY": "1",
                "CARPHONE": "0",
                "INDDEDUCT": 0,
                "INDDEDUCTREM": 0,
                "FAMDEDUCT": 0,
                "FAMDEDUCTREM": 0,
                "INDMAX": 1500,
                "INDMAXREM": 1493.6,
                "FAMMAX": 99999,
                "FAMMAXREM": 99992.6,
                "INDORTHOMAX": 1500,
                "INDORTHOREM": 1500,
                "SUBFNAME": "Chun",
                "SUBLNAME": "Allie",
                "SUBAD1": "Asdf",
                "SUBAD2": "",
                "SUBCITY": "Asdf",
                "SUBSTATE": "AA",
                "SUBZIP": "10001",
                "RELTOSUB": "",
                "SUBGENDER": "F",
                "SUBBDAY": "1967-05-29T00:00:00"
              }
            ],
            "ResposibleParty":[
              {  
                "RID":"1501",
                "RPTY":"CA",
                "AD":"559  MAPLEWOOD AVE",
                "AD2":"",
                "CT":"STRUTHERS",
                "ST":"OH",
                "ZP":"44471",
                "FN":"John",
                "LN":"Kerry",
                "HP":"85452789999",
                "WP":"67845311888",
                "CP":"71467777444",
                "EM": "john.doe@hotmail.com",
                "SX": "F",
                "BD": "02/29/2000"
              }
            ]
        }
      ],
      "TotalRecords":"1659",
      "Message":""
   },
   "Exception":null,
   "ResponseCode":200
}

POST Delta - Appointment /v2/api/Patient/DeltaAppointment/

Description: Returns all appointment data modified between the time range specified for the given PGID/OID combination.

Request Information

Parameter	Type	Max-Length	Required	Description
OID	Integer	-	Required	Office ID
PAGEINDEX	Integer	-	Required	Page Index Number (1000 record per page)
INCLUDEAPPTCODES	boolean	-	Optional	To Include Current Patient Insurance
FROMDATE	Date	-	Required	Last Modified Date (MM/DD/YYYY)
FROMTIME	Time	-	Optional	Time (HH:MM) in 24 hr format
TODATE	Date	-	Required	Last Modified Date (MM/DD/YYYY)
TOTIME	Time	-	Optional	Time (HH:MM) in 24 hr format
INCLUDENONHOMEOFFICETRANSACTIONS	boolean	-	Optional	To Include Appointments Outside Current Office

                                    
    {  
   "Successful":true,
   "Data":{  
      "Appointment":[  
                {  
                    "RS":"Modified",
                    "APID":"4578",
                    "PID":"1001",
                    "ISNP":"False",
                    "OPID":"101",
                    "OPN":"op1",
                    "ATY": "Appointment",
                    "O":"1"
                    "OSID": "DSMILE",
                    "APD":"04/24/2017",
                    "FN": "JOE",
                    "LN": "SMITH",
                    "HP": "5551982809",
                    "WP": "5559827221",
                    "CP": "5553230999",
                    "EM": "test@denticon.com",
                    "PDR":"195",
                    "SID": "HYG1",
                    "APS":"Valid",
                    "ISC":"False",
                    "ISM":"False",
                    "ISP":"False",
                    "ISN":"False",
                    "ISASAP": false,
                    "WSKPT": 1,
                    "APN":"Need follow up in 2 weeks",
                    "APL":"10",
                    "FEE":68.00,
                    "CBO":"04/24/2017T00:49:00",
                    "CBY":"ADAM.JACK",
                    "MBO":"",
                    "MBY":"",
                    "Codes": [
                        {
                            "CD": "D0180",
                            "DES": "Compsve Perio Eval New/Est Pat"
                        }
                    ]
                }
        ],
        "TotalRecords":"1659",
        "Message":""
   },
   "Exception":null,
   "ResponseCode":200
}

POST Delta - Ledger /v2/api/Patient/DeltaLedger/

Description: Returns all ledger data modified between the time range specified for the given PGID/OID combination.

Request Information

Parameter	Type	Max-Length	Required	Description
OID	Integer	-	Required	Office ID
PAGEINDEX	Integer	-	Required	Page Index Number (1000 record per page)
FROMDATE	Date	-	Required	Last Modified Date (MM/DD/YYYY)
FROMTIME	Time	-	Optional	Time (HH:MM) in 24 hr format
TODATE	Date	-	Required	Last Modified Date (MM/DD/YYYY)
TOTIME	Time	-	Optional	Time (HH:MM) in 24 hr format
INCLUDENONHOMEOFFICETRANSACTIONS	boolean	-	Optional	To Include Ledger Records Outside Current Office

                                    
    {  
   "Successful":true,
   "Data":{  
        "Ledger":[  
            {  
                "RS":"Modified",
                "PID":"1001",
                "RID":"1501",
                "LEID":"27490",
                "LTY":"C",
                "LTY2":"I",
                "CID":"123",
                "TD":"06/29/2017",
                "AMT":"220.0000",
                "CD":"D7140",
                "DES":"Extract Erupted Th/Expsed Root",
                "PRDUR":"",
                "PRPDR":"101",
                "PREPAT":"20.0000",
                "PREINS":"200.0000",
                "APID":"100",
                "TTH":  "1",
                "SURF": "M"
            }
        ],
        "TotalRecords":"1659",
        "Message":""
   },
   "Exception":null,
   "ResponseCode":200
}

POST Delta - Treatment Plan /v2/api/Patient/DeltaTreatPlan/

Description: Returns all treatment plan data modified between the time range specified for the given PGID/OID combination.

Request Information

Parameter	Type	Max-Length	Required	Description
OID	Integer	-	Required	Office ID
PAGEINDEX	Integer	-	Required	Page Index Number (1000 record per page)
FROMDATE	Date	-	Required	Last Modified Date (MM/DD/YYYY)
FROMTIME	Time	-	Optional	Time (HH:MM) in 24 hr format
TODATE	Date	-	Required	Last Modified Date (MM/DD/YYYY)
TOTIME	Time	-	Optional	Time (HH:MM) in 24 hr format
INCLUDENONHOMEOFFICETRANSACTIONS	boolean	-	Optional	To Include Treatment Plans Outside Current Office

                                    
    {  
   "Successful":true,
   "Data":{  
      "TXPlans": [
              {
                "RS":"Modified",
                "PID": "583",
                "TXS": "U",
                "O": "106",
                "TXPID": "5696",
                "TXPN": "1",
                "TXPHASE": "1",
                "TXORDRID": "1",
                "TXPRPDT": "08/05/2018T00:00:00",
                "TXPREAUTHDT": "08/05/2018T00:00:00",
                "TXSTRTDT": "08/05/2018T00:00:00",
                "TXFD": "08/05/2018T00:00:00",
                "PDR": "206",
                "CD": "D0210",
                "ADACD": "D0210",
                "DES": "Intraoral Complete Incl Bwings",
                "TXDUR": "0",
                "ISSCHD": "False",
                "TXSCHD": "08/05/2018T00:00:00",
                "ISC": "False",
                "FEE": 50,
                "TXSP": "RAHUL",
                "ESTINS": 25,
                "ESTPAT": 25
              }
            ],
      "TotalRecords":"1659",
      "Message":""
   },
   "Exception":null,
   "ResponseCode":200
}

POST Delta - Patient Recall /v2/api/Patient/DeltaRecall/

Description: Returns all patient recall data modified between the time range specified for the given PGID/OID combination.

Request Information

Parameter	Type	Max-Length	Required	Description
OID	Integer	-	Required	Office ID
PAGEINDEX	Integer	-	Required	Page Index Number (1000 record per page)
FROMDATE	Date	-	Required	Last Modified Date (MM/DD/YYYY)
FROMTIME	Time	-	Optional	Time (HH:MM) in 24 hr format
TODATE	Date	-	Required	Last Modified Date (MM/DD/YYYY)
TOTIME	Time	-	Optional	Time (HH:MM) in 24 hr format
INCLUDENONHOMEOFFICETRANSACTIONS	boolean	-	Optional	To Include Recalls Outside Current Office

                                    
    {  
   "Successful":true,
   "Data":{  
      "Recall":[  
               {  
                  "RS":"Modified",
                  "PID":"1001",
                  "CD":"D7140",
                  "RCUNT": "mm",
                  "RCINT": 12,
                  "RDT":"10/17/2016",
                  "SCHDT": "",
                  "SCHTM": "",
                  "RR":"Follow up"
               }
            ],
      "TotalRecords":"1659",
      "Message":""
   },
   "Exception":null,
   "ResponseCode":200
}

POST Get All Patients /v2/api/Patient/AllPatients

Description: Returns a list of patients for the given PGID/OID combination.

Request Information

Parameter	Type	Value	Max-Length	Required	Description
OID	Integer		-	Optional	Office ID
PAGEINDEX	Integer		-	Required	Page Index Number (1000 record per page)

                                    
 {  
   "Successful":true,
   "Data":{  
      "TotalRecords":"1652",
      "Patients":[  
         {  
            "O":101,
            "PID":1001,
            "RID":1501,
            "CNO":CHRT01,
            "FN":"John",
            "LN":"Doe",
            "MI":"D",
            "EM":"john.doe@gmail.com",
            "AD": "151 Kalmus Dr",
            "AD2": "Street #A",
            "CT": "Costa Mesa",
            "ST": "CA",
            "ZP": "92626",
            "BD":"11/16/1980",
            "SX": "M",
            "HP":"85452789999",
            "CP":"71467777444",
            "WP":"2134567890",
            "AC":true,
            "FV":"04/18/2017T00:00:00",
            "LV":"04/18/2017T00:00:00",
            "ISCD": "false",
            "ISAE": "true",
            "ISAS": "true",
            "BLC":"68.00"
         } 
      ],
      "Message":""
   },
   "Exception":null,
   "ResponseCode":200
}

POST Get Patient Detail /v2/api/Patient/GetPatientDetail

Description: Returns details of a single patient based off the supplied PATID.

Request Information

Parameter	Type	Max-Length	Required	Description
PATIENTID	Integer	-	Required	Patient Indentification Number
INCLUDEINSURANCE	boolean	-	Optional	To Include Patient Insurance Details
INCLUDETXPLAN	boolean	-	Optional	To Include Patient Treatment Plan Details

                                    
{
  "Successful": true,
  "Data": {
    "P": "1",
    "O": 101,
    "PID": 1001,
    "RID": 1501,
    "CNO": "CHRT01",
    "FN": "John",
    "LN": "Doe",
    "MI": "D",
    "EM": "john.doe@gmail.com",
    "AD": "151 Kalmus Dr",
    "AD2": "Street #A",
    "ISO": false,
    "CT": "Costa MESA",
    "ST": "CA",
    "ZP": "92626",
    "BD": "02/13/1977",
    "SX": "M",
    "HP":"85452789999",
    "CP":"71467777444",
    "AC": true,
    "FV": "09/07/2004T00:00:00",
    "LV": "10/09/2017T00:00:00",
    "ISCD": false,
    "ISAE": true,
    "ISAS": true,
    "WP": "9874169834",
    "RETRP": "S",
    "RFTY": "DOC",
    "RFBY": "",
    "PTY": "Cash, Collection, Senior Citizen",
    "PPRSID": 235,
    "PN": "Allergic to nuts",
    "MEDA": "ALLRGY NUTS",
    "BLC":"68.00",
    "OVR30": 0,
    "OVR60": 0,
    "OVR90": 0,
    "OVR120": 0,
    "CURRBLC": 0,
    "CBO": "09/07/2004T18:17:00",
    "CBY": "ADAM.JACK",
    "MBO": "09/12/2017T23:50:00",
    "MBY": "ADAM.JACK",
    "INSURANCE": [
      {
        "PID": "1001",
        "PRIMORSEC": "P",
        "INSID": "2121",
        "GRPNO": "000",
        "PLNID": "176",
        "PLNTY": "Denti-cal",
        "ANNIVDATE": "2018-01-01T00:00:00",
        "CARNAME": "Denti Cal",
        "CARAD1": "765 intel ave",
        "CARAD2": "#244",
        "CARCITY": "sacramento",
        "CARSTATE": "CA",
        "CARZIP": "92627",
        "CARPAYERID": "gggjj",
        "CARTY": "1",
        "CARPHONE": "0",
        "INDDEDUCT": 50,
        "INDDEDUCTREM": 0,
        "FAMDEDUCT": 50,
        "FAMDEDUCTREM": 0,
        "INDMAX": 50,
        "INDMAXREM": 36,
        "FAMMAX": 50,
        "FAMMAXREM": 36,
        "INDORTHOMAX": 50,
        "INDORTHOREM": 50,
        "SUBFNAME": "Chun",
        "SUBLNAME": "Allie",
        "SUBAD1": "Asdf",
        "SUBAD2": "",
        "SUBCITY": "Asdf",
        "SUBSTATE": "AA",
        "SUBZIP": "10001",
        "RELTOSUB": "",
        "SUBGENDER": "F",
        "SUBBDAY": "1967-05-29T00:00:00"
      },
      {
        "PID": "1001",
        "PRIMORSEC": "S",
        "INSID": "2122",
        "GRPNO": "111",
        "PLNID": "256",
        "PLNTY": "Indemnity",
        "ANNIVDATE": "2017-01-01T00:00:00",
        "CARNAME": "Ae Insurance Company",
        "CARAD1": "123 Villa Sienna",
        "CARAD2": "",
        "CARCITY": "Irvine",
        "CARSTATE": "CA",
        "CARZIP": "92627",
        "CARPAYERID": "06126",
        "CARTY": "1",
        "CARPHONE": "0",
        "INDDEDUCT": 0,
        "INDDEDUCTREM": 0,
        "FAMDEDUCT": 0,
        "FAMDEDUCTREM": 0,
        "INDMAX": 1500,
        "INDMAXREM": 1493.6,
        "FAMMAX": 99999,
        "FAMMAXREM": 99992.6,
        "INDORTHOMAX": 1500,
        "INDORTHOREM": 1500,
        "SUBFNAME": "Chun",
        "SUBLNAME": "Allie",
        "SUBAD1": "Asdf",
        "SUBAD2": "",
        "SUBCITY": "Asdf",
        "SUBSTATE": "AA",
        "SUBZIP": "10001",
        "RELTOSUB": "",
        "SUBGENDER": "F",
        "SUBBDAY": "1967-05-29T00:00:00"
      }
    ],
    "TXPlans": [
      {
        "TXS": "D",
        "O": 1,
        "PID": 64,
        "TXPID": 2,
        "TXPN": 3,
        "TXPHASE": 1,
        "TXORDERID": 2,
        "TXPRPDT": "2021-05-25T00:00:00",
        "TXPREAUTHDT": null,
        "TXSTRTDT": null,
        "TXFD": null,
        "PDR": 102,
        "CD": "01102",
        "ADACD": "01102",
        "DES": "COMPLETE EXAM,MIXED",
        "TXDUR": 0,
        "ISSCHD": null,
        "TXSCHD": null,
        "ISC": null,
        "FEE": 0,
        "TXSP": "SPEEDMAN3600",
        "ESTINS": 25,
        "ESTPAT": 25
      }
    ]
  },
  "Exception": null,
  "ResponseCode": 200
}

POST Get All Responsible Parties /v2/api/Patient/AllRespParties

Description: Returns a list of all responsible parties for the given PGID/OID combination.

Request Information

Parameter	Type	Value	Max-Length	Required	Description
OID	Integer		-	Required	Office ID (Positive Integer)
PAGEINDEX	Integer		-	Required	Page Index Number (100 record per page)

                                    
  {  
   "Successful":true,
   "Data":{  
      "TotalRecords":"1147",
      "ResponsibleParty":[  
         {  
            "O":101,
            "RID":1501,
            "FN":"John",
            "LN":"Doe",
            "MI":"D",
            "EM":"john.doe@gmail.com",
            "SX":"M",
            "HP":"85452789999",
            "CP":"71467777444",
            "RPTY":"CA",
            "BD": "02/29/2000"
         } 
      ],
      "Message":""
   },
   "Exception":null,
   "ResponseCode":200
}

POST Get All Patient Ledger /v2/api/Patient/GetPatientLedger

Description: Returns all patient ledger records.

Request Information

Parameter	Type	Value	Max-Length	Required	Description
PATID	Integer		-	Required	Patient ID

                                    
{
"Successful": true,
"Data": {
    "TotalRecords": "1",
    "Ledger": [
        {
            "P": "1",
            "PID": "64",
            "RID": "64",
            "LEID": "10736",
            "LTY": "C",
            "LTY2": "I",
            "CID": "123",
            "TD": "09/18/2016",
            "AMT": "26.1600",
            "CD": "123",
            "DES": "A Medical Code",
            "PRDUR": "0",
            "PRPDR": "107",
            "PREPAT": "0.0000",
            "PREINS": "26.1600",
            "APID": "2011",
            "TTH":  "1",
            "SURF": "M"
        }
    ],
    "Message":""
},
"Exception":null,
"ResponseCode":200
}

POST Get All Patients Ledger By Date Range /v2/api/Patient/GetPatientLedgerDateRange

Description: Returns all patients ledger records with a transaction date that falls between the dates specified.

Request Information

Parameter	Type	Max-Length	Required	Description
FROMDATE	Date	-	Required	Last Modified Date (MM/DD/YYYY)
TODATE	Date	-	Required	Last Modified Date (MM/DD/YYYY)
OID	Integer		Optional	Office ID - If empty, ledger data for all offices the vendor has access to will be returned

                                    
{
"Successful": true,
"Data": {
    "TotalRecords": "1",
    "Ledger": [
        {
            "P": "1",
            "PID": "64",
            "RID": "64",
            "LEID": "10736",
            "LTY": "C",
            "LTY2": "I",
            "CID": "123",
            "TD": "09/18/2016",
            "AMT": "26.1600",
            "CD": "123",
            "DES": "A Medical Code",
            "PRDUR": "0",
            "PRPDR": "107",
            "PREPAT": "0.0000",
            "PREINS": "26.1600",
            "APID": "2011",
            "TTH":  "1",
            "SURF": "M"
        }
    ],
    "Message":""
},
"Exception":null,
"ResponseCode":200
}

POST Get Initial Sync Data Overnight /v2/api/Patient/InitialBatchSync

Description: Returns all initial sync data as a zip file. Records are processed nightly.

Request Information

Parameter	Type	Max-Length	Required	Description
OID	Integer		Required	Office ID
INCLUDEINSURANCE	boolean	-	Optional	To Include Current Patient Insurance
INCLUDEAPPTCODES	boolean	-	Optional	To Include Codes in Appointment Objects

                                    
{
  "Successful": true,
  "Data": [
    {
      "IsSuccess": 1,
      "Message": "Successfully added batch request. Check back tomorrow for download file.",
      "Password": ""
    }
  ],
  "Exception":null,
  "ResponseCode":200
}

GET Get Initial Sync Data Overnight /v2/api/Patient/InitialBatchDownload

Description: Returns batch file download URL. Records are processed nightly.

Request Information

Parameter	Type	Value	Max-Length	Required	Description
OID	Integer			Required	Office ID
Password	String			Required	Password for the download file.

                                    
{
  "Successful": true,
  "Data": [
    {
      "IsSuccess": 1,
      "Message": "File ready for download.",
      "DownloadURL": ""
    }
  ],
  "Exception":null,
  "ResponseCode":200
}

POST Get Appointments By PID /v2/api/Patient/GetAppointments

Description: Get all appointments by PID

Request Information

Parameter	Type	Value	Max-Length	Required	Description
PID	Integer			Required	Patient ID
OID	Integer			Optional	Office ID

                                    
 {
  "Successful": true,
  "Data": [
    {
      "APID": 4558,
      "PRODTY": 43,
      "PID": 1449,
      "O": 101,
      "OPN": "03",
      "OPID": 104,
      "FN": "JOHN",
      "LN": "DOE",
      "HP": "85452789999",
      "WP": "67845311888",
      "CP": "1111111111",
      "EM": "test@denticon.com",
      "ATY": "Appointment",
      "APD": "2020-11-16T15:30:00",
      "PDR": 341,
      "PDRID": "",
      "OSID": "",
      "APS": "Valid and Un-confirmed",
      "ISC": false,
      "ISM": false,
      "ISP": false,
      "ISN": false,
      "ISASAP": false,
      "WSKPT": "1",
      "APN": "Appointment Name",
      "APL": 15,
      "FEE": 0,
      "CBO": "2020-11-24T23:35:00",
      "CBY": "DenticonUser1",
      "MBO": "2020-12-07T12:44:00",
      "MBY": "DenticonUser2"
    },
    {
      "APID": 4560,
      "PRODTY": 9,
      "PID": 1449,
      "O": 104,
      "OPN": "3",
      "OPID": 117,
      "FN": "JOHN",
      "LN": "DOE",
      "HP": "85452789999",
      "WP": "67845311888",
      "CP": "1111111111",
      "EM": "test@denticon.com",
      "ATY": "Appointment",
      "APD": "2020-11-25T10:30:00",
      "PDR": 224,
      "PDRID": "001234",
      "OSID": "DDC",
      "APS": "Valid and Un-confirmed",
      "ISC": false,
      "ISM": false,
      "ISP": false,
      "ISN": false,
      "ISASAP": false,
      "WSKPT": "1",
      "APN": "Appointment Name",
      "APL": 30,
      "FEE": 0,
      "CBO": "2020-11-25T02:32:00",
      "CBY": "DenticonUser1",
      "MBO": "",
      "MBY": "DenticonUser2"
    },
    {
      "APID": 4564,
      "PRODTY": 20,
      "PID": 1449,
      "O": 101,
      "OPN": "04",
      "OPID": 105,
      "FN": "JOHN",
      "LN": "DOE",
      "HP": "85452789999",
      "WP": "67845311888",
      "CP": "1111111111",
      "EM": "test@denticon.com",
      "ATY": "Appointment",
      "APD": "2020-11-28T10:45:00",
      "PDR": 341,
      "PDRID": "",
      "OSID": "",
      "APS": "Valid and Un-confirmed",
      "ISC": false,
      "ISM": false,
      "ISP": false,
      "ISN": false,
      "ISASAP": false,
      "WSKPT": "1",
      "APN": "Appointment Name",
      "APL": 105,
      "FEE": 212,
      "CBO": "2020-11-25T22:32:00",
      "CBY": "DenticonUser1",
      "MBO": "",
      "MBY": "DenticonUser2"
    }
  ],
  "Exception": null,
  "ResponseCode": 200
}

GET Get Account Balance /v2/api/Patient/GetAccountBalance

Description: Returns the account balance of the Responsible Party by RID

Request Information

Parameter	Type	Value	Max-Length	Required	Description
RID	Integer			Required	Responsible Party ID

                                    
{
  "Successful": true,
  "Data": [
    {
      "BLC":150.50
    }
  ],
  "Exception":null,
  "ResponseCode":200
}

Patient V2 Interactive API List

Service Authentication :

POST Communicator Batch - Patient /v2/api/Patient/CommunicatorBatchPatient/

Request Information

Request URL

Request JSON

HTTP Status Code

Request Headers

Request Body

POST Communicator Batch - Appointment /v2/api/Patient/CommunicatorBatchAppointment/

Request Information

Request URL

Request JSON

HTTP Status Code

Request Headers

Request Body

POST Communicator Batch - Ledger /v2/api/Patient/CommunicatorBatchLedger/

Request Information

Request URL

Request JSON

HTTP Status Code

Request Headers

Request Body

POST Communicator Batch - Treatment Plan /v2/api/Patient/CommunicatorBatchTreatPlan/

Request Information

Request URL

Request JSON

HTTP Status Code

Request Headers

Request Body

POST Communicator Batch - Patient Recall /v2/api/Patient/CommunicatorBatchRecall/

Request Information

Request URL

Request JSON

HTTP Status Code

Request Headers

Request Body

POST Communicator Delta - Patient /v2/api/Patient/CommunicatorDeltaPatient/

Request Information

Request URL

Request JSON

HTTP Status Code

Request Headers

Request Body

POST Communicator Delta - Appointment /v2/api/Patient/CommunicatorDeltaAppointment/

Request Information

Request URL

Request JSON

HTTP Status Code

Request Headers

Request Body

POST Communicator Delta - Ledger /v2/api/Patient/CommunicatorDeltaLedger/

Request Information

Request URL

Request JSON

HTTP Status Code

Request Headers

Request Body

POST Communicator Delta - Treatment Plan /v2/api/Patient/CommunicatorDeltaTreatPlan/

Request Information

Request URL

Request JSON

HTTP Status Code

Request Headers

Request Body

POST Communicator Delta - Patient Recall /v2/api/Patient/CommunicatorDeltaRecall/

Request Information

Request URL

Request JSON

HTTP Status Code

Request Headers

Request Body

POST Delta - Patient /v2/api/Patient/DeltaPatient/

Request Information

Request URL

Request JSON

HTTP Status Code

Request Headers

Request Body

POST Delta - Appointment /v2/api/Patient/DeltaAppointment/