STU 3 Ballot

This page is part of the FHIR Specification (v1.6.0: STU 3 Ballot 4). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3

Operation-observation-stats

This is the narrative for the resource. See also the XML or JSON format.


Observation Statistics

OPERATION: Observation Statistics

The Statistics operation performs a set of statistical calculations on a set of clinical measurements such as a blood pressure. This operation is limited to Observation resources with valueQuantity elements.

The set of Observations is defined by a the input parameters patient,code and duration and params. The set of statistical calculation depends upon the value of the params parameter:

  • average - for example if code = 55284-4 the mean of 55284-4 over the stated period from an operation
  • max - for example if code = 55284-4 the max of 55284-4 over the stated period from an operation
  • min - for example if code = 55284-4 the min of 55284-4 over the stated period from an operation
  • count - for example if code = 55284-4 the number of occurances of value x of 55284-4 over the stated period from an operation

If successful, the operation returns an Observation resource with the results of the statistical calculations as component value pairs where the component code = the params code. The Observation also contains the the input parameters patient,code and duration parameters. If unsuccessful, an OperationOutcome with an error message will be returned.

URL: [base]/Observation/$stats

URL: [base]/Observation/[id]/$stats

Parameters

UseNameCardinalityTypeBindingDocumentation
INpatient1..1id

The FHIR Patient resource id of the relevant Observations. For example The patient id = "123" in Observation.subject.reference = Patient/123.

INcode1..1string

The test code upon which the statistics are being performed. For example, the code = "45667-2" will evaluate all relevant Observations with this code in Observation.code.

INduration1..1decimal

The time period of interest given as hours. For example, the duration = "1" is the last hour

INparams1..4code

average|max|min|count The statistical operations to be performed on the relevant operations. These codes are defined here

OUTobs1..2Observation

The Observation.component.code is relative to the Observation.code and cannot be interpreted independently. The code input parameter is returned as the code element. The 'patient' parameter is returned as the patient element. The period input parameter is returned as the appliesPeriod element. The status is fixed to final.


 

 

Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.