API ProcedureCodes

See API Specification

ProcedureCodes GET

Version Added: 22.3.22

Gets a list of ProcedureCodes.

Example Request:
GET /procedurecodes
GET /procedurecodes?Limit=50&Offset=100

Example Response:
[
{
"CodeNum": 74,
"ProcCode": "D0120",
"Descript": "periodic oral evaluation - established patient",
"AbbrDesc": "PerEx",
"ProcTime": "/X/",
"ProcCat": 73,
"procCat": "Exams & Xrays",
"DefaultNote": "",
"IsHygiene": "false",
"MedicalCode": "",
"LaymanTerm": "",
"SubstitutionCode": "",
"SubstOnlyIf": "Always",
"DateTStamp": "2021-11-08 10:02:33",
"ProvNumDefault": 0,
"CanadaTimeUnits": 0,
"TaxCode": ""
},
{
"CodeNum": 75,
"ProcCode": "D0140",
"Descript": "limited oral evaluation - problem focused",
"AbbrDesc": "LimEx",
"ProcTime": "/X/",
"ProcCat": 73,
"procCat": "Exams & Xrays",
"DefaultNote": "",
"IsHygiene": "false",
"MedicalCode": "",
"LaymanTerm": "",
"SubstitutionCode": "C0123",
"SubstOnlyIf": "Molar",
"DateTStamp": "2021-11-08 10:02:33",
"ProvNumDefault": 0,
"CanadaTimeUnits": 0,
"TaxCode": ""
},
etc...
]

200 OK
400 BadRequest

ProcedureCodes POST (create)

Version Added: 22.3

Creates a new ProcedureCode.

ProcCode: Required. Dental code.
Descript: Required. The main description of the Procedure.
AbbrDesc: Required. Abbreviated description.
ProcCat: Required if procCat is not provided. FK to definition.DefNum where definition.Category=11.
procCat: Required if ProcCat is not provided. The string version of the definition.ItemName.

ProcTime: Optional. Default "/X/". Time pattern in 5 minute increments. A string consisting of 'X' and '/' characters only.
DefaultNote: Optional. The default note for this Procedure that will be copied to a ProcNote when marking complete.
IsHygiene: Optional. Either "true" or "false". Default "false".
MedicalCode: Optional. FK to procedurecode.ProcCode. The medical code that is being referenced must be setup first. Anytime a procedure is added, this medical code will also be added to that Procedure.
LaymanTerm: Optional. When creating treatment plans, this description will be used instead of the Descript.
SubstitutionCode: (Added in Version 22.4.9) Optional. FK to ProcedureCode.ProcCode. Used to create a substitution code at the procedure level. Case sensitive.
SubstOnlyIf: (Added in Version 22.4.9) Optional. Either "Always", "Molar", "SecondMolar", "Never", or "Posterior". Only used if SubstitutionCode is set. Default is "Always".
ProvNumDefault: Optional. FK to provider.ProvNum. 0 for none. Otherwise, this provider will override other providers.
CanadaTimeUnits: Optional. Tracks scaling insurance and periodontal scaling units for patients depending on coverage.
TaxCode: Optional. Used for determining sales tax to charge for this Procedure.

Example Request:
POST /procedurecodes
{
"ProcCode": "G0140",
"Descript": "limited oral evaluation - problem focused",
"AbbrDesc": "LimEx",
"ProcCat": 83
}

Example Response:
{
"CodeNum": 654,
"ProcCode": "G0140",
"Descript": "limited oral evaluation - problem focused",
"AbbrDesc": "LimEx",
"ProcTime": "/X/",
"ProcCat": 83,
"procCat": "Ortho",
"DefaultNote": "",
"IsHygiene": "false",
"MedicalCode": "",
"LaymanTerm": "",
"SubstitutionCode": "",
"SubstOnlyIf": "Always",
"DateTStamp": "2021-11-08 10:02:33",
"ProvNumDefault": 0,
"CanadaTimeUnits": 0,
"TaxCode": ""
}

201 Created
400 BadRequest (Missing or Invalid fields)
404 NotFound (Provider not found)