Skip to content

Commit

Permalink
improved elation documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
bejoinka committed May 1, 2023
1 parent 42264f8 commit 71647cb
Show file tree
Hide file tree
Showing 3 changed files with 58 additions and 0 deletions.
58 changes: 58 additions & 0 deletions extensions/elation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,61 @@ In order to use this extension you will need to provide the extension with the f
- Client Secret for OAuth2 Password authentication
- API Username for OAuth2 Password authentication
- API Password for OAuth2 Password authentication

## Actions

The following actions are supported with Elation today:

### Create Patient

Create a patient in the EHR. **Does not look for duplicates**

Required fields include:
- First Name
- Last Name
- Date of Birth (YYYY-MM-DD)
- Sex (Male, Female, Other, Unknown)
- Primary Physician (the ID of the physician, which you will be able to retrieve using the [Find Physicians](https://docs.elationhealth.com/reference/find-physicians) API call, or by using the `Find Physician` action)
- Caregiver Practice (the ID of the practice. Again, you can find using the same API call or action as listed above)

There are also a number of optional fields.

**NOTE: We currently do not support nested objects, so the entire patient object supported by elation's API is not yet exposed**. Please reach out to us if you're looking to add a particular field or set of fields.

### Get Patient

Using a patient identifier, get a patient object that has all datapoints listed above in `Create Patient`.

**NOTE: Because we don't yet support nested objects and arrays in extensions, we expose specifically the `mobile_phone` field, which is a search for the patient's mobile phone specifically.**

### Update Patient

Update a patient using any fields available in create patient.

Oddly enough, the following fields are always required by Elation:
- first_name
- last_name
- dob
- sex
- primary_physician
- caregiver_practice

![Postman request](./assets/elation-update-patient.png?raw=true "Bad Update Patient Request")

### Create Appointment

Create a patient appointment in your EHR for a given practice and physician.

Creating an appointment requires a few strings to be well-formulated:
- `Scheduled date` must be a datetime string (ISO-8601). For example, January 1, 2023 at noon, Pacific Time (-8 hours) would be shown as such: `2023-01-01T12:00:00.000-08:00`
- `Reason` must not be free text. This value comes from the following list of appointment types (`Follow-Up`, `Office Visit`, `Physical Exam`, etc.):
![Appointment types](./assets/elation-appointment-reason.png?raw=true "Elation Appointment Types")
- `Patient` is the patient ID.
- `Physician` is the physician ID (see `Find Physician`)
- `Practice` is the practice ID (again, see `Find Physician`)

You can also include a duration (default to 15 minutes, or whatever has been set in your EHR)

### Get Appointment

Get an appointment using an appointment ID. View all of the fields supported by the API.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 71647cb

Please sign in to comment.