Patient search improvement

For requests or help with our API
Post Reply
aearl23
Posts: 14
Joined: Wed Jan 22, 2025 3:33 pm

Patient search improvement

Post by aearl23 » Tue Feb 11, 2025 7:13 pm

Hello, I am currently wondering if there could be a GET/patients endpoint that uses FN and LN? This is currently the only option and it would be useful to have a search by FN and LN without requiring the DOB.

GET /patients?LName=smi

RyanH
Posts: 17
Joined: Thu Dec 19, 2024 8:33 am

Re: Patient search improvement

Post by RyanH » Wed Feb 12, 2025 10:32 am

aearl23 wrote:
Tue Feb 11, 2025 7:13 pm
Hello, I am currently wondering if there could be a GET/patients endpoint that uses FN and LN? This is currently the only option and it would be useful to have a search by FN and LN without requiring the DOB.

GET /patients?LName=smi
Hello aearl23,

Both Patients GET (multiple) and Patients GET Simple allow you to request patients by FName and LName. All parameters are optional for both endpoints, so Birthdate is not required - although it is recommended to ensure uniqueness when looking for a specific patient by name.

Thanks!

aearl23
Posts: 14
Joined: Wed Jan 22, 2025 3:33 pm

Re: Patient search improvement

Post by aearl23 » Wed Feb 12, 2025 4:01 pm

What is the required syntax for such ra equest?

I am trying a request formatted as : curl -i https://api.opendental.com/api/v1/patie ... FName={PHI} -H "Authorization: {key}/{key}"
and get this message : "You are missing an Authorization header."'FName' is not recognized as an internal or external command,
operable program or batch file.

justine
Posts: 265
Joined: Tue Dec 28, 2021 7:59 am

Re: Patient search improvement

Post by justine » Thu Feb 13, 2025 10:42 am

aearl23 wrote:
Wed Feb 12, 2025 4:01 pm
What is the required syntax for such ra equest?

I am trying a request formatted as : curl -i https://api.opendental.com/api/v1/patie ... FName={PHI} -H "Authorization: {key}/{key}"
and get this message : "You are missing an Authorization header."'FName' is not recognized as an internal or external command,
operable program or batch file.
Hello aearl23,

For syntax questions, I suggest reading curl documentation.

The error message "You are missing an Authorization header" suggests that your request is not properly including the required authentication.

The 'FName' is not recognized message suggests an issue with how the request is being formatted or executed in your command line environment. This is not related to the API itself but rather to how your request is being constructed or processed by your system. If I had to guess, your enviornment may require you to escape special characters or doesn't interperet {PHI} correctly.

Here's an example that worked fine in my environment:

Code: Select all

curl https://api.opendental.com/api/v1/patients?LName=Smith -H Authorization:"ODFHIR NFF6i0KrXrxDkZHt/VzkmZEaUWOjnQX2z" -H content-type:application/json
Thanks!

aearl23
Posts: 14
Joined: Wed Jan 22, 2025 3:33 pm

Re: Patient search improvement

Post by aearl23 » Wed Feb 19, 2025 5:27 pm

I am trying to do a request such as: curl https://api.opendental.com/api/v1/patie ... Nname=John where the last name and first name are used together. Is this possible?

justine
Posts: 265
Joined: Tue Dec 28, 2021 7:59 am

Re: Patient search improvement

Post by justine » Thu Feb 20, 2025 9:16 am

aearl23 wrote:
Wed Feb 19, 2025 5:27 pm
I am trying to do a request such as: curl https://api.opendental.com/api/v1/patie ... Nname=John where the last name and first name are used together. Is this possible?
Hello aearl23,

Your request example uses the param 'FNname' and should use 'FName'. The following example worked for me:

Code: Select all

curl "https://api.opendental.com/api/v1/patients?LName=Smith&FName=John" -H "Authorization: ODFHIR NFF6i0KrXrxDkZHt/VzkmZEaUWOjnQX2z" -H "Content-Type: application/json"
Thanks!

Post Reply