Overview
Simple Observation Information addresses:- Observation HL7® FHIR® resource with US Core Profile 6.1.0
- a status
- a category code
- a code
- a patient
- a time indicating when the observation was made
- who answered the questions
- a value
Must support elements, mandatory and optional search parameters
Simple Observation must support these elements:statuscategorycategory:us-core
codesubjecteffective[x]performervalue[x]
statuscategorycodesubject
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 ofpatient and category parameters.
METHOD GET
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 the Authentication and Authorization process. Go to Authentication and Authorization for further details.
RESPONSES
The response to any search operation is always a list of resources in a Bundle or an Operation Outcome.
EXAMPLE:
Simple Observation by Patient and Code
Search for Simple Observation using combination ofpatient and code parameters.
METHOD GET
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 the Authentication and Authorization process. Go to Authentication and Authorization for further details.
RESPONSES
The response to any search operation is always a list of resources in a Bundle or an Operation Outcome.
EXAMPLE:
Simple Observation by Patient, Category, and Date
Search for Simple Observation using combination ofpatient, category, and date parameters.
METHOD GET
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 the Authentication and Authorization process. Go to Authentication and Authorization for further details.
RESPONSES
The response to any search operation is always a list of resources in a Bundle or an Operation Outcome.
EXAMPLE:
Simple Observation by Patient, Code, and Date
Search for Simple Observation using combination ofpatient, code, and date parameters.
METHOD GET
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 the Authentication and Authorization process. Go to Authentication and Authorization for further details.
RESPONSES
The response to any search operation is always a list of resources in a Bundle or an Operation Outcome.
EXAMPLE:
Simple Observation by Patient, Category, and Status
Search for Simple Observation using combination ofpatient, category, and status parameters.
METHOD GET
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 the Authentication and Authorization process. Go to Authentication and Authorization for further details.
RESPONSES
The response to any search operation is always a list of resources in a Bundle or an Operation Outcome.
EXAMPLE: