Operation-observation-stats.json

Operation Definition

{
  "resourceType": "OperationDefinition",
  "id": "Observation-stats",
  "text": {
    "status": "generated",
    "div": "<div>!-- Snipped for Brevity --></div>"
  },
  "url": "http://hl7.org/fhir/OperationDefinition/Observation-stats",
  "name": "Observation Statistics",
  "status": "draft",
  "kind": "operation",
  "date": "2016-12-06T12:22:34+11:00",
  "publisher": "HL7 (FHIR Project)",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://hl7.org/fhir"
        },
        {
          "system": "email",
          "value": "fhir@lists.hl7.org"
        }
      ]
    }
  ],
  "description": "The Statistics operation performs a set of statistical calculations on a set of clinical measurements such as a blood pressure as stored on the server.  This operation is focused on [Observation](observation.html) resources with valueQuantity elements that have UCUM unit codes.\n\nThe set of Observations is defined by 4 parameters: \n\n- the subject of the observations for which the statistics are being generated (`subject`)\n- which observations to generate statistics for (`code` and 'system', or 'coding')\n- the time period over which to generate statistics ('duration' or 'period')\n- the set of statistical analyses to return (`statistic`). \n\nPossible statistical analyses (see [StatisticsCode](valueset-observation-statistics.html)):\n\n - **average** (\"Average\"): The [mean](https://en.wikipedia.org/wiki/Arithmetic_mean) of N measurements over the stated period\r\n - **maximum** (\"Maximum\"): The [maximum](https://en.wikipedia.org/wiki/Maximal_element) value of N measurements over the stated period\r\n - **minimum** (\"Minimum\"): The [minimum](https://en.wikipedia.org/wiki/Minimal_element) value of N measurements over the stated period\r\n - **count** (\"Count\"): The [number] of valid measurements over the stated period that contributed to the other statistical outputs\r\n - **totalcount** (\"Total Count\"): The total [number] of valid measurements over the stated period, including observations that were ignored because they did not contain valid result values\r\n - **median** (\"Median\"): The [median](https://en.wikipedia.org/wiki/Median) of N measurements over the stated period\r\n - **std-dev** (\"standard deviation\"): The [standard deviation](https://en.wikipedia.org/wiki/Standard_deviation) of N measurements over the stated period\r\n - **sum** (\"sum\"): The [sum](https://en.wikipedia.org/wiki/Summation) of N measurements over the stated period\r\n - **variance** (\"variance\"): The [variance](https://en.wikipedia.org/wiki/Variance) of N measurements over the stated period\r\n - **%20** (\"20th percentile\"): The 20th [Percentile](https://en.wikipedia.org/wiki/Percentile) of N measurements over the stated period\r\n - **%80** (\"80th percentile\"): The 80th [Percentile](https://en.wikipedia.org/wiki/Percentile) of N measurements over the stated period\r\n - **4-lower** (\"lower quartile\"): The lower [Quartile](https://en.wikipedia.org/wiki/Quartile) Boundary of N measurements over the stated period\r\n - **4-upper** (\"upper quartile\"): The upper [Quartile](https://en.wikipedia.org/wiki/Quartile) Boundary of N measurements over the stated period\r\n - **4-dev** (\"quartile deviation\"): The difference between the upper and lower [Quartiles](https://en.wikipedia.org/wiki/Quartile) is called the Interquartile range. (IQR = Q3-Q1) Quartile deviation or Semi-interquartile range is one-half the difference between the first and the third quartiles.\r\n - **5-1** (\"1st quintile\"): The lowest of four values that divide the N measurementsinto a frequency distribution of five classes with each containing one fifth of the total population\r\n - **5-2** (\"2nd quintile\"): The second of four values that divide the N measurementsinto a frequency distribution of five classes with each containing one fifth of the total population\r\n - **5-3** (\"3rd quintile\"): The third of four values that divide the N measurementsinto a frequency distribution of five classes with each containing one fifth of the total population\r\n - **5-4** (\"4th quintile\"): The fourth of four values that divide the N measurementsinto a frequency distribution of five classes with each containing one fifth of the total population\r\n\n\n\r\rIf successful, the operation returns an Observation resource for each code with the results of the statistical calculations as component value pairs where the component code = the statistical code. The Observation also contains the the input parameters `patient`,`code` and `duration` parameters. If unsuccessful, an [OperationOutcome](operationoutcome.html) with an error message will be returned.\r\r\n\nThe client can request that all the observations on which the statistics are based be returned as well, using the include parameter. If an include parameter is specified, a limit may also be specified; the sources observations are subsetted at the server's discretion if count > limit. This functionality is included with the intent of supporting graphical presentation",
  "code": "stats",
  "resource": [
    "Observation"
  ],
  "system": false,
  "type": true,
  "instance": false,
  "parameter": [
    {
      "name": "subject",
      "use": "in",
      "min": 1,
      "max": "1",
      "documentation": "The subject of the relevant Observations, which has the value of the Observation.subject.reference. E.g. 'Patient/123'. Reference can be to an absolute URL, but servers only perform stats on their own observations",
      "type": "uri"
    },
    {
      "name": "code",
      "use": "in",
      "min": 0,
      "max": "*",
      "documentation": "The test code(s) upon which the statistics are being performed. Provide along with a system, or as a coding. For example, the code  = \"45667-2\"  will evaluate all relevant Observations with this code in Observation.code. For LOINC codes that are panels, (e.g. 55284-4) this means to include all the individual codes that are part of a panel",
      "type": "string"
    },
    {
      "name": "system",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "The system for the code(s). Or provide a coding instead",
      "type": "uri"
    },
    {
      "name": "coding",
      "use": "in",
      "min": 0,
      "max": "*",
      "documentation": "The test code upon which the statistics are being performed, as a Coding",
      "type": "Coding"
    },
    {
      "name": "duration",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "The time period of interest given as hours.  For example, the duration = \"1\" represents the last hour - the time period from on hour ago to now",
      "type": "decimal"
    },
    {
      "name": "period",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "The time period over which the calculations to be performed, if a duration is not provided",
      "type": "Period"
    },
    {
      "name": "params",
      "use": "in",
      "min": 1,
      "max": "*",
      "documentation": "average|max|min|count  The statistical operations to be performed on the relevant operations. Multiple statistics operations can be specified. These codes are defined [here](valueset-observation-statistics.html)",
      "type": "code"
    },
    {
      "name": "return",
      "use": "out",
      "min": 1,
      "max": "*",
      "documentation": "A set of observations, one observation for each code, each containing one component for each statistic. The Observation.component.code contains the statistic, and is relative to the Observation.code and cannot be interpreted independently.  The Observation will also contain a subject, effectivePeriod, and code reflecting the input parameters.  The status is fixed to `final`.",
      "type": "Observation"
    },
    {
      "name": "source",
      "use": "out",
      "min": 0,
      "max": "*",
      "documentation": "Source observations on which the statistics are based",
      "type": "Observation"
    }
  ]
}