AppointmentTypeNumber for Appointments POST

[PBECKER]

Can we get some guidance on AppointmentTypeNumber for Appointments POST (create)

What values can we pass for AppointmentTypeNumber?
Where is their more rerferene info on how we can utilize AppointmentTypeNumber?

Thank you API team.

Appointments POST (create)

Version Added: 21.1

The following fields cannot be set as part of a POST: AptNum, provAbbr, ProcDescript, and UnschedStatus. Attempts to set them will be silently ignored.

PatNum: Required.
Op: Required.
AptDateTime: Required. String in "yyyy-MM-dd HH:mm:ss". Use Appointments GET Slots to find available times.
AptStatus: Optional. Either "Scheduled", "Complete", "UnschedList", "Planned", or (rarely used) "PtNote", "PtNoteCompleted". Default "Scheduled".
Pattern: Optional. Time pattern in 5 minute increments. A string consisting of 'X' and '/' characters only. Default "/XX/" (20 minutes).
Confirmed: Optional. Definition.DefNum where definition.Category=2. Default is the first definition in that Category.
Note: Optional. Default blank.
ProvNum: Optional. Defaults to the PriProv of the patient, if set, or the dental office's default provider.
ProvHyg: Optional. Default 0.
ClinicNum: Optional. Default is the ClinicNum of the Patient.
IsHygiene: Optional. Default "false".
IsNewPatient: (Added in version 21.3) Optional. Either "true" or "false". Default "false".
Priority: (Added in version 22.1) Optional. Either "Normal" or "ASAP". Default "Normal".
AppointmentTypeNum: (Added in version 22.1) Optional. FK to AppointmentType.AppointmentTypeNum. Default 0 (None). Follows the same logic for adding attached procedures, pattern, and color as in Open Dental. The pattern will only be applied if Pattern is not specified in the request.

[justine]

Can we get some guidance on AppointmentTypeNumber for Appointments POST (create)

What values can we pass for AppointmentTypeNumber?
Where is their more rerferene info on how we can utilize AppointmentTypeNumber?

Thank you API team.

Appointments POST (create)

Version Added: 21.1

The following fields cannot be set as part of a POST: AptNum, provAbbr, ProcDescript, and UnschedStatus. Attempts to set them will be silently ignored.

PatNum: Required.
Op: Required.
AptDateTime: Required. String in "yyyy-MM-dd HH:mm:ss". Use Appointments GET Slots to find available times.
AptStatus: Optional. Either "Scheduled", "Complete", "UnschedList", "Planned", or (rarely used) "PtNote", "PtNoteCompleted". Default "Scheduled".
Pattern: Optional. Time pattern in 5 minute increments. A string consisting of 'X' and '/' characters only. Default "/XX/" (20 minutes).
Confirmed: Optional. Definition.DefNum where definition.Category=2. Default is the first definition in that Category.
Note: Optional. Default blank.
ProvNum: Optional. Defaults to the PriProv of the patient, if set, or the dental office's default provider.
ProvHyg: Optional. Default 0.
ClinicNum: Optional. Default is the ClinicNum of the Patient.
IsHygiene: Optional. Default "false".
IsNewPatient: (Added in version 21.3) Optional. Either "true" or "false". Default "false".
Priority: (Added in version 22.1) Optional. Either "Normal" or "ASAP". Default "Normal".
AppointmentTypeNum: (Added in version 22.1) Optional. FK to AppointmentType.AppointmentTypeNum. Default 0 (None). Follows the same logic for adding attached procedures, pattern, and color as in Open Dental. The pattern will only be applied if Pattern is not specified in the request.

Hello PBECKER,

AppointmentTypeNum was added in version 22.1 and was requested by a developer here:
https://www.opendentalsoft.com:8085/for ... f=9&t=7770

Please see information about Appointment Types here:
https://www.opendental.com/manual/appointmenttypes.html

Appointments GET will return the AppointmentTypeNum for the appointment type.

You can use PUT /queries/ShortQuery to get a list of appointment types for the dental office.

Code: Select all

{
	"SqlCommand":"SELECT * FROM appointmenttype"
}

[PBECKER]

Hello Sarah

My apologies on the miscommunication.

We're trying to find out when we use POST Appointment how can we also attach a certain type of procedure code for example d110?

If we're not able to attach a procedure how how would the practice know what the appointment was created for if we dont' add the procedure code to the newly created appointment?

Please let me know thank you so much Sarah.

[SLeon]

Good morning Pedro,

There are two common ways you can add procedures to an appointment through the API:

1. Use the Appointments POST method and supply an AppointmentTypeNum in your JSON. This will automatically add the Pattern, Procedures, and Color associated with the specified Appointment Type. See https://www.opendental.com/site/apiappointments.html. This workflow is common for adding a set of procedures or adding procedures that have not been treatment planned.
2. Use Appointment POST to make an appointment without procedures. Use the AptNum of this newly created appointment with the Procedurelogs POST method to attach the procedure. See https://www.opendental.com/site/apiprocedurelogs.html. This workflow is common for adding procedures to existing appointments.

A third option you may also use is Appointments POST Planned to create planned appointments with procedures (either by AppointmentTypeNum or a list of ProcNums). Then when the patient is ready to schedule, use Appointments POST SchedulePlanned to schedule the appointment and place it on the appointment book.