Overview
The Observation Clinical Result resource represents clinical observations and measurements about a patient, including findings from diagnostic imaging, clinical procedures, and other non-laboratory tests. This resource captures results from various clinical assessments such as radiology findings, procedure observations, and examination results. For example, it records observations like the size of a polyp noted during a colonoscopy or findings from an imaging study. At its minimum, Observation contains a code identifying what was observed, a status, a reference to the patient, and the observed value or result, but may also contain data about the performer, timing, and interpretation of the observation. the observation.
Each Observation Must Have:
- a status
- a category code
- a LOINC code, if available, which tells you what is being measured
- a patient
Each Observation Must Support:
- a time indicating when the measurement was taken
- a result value
- a reason why the data is absent
This resource conforms to USCDI v3 profile for Observation Clinical Result - refer to StructureDefinition US Core Observation Clinical Result. Observation Clinical Result response will be provided in JSON (refers to Capability Statement) format as per FHIR standard R4 version.
Must support elements, mandatory and optional search parameters
Observation Clinical Result must support these elements:
statuscategorycategory:us-core
codesubjecteffective[x]value[x]dataAbsentReason
The following search parameters and search parameter combinations SHALL be supported:
The syntax used to describe the interactions is described here.
SHALL support searching using the combination of the patient and category search parameters:
GET [base url]/Observation?patient={Type/}[id]&category={system|}[code]
SHALL support searching using the combination of the patient and code search parameters:
- including optional support for OR search on code
GET [base url]/Observation?patient={Type/}[id]&code={system|}[code]
SHALL support searching using the combination of the patient and category and date search parameters:
- including support for these date comparators: gt,lt,ge,le
- including optional support for AND search on date (e.g.date=[date]&date=[date]]&...)
GET [base url]/Observation?patient={Type/}[id]&category={system|}[code]&date=[date]
The following search parameters and search parameter combinations SHOULD be supported:
SHOULD support searching using the combination of the patient and code and date search parameters:
- including support for these date comparators: gt,lt,ge,le
- including optional support for OR search on code (e.g.code={system|}[code],{system|}[code],...)
- including optional support for AND search on date (e.g.date=[date]&date=[date]]&...)
GET [base url]/Observation?patient={Type/}[id]&code={system|}[code]&date=[date]
SHOULD support searching using the combination of the patient and category and status search parameters:
- including support for OR search on status
GET [base url]/Observation?patient={Type/}[id]&category={system|}[code]&status={system|}[code]
The response to any search operation is always a list of resources in a Bundle or an Operation Outcome.
Observation Clinical Result By patient and category search parameters
Get Observation Clinical Result by combination of the patient and category search parameters.
METHOD GET
[base url]/Observation?patient=[reference]&category={system|}[code]PARAMS [base url] - FHIR base url [reference] - reference to the Patient {system|} - terminology system used to define observation category code [code] - category of observation (e.g., laboratory, vital-signs)
HEADERS
The Authorization token SHALL be obtained during Authentication and Authorization process. Goto Authentication and Authorization for further details.
| Header | Type | Required/Optional | Value |
|---|---|---|---|
| Authorization | string | required | Bearer <token> |
RESPONSES
| Code | Description | Comment |
|---|---|---|
| 200 | OK | The request was processed successfully |
| 400 | Bad request | Invalid request parameters or FHIR operation outcome resource returned |
| 401 | Unauthorized | This code indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource |
| 404 | no Route matched with those values | The request was able to communicate with a given server, but the server could not find what was requested |
| 500 | Internal Server Error | The server has encountered a situation it doesn't know how to handle |
EXAMPLE:
curl --location --request GET 'https://sandbox.fhir.elationemr.com/fhir/Observation?patient=1137192&category=laboratory' \
--header 'Authorization: Bearer fe1cd986-1ac7-4c26-b8b3-d632a48408fd'Observation Clinical Result By patient and code search parameters
Get Observation Clinical Result by combination of the patient and code search parameters.
METHOD GET
[base url]/Observation?patient=[reference]&code={system|}[code]PARAMS [base url] - FHIR base url [reference] - reference to the Patient {system|} - terminology system used to define observation code (e.g., LOINC) [code] - code identifying what was observed
HEADERS
The Authorization token SHALL be obtained during Authentication and Authorization process. Goto Authentication and Authorization for further details.
| Header | Type | Required/Optional | Value |
|---|---|---|---|
| Authorization | string | required | Bearer <token> |
RESPONSES
| Code | Description | Comment |
|---|---|---|
| 200 | OK | The request was processed successfully |
| 400 | Bad request | Invalid request parameters or FHIR operation outcome resource returned |
| 401 | Unauthorized | This code indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource |
| 404 | no Route matched with those values | The request was able to communicate with a given server, but the server could not find what was requested |
| 500 | Internal Server Error | The server has encountered a situation it doesn't know how to handle |
EXAMPLE:
curl --location --request GET 'https://sandbox.fhir.elationemr.com/fhir/Observation?patient=1137192&code=http://loinc.org|2339-0' \
--header 'Authorization: Bearer fe1cd986-1ac7-4c26-b8b3-d632a48408fd'Observation Clinical Result By patient, category and date search parameters
Get Observation Clinical Result by combination of the patient, category and date search parameters.
METHOD GET
[base url]/Observation?patient=[reference]&category={system|}[code]&date={gt|lt|ge|le}[date]{&date={gt|lt|ge|le}[date]&...}PARAMS [base url] - FHIR base url [reference] - reference to the Patient {system|} - terminology system used to define observation category code [code] - category of observation [date] - effective date of observation
HEADERS
The Authorization token SHALL be obtained during Authentication and Authorization process. Goto Authentication and Authorization for further details.
| Header | Type | Required/Optional | Value |
|---|---|---|---|
| Authorization | string | required | Bearer <token> |
RESPONSES
| Code | Description | Comment |
|---|---|---|
| 200 | OK | The request was processed successfully |
| 400 | Bad request | Invalid request parameters or FHIR operation outcome resource returned |
| 401 | Unauthorized | This code indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource |
| 404 | no Route matched with those values | The request was able to communicate with a given server, but the server could not find what was requested |
| 500 | Internal Server Error | The server has encountered a situation it doesn't know how to handle |
EXAMPLE:
curl --location --request GET 'https://sandbox.fhir.elationemr.com/fhir/Observation?patient=1137192&category=laboratory&date=ge2023-01-01' \
--header 'Authorization: Bearer fe1cd986-1ac7-4c26-b8b3-d632a48408fd'Observation Clinical Result By patient, code and date search parameters
Get Observation Clinical Result by combination of the patient, code and date search parameters.
METHOD GET
[base url]/Observation?patient=[reference]&code={system|}[code]&date={gt|lt|ge|le}[date]{&date={gt|lt|ge|le}[date]&...}PARAMS [base url] - FHIR base url [reference] - reference to the Patient {system|} - terminology system used to define observation code [code] - code identifying what was observed [date] - effective date of observation
HEADERS
The Authorization token SHALL be obtained during Authentication and Authorization process. Goto Authentication and Authorization for further details.
| Header | Type | Required/Optional | Value |
|---|---|---|---|
| Authorization | string | required | Bearer <token> |
RESPONSES
| Code | Description | Comment |
|---|---|---|
| 200 | OK | The request was processed successfully |
| 400 | Bad request | Invalid request parameters or FHIR operation outcome resource returned |
| 401 | Unauthorized | This code indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource |
| 404 | no Route matched with those values | The request was able to communicate with a given server, but the server could not find what was requested |
| 500 | Internal Server Error | The server has encountered a situation it doesn't know how to handle |
EXAMPLE:
curl --location --request GET 'https://sandbox.fhir.elationemr.com/fhir/Observation?patient=1137192&code=http://loinc.org|2339-0&date=ge2023-01-01' \
--header 'Authorization: Bearer fe1cd986-1ac7-4c26-b8b3-d632a48408fd'Observation Clinical Result By patient, category and status search parameters
Get Observation Clinical Result by combination of the patient, category and status search parameters.
METHOD GET
[base url]/Observation?patient=[reference]&category={system|}[code]&status={system|}[code]PARAMS [base url] - FHIR base url [reference] - reference to the Patient {system|} - terminology system used to define observation category/status code [code] - category of observation and status code
HEADERS
The Authorization token SHALL be obtained during Authentication and Authorization process. Goto Authentication and Authorization for further details.
| Header | Type | Required/Optional | Value |
|---|---|---|---|
| Authorization | string | required | Bearer <token> |
RESPONSES
| Code | Description | Comment |
|---|---|---|
| 200 | OK | The request was processed successfully |
| 400 | Bad request | Invalid request parameters or FHIR operation outcome resource returned |
| 401 | Unauthorized | This code indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource |
| 404 | no Route matched with those values | The request was able to communicate with a given server, but the server could not find what was requested |
| 500 | Internal Server Error | The server has encountered a situation it doesn't know how to handle |
EXAMPLE:
curl --location --request GET 'https://sandbox.fhir.elationemr.com/fhir/Observation?patient=1137192&category=laboratory&status=final' \
--header 'Authorization: Bearer fe1cd986-1ac7-4c26-b8b3-d632a48408fd'