Current Build

14.12.0 OrderedDistribution

Clinical Decision Support Work GroupMaturity Level: 0Standards 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 OrderedDistribution data type is series of statistics in a logical order

Note: the OrderedDistribution structure allows modifier extensions.

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. OrderedDistributionIDBackBoneElementAn ordered list (distribution) of statistics
+ Rule: The cardinality of interval SHALL equal the value of numberOfIntervals
Elements defined in Ancestors: id, extension, modifierExtension
... description0..1stringA description of the content and value of the statistic
... note0..*AnnotationFootnotes and/or explanatory notes
... numberOfIntervalsΣ1..1integerNumber of intervals in an array, eg 4 for quartiles
... bottomOfFirstIntervalI0..1QuantityBottom of first interval
+ Rule: If minimum is not empty, all instances of interval.maximum must either be absent or > minimum..
... intervalΣI1..*ElementInterval
+ Rule: For every interval n, if n.maximum is not empty then, for every interval k, if k.rankOrder < n.rankOrder then k.maximum must be < n.maximum or empty.
.... rankOrderΣI1..1integerRelative order of interval
+ Rule: Now two intervals in the same OrderedDistribution can have the same rankOrder
+ Rule: The rankOrder value SHALL be an integer from 1 to k where k is the value of numberOfIntervals
.... intervalStatistic0..*StatisticValues and parameters for a single statistic related to the interval
... topOfInterval0..1QuantitySingular value of the statistic at the upper bound of the interval

doco Documentation for this format

XML Template

<OrderedDistribution xmlns="http://hl7.org/fhir">
 <!-- from BackboneElement: extension, modifierExtension -->
 <description value="[string]"/><!-- 0..1 A description of the content and value of the statistic -->
 <note><!-- 0..* Annotation Footnotes and/or explanatory notes --></note>
 <numberOfIntervals value="[integer]"/><!-- 1..1 Number of intervals in an array, eg 4 for quartiles -->
 <bottomOfFirstInterval><!-- 0..1 Quantity Bottom of first interval --></bottomOfFirstInterval>
 <interval>  <!-- 1..* Interval -->
  <rankOrder value="[integer]"/><!-- 1..1 Relative order of interval -->
  <intervalStatistic><!-- 0..* Statistic Values and parameters for a single statistic related to the interval --></intervalStatistic>
 </interval>
 <topOfInterval><!-- 0..1 Quantity Singular value of the statistic at the upper bound of the interval --></topOfInterval>
</OrderedDistribution>

Turtle Template

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

[
 # from BackboneElement: Element.extension, BackboneElement.modifierextension
  fhir:OrderedDistribution.description [ string ]; # 0..1 A description of the content and value of the statistic
  fhir:OrderedDistribution.note [ Annotation ], ... ; # 0..* Footnotes and/or explanatory notes
  fhir:OrderedDistribution.numberOfIntervals [ integer ]; # 1..1 Number of intervals in an array, eg 4 for quartiles
  fhir:OrderedDistribution.bottomOfFirstInterval [ Quantity ]; # 0..1 Bottom of first interval
  fhir:OrderedDistribution.interval [ # 1..* Interval
    fhir:OrderedDistribution.interval.rankOrder [ integer ]; # 1..1 Relative order of interval
    fhir:OrderedDistribution.interval.intervalStatistic [ Statistic ], ... ; # 0..* Values and parameters for a single statistic related to the interval
  ], ...;
  fhir:OrderedDistribution.topOfInterval [ Quantity ]; # 0..1 Singular value of the statistic at the upper bound of the interval
]

Changes since Release 3

