Observation

Top  Previous  Next

Measurements and simple assertions made about a patient, device or other subject.

 

Currently the following Observations are supported:

smoking status

vital signs:

obody height

obody weight

obody temperature

oblood pressure systolic and diastolic

orespiratory rate

oheart rate

opulse oximetry

laboratory results

 

The following Observations can be queried, but will only return dataAbsent:

pediatric weight for height

pediatric BMI for age

pediatric head occipital-frontal circumference percentile

 

Response Description

Sample Response

{

  "resourceType": "Observation",

  "id": "DEV-DEV-11913-S872",

  "meta": {

     "lastUpdated": "2022-11-19T12:00:00-05:00",

     "profile": [

        "http://hl7.org/fhir/us/core/StructureDefinition/us-core-smokingstatus"

     ]

  },

  "text": {

     "status": "generated",

     "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><table><tbody><tr><td>Patient:</td><td>Cole Andersonian, Sr. (DEV-DEV-11913)</td></tr><tr><td>Encounter:</td><td>DEV-DEV-11913-0014796</td></tr><tr><td></td></tr><tr><td>Smoking Status:</td><td>Never smoked tobacco (finding)</td></tr><tr><td>Recorded Date:</td><td>11/19/2022</td></tr></tbody></table></div>"

  },

  "status": "final",

  "category": [

     {

        "coding": [

           {

              "system": "http://terminology.hl7.org/CodeSystem/observation-category",

              "code": "social-history",

              "display": "Social History"

           }

        ]

     }

  ],

  "code": {

     "coding": [

        {

           "system": "http://loinc.org",

           "code": "72166-2",

           "display": "Tobacco smoking status"

        }

     ]

  },

  "subject": {

     "reference": "Patient/DEV-DEV-11913",

     "display": "Cole Andersonian, Sr. (DEV-DEV-11913)"

  },

  "encounter": {

     "reference": "Encounter/DEV-DEV-11913-0014796",

     "display": "11/04/2022 at 9:10 am, Blood Pressure Visit with provider 117 at location solo"

  },

  "effectiveDateTime": "2022-11-19T12:00:00-05:00",

  "issued": "2022-11-19T12:00:00-05:00",

  "valueCodeableConcept": {

     "coding": [

        {

           "system": "http://snomed.info/sct",

           "code": "266919005",

           "display": "Never smoked tobacco (finding)"

        }

     ]

  }

}

 

 

Observation.id

 

The logical ID of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Cardinality

0..1

Type

string

Comment

The only time that a resource does not have an ID is when it is being submitted to the server using a create operation.

 

 

Observation.meta

 

Metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Cardinality

0..1

Type

Meta

 

 

Observation.text

 

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative.

Cardinality

0..1

Type

Narrative

Comment

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

 

 

Observation.status

 

The status of the result value, such as finalcorrected, or preliminary.

Cardinality

1..1

Type

code: ObservationStatus

Requirements

Need to track the status of individual results. Some results are finalized before the whole report is finalized.

 

 

Observation.category

 

A code that classifies the general type of Observation being made.

Cardinality

0..*

Type

CodeableConcept: Observation Category Codes

Comment

social-history for smoking status

laboratory for results of lab tests

vital-signs for the rest of supported Observations

Requirements

Used for filtering what observations are retrieved and displayed.

 

 

Observation.code

 

A name associated with the Observation.

Cardinality

0..1

Type

CodeableConcept: LOINC Codes

Comment

72166-2 for smoking status

2708-6 for pulse oximetry

8302-2 for body height

29463-7 for body weight

8310-5 for body temperature

9279-1 for respiratory rate

85354-9 for blood pressure

8867-4 for heart rate

A lot of codes for different lab tests

 

pediatric vital signs:

77606-2 for pediatric weight for height

59576-9 for pediatric BMI for age

8289-1 for pediatric head occipital-frontal circumference percentile

 

 

Observation.subject

 

The patient this Observation is about and into whose record the Observation is placed.

Cardinality

0..1

Type

Reference(Patient)

 

 

Observation.encounter

 

The healthcare event during which this Observation is made.

Cardinality

0..1

Type

Reference(Encounter)

Comment

