Release 5 Preview #2

Ordereddistribution.profile.json

Modeling and Methodology Work GroupMaturity Level: N/AStandards Status: Informative

Raw JSON (canonical form + also see JSON Format Specification)

StructureDefinition for OrderedDistribution

{
  "resourceType" : "StructureDefinition",
  "id" : "OrderedDistribution",
  "meta" : {
    "lastUpdated" : "2020-07-02T00:59:53.707+00:00"
  },
  "text" : {
    "status" : "generated",
    "div" : "<div>!-- Snipped for Brevity --></div>"
  },
  "extension" : [{
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
    "valueCode" : "draft"
  }],
  "url" : "http://hl7.org/fhir/StructureDefinition/OrderedDistribution",
  "version" : "4.4.0",
  "name" : "OrderedDistribution",
  "status" : "draft",
  "date" : "2020-07-02T00:59:53+00:00",
  "publisher" : "HL7 FHIR Standard",
  "contact" : [{
    "telecom" : [{
      "system" : "url",
      "value" : "http://hl7.org/fhir"
    }]
  }],
  "description" : "Base StructureDefinition for OrderedDistribution Type: An ordered list (distribution) of statistics.",
  "fhirVersion" : "4.4.0",
  "mapping" : [{
    "identity" : "rim",
    "uri" : "http://hl7.org/v3",
    "name" : "RIM Mapping"
  }],
  "kind" : "complex-type",
  "abstract" : false,
  "type" : "OrderedDistribution",
  "baseDefinition" : "http://hl7.org/fhir/StructureDefinition/BackboneType",
  "derivation" : "specialization",
  "snapshot" : {
    "element" : [{
      "id" : "OrderedDistribution",
      "extension" : [{
        "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
        "valueCode" : "draft"
      }],
      "path" : "OrderedDistribution",
      "short" : "An ordered list (distribution) of statistics",
      "definition" : "An ordered list (distribution) of statistics.",
      "min" : 0,
      "max" : "*",
      "base" : {
        "path" : "OrderedDistribution",
        "min" : 0,
        "max" : "*"
      },
      "constraint" : [{
        "key" : "ele-1",
        "severity" : "error",
        "human" : "All FHIR elements must have a @value or children",
        "expression" : "hasValue() or (children().count() > id.count())",
        "xpath" : "@value|f:*|h:div",
        "source" : "http://hl7.org/fhir/StructureDefinition/Element"
      },
      {
        "key" : "odd-4",
        "severity" : "error",
        "human" : "The cardinality of interval SHALL equal the value of numberOfIntervals",
        "expression" : "interval.count() = numberOfIntervals",
        "xpath" : "minimum",
        "source" : "http://hl7.org/fhir/StructureDefinition/OrderedDistribution"
      }],
      "isModifier" : false,
      "mapping" : [{
        "identity" : "rim",
        "map" : "n/a"
      }]
    },
    {
      "id" : "OrderedDistribution.id",
      "path" : "OrderedDistribution.id",
      "representation" : ["xmlAttr"],
      "short" : "Unique id for inter-element referencing",
      "definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
      "min" : 0,
      "max" : "1",
      "base" : {
        "path" : "Element.id",
        "min" : 0,
        "max" : "1"
      },
      "type" : [{
        "extension" : [{
          "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
          "valueUri" : "string"
        }],
        "code" : "http://hl7.org/fhirpath/System.String"
      }],
      "isModifier" : false,
      "isSummary" : false,
      "mapping" : [{
        "identity" : "rim",
        "map" : "n/a"
      }]
    },
    {
      "id" : "OrderedDistribution.extension",
      "path" : "OrderedDistribution.extension",
      "slicing" : {
        "discriminator" : [{
          "type" : "value",
          "path" : "url"
        }],
        "description" : "Extensions are always sliced by (at least) url",
        "rules" : "open"
      },
      "short" : "Additional content defined by implementations",
      "definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance  applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
      "comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
      "alias" : ["extensions",
      "user content"],
      "min" : 0,
      "max" : "*",
      "base" : {
        "path" : "Element.extension",
        "min" : 0,
        "max" : "*"
      },
      "type" : [{
        "code" : "Extension"
      }],
      "constraint" : [{
        "key" : "ele-1",
        "severity" : "error",
        "human" : "All FHIR elements must have a @value or children",
        "expression" : "hasValue() or (children().count() > id.count())",
        "xpath" : "@value|f:*|h:div",
        "source" : "http://hl7.org/fhir/StructureDefinition/Element"
      },
      {
        "key" : "ext-1",
        "severity" : "error",
        "human" : "Must have either extensions or value[x], not both",
        "expression" : "extension.exists() != value.exists()",
        "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
        "source" : "http://hl7.org/fhir/StructureDefinition/Extension"
      }],
      "isModifier" : false,
      "isSummary" : false,
      "mapping" : [{
        "identity" : "rim",
        "map" : "n/a"
      }]
    },
    {
      "id" : "OrderedDistribution.modifierExtension",
      "path" : "OrderedDistribution.modifierExtension",
      "short" : "Extensions that cannot be ignored even if unrecognized",
      "definition" : "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
      "comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
      "requirements" : "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored.  This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
      "alias" : ["extensions",
      "user content",
      "modifiers"],
      "min" : 0,
      "max" : "*",
      "base" : {
        "path" : "BackboneType.modifierExtension",
        "min" : 0,
        "max" : "*"
      },
      "type" : [{
        "code" : "Extension"
      }],
      "constraint" : [{
        "key" : "ele-1",
        "severity" : "error",
        "human" : "All FHIR elements must have a @value or children",
        "expression" : "hasValue() or (children().count() > id.count())",
        "xpath" : "@value|f:*|h:div",
        "source" : "http://hl7.org/fhir/StructureDefinition/Element"
      },
      {
        "key" : "ext-1",
        "severity" : "error",
        "human" : "Must have either extensions or value[x], not both",
        "expression" : "extension.exists() != value.exists()",
        "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
        "source" : "http://hl7.org/fhir/StructureDefinition/Extension"
      }],
      "isModifier" : true,
      "isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
      "isSummary" : true,
      "mapping" : [{
        "identity" : "rim",
        "map" : "N/A"
      }]
    },
    {
      "id" : "OrderedDistribution.description",
      "path" : "OrderedDistribution.description",
      "short" : "A description of the content and value of the statistic",
      "definition" : "A description of the content and value of the statistic.",
      "min" : 0,
      "max" : "1",
      "base" : {
        "path" : "OrderedDistribution.description",
        "min" : 0,
        "max" : "1"
      },
      "type" : [{
        "code" : "string"
      }],
      "constraint" : [{
        "key" : "ele-1",
        "severity" : "error",
        "human" : "All FHIR elements must have a @value or children",
        "expression" : "hasValue() or (children().count() > id.count())",
        "xpath" : "@value|f:*|h:div",
        "source" : "http://hl7.org/fhir/StructureDefinition/Element"
      }],
      "isModifier" : false,
      "isSummary" : false
    },
    {
      "id" : "OrderedDistribution.note",
      "path" : "OrderedDistribution.note",
      "short" : "Footnotes and/or explanatory notes",
      "definition" : "Footnotes and/or explanatory notes.",
      "min" : 0,
      "max" : "*",
      "base" : {
        "path" : "OrderedDistribution.note",
        "min" : 0,
        "max" : "*"
      },
      "type" : [{
        "code" : "Annotation"
      }],
      "constraint" : [{
        "key" : "ele-1",
        "severity" : "error",
        "human" : "All FHIR elements must have a @value or children",
        "expression" : "hasValue() or (children().count() > id.count())",
        "xpath" : "@value|f:*|h:div",
        "source" : "http://hl7.org/fhir/StructureDefinition/Element"
      }],
      "isModifier" : false,
      "isSummary" : false
    },
    {
      "id" : "OrderedDistribution.numberOfIntervals",
      "path" : "OrderedDistribution.numberOfIntervals",
      "short" : "Number of intervals in an array, eg 4 for quartiles",
      "definition" : "Number of intervals in an array, eg 4 for quartiles.",
      "min" : 1,
      "max" : "1",
      "base" : {
        "path" : "OrderedDistribution.numberOfIntervals",
        "min" : 1,
        "max" : "1"
      },
      "type" : [{
        "code" : "integer"
      }],
      "constraint" : [{
        "key" : "ele-1",
        "severity" : "error",
        "human" : "All FHIR elements must have a @value or children",
        "expression" : "hasValue() or (children().count() > id.count())",
        "xpath" : "@value|f:*|h:div",
        "source" : "http://hl7.org/fhir/StructureDefinition/Element"
      }],
      "isModifier" : false,
      "isSummary" : true
    },
    {
      "id" : "OrderedDistribution.bottomOfFirstInterval",
      "path" : "OrderedDistribution.bottomOfFirstInterval",
      "short" : "Bottom of first interval",
      "definition" : "Bottom of first interval.",
      "min" : 0,
      "max" : "1",
      "base" : {
        "path" : "OrderedDistribution.bottomOfFirstInterval",
        "min" : 0,
        "max" : "1"
      },
      "type" : [{
        "code" : "Quantity"
      }],
      "constraint" : [{
        "key" : "ele-1",
        "severity" : "error",
        "human" : "All FHIR elements must have a @value or children",
        "expression" : "hasValue() or (children().count() > id.count())",
        "xpath" : "@value|f:*|h:div",
        "source" : "http://hl7.org/fhir/StructureDefinition/Element"
      },
      {
        "key" : "odd-1",
        "severity" : "error",
        "human" : "If minimum is not empty, all instances of interval.maximum  must either be absent or > minimum..",
        "expression" : "true",
        "xpath" : "minimum",
        "source" : "http://hl7.org/fhir/StructureDefinition/OrderedDistribution"
      }],
      "isModifier" : false,
      "isSummary" : false
    },
    {
      "id" : "OrderedDistribution.interval",
      "path" : "OrderedDistribution.interval",
      "short" : "Interval",
      "definition" : "Interval.",
      "min" : 1,
      "max" : "*",
      "base" : {
        "path" : "OrderedDistribution.interval",
        "min" : 1,
        "max" : "*"
      },
      "type" : [{
        "code" : "Element"
      }],
      "constraint" : [{
        "key" : "ele-1",
        "severity" : "error",
        "human" : "All FHIR elements must have a @value or children",
        "expression" : "hasValue() or (children().count() > id.count())",
        "xpath" : "@value|f:*|h:div",
        "source" : "http://hl7.org/fhir/StructureDefinition/Element"
      },
      {
        "key" : "odd-2",
        "severity" : "error",
        "human" : "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.",
        "expression" : "true",
        "xpath" : "minimum",
        "source" : "http://hl7.org/fhir/StructureDefinition/OrderedDistribution"
      }],
      "isModifier" : false,
      "isSummary" : true
    },
    {
      "id" : "OrderedDistribution.interval.id",
      "path" : "OrderedDistribution.interval.id",
      "representation" : ["xmlAttr"],
      "short" : "Unique id for inter-element referencing",
      "definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
      "min" : 0,
      "max" : "1",
      "base" : {
        "path" : "Element.id",
        "min" : 0,
        "max" : "1"
      },
      "type" : [{
        "extension" : [{
          "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
          "valueUri" : "string"
        }],
        "code" : "http://hl7.org/fhirpath/System.String"
      }],
      "isModifier" : false,
      "isSummary" : false,
      "mapping" : [{
        "identity" : "rim",
        "map" : "n/a"
      }]
    },
    {
      "id" : "OrderedDistribution.interval.extension",
      "path" : "OrderedDistribution.interval.extension",
      "slicing" : {
        "discriminator" : [{
          "type" : "value",
          "path" : "url"
        }],
        "description" : "Extensions are always sliced by (at least) url",
        "rules" : "open"
      },
      "short" : "Additional content defined by implementations",
      "definition" : "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance  applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
      "comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
      "alias" : ["extensions",
      "user content"],
      "min" : 0,
      "max" : "*",
      "base" : {
        "path" : "Element.extension",
        "min" : 0,
        "max" : "*"
      },
      "type" : [{
        "code" : "Extension"
      }],
      "constraint" : [{
        "key" : "ele-1",
        "severity" : "error",
        "human" : "All FHIR elements must have a @value or children",
        "expression" : "hasValue() or (children().count() > id.count())",
        "xpath" : "@value|f:*|h:div",
        "source" : "http://hl7.org/fhir/StructureDefinition/Element"
      },
      {
        "key" : "ext-1",
        "severity" : "error",
        "human" : "Must have either extensions or value[x], not both",
        "expression" : "extension.exists() != value.exists()",
        "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
        "source" : "http://hl7.org/fhir/StructureDefinition/Extension"
      }],
      "isModifier" : false,
      "isSummary" : false,
      "mapping" : [{
        "identity" : "rim",
        "map" : "n/a"
      }]
    },
    {
      "id" : "OrderedDistribution.interval.rankOrder",
      "path" : "OrderedDistribution.interval.rankOrder",
      "short" : "Relative order of interval",
      "definition" : "Relative order of interval.",
      "min" : 1,
      "max" : "1",
      "base" : {
        "path" : "OrderedDistribution.interval.rankOrder",
        "min" : 1,
        "max" : "1"
      },
      "type" : [{
        "code" : "integer"
      }],
      "constraint" : [{
        "key" : "ele-1",
        "severity" : "error",
        "human" : "All FHIR elements must have a @value or children",
        "expression" : "hasValue() or (children().count() > id.count())",
        "xpath" : "@value|f:*|h:div",
        "source" : "http://hl7.org/fhir/StructureDefinition/Element"
      },
      {
        "key" : "odd-3",
        "severity" : "error",
        "human" : "Now two intervals in the same OrderedDistribution can have the same rankOrder",
        "expression" : "true",
        "xpath" : "minimum",
        "source" : "http://hl7.org/fhir/StructureDefinition/OrderedDistribution"
      },
      {
        "key" : "odd-5",
        "severity" : "error",
        "human" : "The rankOrder value SHALL be an integer from 1 to k where k is the value of numberOfIntervals",
        "expression" : "true",
        "xpath" : "minimum",
        "source" : "http://hl7.org/fhir/StructureDefinition/OrderedDistribution"
      }],
      "isModifier" : false,
      "isSummary" : true
    },
    {
      "id" : "OrderedDistribution.interval.intervalStatistic",
      "path" : "OrderedDistribution.interval.intervalStatistic",
      "short" : "Values and parameters for a single statistic related to the interval",
      "definition" : "Values and parameters for a single statistic related to the interval.",
      "min" : 0,
      "max" : "*",
      "base" : {
        "path" : "OrderedDistribution.interval.intervalStatistic",
        "min" : 0,
        "max" : "*"
      },
      "type" : [{
        "code" : "Statistic"
      }],
      "constraint" : [{
        "key" : "ele-1",
        "severity" : "error",
        "human" : "All FHIR elements must have a @value or children",
        "expression" : "hasValue() or (children().count() > id.count())",
        "xpath" : "@value|f:*|h:div",
        "source" : "http://hl7.org/fhir/StructureDefinition/Element"
      }],
      "isModifier" : false,
      "isSummary" : false
    },
    {
      "id" : "OrderedDistribution.topOfInterval",
      "path" : "OrderedDistribution.topOfInterval",
      "short" : "Singular value of the statistic at the upper bound of the interval",
      "definition" : "Singular value of the statistic at the upper bound of the interval.",
      "min" : 0,
      "max" : "1",
      "base" : {
        "path" : "OrderedDistribution.topOfInterval",
        "min" : 0,
        "max" : "1"
      },
      "type" : [{
        "code" : "Quantity"
      }],
      "constraint" : [{
        "key" : "ele-1",
        "severity" : "error",
        "human" : "All FHIR elements must have a @value or children",
        "expression" : "hasValue() or (children().count() > id.count())",
        "xpath" : "@value|f:*|h:div",
        "source" : "http://hl7.org/fhir/StructureDefinition/Element"
      }],
      "isModifier" : false,
      "isSummary" : false
    }]
  },
  "differential" : {
    "element" : [{
      "id" : "OrderedDistribution",
      "extension" : [{
        "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
        "valueCode" : "draft"
      }],
      "path" : "OrderedDistribution",
      "short" : "An ordered list (distribution) of statistics",
      "definition" : "An ordered list (distribution) of statistics.",
      "min" : 0,
      "max" : "*",
      "constraint" : [{
        "key" : "odd-4",
        "severity" : "error",
        "human" : "The cardinality of interval SHALL equal the value of numberOfIntervals",
        "expression" : "interval.count() = numberOfIntervals",
        "xpath" : "minimum",
        "source" : "http://hl7.org/fhir/StructureDefinition/OrderedDistribution"
      }]
    },
    {
      "id" : "OrderedDistribution.description",
      "path" : "OrderedDistribution.description",
      "short" : "A description of the content and value of the statistic",
      "definition" : "A description of the content and value of the statistic.",
      "min" : 0,
      "max" : "1",
      "type" : [{
        "code" : "string"
      }]
    },
    {
      "id" : "OrderedDistribution.note",
      "path" : "OrderedDistribution.note",
      "short" : "Footnotes and/or explanatory notes",
      "definition" : "Footnotes and/or explanatory notes.",
      "min" : 0,
      "max" : "*",
      "type" : [{
        "code" : "Annotation"
      }]
    },
    {
      "id" : "OrderedDistribution.numberOfIntervals",
      "path" : "OrderedDistribution.numberOfIntervals",
      "short" : "Number of intervals in an array, eg 4 for quartiles",
      "definition" : "Number of intervals in an array, eg 4 for quartiles.",
      "min" : 1,
      "max" : "1",
      "type" : [{
        "code" : "integer"
      }],
      "isSummary" : true
    },
    {
      "id" : "OrderedDistribution.bottomOfFirstInterval",
      "path" : "OrderedDistribution.bottomOfFirstInterval",
      "short" : "Bottom of first interval",
      "definition" : "Bottom of first interval.",
      "min" : 0,
      "max" : "1",
      "type" : [{
        "code" : "Quantity"
      }],
      "constraint" : [{
        "key" : "odd-1",
        "severity" : "error",
        "human" : "If minimum is not empty, all instances of interval.maximum  must either be absent or > minimum..",
        "expression" : "true",
        "xpath" : "minimum",
        "source" : "http://hl7.org/fhir/StructureDefinition/OrderedDistribution"
      }]
    },
    {
      "id" : "OrderedDistribution.interval",
      "path" : "OrderedDistribution.interval",
      "short" : "Interval",
      "definition" : "Interval.",
      "min" : 1,
      "max" : "*",
      "type" : [{
        "code" : "Element"
      }],
      "constraint" : [{
        "key" : "odd-2",
        "severity" : "error",
        "human" : "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.",
        "expression" : "true",
        "xpath" : "minimum",
        "source" : "http://hl7.org/fhir/StructureDefinition/OrderedDistribution"
      }],
      "isSummary" : true
    },
    {
      "id" : "OrderedDistribution.interval.rankOrder",
      "path" : "OrderedDistribution.interval.rankOrder",
      "short" : "Relative order of interval",
      "definition" : "Relative order of interval.",
      "min" : 1,
      "max" : "1",
      "type" : [{
        "code" : "integer"
      }],
      "constraint" : [{
        "key" : "odd-5",
        "severity" : "error",
        "human" : "The rankOrder value SHALL be an integer from 1 to k where k is the value of numberOfIntervals",
        "expression" : "true",
        "xpath" : "minimum",
        "source" : "http://hl7.org/fhir/StructureDefinition/OrderedDistribution"
      },
      {
        "key" : "odd-3",
        "severity" : "error",
        "human" : "Now two intervals in the same OrderedDistribution can have the same rankOrder",
        "expression" : "true",
        "xpath" : "minimum",
        "source" : "http://hl7.org/fhir/StructureDefinition/OrderedDistribution"
      }],
      "isSummary" : true
    },
    {
      "id" : "OrderedDistribution.interval.intervalStatistic",
      "path" : "OrderedDistribution.interval.intervalStatistic",
      "short" : "Values and parameters for a single statistic related to the interval",
      "definition" : "Values and parameters for a single statistic related to the interval.",
      "min" : 0,
      "max" : "*",
      "type" : [{
        "code" : "Statistic"
      }]
    },
    {
      "id" : "OrderedDistribution.topOfInterval",
      "path" : "OrderedDistribution.topOfInterval",
      "short" : "Singular value of the statistic at the upper bound of the interval",
      "definition" : "Singular value of the statistic at the upper bound of the interval.",
      "min" : 0,
      "max" : "1",
      "type" : [{
        "code" : "Quantity"
      }]
    }]
  }
}

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.