BINSERA EHR - ONC 170.315(g7) - Patient Selection API Documentation

1. API Overview

The Patient Selection API allows authorized users to retrieve patient information and generate a token for secure access.

2. Authentication

All requests require a valid JWT token from an authenticated provider.

3. API Endpoints & Parameters

Get All Patients

GET /api/patients

Response: Returns a list of patients.

Search Patients by Name & DOB

GET /api/patients/search?name=John&dob=1985-01-01

Parameters:

• name (string, required) - Patient's first or last name
• dob (date, required) - Patient's date of birth (YYYY-MM-DD)

Response: Returns an array of matching patients.

Select a Patient by ID

GET /api/patients/{id}

Parameters:

• id (integer, required) - Unique Patient ID

Response: Returns the patient record and an access token.

4. Request Examples

Search for a Patient

    GET https://binsera.net/api/patients/search?name=John&dob=1985-01-01
    Authorization: Bearer {doctor_or_nurse_token}
    

Retrieve a Patient by ID

    GET https://binsera.net/api/patients/123
    Authorization: Bearer {doctor_or_nurse_token}
    

5. Response Examples

Search Response

    [
        {
            "PatientId": 123,
            "FirstName": "John",
            "LastName": "Doe",
            "DOB": "1985-01-01"
        }
    ]
    

Retrieve Patient Response

    {
        "PatientId": 123,
        "FirstName": "John",
        "LastName": "Doe",
        "DOB": "1985-01-01",
        "Token": "eyJhbGciOiJIUzI1NiIsInR..."
    }
    

6. Error Handling

If the patient is not found, the API returns:

    {
      "message": "Patient not found"
    }
    

7. Software Components & Configurations

To successfully interact with the API, an application must:

• Use JWT authentication to obtain and pass a valid access token.
• Send HTTP requests to the correct API endpoints using RESTful standards.
• Handle JSON responses appropriately.

8. API Terms & Conditions

By accessing the API, you agree to the following terms:

• The API must be used for authorized healthcare purposes only.
• Unauthorized access, modification, or misuse is strictly prohibited.
• BINSERA EHR reserves the right to monitor API usage and revoke access if abuse is detected.

For full API terms and conditions, refer to: https://binsera.com/api-terms

9. Public Access

This documentation is available at: https://binsera.com/g7-api-documentation