The FHIR STU3 Observation resource describes measurements and simple assertions made about a patient, device or other subject.

FHIR Resource: Observation <https://www.hl7.org/fhir/observation.html>

Health Gorilla supports the following categories of Observation:

System	Code	Display
`<http://hl7.org/fhir/observation-category>`	laboratory	Laboratory
`<http://hl7.org/fhir/observation-category>`	imaging	Imaging
`<http://hl7.org/fhir/observation-category>`	vital-signs	Vital Sign
`<http://hl7.org/fhir/observation-category>`	social-history	Social History
`<https://www.healthgorilla.com/fhir/observation-category>`	functional-status	Functional Status

Supported Attributes

Name	Comment
status
category
identifier
code	LOINC preferred
subject	Patient
effective
issued
performer	Reference to Practitioner Reference to Patient supported for Vital Signs, Social History, and Functional Status categories.
value
interpretation
comment
referenceRange
related	Observation, DeviceUseStatement
http://hl7.org/fhir/StructureDefinition/event-partOf	DiagnosticReport, Observation

https://api.healthgorilla.com/fhir/Observation

FHIR Operations

The following operations are currently supported:

List of available operations per category:


Laboratory, Imaging	Read, Search, Create
Vital Sign	Read, Search, Create, Update, Delete
Social History	Read, Search, Create, Update, Delete
Functional Status	Read, Search, Create, Update, Delete

1. Read

HTTP Request	Method	Action
/Observation/`{ID}`	GET	Retrieve Observation resource by ID

2. Search

HTTP Request	Method	Action
/Observation?[parameter=`{value}`]	GET	Retrieve Observation resources by the specified search criteria

Parameters:

