FHIR Extraction is in beta. The request and response schemas can still change. Contact us to share feedback or report issues.
Prerequisites
- An API client. You need your tenant name, environment (
euorus), and an access token. See Creating API clients and the authentication quickstart. - Basic FHIR knowledge. If terms such as CodeableConcept or Bundle are new to you, read FHIR basics first.
Send a note
The example note has three facts in it: a diagnosis, a blood pressure reading, and an allergy.context, the only required field. It also sends the patient and encounter values that your system already knows: your own IDs, so the response links to your records, and the demographics and visit details, so the endpoint does not have to read them from the note. Do the same in your own requests. Reduce extraction errors explains why.
Read the response
The response has two top-level fields:bundle, a FHIR Bundle with all resources, and usageInfo, the credits consumed by the request. For the example note, the Bundle holds six resources:
Notice that the endpoint splits the blood pressure into two Observations, one for each number. Every measurement gets its own resource.
The full response below shows the real JSON. It is long, mostly because of the
extension entries, which the next section explains. It is valid FHIR R4: each clinical resource points to the Patient and Encounter through their fullUrl. See How the response meets FHIR R4.
Full response JSON
Full response JSON
A
coding entry can also carry a version field with the version of the code system the endpoint used. The examples in these docs leave it out.Check each value against the note
Each clinical resource carriesextension entries that point back to the note:
- Mentions link a field to the words that support it. The systolic Observation has a mention for
code(“BP”, characters 59 to 61) and one forvalueQuantity(“150”, characters 62 to 65). - Alternatives list other codes that could fit. The Condition offers
443694000Uncontrolled type 2 diabetes mellitus as an alternative to44054006Type 2 diabetes mellitus.
Next steps
How FHIR Extraction works
Learn the rules behind every response, such as positive codes and status fields.
Reduce extraction errors
Send what you know, skip structured data, and review the results.
Filter FHIR resources
Produce only the resources you need and restrict the codes they carry.
FHIR Extraction request and response
Look up every request field, error, and limit.