Tutorials
Use Cases
- About Use Cases
- Find a Patient/Member
- Build a Medication List
- Gather Immunization History
- Retrieve Inpatient and Outpatient Visits
- Build a Problem List
- Build a Provider List
- Find Lab Results
- Find a Discharge Summary
- Receive ADT Notifications
Interface
Examples & Testing
Endpoints
Find a Patient/Member
To retrieve data for a member or patient, you can query the Patient resource for a unique patient identifier to be used in subsequent resource requests or each individual resource can be queried with a patient filter.
Contents
If search parameters match more than one
Patient, multiple patients will be returned.The same applies in ‘chained’ searches (e.g., searching for
Claims or Encounters using name or DOB rather than Patient.id – All claims or encounters would be returned for multiple patients if more than one Patient matched the criteria).Better performance can also be achieved by finding a
Patient.id and reusing it in subsequent queries, since it will avoid the FHIR server having to perform a Patient query with every request.It is therefore recommended to first search on Patient resource to obtain a
Patient.id to be used in other resource queries.Querying by Identifier
Specific syntax is required for searching with identifiers (e.g. to search for an MCID: http://careevolution.com/fhiridentifiers#MCID|123456789)
Supported identifiers/namespace syntaxes include:
- MCID
- HCID
- SubscriberID
- MedicaidID
- MedicareID
A full list of available identifiers can be found at https://[YOUR_FHIR_ENDPOINT]/documentation?prefix=fhir-r4#identifier-systems.
Querying by Name and Date of Birth
given is the First name. family is the last name. birthdate should be in the form ` yyyy-mm-dd`
Wildcards are NOT supported in identifier searches.
Wildcards ARE supported in name searches. By default,
family=Foo finds all family names that start with Foo (it is treated like Foo*). family:contains=Foo (treated like *Foo *). family:exact=Foo performs exact match. Given name works the same.
Example Queries
| Example | Resource | Example URL |
|---|---|---|
| MCID 123456789 | Patient | https://[YOUR_FHIR_ENDPOINT]/Patient?identifier=http://careevolution.com/fhiridentifiers#MCID|123456789 |
| SubscriberID 987654321 | Condition | https://[YOUR_FHIR_ENDPOINT]/Condition? patient.identifier=http://careevolution.com/fhiridentifiers#SubscriberID|987654321 |
| Name John Smith DOB 1978-05-08 |
Patient | https://[YOUR_FHIR_ENDPOINT]/Patient?family:exact=Smith&given:exact=John&birthdate=1978-05-08 |
Retrieving a List of Patients/Members
Searching for family/related patients
Use an identifier that is family/plan-specific, like HCID
FHIR can be used to retrieve a list of patients matching a set of criteria (e.g., ‘Diabetic members with HbA1c>9’, ‘Members hospitalized within the last 24 hours’).
Use the FHIR List resource to retrieve a population health list.
Available lists can be queried by
https://[YOUR_FHIR_ENDPOINT]List?_summary=true&_count=10. New lists can be created within HIEBus. Ask a CareEvolution team member for more information.
Have questions about the HIEBus FHIR interface? Contact us at fhir@careevolution.com.
© 2023 CareEvolution, LLC
