FormDr
  • Home
  • Getting Started
    • Quick Start
  • Documentation
    • Access Token
      • Using the Refresh Token
    • Get Practices
    • Get Forms List
    • Get Form by ID
    • Find Patient
    • Submissions
      • Get Submission
      • Create Submission
      • Update Submission
      • Delete Submission
      • List Submissions
    • Files
      • Get file
      • Upload file
      • PDF
    • Documents
      • Get Templates
      • Send Template To Sign
      • Get Document Submissions
      • Get Document By Id
      • Download Document PDF
  • Webhook
Powered by GitBook
On this page
  • Get a list of all patient submissions
  • Testing
  1. Documentation

Find Patient

Get a list of all submissions by Patient Name or Record ID

Get a list of all patient submissions

GET https://api.formdr.com/api/v1/practice/{practiceId}

Path Parameters

Name
Type
Description

practiceId

String

Practice ID

Query Parameters

Name
Type
Description

firstName*

String

Patient First Name

lastName*

String

Patient Last Name

[{
    submissionId: number,
    practiceId: number,
    formUuid: string,
    recordId: number,
    demographics: {
        firstName: string,
        middleName: string,
        lastName: string,
        preferredName: string,
        sex: string,
        birthday: string,
        email: string,
        primaryPhone: string,
        cellPhone: string,
        address: {
            address: string,
            address2: string,
            city: string,
            state: string,
            zip: string
        }
    }
}]
{
    "Not authorized"
}
{
    name: "Error",
    message: "No Record Found",
    "errors": []
}

If you are seeing multiple patient records of the same name, ensure that you form has a DOB field named "birthday". In order to match patient records and ensure submissions are going to the same patient record, firstName, lastName and birthday are the matchers.

Get a list of all submissions by Record ID

GET https://api.formdr.com/api/v1/practice/{practiceId}

Query Parameters

Name
Type
Description

recordId*

String

[{
    submissionId: number,
    practiceId: number,
    formUuid: string,
    recordId: number,
    demographics: {
        firstName: string,
        middleName: string,
        lastName: string,
        preferredName: string,
        sex: string,
        birthday: string,
        email: string,
        primaryPhone: string,
        cellPhone: string,
        address: {
            address: string,
            address2: string,
            city: string,
            state: string,
            zip: string
        }
    }
}]

Testing

For additional security, when you are testing using the test access tokens, you will not be able to retrieve any PHI data. The only data that will return is the firstName and lastName variables. The remaining variables with simply return a string of the key name.

PreviousGet Form by IDNextSubmissions

Last updated 1 year ago