This page is part of the FHIR Specification (v4.6.0: R5 Draft Ballot - see ballot notes). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

14.13.0 Statistic

Clinical Decision Support

Work Group

Maturity Level: 1

Standards Status: Trial Use

This type is still undergoing development and review by the appropriate Workgroups. At this time, is considered only as a draft design not suitable for production implementation

The Statistic data type represents single datum (quantitative value), computed from a sample, and its attributes.

Note: the Statistic structure allows modifier extensions.

Structure

Name	Flags	Card.	Type	Description & Constraints
Statistic	Σ D		Element	Single statistic Elements defined in Ancestors: id, extension, modifierExtension
description	Σ	0..1	string	Description of content
note	Σ	0..*	Annotation	Footnotes and/or explanatory notes
statisticType	Σ	0..1	CodeableConcept	Type of statistic, eg relative risk StatisticType (Extensible)
category	Σ	0..1	CodeableConcept	Associated category for categorical variable"
quantity	Σ	0..1	Quantity	Statistic value
numberOfEvents	Σ	0..1	unsignedInt	The number of events associated with the statistic
numberAffected	Σ	0..1	unsignedInt	The number of participants affected
sampleSize	Σ	0..1	Element	Number of samples in the statistic
description	Σ	0..1	string	Textual description of sample size for statistic
note	Σ	0..*	Annotation	Footnote or explanatory note about the sample size
numberOfStudies	Σ	0..1	unsignedInt	Number of contributing studies
numberOfParticipants	Σ	0..1	unsignedInt	Cumulative number of participants
knownDataCount	Σ	0..1	unsignedInt	Number of participants with known results for measured variables
attributeEstimate	Σ	0..*	Element	An attribute of the Statistic
description	Σ	0..1	string	Textual description of the attribute estimate
note	Σ	0..*	Annotation	Footnote or explanatory note about the estimate
type	Σ	0..1	CodeableConcept	The type of attribute estimate, eg confidence interval or p value StatisticAttributeEstimateType (Extensible)
quantity	Σ	0..1	Quantity	The singular quantity of the attribute estimate, for attribute estimates represented as single values; also used to report unit of measure
level	Σ	0..1	decimal	Level of confidence interval, eg 0.95 for 95% confidence interval
range	Σ	0..1	Range	Lower and upper bound values of the attribute estimate
attributeEstimate	Σ	0..*	Element	A nested attribute estimate; which is the attribute estimate of an attribute estimate
description	Σ	0..1	string	Textual description of the attribute estimate
note	Σ	0..*	Annotation	Footnote or explanatory note about the estimate
type	Σ	0..1	CodeableConcept	The type of attribute estimate, eg confidence interval or p value StatisticAttributeEstimateType (Extensible)
quantity	Σ	0..1	Quantity	The singular quantity of the attribute estimate, for attribute estimates represented as single values; also used to report unit of measure
level	Σ	0..1	decimal	Level of confidence interval, eg 0.95 for 95% confidence interval
range	Σ	0..1	Range	Lower and upper bound values of the attribute estimate
modelCharacteristic	Σ	0..*	Element	Model characteristic
code	Σ	1..1	CodeableConcept	Model specification StatisticModelCode (Extensible)
value	Σ	0..1	SimpleQuantity	Numerical value to complete model specification
variable	Σ	0..*	Element	A variable adjusted for in the adjusted analysis
variableDefinition	Σ	1..1	Reference(Group \| EvidenceVariable)	Description of the variable
handling	Σ	0..1	code	continuous \| dichotomous \| ordinal \| polychotomous EvidenceVariableHandling (Required)
valueCategory	Σ	0..*	CodeableConcept	Description for grouping of ordinal or polychotomous variables
valueQuantity	Σ	0..*	Quantity	Discrete value for grouping of ordinal or polychotomous variables
valueRange	Σ	0..*	Range	Range of values for grouping of ordinal or polychotomous variables
Documentation for this format

UML Diagram (Legend)

