Get a list of observations
/Observation
Note: The FHIR API endpoints described below are currently pending production deployment for electronic health record (EHR) environments. Developers are welcome and encouraged to develop against the specifications in anticipation of production availability, which will be announced at a later date.
Retrieves a list of observations that meet the supplied query parameters.
Request
-
_id: string
The logical resource ID.
-
_revinclude: string
The related Provenance resources to include in the search bundle.Allowed Values:
[ "Provenance:target" ] -
category: string
The classification of the type of observation.
-
code: string
The observation code.
-
date: string
The obtained date and time. If the obtained element is a period, a date within the period.
-
patient: string
Who or what the observation is about.
-
accept(required): string
The media type to be requested.
Example:
application/fhir+json -
authorization(required): string
The credentials to authenticate a consumer to the service. This should be the OAuth2 Bearer Token.
There's no request body for this operation.
Back to TopResponse
200 Response
object-
entry: array
entry
-
id(required): string
-
link: array
link
-
resourceType(required): string
Allowed Values:
[ "Bundle" ] -
type(required): string
object-
category(required): array
category
(USCDI) A code that classifies the general type of observation being made.
For the following vital sign profiles,
category.coding.systemis set tohttp://terminology.hl7.org/CodeSystem/observation-categoryandcategory.coding.codeis set tovital-signs:- Blood Pressure
- BMI
- Body Height
- Body Temperature
- Body Weight
- Head Circumference
- Head Occipital Frontal Circumference Percentile
- Heart Rate
- Pediatric BMI for Age
- Pediatric Weight for Height
- Pulse Oximetry
- Respiratory Rate
- Vital Signs
-
code(required):
code
(USCDI) What was observed.
-
component: array
component
(USCDI) The component observations that are part of this observation.
For each component, only one
value[x]representation is returned (for example,valueQuantityorvalueCodeableConcept). -
dataAbsentReason:
dataAbsentReason
(USCDI) A reason why the expected value is missing.
-
derivedFrom: array
derivedFrom
The related measurements the observation is made from.
-
effectiveDateTime: string
(date-time)
(USCDI) The clinically relevant time or time period for the observation.
-
effectivePeriod:
effectivePeriod
(USCDI) The clinically relevant time or time period for the observation.
-
hasMember: array
hasMember
A related resource that belongs to the observation group.
-
id(required): string
-
performer: array
performer
The individual who is responsible for the observation.
-
resourceType(required): string
Allowed Values:
[ "Observation" ] -
specimen:
specimen
(USCDI) The specimen used for this observation.
-
status(required): string
(USCDI) The status of the result value.
-
subject(required):
subject
(USCDI) Who or what the observation is about.
-
valueCodeableConcept:
valueCodeableConcept
(USCDI) The result value as a coded concept.
-
valueQuantity:
valueQuantity
(USCDI) The result value as a quantity.
- For the following vital sign profiles,
valueQuantity.systemis set tohttp://unitsofmeasure.org:- Body Height
- Body Temperature
- Body Weight
- Head Circumference
- Heart Rate
- Respiratory Rate
- Pulse Oximetry
- BMI
- Pediatric BMI for Age
- Pediatric Weight for Height
- Head Occipital Frontal Circumference Percentile
- For BMI,
valueQuantity.codeis set tokg/m2. - For Heart Rate and Respiratory Rate,
valueQuantity.codeis set to/min. - For Pulse Oximetry, Pediatric BMI for Age, Pediatric Weight for Height, and Head Occipital Frontal Circumference Percentile,
valueQuantity.codeis set to%.
- For the following vital sign profiles,
array(USCDI) A code that classifies the general type of observation being made.
For the following vital sign profiles, category.coding.system is set to http://terminology.hl7.org/CodeSystem/observation-category and category.coding.code is set to vital-signs:
- Blood Pressure
- BMI
- Body Height
- Body Temperature
- Body Weight
- Head Circumference
- Head Occipital Frontal Circumference Percentile
- Heart Rate
- Pediatric BMI for Age
- Pediatric Weight for Height
- Pulse Oximetry
- Respiratory Rate
- Vital Signs
array(USCDI) The component observations that are part of this observation.
For each component, only one value[x] representation is returned (for example, valueQuantity or valueCodeableConcept).
arrayarrayarray(USCDI) The result value as a quantity.
- For the following vital sign profiles,
valueQuantity.systemis set tohttp://unitsofmeasure.org:- Body Height
- Body Temperature
- Body Weight
- Head Circumference
- Heart Rate
- Respiratory Rate
- Pulse Oximetry
- BMI
- Pediatric BMI for Age
- Pediatric Weight for Height
- Head Occipital Frontal Circumference Percentile
- For BMI,
valueQuantity.codeis set tokg/m2. - For Heart Rate and Respiratory Rate,
valueQuantity.codeis set to/min. - For Pulse Oximetry, Pediatric BMI for Age, Pediatric Weight for Height, and Head Occipital Frontal Circumference Percentile,
valueQuantity.codeis set to%.
(USCDI) The result value as a quantity.
- For the following vital sign profiles,
valueQuantity.systemis set tohttp://unitsofmeasure.org:- Body Height
- Body Temperature
- Body Weight
- Head Circumference
- Heart Rate
- Respiratory Rate
- Pulse Oximetry
- BMI
- Pediatric BMI for Age
- Pediatric Weight for Height
- Head Occipital Frontal Circumference Percentile
- For BMI,
valueQuantity.codeis set tokg/m2. - For Heart Rate and Respiratory Rate,
valueQuantity.codeis set to/min. - For Pulse Oximetry, Pediatric BMI for Age, Pediatric Weight for Height, and Head Occipital Frontal Circumference Percentile,
valueQuantity.codeis set to%.
object-
code(required):
code
(USCDI) The type of component observation.
-
dataAbsentReason:
dataAbsentReason
(USCDI) A reason why the expected component value is missing.
-
valueCodeableConcept:
valueCodeableConcept
(USCDI) The component observation value as a coded concept.
-
valueQuantity:
valueQuantity
(USCDI) The component observation value as a quantity.
- For Blood Pressure component values,
valueQuantity.systemis set tohttp://unitsofmeasure.organdvalueQuantity.codeis set tomm[Hg]. - For Pulse Oximetry components,
valueQuantity.systemis set tohttp://unitsofmeasure.org. Component values may useL/minor%depending on component code.
- For Blood Pressure component values,
(USCDI) The component observation value as a quantity.
- For Blood Pressure component values,
valueQuantity.systemis set tohttp://unitsofmeasure.organdvalueQuantity.codeis set tomm[Hg]. - For Pulse Oximetry components,
valueQuantity.systemis set tohttp://unitsofmeasure.org. Component values may useL/minor%depending on component code.
(USCDI) The component observation value as a quantity.
- For Blood Pressure component values,
valueQuantity.systemis set tohttp://unitsofmeasure.organdvalueQuantity.codeis set tomm[Hg]. - For Pulse Oximetry components,
valueQuantity.systemis set tohttp://unitsofmeasure.org. Component values may useL/minor%depending on component code.
object-
relation: string
Allowed Values:
[ "self", "next", "previous" ] -
url: string
(uri)
Default Response
object-
issue(required): array
issue
-
resourceType(required): string
Allowed Values:
[ "OperationOutcome" ]