This complex-type did not exist in Release 2

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. OrderedDistributionIDBackBoneElementAn ordered list (distribution) of statistics
+ Rule: The cardinality of interval SHALL equal the value of numberOfIntervals
Elements defined in Ancestors: id, extension, modifierExtension
... description0..1stringA description of the content and value of the statistic
... note0..*AnnotationFootnotes and/or explanatory notes
... numberOfIntervalsΣ1..1integerNumber of intervals in an array, eg 4 for quartiles
... bottomOfFirstIntervalI0..1QuantityBottom of first interval
+ Rule: If minimum is not empty, all instances of interval.maximum must either be absent or > minimum..
... intervalΣI1..*ElementInterval
+ Rule: For every interval n, if n.maximum is not empty then, for every interval k, if k.rankOrder < n.rankOrder then k.maximum must be < n.maximum or empty.
.... rankOrderΣI1..1integerRelative order of interval
+ Rule: Now two intervals in the same OrderedDistribution can have the same rankOrder
+ Rule: The rankOrder value SHALL be an integer from 1 to k where k is the value of numberOfIntervals
.... intervalStatistic0..*StatisticValues and parameters for a single statistic related to the interval
... topOfInterval0..1QuantitySingular value of the statistic at the upper bound of the interval

doco Documentation for this format

XML Template

<OrderedDistribution xmlns="http://hl7.org/fhir">
 <!-- from BackboneElement: extension, modifierExtension -->
 <description value="[string]"/><!-- 0..1 A description of the content and value of the statistic -->
 <note><!-- 0..* Annotation Footnotes and/or explanatory notes --></note>
 <numberOfIntervals value="[integer]"/><!-- 1..1 Number of intervals in an array, eg 4 for quartiles -->
 <bottomOfFirstInterval><!-- 0..1 Quantity Bottom of first interval --></bottomOfFirstInterval>
 <interval>  <!-- 1..* Interval -->
  <rankOrder value="[integer]"/><!-- 1..1 Relative order of interval -->
  <intervalStatistic><!-- 0..* Statistic Values and parameters for a single statistic related to the interval --></intervalStatistic>
 </interval>
 <topOfInterval><!-- 0..1 Quantity Singular value of the statistic at the upper bound of the interval --></topOfInterval>
</OrderedDistribution>

Turtle Template

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

[
 # from BackboneElement: Element.extension, BackboneElement.modifierextension
  fhir:OrderedDistribution.description [ string ]; # 0..1 A description of the content and value of the statistic
  fhir:OrderedDistribution.note [ Annotation ], ... ; # 0..* Footnotes and/or explanatory notes
  fhir:OrderedDistribution.numberOfIntervals [ integer ]; # 1..1 Number of intervals in an array, eg 4 for quartiles
  fhir:OrderedDistribution.bottomOfFirstInterval [ Quantity ]; # 0..1 Bottom of first interval
  fhir:OrderedDistribution.interval [ # 1..* Interval
    fhir:OrderedDistribution.interval.rankOrder [ integer ]; # 1..1 Relative order of interval
    fhir:OrderedDistribution.interval.intervalStatistic [ Statistic ], ... ; # 0..* Values and parameters for a single statistic related to the interval
  ], ...;
  fhir:OrderedDistribution.topOfInterval [ Quantity ]; # 0..1 Singular value of the statistic at the upper bound of the interval
]

Changes since Release 3

This complex-type did not exist in Release 2

Constraints

idLevelLocationDescriptionExpression
odd-1Rule OrderedDistribution.bottomOfFirstIntervalIf minimum is not empty, all instances of interval.maximum must either be absent or > minimum..true
odd-2Rule OrderedDistribution.intervalFor every interval n, if n.maximum is not empty then, for every interval k, if k.rankOrder < n.rankOrder then k.maximum must be < n.maximum or empty.true
odd-3Rule OrderedDistribution.interval.rankOrderNow two intervals in the same OrderedDistribution can have the same rankOrdertrue
odd-4Rule (base)The cardinality of interval SHALL equal the value of numberOfIntervalsinterval.count() = numberOfIntervals
odd-5Rule OrderedDistribution.interval.rankOrderThe rankOrder value SHALL be an integer from 1 to k where k is the value of numberOfIntervalstrue

OrderedDistribution is used in the following places: Evidence