XML Template

<Statistic xmlns="http://hl7.org/fhir">
 <!-- from Element: extension -->
 <description value="[string]"/><!-- 0..1 Description of content -->
 <note><!-- 0..* Annotation Footnotes and/or explanatory notes --></note>
 <statisticType><!-- 0..1 CodeableConcept Type of statistic, eg relative risk --></statisticType>
 <category><!-- 0..1 CodeableConcept Associated category for categorical variable" --></category>
 <quantity><!-- 0..1 Quantity Statistic value --></quantity>
 <numberOfEvents value="[unsignedInt]"/><!-- 0..1 The number of events associated with the statistic -->
 <numberAffected value="[unsignedInt]"/><!-- 0..1 The number of participants affected -->
 <sampleSize>  <!-- 0..1 Number of samples in the statistic -->
  <description value="[string]"/><!-- 0..1 Textual description of sample size for statistic -->
  <note><!-- 0..* Annotation Footnote or explanatory note about the sample size --></note>
  <numberOfStudies value="[unsignedInt]"/><!-- 0..1 Number of contributing studies -->
  <numberOfParticipants value="[unsignedInt]"/><!-- 0..1 Cumulative number of participants -->
  <knownDataCount value="[unsignedInt]"/><!-- 0..1 Number of participants with known results for measured variables -->
 </sampleSize>
 <attributeEstimate>  <!-- 0..* An attribute of the Statistic -->
  <description value="[string]"/><!-- 0..1 Textual description of the attribute estimate -->
  <note><!-- 0..* Annotation Footnote or explanatory note about the estimate --></note>
  <type><!-- 0..1 CodeableConcept The type of attribute estimate, eg confidence interval or p value --></type>
  <quantity><!-- 0..1 Quantity The singular quantity of the attribute estimate, for attribute estimates represented as single values; also used to report unit of measure --></quantity>
  <level value="[decimal]"/><!-- 0..1 Level of confidence interval, eg 0.95 for 95% confidence interval -->
  <range><!-- 0..1 Range Lower and upper bound values of the attribute estimate --></range>
  <attributeEstimate>  <!-- 0..* A nested attribute estimate; which is the attribute estimate of an attribute estimate -->
   <description value="[string]"/><!-- 0..1 Textual description of the attribute estimate -->
   <note><!-- 0..* Annotation Footnote or explanatory note about the estimate --></note>
   <type><!-- 0..1 CodeableConcept The type of attribute estimate, eg confidence interval or p value --></type>
   <quantity><!-- 0..1 Quantity The singular quantity of the attribute estimate, for attribute estimates represented as single values; also used to report unit of measure --></quantity>
   <level value="[decimal]"/><!-- 0..1 Level of confidence interval, eg 0.95 for 95% confidence interval -->
   <range><!-- 0..1 Range Lower and upper bound values of the attribute estimate --></range>
  </attributeEstimate>
 </attributeEstimate>
 <modelCharacteristic>  <!-- 0..* Model characteristic -->
  <code><!-- 1..1 CodeableConcept Model specification --></code>
  <value><!-- 0..1 Quantity(SimpleQuantity) Numerical value to complete model specification --></value>
  <variable>  <!-- 0..* A variable adjusted for in the adjusted analysis -->
   <variableDefinition><!-- 1..1 Reference(EvidenceVariable|Group) Description of the variable --></variableDefinition>
   <handling value="[code]"/><!-- 0..1 continuous | dichotomous | ordinal | polychotomous -->
   <valueCategory><!-- 0..* CodeableConcept Description for grouping of ordinal or polychotomous variables --></valueCategory>
   <valueQuantity><!-- 0..* Quantity Discrete value for grouping of ordinal or polychotomous variables --></valueQuantity>
   <valueRange><!-- 0..* Range Range of values for grouping of ordinal or polychotomous variables --></valueRange>
  </variable>
 </modelCharacteristic>
</Statistic>

JSON Template