This will typically be the encounter the event occurred within, but some events may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter.

 

 

Observation.effectiveDateTime

 

The time or time-period the observed value is asserted as being true.

Cardinality

0..1

Type

dateTime

Comment

At least a date should be present unless this observation is a historical report.

 

 

Observation.valueCodeableConcept

 

The information determined as a result of making the observation, if the information has a simple value. Used in smoking status Observation.

Cardinality

0..1

Type

CodeableConcept

 

 

Observation.valueQuantity

 

A measured amount (or an amount that can potentially be measured). Observations with a numeric value to report (except blood pressure).

Cardinality

0..1

Type

Quantity

 

 

Observation.dataAbsentReason

 

Provides a reason why the expected value in the element Observation.value[x] is missing.

Cardinality

0..1

Type

CodeableConcept DataAbsentReason

 

 

Observation.valueString

 

Used for Observations with a non-numeric result.

Cardinality

0..1

Type

string

 

 

Observation.component

 

Used to display the multiple values included in a blood pressure Observation.

Cardinality

0..*

Type

BackboneElement

 

 


 

Search

 

URL Syntax

Two HTTP methods are supported for searching: GET and POST. It is recommended to use HTTP POST.

Visit the FHIR Sandbox to try requests.

 

 

HTTP GET - searching

https://sandbox.pai.healthcare/preview/fhir/Observation?{query string}

 

HTTP GET - return single record

https://sandbox.pai.healthcare/preview/fhir/Observation/{resource id}

 

HTTP POST - searching

https://sandbox.pai.healthcare/preview/fhir/Observation/_search

Set the Content-Type header to application/x-www-urlencoded

The body of the request is a similar query string used in the GET type of request detailed above.

 

 

Error Handling

If no records are returned or invalid search parameters are provided, then an HTTP 400 Bad Request is returned.

The body of the response will be an OperationOutcome.

 

 

Supported Search Parameters

 

_id

Corresponds to

Observation.id

Search

exact

Example

https://sandbox.pai.healthcare/preview/fhir/Observation?_id=DEV-DEV-test-P2106

 

Returns Observation P2106 for user test in practice DEV.

 

patient

Corresponds to

Observation.subject

Search

exact

Example

https://sandbox.pai.healthcare/preview/fhir/Observation?patient=DEV-DEV-test

 

Returns all Observations for the user test.

 

encounter

Corresponds to

Observation.encounter

Search

exact

Example

https://sandbox.pai.healthcare/preview/fhir/Observation?encounter=DEV-DEV-test-0000527

 

Returns the Observation with accession# 0000527 for account test.

 

code + encounter

Corresponds to

Observation.code and Observation.encounter

Search

exact

Example

https://sandbox.pai.healthcare/preview/fhir/Observation?encounter=DEV-DEV-test-0000527&code=72166-2

 

Returns the Observation for encounter 0000527 with a code of 72166-2.

 

code + patient

Corresponds to

Observation.code and Observation.subject

Search

exact

Example

https://sandbox.pai.healthcare/preview/fhir/Observation?patient=DEV-DEV-11913&code=72166-2

 

Returns the Observations with a code of 72166-2 for patient 11913.

 

 

category + patient

Corresponds to

Observation.category and Observation.subject

Search

exact

Example

https://sandbox.pai.healthcare/preview/fhir/Observation?patient=DEV-DEV-11913&category=social-history

 

Returns the Observations on smoking status for patient 11913.

 

category + patient+date

Corresponds to

Observation.category and Observation.subject

Search

exact

Example

https://sandbox.pai.healthcare/preview/fhir/Observation?patient=DEV-DEV-11913&category=social-history&date=2022-10-24

 

Returns the Observations on smoking status on 10/24/2022 for patient 11913.

 

date + patient

Corresponds to

Observation.effectiveDateTime and Observation.subject

Search

exact

Modifiers

ge - greater than or equal to

gt - greater than

le - less than or equal to

lt - less than

eq - equal to

Example

https://sandbox.pai.healthcare/preview/fhir/Observation?patient=DEV-DEV-test&date=gt2022-10-24

 

Returns the Observations with a date after 10/24/2022 for patient 11913.