Appointment Types?

For requests or help with our API
Post Reply
TrueDentalApp
Posts: 4
Joined: Thu Apr 28, 2022 12:16 pm

Appointment Types?

Post by TrueDentalApp » Thu Apr 28, 2022 12:29 pm

Hi Vendor relations team,

We are looking to ‘create’ a new appointment via ‘API Appointment’

We would like to define the ‘Appointment Type’

We are unable to pass ‘defnumApptType’ value to set the correct AppointmentType?

As well we are not able to find the value for any of our ‘Appointment Types’ within the OpenDental software?
For example if I edit ‘Appointment Types’ where do I find the value that corresponds to that appointment?

Thank you!

SLeon
Posts: 168
Joined: Mon Mar 01, 2021 11:00 am

Re: Appointment Types?

Post by SLeon » Thu Apr 28, 2022 2:22 pm

Appointment Types are stored in their own table (appointmenttype). You can use Queries PUT ShortQuery to see the list of appointment types created by the dental office.

We will add "AppointmentType" as one of the fields that can be included when creating and modifying appointments. The method Appointments POST (create) does not yet support this. Once complete, you will use the primary key (AppointmentTypeNum) to specify the Appointment Type of the appointment you create.

TrueDentalApp
Posts: 4
Joined: Thu Apr 28, 2022 12:16 pm

Re: Appointment Types?

Post by TrueDentalApp » Thu Apr 28, 2022 3:09 pm

Hi SLeon

Thank you for your reply

That sounds great! I think adding 'AppointmentType' to the API Appointment, and
being able to create/update a specific 'AppointmentType' would be very valuable!

I would also appreciate if you could explain how I can view & setup 'AppointmentTypeNum' and its corresponding 'AppointmentType'.

For reference, below are the values that I'm able to pull from the AppointmentAPI

Thank you!

------------------------------------------

{
"AptNum": 57,
"PatNum": 9,
"AptStatus": "Scheduled",
"Pattern": "////////////",
"Confirmed": 21,
"confirmed": "Confirmed",
"Op": 6,
"Note": "Note to Brad.\r\nRequests reschedule",
"ProvNum": 3,
"provAbbr": "DOC2",
"ProvHyg": 0,
"AptDateTime": "2022-04-29 10:00:00",
"IsNewPatient": "False",
"ProcDescript": "",
"ClinicNum": "0",
"IsHygiene": "false",
"DateTStamp": "2022-04-28 14:24:46",
"Priority": "Normal",
"serverDateTime": "2022-04-28 14:24:56"
}

SLeon
Posts: 168
Joined: Mon Mar 01, 2021 11:00 am

Re: Appointment Types?

Post by SLeon » Thu Apr 28, 2022 3:26 pm

Right now you can send the following JSON to api.opendental.com/api/via/queries/ShortQuery to get a list of appointment types for the dental office.

Code: Select all

{
	"SqlCommand":"SELECT * FROM appointmenttype"
}
You will get back something like this:

Code: Select all

{
"AppointmentTypeNum": 1,
"AppointmentTypeName": "WebSched New Patient Default",
"AppointmentTypeColor": 0,
"ItemOrder": 0,
"IsHidden": 0,
"Pattern": "//XX//",
"CodeStr": ""
}, ...
Once we finish your feature request for Appointments POST, you will be able to include this line in your JSON body.

Code: Select all

"AppointmentTypeNum": 1,
And when you use Appointments GET, you will see it's type as follows:

Code: Select all

"AppointmentType": 1,
"appointmentType": "WebSched New Patient Default",

TrueDentalApp
Posts: 4
Joined: Thu Apr 28, 2022 12:16 pm

Re: Appointment Types?

Post by TrueDentalApp » Thu Apr 28, 2022 3:34 pm

Thank you SLeon!

I really appreciate you adding this feature request!

SLeon
Posts: 168
Joined: Mon Mar 01, 2021 11:00 am

Re: Appointment Types?

Post by SLeon » Fri May 20, 2022 10:21 am

We have completed this feature request. Appointments GET (single/multiple) will now display the AppointmentTypeNum for the appointment type. Our Appointments POST (create) and PUT (update) methods also support assigning an appointment type in the JSON body.

These methods will be available staring in version 22.1.32. For more information, see https://www.opendental.com/site/apiappointments.html.
Last edited by SLeon on Mon May 23, 2022 1:50 pm, edited 1 time in total.

TrueDentalApp
Posts: 4
Joined: Thu Apr 28, 2022 12:16 pm

Re: Appointment Types?

Post by TrueDentalApp » Mon May 23, 2022 1:10 pm

Thanks very much! I look forward to testing it once the new OD version is rolled out!

Post Reply