Key	Type	Description
patient	Reference	Patient resource logical identifier. Required.
category	Token	Observation category (see: http://hl7.org/fhir/codesystem-observation-category.html). Required.
_lastUpdated	Date
_offset	Number
_count	Number

Examples

2.1 Retrieve Laboratory Observations by patient

https://api.healthgorilla.com/fhir/Observation?
category=http://hl7.org/fhir/observation-category|laboratory
&patient=8063965523692105bfc35def

2.2 Retrieve Vital Signs by patient

https://api.healthgorilla.com/fhir/Observation?
category=http://hl7.org/fhir/observation-category|vital-signs
&patient=8063965523692105bfc35def

2.3 Retrieve Social History by patient

https://api.healthgorilla.com/fhir/Observation?
category=http://hl7.org/fhir/observation-category|social-history
&patient=8063965523692105bfc35def

2.4 Retrieve Functional Status by patient

https://api.healthgorilla.com/fhir/Observation?
category=https://www.healthgorilla.com/fhir/observation-category|functional-status
&patient=8063965523692105bfc35def

2.5 Search records updated saince March 2019

https://api.healthgorilla.com/fhir/Observation?
category=http://hl7.org/fhir/observation-category|vital-signs
&_lastUpdated=gt2019-03
&_offset=0
&_count=5

2.6 Retrieve records for the given patient updated in 2018

https://api.healthgorilla.com/fhir/Observation?
category=http://hl7.org/fhir/observation-category|vital-signs
&patient=8063965523692105bfc35def
&_lastUpdated=2018

3. Create

HTTP Request	Method	Action
/Observation	POST	Creates Observation resource

The following attributes are required for Vital Sign:

Name	Details
subject
status
related	Observation (code, value)

The following attributes are required for Social History:

Name	Details
subject
status
code
value

The following attributes are required for Functional Status:

Name	Details
subject
status
code
related	DeviceUseStatement

Example

3.1 Add Vital Sign

<Observation xmlns="http://hl7.org/fhir">
    <meta>
        <profile value="http://hl7.org/fhir/StructureDefinition/vitalspanel"/>
    </meta>
    <contained>
        <Observation xmlns="http://hl7.org/fhir">
            <id value="1"/>
            <status value="unknown"/>
            <category>
                <coding>
                    <system value="http://hl7.org/fhir/observation-category"/>
                    <code value="vital-signs"/>
                    <display value="Vital Signs"/>
                </coding>
            </category>
            <code>
                <coding>
                    <system value="http://loinc.org"/>
                    <code value="8310-5"/>
                    <display value="Body temperature"/>
                </coding>
                <coding>
                    <system value="http://snomed.info/sct"/>
                    <code value="386725007"/>
                    <display value="Body temperature"/>
                </coding>
            </code>
            <subject>
                <reference value="Patient/03db4352ee0190ad5e9e6748"/>
                <display value="Homer Simpson"/>
            </subject>
            <valueQuantity>
                <value value="36.5"/>
                <unit value="C"/>
                <system value="http://unitsofmeasure.org"/>
                <code value="Cel"/>
            </valueQuantity>
        </Observation>
    </contained>
    <status value="unknown"/>
    <category>
        <coding>
            <system value="http://hl7.org/fhir/observation-category"/>
            <code value="vital-signs"/>
            <display value="Vital Signs"/>
        </coding>
    </category>
    <code>
        <coding>
            <system value="http://loinc.org"/>
            <code value="85353-1"/>
            <display value="Vital Signs Panel"/>
        </coding>
    </code>
    <subject>
        <reference value="Patient/03db4352ee0190ad5e9e6748"/>
        <display value="Homer Simpson"/>
    </subject>
    <effectiveDateTime value="2018-06-01"/>
    <performer>
        <reference value="Practitioner/ceda4352e8f6405dd2e42f09"/>
        <display value="John Doe"/>
    </performer>
    <related>
        <type value="has-member"/>
        <target>
            <reference value="#1"/>
        </target>
    </related>
</Observation>

3.2 Add Social History

<Observation xmlns="http://hl7.org/fhir">
    <status value="unknown"/>
    <category>
        <coding>
            <system value="http://hl7.org/fhir/observation-category"/>
            <code value="social-history"/>
            <display value="Social History"/>
        </coding>
    </category>
    <code>
        <coding>
            <system value="http://snomed.info/sct"/>
            <code value="160573003"/>
            <display value="Alcohol Use"/>
        </coding>
        <text value="port wine, red"/>
    </code>
    <subject>
        <reference value="Patient/03db4352ee0190ad5e9e6748"/>
        <display value="Homer Simpson"/>
    </subject>
    <effectivePeriod>
        <start value="2017-12-06"/>
        <end value="2018-09-20T01:30:00+03:00"/>
    </effectivePeriod>
    <performer>
        <reference value="Practitioner/ceda4352e8f6405dd2e42f09"/>
        <display value="John Doe"/>
    </performer>
    <valueCodeableConcept>
        <coding>
            <display value="Only 10 old port wine"/>
        </coding>
    </valueCodeableConcept>
    <comment value="This began just after the trip to Lisboa."/>
</Observation>

3.3 Add Laboratory Observation

{ 
   "resourceType":"Observation",
   "contained":[ 
      { 
         "id":"1",
         "resourceType":"Patient",
         "identifier":[ 
            { 
               "use":"usual",
               "type":{ 
                  "coding":[ 
                     { 
                        "system":"http://terminology.hl7.org/CodeSystem/v2-0203",
                        "code":"MR",
                        "display":"Medical record number"
                     }
                  ],
                  "text":"Medical record number"
               },
               "system":"https://www.healthgorilla.com",
               "value":"e20f61506d170a4423bb35a0"
            }
         ]
      }
   ],
   "status":"final",
   "category":{ 
      "coding":[ 
         { 
            "code":"laboratory",
            "system":"http://hl7.org/fhir/observation-category"
         }
      ],
      "text":"Laboratory"
   },
   "code":{ 
      "coding":[ 
         { 
            "code":"3043-7",
            "system":"http://loinc.org"
         }
      ],
      "text":"Triglycerides"
   },
   "issued":"2017-03-18T00:00:00Z",
   "referenceRange":[ 
      { 
         "high":{ 
            "code":"mg/dL",
            "system":"http://unitsofmeasure.org",
            "unit":"mg/dL",
            "value":250
         },
         "low":{ 
            "code":"mg/dL",
            "system":"http://unitsofmeasure.org",
            "unit":"mg/dL",
            "value":10
         },
         "text":"10 to 250 mg/dL"
      }
   ],
   "valueQuantity":{ 
      "code":"mg/dL",
      "system":"http://unitsofmeasure.org",
      "unit":"mg/dL",
      "value":86
   },
   "subject":{ 
      "display":"James Ellroy",
      "reference":"#1"
   }
}

4. Update

HTTP Request	Method	Action
/Observation/`{ID}`	PUT	Updates Observation resource

The following attributes are immutable for Vital Sign:

Name	Details
patient
performer

The following attributes are immutable for Social History:

Name	Details
patient
performer
code

The following attributes are immutable for Functional Status:

Name	Details
patient
performer

5. Delete

HTTP Request	Method	Action
/Observation/`{ID}`	DELETE	Deletes Observation resource