This page is part of the FHIR Specification (v4.2.0: R5 Preview #1). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions
Clinical Decision Support Work Group | Maturity Level: 0 | 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 StatisticStatisticType (Extensible) |
quantity | Σ | 0..1 | Quantity | Statistic value |
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 | integer | Number of contributing studies |
numberOfParticipants | Σ | 0..1 | integer | Cumulative number of participants |
knownDataCount | Σ | 0..1 | integer | Number of participants with known results for measured variables |
numeratorCount | Σ | 0..1 | integer | Number of participants with “positive” results, only used to report actual numerator count for a proportion |
attributeEstimate | Σ | 0..* | Element | An estimate of the precision of the statistic |
description | Σ | 0..1 | string | Textual description of the precision estimate |
note | Σ | 0..* | Annotation | Footnote or explanatory note about the estimate |
type | Σ | 0..1 | CodeableConcept | The estimateType of precision estimate, eg confidence interval or p value type StatisticAttributeEstimateType (Extensible) |
quantity | Σ | 0..1 | Quantity | The singular quantity of the precision estimate, for precision 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 precision estimate |
estimateQualifier | Σ | 0..* | Element | An estimate of the precision of the estimate |
description | Σ | 0..1 | string | Textual description of the precision estimate |
note | Σ | 0..* | Annotation | Footnote or explanatory note about the estimate |
type | Σ | 0..1 | CodeableConcept | The estimateType of attribute estimate, eg confidence interval or p value type 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 precision estimate |
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> <quantity><!-- 0..1 Quantity Statistic value --></quantity> <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="[integer]"/><!-- 0..1 Number of contributing studies --> <numberOfParticipants value="[integer]"/><!-- 0..1 Cumulative number of participants --> <knownDataCount value="[integer]"/><!-- 0..1 Number of participants with known results for measured variables --> <numeratorCount value="[integer]"/><!-- 0..1 Number of participants with “positive” results, only used to report actual numerator count for a proportion --> </sampleSize> <attributeEstimate> <!-- 0..* An estimate of the precision of the statistic --> <description value="[string]"/><!-- 0..1 Textual description of the precision estimate --> <note><!-- 0..* Annotation Footnote or explanatory note about the estimate --></note> <type><!-- 0..1 CodeableConcept The estimateType of precision estimate, eg confidence interval or p value type --></type> <quantity><!-- 0..1 Quantity The singular quantity of the precision estimate, for precision 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 precision estimate --></range> <estimateQualifier> <!-- 0..* An estimate of the precision of the estimate --> <description value="[string]"/><!-- 0..1 Textual description of the precision estimate --> <note><!-- 0..* Annotation Footnote or explanatory note about the estimate --></note> <type><!-- 0..1 CodeableConcept The estimateType of attribute estimate, eg confidence interval or p value type --></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 precision estimate --></range> </estimateQualifier> </attributeEstimate> </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 "quantity" : { Quantity }, // Statistic value "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" : <integer>, // Number of contributing studies "numberOfParticipants" : <integer>, // Cumulative number of participants "knownDataCount" : <integer>, // Number of participants with known results for measured variables "numeratorCount" : <integer> // Number of participants with “positive� results, only used to report actual numerator count for a proportion }, "attributeEstimate" : [{ // An estimate of the precision of the statistic "description" : "<string>", // Textual description of the precision estimate "note" : [{ Annotation }], // Footnote or explanatory note about the estimate "type" : { CodeableConcept }, // The estimateType of precision estimate, eg confidence interval or p value type "quantity" : { Quantity }, // The singular quantity of the precision estimate, for precision 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 precision estimate "estimateQualifier" : [{ // An estimate of the precision of the estimate "description" : "<string>", // Textual description of the precision estimate "note" : [{ Annotation }], // Footnote or explanatory note about the estimate "type" : { CodeableConcept }, // The estimateType of attribute estimate, eg confidence interval or p value type "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 precision estimate }] }] }
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.quantity [ Quantity ]; # 0..1 Statistic value 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 [ integer ]; # 0..1 Number of contributing studies fhir:Statistic.sampleSize.numberOfParticipants [ integer ]; # 0..1 Cumulative number of participants fhir:Statistic.sampleSize.knownDataCount [ integer ]; # 0..1 Number of participants with known results for measured variables fhir:Statistic.sampleSize.numeratorCount [ integer ]; # 0..1 Number of participants with “positive� results, only used to report actual numerator count for a proportion ]; fhir:Statistic.attributeEstimate [ # 0..* An estimate of the precision of the statistic fhir:Statistic.attributeEstimate.description [ string ]; # 0..1 Textual description of the precision estimate fhir:Statistic.attributeEstimate.note [ Annotation ], ... ; # 0..* Footnote or explanatory note about the estimate fhir:Statistic.attributeEstimate.type [ CodeableConcept ]; # 0..1 The estimateType of precision estimate, eg confidence interval or p value type fhir:Statistic.attributeEstimate.quantity [ Quantity ]; # 0..1 The singular quantity of the precision estimate, for precision 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 precision estimate fhir:Statistic.attributeEstimate.estimateQualifier [ # 0..* An estimate of the precision of the estimate fhir:Statistic.attributeEstimate.estimateQualifier.description [ string ]; # 0..1 Textual description of the precision estimate fhir:Statistic.attributeEstimate.estimateQualifier.note [ Annotation ], ... ; # 0..* Footnote or explanatory note about the estimate fhir:Statistic.attributeEstimate.estimateQualifier.type [ CodeableConcept ]; # 0..1 The estimateType of attribute estimate, eg confidence interval or p value type fhir:Statistic.attributeEstimate.estimateQualifier.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.estimateQualifier.level [ decimal ]; # 0..1 Level of confidence interval, eg 0.95 for 95% confidence interval fhir:Statistic.attributeEstimate.estimateQualifier.range [ Range ]; # 0..1 Lower and upper bound values of the precision estimate ], ...; ], ...; ]
Changes since Release 3
This complex-type did not exist in Release 2
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 StatisticStatisticType (Extensible) |
quantity | Σ | 0..1 | Quantity | Statistic value |
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 | integer | Number of contributing studies |
numberOfParticipants | Σ | 0..1 | integer | Cumulative number of participants |
knownDataCount | Σ | 0..1 | integer | Number of participants with known results for measured variables |
numeratorCount | Σ | 0..1 | integer | Number of participants with “positive” results, only used to report actual numerator count for a proportion |
attributeEstimate | Σ | 0..* | Element | An estimate of the precision of the statistic |
description | Σ | 0..1 | string | Textual description of the precision estimate |
note | Σ | 0..* | Annotation | Footnote or explanatory note about the estimate |
type | Σ | 0..1 | CodeableConcept | The estimateType of precision estimate, eg confidence interval or p value type StatisticAttributeEstimateType (Extensible) |
quantity | Σ | 0..1 | Quantity | The singular quantity of the precision estimate, for precision 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 precision estimate |
estimateQualifier | Σ | 0..* | Element | An estimate of the precision of the estimate |
description | Σ | 0..1 | string | Textual description of the precision estimate |
note | Σ | 0..* | Annotation | Footnote or explanatory note about the estimate |
type | Σ | 0..1 | CodeableConcept | The estimateType of attribute estimate, eg confidence interval or p value type 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 precision estimate |
Documentation for this format |
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> <quantity><!-- 0..1 Quantity Statistic value --></quantity> <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="[integer]"/><!-- 0..1 Number of contributing studies --> <numberOfParticipants value="[integer]"/><!-- 0..1 Cumulative number of participants --> <knownDataCount value="[integer]"/><!-- 0..1 Number of participants with known results for measured variables --> <numeratorCount value="[integer]"/><!-- 0..1 Number of participants with “positive” results, only used to report actual numerator count for a proportion --> </sampleSize> <attributeEstimate> <!-- 0..* An estimate of the precision of the statistic --> <description value="[string]"/><!-- 0..1 Textual description of the precision estimate --> <note><!-- 0..* Annotation Footnote or explanatory note about the estimate --></note> <type><!-- 0..1 CodeableConcept The estimateType of precision estimate, eg confidence interval or p value type --></type> <quantity><!-- 0..1 Quantity The singular quantity of the precision estimate, for precision 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 precision estimate --></range> <estimateQualifier> <!-- 0..* An estimate of the precision of the estimate --> <description value="[string]"/><!-- 0..1 Textual description of the precision estimate --> <note><!-- 0..* Annotation Footnote or explanatory note about the estimate --></note> <type><!-- 0..1 CodeableConcept The estimateType of attribute estimate, eg confidence interval or p value type --></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 precision estimate --></range> </estimateQualifier> </attributeEstimate> </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 "quantity" : { Quantity }, // Statistic value "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" : <integer>, // Number of contributing studies "numberOfParticipants" : <integer>, // Cumulative number of participants "knownDataCount" : <integer>, // Number of participants with known results for measured variables "numeratorCount" : <integer> // Number of participants with “positive� results, only used to report actual numerator count for a proportion }, "attributeEstimate" : [{ // An estimate of the precision of the statistic "description" : "<string>", // Textual description of the precision estimate "note" : [{ Annotation }], // Footnote or explanatory note about the estimate "type" : { CodeableConcept }, // The estimateType of precision estimate, eg confidence interval or p value type "quantity" : { Quantity }, // The singular quantity of the precision estimate, for precision 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 precision estimate "estimateQualifier" : [{ // An estimate of the precision of the estimate "description" : "<string>", // Textual description of the precision estimate "note" : [{ Annotation }], // Footnote or explanatory note about the estimate "type" : { CodeableConcept }, // The estimateType of attribute estimate, eg confidence interval or p value type "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 precision estimate }] }] }
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.quantity [ Quantity ]; # 0..1 Statistic value 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 [ integer ]; # 0..1 Number of contributing studies fhir:Statistic.sampleSize.numberOfParticipants [ integer ]; # 0..1 Cumulative number of participants fhir:Statistic.sampleSize.knownDataCount [ integer ]; # 0..1 Number of participants with known results for measured variables fhir:Statistic.sampleSize.numeratorCount [ integer ]; # 0..1 Number of participants with “positive� results, only used to report actual numerator count for a proportion ]; fhir:Statistic.attributeEstimate [ # 0..* An estimate of the precision of the statistic fhir:Statistic.attributeEstimate.description [ string ]; # 0..1 Textual description of the precision estimate fhir:Statistic.attributeEstimate.note [ Annotation ], ... ; # 0..* Footnote or explanatory note about the estimate fhir:Statistic.attributeEstimate.type [ CodeableConcept ]; # 0..1 The estimateType of precision estimate, eg confidence interval or p value type fhir:Statistic.attributeEstimate.quantity [ Quantity ]; # 0..1 The singular quantity of the precision estimate, for precision 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 precision estimate fhir:Statistic.attributeEstimate.estimateQualifier [ # 0..* An estimate of the precision of the estimate fhir:Statistic.attributeEstimate.estimateQualifier.description [ string ]; # 0..1 Textual description of the precision estimate fhir:Statistic.attributeEstimate.estimateQualifier.note [ Annotation ], ... ; # 0..* Footnote or explanatory note about the estimate fhir:Statistic.attributeEstimate.estimateQualifier.type [ CodeableConcept ]; # 0..1 The estimateType of attribute estimate, eg confidence interval or p value type fhir:Statistic.attributeEstimate.estimateQualifier.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.estimateQualifier.level [ decimal ]; # 0..1 Level of confidence interval, eg 0.95 for 95% confidence interval fhir:Statistic.attributeEstimate.estimateQualifier.range [ Range ]; # 0..1 Lower and upper bound values of the precision estimate ], ...; ], ...; ]
Constraints
Statistic is used in the following places: OrderedDistribution and Evidence