{
  // from Element: extension
  "description" : "<string>", // Description of content
  "note" : [{ Annotation }], // Footnotes and/or explanatory notes
  "statisticType" : { CodeableConcept }, // Type of statistic, eg relative risk
  "category" : { CodeableConcept }, // Associated category for categorical variable"
  "quantity" : { Quantity }, // Statistic value
  "numberOfEvents" : "<unsignedInt>", // The number of events associated with the statistic
  "numberAffected" : "<unsignedInt>", // The number of participants affected
  "sampleSize" : { // Number of samples in the statistic
    "description" : "<string>", // Textual description of sample size for statistic
    "note" : [{ Annotation }], // Footnote or explanatory note about the sample size
    "numberOfStudies" : "<unsignedInt>", // Number of contributing studies
    "numberOfParticipants" : "<unsignedInt>", // Cumulative number of participants
    "knownDataCount" : "<unsignedInt>" // Number of participants with known results for measured variables
  },
  "attributeEstimate" : [{ // An attribute of the Statistic
    "description" : "<string>", // Textual description of the attribute estimate
    "note" : [{ Annotation }], // Footnote or explanatory note about the estimate
    "type" : { CodeableConcept }, // The type of attribute estimate, eg confidence interval or p value
    "quantity" : { Quantity }, // The singular quantity of the attribute estimate, for attribute estimates represented as single values; also used to report unit of measure
    "level" : <decimal>, // Level of confidence interval, eg 0.95 for 95% confidence interval
    "range" : { Range }, // Lower and upper bound values of the attribute estimate
    "attributeEstimate" : [{ // A nested attribute estimate; which is the attribute estimate of an attribute estimate
      "description" : "<string>", // Textual description of the attribute estimate
      "note" : [{ Annotation }], // Footnote or explanatory note about the estimate
      "type" : { CodeableConcept }, // The type of attribute estimate, eg confidence interval or p value
      "quantity" : { Quantity }, // The singular quantity of the attribute estimate, for attribute estimates represented as single values; also used to report unit of measure
      "level" : <decimal>, // Level of confidence interval, eg 0.95 for 95% confidence interval
      "range" : { Range } // Lower and upper bound values of the attribute estimate
    }]
  }],
  "modelCharacteristic" : [{ // Model characteristic
    "code" : { CodeableConcept }, // R!  Model specification
    "value" : { Quantity(SimpleQuantity) }, // Numerical value to complete model specification
    "variable" : [{ // A variable adjusted for in the adjusted analysis
      "variableDefinition" : { Reference(EvidenceVariable|Group) }, // R!  Description of the variable
      "handling" : "<code>", // continuous | dichotomous | ordinal | polychotomous
      "valueCategory" : [{ CodeableConcept }], // Description for grouping of ordinal or polychotomous variables
      "valueQuantity" : [{ Quantity }], // Discrete value for grouping of ordinal or polychotomous variables
      "valueRange" : [{ Range }] // Range of values for grouping of ordinal or polychotomous variables
    }]
  }]
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .

[
 # from Element: Element.extension
  fhir:Statistic.description [ string ]; # 0..1 Description of content
  fhir:Statistic.note [ Annotation ], ... ; # 0..* Footnotes and/or explanatory notes
  fhir:Statistic.statisticType [ CodeableConcept ]; # 0..1 Type of statistic, eg relative risk
  fhir:Statistic.category [ CodeableConcept ]; # 0..1 Associated category for categorical variable"
  fhir:Statistic.quantity [ Quantity ]; # 0..1 Statistic value
  fhir:Statistic.numberOfEvents [ unsignedInt ]; # 0..1 The number of events associated with the statistic
  fhir:Statistic.numberAffected [ unsignedInt ]; # 0..1 The number of participants affected
  fhir:Statistic.sampleSize [ # 0..1 Number of samples in the statistic
    fhir:Statistic.sampleSize.description [ string ]; # 0..1 Textual description of sample size for statistic
    fhir:Statistic.sampleSize.note [ Annotation ], ... ; # 0..* Footnote or explanatory note about the sample size
    fhir:Statistic.sampleSize.numberOfStudies [ unsignedInt ]; # 0..1 Number of contributing studies
    fhir:Statistic.sampleSize.numberOfParticipants [ unsignedInt ]; # 0..1 Cumulative number of participants
    fhir:Statistic.sampleSize.knownDataCount [ unsignedInt ]; # 0..1 Number of participants with known results for measured variables
  ];
  fhir:Statistic.attributeEstimate [ # 0..* An attribute of the Statistic
    fhir:Statistic.attributeEstimate.description [ string ]; # 0..1 Textual description of the attribute estimate
    fhir:Statistic.attributeEstimate.note [ Annotation ], ... ; # 0..* Footnote or explanatory note about the estimate
    fhir:Statistic.attributeEstimate.type [ CodeableConcept ]; # 0..1 The type of attribute estimate, eg confidence interval or p value
    fhir:Statistic.attributeEstimate.quantity [ Quantity ]; # 0..1 The singular quantity of the attribute estimate, for attribute estimates represented as single values; also used to report unit of measure
    fhir:Statistic.attributeEstimate.level [ decimal ]; # 0..1 Level of confidence interval, eg 0.95 for 95% confidence interval
    fhir:Statistic.attributeEstimate.range [ Range ]; # 0..1 Lower and upper bound values of the attribute estimate
    fhir:Statistic.attributeEstimate.attributeEstimate [ # 0..* A nested attribute estimate; which is the attribute estimate of an attribute estimate
      fhir:Statistic.attributeEstimate.attributeEstimate.description [ string ]; # 0..1 Textual description of the attribute estimate
      fhir:Statistic.attributeEstimate.attributeEstimate.note [ Annotation ], ... ; # 0..* Footnote or explanatory note about the estimate
      fhir:Statistic.attributeEstimate.attributeEstimate.type [ CodeableConcept ]; # 0..1 The type of attribute estimate, eg confidence interval or p value
      fhir:Statistic.attributeEstimate.attributeEstimate.quantity [ Quantity ]; # 0..1 The singular quantity of the attribute estimate, for attribute estimates represented as single values; also used to report unit of measure
      fhir:Statistic.attributeEstimate.attributeEstimate.level [ decimal ]; # 0..1 Level of confidence interval, eg 0.95 for 95% confidence interval
      fhir:Statistic.attributeEstimate.attributeEstimate.range [ Range ]; # 0..1 Lower and upper bound values of the attribute estimate
    ], ...;
  ], ...;
  fhir:Statistic.modelCharacteristic [ # 0..* Model characteristic
    fhir:Statistic.modelCharacteristic.code [ CodeableConcept ]; # 1..1 Model specification
    fhir:Statistic.modelCharacteristic.value [ Quantity(SimpleQuantity) ]; # 0..1 Numerical value to complete model specification
    fhir:Statistic.modelCharacteristic.variable [ # 0..* A variable adjusted for in the adjusted analysis
      fhir:Statistic.modelCharacteristic.variable.variableDefinition [ Reference(EvidenceVariable|Group) ]; # 1..1 Description of the variable
      fhir:Statistic.modelCharacteristic.variable.handling [ code ]; # 0..1 continuous | dichotomous | ordinal | polychotomous
      fhir:Statistic.modelCharacteristic.variable.valueCategory [ CodeableConcept ], ... ; # 0..* Description for grouping of ordinal or polychotomous variables
      fhir:Statistic.modelCharacteristic.variable.valueQuantity [ Quantity ], ... ; # 0..* Discrete value for grouping of ordinal or polychotomous variables
      fhir:Statistic.modelCharacteristic.variable.valueRange [ Range ], ... ; # 0..* Range of values for grouping of ordinal or polychotomous variables
    ], ...;
  ], ...;
]

Changes since Release 3

This complex-type did not exist in Release 2