If you already have an identifier for a patient, you can easily locate the patient’s record in an EHR system by searching for a patient with that identifier. Typically, you can use this for:
There are two ways to locate a patient in an EHR system: with an identifier or with demographics. So how do you know which to use and when?
Using the patient identifier:
The catch is that you have to already have a patient identifier, like the MRN, on hand. If you do, we definitely recommend this option. We also recommend validating you found the right patient (because you don't ever make typos, right?) by confirming the returned patient's demographics match your patient. Once confirmed, you can start retrieving the patient's relevant clinical data.
On the flip side, using the patient demographics:
So this back-door alternative is fantastic if you have the patient's info, minus the appropriate identifier. We can still help you find the right patient with a little extra time.
You can use this API action with the Redox FHIR® API.
Your connection's system can return results with their own FHIR® or query-based API.
It's possible that your connection's system can't support a query-based data exchange, but they may still be willing to provide results with a push-based method.
However, we understand that you may not want to store all that data—maybe you don't need all possible results and just want to query for what you want when you need it. If so, you can use this API action via our data on demand service, which stores the connection's data so that you can query from Redox "on demand." Learn more about data on demand.
We mentioned that this API action is a great option for easily locating a patient, but that doesn't mean that it works like a Google search or a typical SQL database search. The purpose is to find matches for a specific patient, not a list of potential patients. In other words, you have to know who you’re looking for.
A patient identifier is a unique value that represents a patient record. That value is only meaningful in a certain context, whether that be a particular system or namespace. The identifier type indicates what context to use to interpret the identifier. Typically each organization has a single unique identifier type for a patient, which is called the master patient index (MPI). Then, there are alternative identifiers that are used for specific purposes.
For example, if the identifier is 123 with a type of MRN, then you may know it’s for System A, which uses MRNs to track patient records. On the other hand, you may have an identifier of 123 with a type of MRN, which should be used for System B since they use MRNs to track patient records. So the identifier may be the same, but the type may change the system it should be used with.
You can potentially search for a patient with any of these common identifier types:
A patient OID is an identifier specific to large integration networks, like the Carequality Interoperability Framework. The others are general identifiers that EHR systems may use to identify a patient.
FHIR® uses a resource ID for the patient identifier type. If your connection uses FHIR®, you likely need the resource ID to locate patient data. If your workflow doesn’t begin with a FHIR®-supported API action, you may have a different identifier type for the patient. If so, you can use the patient identifier you already have with this API action to request the resource ID. Alternatively, you can search for a patient with demographics to locate the resource ID. Learn more about searching for a patient with demographics.
The important thing to note about searching for a patient with an identifier is that you must search with the identifier types that are relevant to the EHR that you’re searching. That may sound obvious; but you can’t search for a patient by their driver’s license number if the EHR uses their MRN instead. You must use the ID and ID type as specified by the EHR.
Typically, the EHR provides at least one patient identifier that you can later search with. So, however you receive the patient identifier from the EHR is how you should send it in requests to the EHR. In some cases, you may need to ask the EHR what static identifier type they use. Or, you may receive the patient identifier when you send requests for other data, like requests related to scheduling or orders for that patient.
Does this API action seem like a good fit for your unique workflow? If so, let your Redox rep know! You can begin development by downloading the relevant resource schema (which is noted in the relevant action step below), and deciding which data elements you need. Then head over to our Quickstart guide to dive right in.
If you're not engaged with our sales team yet, talk to a Redoxer to get started.
You can search for a patient with their unique identifier if you know which identifier type to use for the given EHR system.
For example, if you have the patient's MRN, but the EHR system uses the FHIR® resource ID, you may have to search for the patient with the MRN to locate all identifiers for this patient first; alternatively, you can search for a patient with demographics to locate the resource ID. Then, you can perform additional API actions that require the FHIR® resource ID.
This table has notes about how to use parameters for this API action specifically, but it's not exhaustive. Refer to the resource schema for more details.
Query parameter | Required | Notes |
---|---|---|
identifier | Y | When searching by identifier, you must include the patient's unique identifier within the EHR system that you're searching. This means you must know the unique identifier for that specific system for the search to be successful. |
You typically receive either one result or none. Multiple matches may be returned depending on the identifier type that you’re using (since not all patient identifiers are unique) or your integration type.
If you're operating in Canada, you must tweak the Redox hostname slightly. All you need to do is add a ca
in that URL like this: https://api.ca.redoxengine.com
.
curl ---location --request POST 'https://api.redoxengine.com/fhir/R4/epic-fhir-sandbox/Development/Patient/_search' \--header 'Content-Type: application/x-www-form-urlencoded' \--header 'Authorization: Bearer $API_TOKEN' \--data-urlencode 'identifier=MRN|203709'
{"resourceType": "Bundle","type": "searchset","total": 1,"link": [{"relation": "self","url": "https://fhir.epic.com/interconnect-fhir-oauth/api/FHIR/R4/Patient?_id=&_include=&_revinclude=&_sort=&_count=&identifier=MRN%7C203709&active=&general-practitioner=&given=&family=&birthdate=&address-city=&address-state=&address-postalcode=&phone=&email=&general-practitioner.identifier="}],"entry": [{"link": [{"relation": "self","url": "https://fhir.epic.com/interconnect-fhir-oauth/api/FHIR/R4/Patient/egqBHVfQlt4Bw3XGXoxVxHg3"}],"fullUrl": "https://fhir.epic.com/interconnect-fhir-oauth/api/FHIR/R4/Patient/egqBHVfQlt4Bw3XGXoxVxHg3","resource": {"resourceType": "Patient","id": "egqBHVfQlt4Bw3XGXoxVxHg3","extension": [{"extension": [{"valueCoding": {"system": "urn:oid:2.16.840.1.113883.6.238","code": "2054-5","display": "Black or African American"},"url": "ombCategory"},{"valueString": "Black or African American","url": "text"}],"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race"},{"extension": [{"valueCoding": {"system": "urn:oid:2.16.840.1.113883.6.238","code": "UNK","display": "Unknown"},"url": "ombCategory"},{"valueString": "Unknown","url": "text"}],"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity"},{"valueCodeableConcept": {"coding": [{"system": "urn:oid:1.2.840.114350.1.13.0.1.7.10.698084.130.657370.19999000","code": "male"}]},"url": "http://open.epic.com/FHIR/StructureDefinition/extension/legal-sex"},{"valueCodeableConcept": {"coding": [{"system": "http://hl7.org/fhir/gender-identity","code": "male"}]},"url": "http://hl7.org/fhir/StructureDefinition/patient-genderIdentity"},{"valueCodeableConcept": {"coding": [{"system": "urn:oid:1.2.840.114350.1.13.0.1.7.10.698084.130.657370.19999000","code": "male"}]},"url": "http://open.epic.com/FHIR/StructureDefinition/extension/sex-for-clinical-use"},{"valueCode": "M","url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex"}],"identifier": [{"use": "usual","type": {"text": "EPIC"},"system": "urn:oid:1.2.840.114350.1.13.0.1.7.5.737384.0","value": "E4003"},{"use": "usual","type": {"text": "EXTERNAL"},"system": "urn:oid:1.2.840.114350.1.13.0.1.7.2.698084","value": "Z6125"},{"use": "usual","type": {"text": "FHIR"},"system": "http://open.epic.com/FHIR/StructureDefinition/patient-dstu2-fhir-id","value": "TZP1AvJlIR4IZDc3myX64DDxFHjn24zSDxI1BPYXIAk4B"},{"use": "usual","type": {"text": "FHIR STU3"},"system": "http://open.epic.com/FHIR/StructureDefinition/patient-fhir-id","value": "egqBHVfQlt4Bw3XGXoxVxHg3"},{"use": "usual","type": {"text": "INTERNAL"},"system": "urn:oid:1.2.840.114350.1.13.0.1.7.2.698084","value": " Z6125"},{"use": "usual","type": {"text": "EPI"},"system": "urn:oid:1.2.840.114350.1.13.0.1.7.5.737384.14","value": "203709"},{"use": "usual","type": {"text": "MYCHARTLOGIN"},"system": "urn:oid:1.2.840.114350.1.13.0.1.7.3.878082.110","value": "FHIRELIJAH"},{"use": "usual","type": {"text": "WPRINTERNAL"},"system": "urn:oid:1.2.840.114350.1.13.0.1.7.2.878082","value": "740"}],"active": true,"name": [{"use": "old","text": "DAVIS,ELIJAH","family": "Davis","given": ["Elijah"]},{"use": "official","text": "Elijah John Davis","family": "Davis","given": ["Elijah","John"]},{"use": "usual","text": "Elijah John Davis","family": "Davis","given": ["Elijah","John"]}],"telecom": [{"system": "phone","value": "608-555-5555","use": "mobile"}],"gender": "male","birthDate": "1993-08-18","deceasedBoolean": false,"address": [{"use": "old","line": ["231 Aspen Street"],"city": "MADISON","district": "DANE","state": "WI","postalCode": "53791","country": "US"},{"use": "home","line": ["231 Aspen Street"],"city": "MADISON","district": "DANE","state": "WI","postalCode": "53791","country": "US","period": {"start": "2019-05-24"}}],"maritalStatus": {"text": "Single"},"communication": [{"language": {"coding": [{"system": "urn:ietf:bcp:47","code": "en","display": "English"}],"text": "English"},"preferred": true}],"managingOrganization": {"reference": "Organization/enRyWnSP963FYDpoks4NHOA3","display": "Epic Hospital System"}},"search": {"mode": "match"}}]}