Patient-GET
Description
Retrieves a list of patients with summary demographic and health data like name, date of birth, gender, medications, conditions.
Use Cases
- Retrieve Patient Details: Obtain information on a specific patient
- Access Medical History: Retrieve details of a patient's medical history
- Query Vital Signs: Obtain specific vital sign details
- Review Lab Results: Access details of laboratory results
- Examine Imaging Records: Retrieve information on imaging records
Request Sample
Athena
Elation
Canvas
cURL
JavaScript
Java
Python
Source Specific Details
| EHR | APIs | mandatory filters | optional filters |
|---|---|---|---|
| Athena |
|
|
|
| Elation |
|
| |
| Canvas |
|
|
|
Filters
| FilterName | Description | Default Value | Allowed Values |
|---|---|---|---|
| _count | Pagination params | ||
| _offset | Pagination params. Athena: Starting point of entries; 0-indexed | ||
| _sort | Triggers sorting of the results by a specific criteria. Accepted values are id, birthdate, family, given. Use -id, -birthdate, -family, -given to sort in descending order | ||
| active | Whether this patient's record is in active use | ||
| address-city | Patient's city | ||
| address-country | Patient's country code | ||
| address-postalcode | Patient's zip | ||
| address-state | Patient's state | ||
| address1 | Patient's address | ||
| address2 | Patient's address - 2nd line | ||
| agricultural-worker | Used to identify this patient as an agricultural worker | ||
| agricultural-worker-type | For patients that are agricultural workers, identifies the type of worker | ||
| any-phone | Any phone number for the patient | ||
| appointment-department-id | The ID of the department associated with the upcoming appointment. | ||
| appointment-provider-id | The ID of the provider associated with the upcoming appointment | ||
| birthdate | The date of birth for the individual | ||
| birthsex | The birth sex for the individual | ||
| care-summary-delivery-preference | The patient's preference for care summary delivery | ||
| clinical-order-type-group-id | The clinical order type group of the clinical provider | ||
| consent-to-call | The flag is used to record the consent of a patient to receive automated calls per FCC requirements | ||
| consent-to-text | The flag is used to record the consent of a patient to receive text messages per FCC requirements | ||
| contact-home-phone | Emergency contact home phone. | ||
| contact-mobile-phone | Emergency contact mobile phone | ||
| contact-name | The name of the (emergency) person to contact about the patient | ||
| contact-preference | The MU-required field for preferred contact method. This is not used by any automated systems | ||
| contact-relationship | Emergency contact relationship. | ||
| contactpreference-announcement-email | If set, the patient has indicated a preference to get or not get announcement communications delivered via email | ||
| contactpreference-announcement-phone | If set, the patient has indicated a preference to get or not get announcement communications delivered via phone | ||
| contactpreference-announcement-sms | If set, the patient has indicated a preference to get or not get announcement communications delivered via SMS | ||
| contactpreference-appointment-email | If set, the patient has indicated a preference to get or not get appointment communications delivered via email. | ||
| contactpreference-appointment-phone | If set, the patient has indicated a preference to get or not get appointment communications delivered via phone | ||
| contactpreference-appointment-sms | If set, the patient has indicated a preference to get or not get appointment communications delivered via SMS | ||
| contactpreference-billing-email | If set, the patient has indicated a preference to get or not get billing communications delivered via email | ||
| contactpreference-billing-phone | If set, the patient has indicated a preference to get or not get billing communications delivered via phone | ||
| contactpreference-billing-sms | If set, the patient has indicated a preference to get or not get billing communications delivered via SMS. | ||
| contactpreference-lab-email | If set, the patient has indicated a preference to get or not get lab communications delivered via email | ||
| contactpreference-lab-phone | If set, the patient has indicated a preference to get or not get lab communications delivered via phone | ||
| contactpreference-lab-sms | If set, the patient has indicated a preference to get or not get lab communications delivered via SMS | ||
| death-note | If present, the date on which a patient died. | ||
| deceased | Indicates if the individual is deceased or not | ||
| default-pharmacy-ncpdp-id | The NCPDP ID of the patient's preferred pharmacy | ||
| departmentId | Identifier for the department | ||
| documentUpload | Flag to identify if document should be uploaded | ||
| drivers-license-expiration-date | The expiration date of the patient's driver's license | ||
| drivers-license-number | The number of the patient's driver's license | ||
| drivers-license-state-id | The state of the patient's driver's license | ||
| Email address for the patient | |||
| employer-id | The patient's employer's ID | ||
| employer-phone | The patient's employer's phone number | ||
| ethnicity-code | Ethnicity of the patient | ||
| family | last Name of the individual | ||
| gender | male | female | other | unknown | ||
| given | First Name of the individual | ||
| guarantor-address1 | Guarantor's address | ||
| guarantor-address2 | Guarantor's address - line 2 | ||
| guarantor-city | Guarantor's city | ||
| guarantor-country-code3166 | Guarantor's country code | ||
| guarantor-dob | Guarantor's DOB | ||
| guarantor-email | Guarantor's email address | ||
| guarantor-employer-id | The guaranror's employer's ID | ||
| guarantor-first-name | Guarantor's first name | ||
| guarantor-last-name | Guarantor's last name | ||
| guarantor-middle-name | Guarantor's middle name | ||
| guarantor-phone | Guarantor's phone number. Invalid numbers in a GET/PUT will be ignored | ||
| guarantor-relationship-to-patient | The guarantor's relationship to the patient | ||
| guarantor-ssn | Guarantor's SSN | ||
| guarantor-state | Guarantor's state | ||
| guarantor-suffix | Guarantor's name suffix | ||
| guarantor-zip | Guarantor's zip | ||
| guardian-first-name | The first name of the patient's guardian. | ||
| guardian-last-name | The last name of the patient's guardian | ||
| guardian-middle-name | The middle name of the patient's guardian | ||
| guardian-suffix | The suffix of the patient's guardian | ||
| has-mobile-yn | Set to false if a client has declined a phone number | ||
| has:CareTeam:participant:member | Search for patients based on references from other resources using the FHIR reverse-chaining syntax. Currently supported for CareTeam, e.g. _has:CareTeam:participant:member=Practitioner/{practitioner_id} | ||
| hierarchical-code | The patient race hierarchical code | ||
| home-bound-yn | If the patient is homebound, this is true | ||
| home-phone | The patient's home phone number. | ||
| homeless | Used to identify this patient as homeless | ||
| homeless-type | For patients that are homeless, provides more detail regarding the patient's homeless situation | ||
| identifier | An identifier for this patient | ||
| ignore-restrictions | Set to true to allow ability to find patients with record restrictions and blocked patients | ||
| include | List of fields which needed to be shown in result | ||
| industry-code | Industry of the patient, using the US Census industry code | ||
| language-6392-code | Language of the patient, using the ISO 639.2 code. | ||
| maritalStatus | Marital Status | ||
| master-patient | Master patient | ||
| mobile-carrier-id | The ID of the mobile carrier | ||
| modified-date | Modified date for patient details | ||
| name | A name associated with the patient | ||
| next-kin-name | The full name of the next of kin. | ||
| next-kin-phone | The next of kin phone number | ||
| next-kin-relationship | The next of kin relationship | ||
| nickname | Preferred or alternate name | ||
| notes | Notes associated with this patient. | ||
| occupation-code | Occupation of the patient, using the US Census occupation code | ||
| omit-balances | When true, current patient balances will not be calculated | ||
| omit-default-pharmacy | When true, the default NCPDPID for patients will not be determined | ||
| omit-photo-information | When true, current patient photo information will not be determined | ||
| online-statement-only-yn | Set to true if a patient wishes to get e-statements instead of paper statements | ||
| patient | Patient reference for any fhir resource | ||
| phone | Phone number for the patient | ||
| portal-access-given | This flag is set if the patient has been given access to the portal | ||
| poverty-level-calculated | Patient's poverty level | ||
| poverty-level-family-size | Patient's family size | ||
| poverty-level-family-size-declined | Indicates if the patient delcines to provide povertylevelfamilysize. | ||
| poverty-level-income-declined | Indicates if the patient delcines to provide povertylevelincomeperpayperiod | ||
| poverty-level-income-pay-period | Patient's pay period | ||
| poverty-level-income-per-pay-period | Patient's income per specified pay perio | ||
| poverty-level-income-range-declined | Indicates whether or not the patient declines to provide an income level. | ||
| practitioner | Practitioner reference for the any fhir resource | ||
| primary-department-id | The patient's current department | ||
| public-housing | Used to identify this patient as living in public housing | ||
| quorum | sets sync/async mode | true | |
| race | The patient race, using the 2.16.840.1.113883.5.104 codeset | ||
| referral-source-id | The referral how did you hear about us ID | ||
| registration-date | Date the patient was registered. | ||
| school-based-health-center | Used to identify this patient as school-based health center patient | ||
| ssn | ssn | ||
| status | The status of the patient | ||
| suffix | Patient's name suffix | ||
| upcoming-appointment-hours | Used to identify patients with appointments scheduled within the upcoming input hours | ||
| veteran | Used to identify this patient as a veteran | ||
| work-phone | The patient's work phone number. Generally not used to contact a patient |