Overview
Simple Observation Information addresses:
- Observation HL7® FHIR® resource with US Core Profile 6.1.0
The Simple Observation profile is used to record observations that are not covered by other specific US Core Observation profiles (such as Laboratory, Vital Signs, Smoking Status, etc.). This profile meets the U.S. Core Data for Interoperability (USCDI) v3 requirements for Clinical Tests and Observations.
Simple Observations can include clinical observations, assessments, survey results, and other measurements or assertions about a patient that don't fit into more specialized observation categories. Examples include visual acuity tests, hearing tests, developmental milestones, functional assessments, and non-laboratory test results.
Each Simple Observation Must Have:
- a status
- a category code
- a code
- a patient
Each Simple Observation Must Support:
- a time indicating when the observation was made
- who answered the questions
- a value
This resource conforms to USCDI v3 for Clinical Tests * refers to US Core Simple Observation Profile 6.1.0. Simple Observation 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
Simple Observation must support these elements:
statuscategorycategory:us-core
codesubjecteffective[x]performervalue[x]
Each Simple Observation Must Have (Mandatory):
statuscategorycodesubject
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:
- including support for OR search on category (e.g.category={system|}[code],{system|}[code],...)
GET [base url]/Observation?patient={Type/}[id]&category={system|}[code]
SHALL support searching using the combination of the patient and code search parameters:
- including support for OR search on code (e.g.code={system|}[code],{system|}[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={gt|lt|ge|le}[date]
The following search parameter combinations SHOULD be supported:
SHOULD support searching using the combination of the patient and code and date search parameters:
- including support for OR search on code (e.g.code={system|}[code],{system|}[code],...)
- 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]&code={system|}[code]&date={gt|lt|ge|le}[date]
SHOULD support searching using the combination of the patient and category and status search parameters:
- including support for OR search on category (e.g.category={system|}[code],{system|}[code],...)
- including support for OR search on status (e.g.status={system|}[code],{system|}[code],...)
GET [base url]/Observation?patient={Type/}[id]&category={system|}[code]&status={code}
The response to any search operation is always a list of resources in a Bundle or an Operation Outcome.
Simple Observation by Patient and Category
Search for Simple Observation using combination of patient and category parameters.
METHOD GET
GET [base url]/Observation?patient={Type/}[id]&category={system|}[code]PARAMS
[base url] - FHIR base url
{Type/} - Reference type for the patient resource. Example: Patient/
[id] - Patient's id
{system|} - Category system. FHIR search token parameter. See Search specification for more information. Example: http://terminology.hl7.org/CodeSystem/observation-category|
[code] - Category code. Example: exam (Exam) or survey (Survey)
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 |
The response to any search operation is always a list of resources in a Bundle or an Operation Outcome.
EXAMPLE:
curl --location --request GET 'https://sandbox.fhir.elationemr.com/fhir/Observation?patient=Patient/05b87542-b50e-4f19-8a87-2da2e6959bfb&category=http://terminology.hl7.org/CodeSystem/observation-category|exam' \
--header 'Authorization: Bearer fe1cd986-1ac7-4c26-b8b3-d632a48408fd'Simple Observation by Patient and Code
Search for Simple Observation using combination of patient and code parameters.
METHOD GET
GET [base url]/Observation?patient={Type/}[id]&code={system|}[code]PARAMS
[base url] - FHIR base url
{Type/} - Reference type for the patient resource. Example: Patient/
[id] - Patient's id
{system|} - Observation code system. FHIR search token parameter. See Search specification for more information. Example: http://loinc.org|
[code] - Observation code. Example: 28615-3 (Audiology study)
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 |
The response to any search operation is always a list of resources in a Bundle or an Operation Outcome.
EXAMPLE:
curl --location --request GET 'https://sandbox.fhir.elationemr.com/fhir/Observation?patient=Patient/05b87542-b50e-4f19-8a87-2da2e6959bfb&code=http://loinc.org|28615-3' \
--header 'Authorization: Bearer fe1cd986-1ac7-4c26-b8b3-d632a48408fd'Simple Observation by Patient, Category, and Date
Search for Simple Observation using combination of patient, category, and date parameters.
METHOD GET
GET [base url]/Observation?patient={Type/}[id]&category={system|}[code]&date={gt|lt|ge|le}[date]PARAMS
[base url] - FHIR base url
{Type/} - Reference type for the patient resource. Example: Patient/
[id] - Patient's id
{system|} - Category system. FHIR search token parameter. See Search specification for more information. Example: http://terminology.hl7.org/CodeSystem/observation-category|
[code] - Category code. Example: exam (Exam)
{gt|lt|ge|le} - Date comparison operator. Example: ge (greater than or equal to)
[date] - Date in YYYY-MM-DD format. Example: 2024-01-01
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 |
The response to any search operation is always a list of resources in a Bundle or an Operation Outcome.
EXAMPLE:
curl --location --request GET 'https://sandbox.fhir.elationemr.com/fhir/Observation?patient=Patient/05b87542-b50e-4f19-8a87-2da2e6959bfb&category=http://terminology.hl7.org/CodeSystem/observation-category|exam&date=ge2024-01-01' \
--header 'Authorization: Bearer fe1cd986-1ac7-4c26-b8b3-d632a48408fd'Simple Observation by Patient, Code, and Date
Search for Simple Observation using combination of patient, code, and date parameters.
METHOD GET
GET [base url]/Observation?patient={Type/}[id]&code={system|}[code]&date={gt|lt|ge|le}[date]PARAMS
[base url] - FHIR base url
{Type/} - Reference type for the patient resource. Example: Patient/
[id] - Patient's id
{system|} - Observation code system. FHIR search token parameter. See Search specification for more information. Example: http://loinc.org|
[code] - Observation code. Example: 28615-3 (Audiology study)
{gt|lt|ge|le} - Date comparison operator. Example: ge (greater than or equal to)
[date] - Date in YYYY-MM-DD format. Example: 2024-01-01
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 |
The response to any search operation is always a list of resources in a Bundle or an Operation Outcome.
EXAMPLE:
curl --location --request GET 'https://sandbox.fhir.elationemr.com/fhir/Observation?patient=Patient/05b87542-b50e-4f19-8a87-2da2e6959bfb&code=http://loinc.org|28615-3&date=ge2024-01-01' \
--header 'Authorization: Bearer fe1cd986-1ac7-4c26-b8b3-d632a48408fd'Simple Observation by Patient, Category, and Status
Search for Simple Observation using combination of patient, category, and status parameters.
METHOD GET
GET [base url]/Observation?patient={Type/}[id]&category={system|}[code]&status={code}PARAMS
[base url] - FHIR base url
{Type/} - Reference type for the patient resource. Example: Patient/
[id] - Patient's id
{system|} - Category system. FHIR search token parameter. See Search specification for more information. Example: http://terminology.hl7.org/CodeSystem/observation-category|
[code] - Category code. Example: exam (Exam)
{code} - Status code. Example: final or preliminary
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 |
The response to any search operation is always a list of resources in a Bundle or an Operation Outcome.
EXAMPLE:
curl --location --request GET 'https://sandbox.fhir.elationemr.com/fhir/Observation?patient=Patient/05b87542-b50e-4f19-8a87-2da2e6959bfb&category=http://terminology.hl7.org/CodeSystem/observation-category|exam&status=final' \
--header 'Authorization: Bearer fe1cd986-1ac7-4c26-b8b3-d632a48408fd'