Release 5 Draft Ballot

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions

Ratiorange.profile.json

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

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

StructureDefinition for RatioRange

{
  "resourceType" : "StructureDefinition",
  "id" : "RatioRange",
  "meta" : {
    "lastUpdated" : "2022-06-23T13:53:05.635+00:00"
  },
  "text" : {
    "status" : "generated",
    "div" : "<div>!-- Snipped for Brevity --></div>"
  },
  "extension" : [{
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
    "valueCode" : "trial-use"
  }],
  "url" : "http://hl7.org/fhir/StructureDefinition/RatioRange",
  "version" : "4.6.0",
  "name" : "RatioRange",
  "status" : "draft",
  "date" : "2022-06-23T13:53:05+00:00",
  "publisher" : "HL7 FHIR Standard",
  "contact" : [{
    "telecom" : [{
      "system" : "url",
      "value" : "http://hl7.org/fhir"
    }]
  }],
  "description" : "Base StructureDefinition for RatioRange Type: A range of ratios expressed as a low and high numerator and a denominator.",
  "purpose" : "Need to be able to specify ranges of ratios.",
  "fhirVersion" : "4.6.0",
  "mapping" : [{
    "identity" : "v2",
    "uri" : "http://hl7.org/v2",
    "name" : "HL7 v2 Mapping"
  },
  {
    "identity" : "rim",
    "uri" : "http://hl7.org/v3",
    "name" : "RIM Mapping"
  }],
  "kind" : "complex-type",
  "abstract" : false,
  "type" : "RatioRange",
  "baseDefinition" : "http://hl7.org/fhir/StructureDefinition/DataType",
  "derivation" : "specialization",
  "snapshot" : {
    "element" : [{
      "id" : "RatioRange",
      "extension" : [{
        "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
        "valueCode" : "trial-use"
      }],
      "path" : "RatioRange",
      "short" : "Range of ratio values",
      "definition" : "A range of ratios expressed as a low and high numerator and a denominator.",
      "comment" : "The stated low and high value are assumed to have arbitrarily high precision when it comes to determining which values are in the range. I.e. 1.99 is not in the range 2 -> 3.",
      "min" : 0,
      "max" : "*",
      "base" : {
        "path" : "RatioRange",
        "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" : "inv-1",
        "severity" : "error",
        "human" : "One of lowNumerator or highNumerator and denominator SHALL be present, or all are absent. If all are absent, there SHALL be some extension present",
        "expression" : "((lowNumerator.empty() and highNumerator.empty()) xor denominator.exists()) and (lowNumerator.exists() or extension.exists())",
        "xpath" : "(count(f:numerator) = count(f:denominator)) and ((count(f:numerator) > 0) or (count(f:extension) > 0))",
        "source" : "http://hl7.org/fhir/StructureDefinition/RatioRange"
      },
      {
        "key" : "inv-2",
        "severity" : "error",
        "human" : "If present, lowNumerator SHALL have a lower value than highNumerator",
        "expression" : "lowNumerator.empty() or highNumerator.empty() or (lowNumerator <= highNumerator)",
        "xpath" : "not(exists(f:lowNumerator/f:value/@value)) or not(exists(f:highNumerator/f:value/@value)) or (number(f:lowNumerator/f:value/@value) <= number(f:highNumerator/f:value/@value))",
        "source" : "http://hl7.org/fhir/StructureDefinition/RatioRange"
      }],
      "isModifier" : false,
      "mapping" : [{
        "identity" : "rim",
        "map" : "n/a"
      },
      {
        "identity" : "v2",
        "map" : "NR and also possibly SN (but see also quantity)"
      },
      {
        "identity" : "rim",
        "map" : "IVL<RTO<QTY[not(type=\"TS\")]>> [lowClosed=\"true\" and highClosed=\"true\"]or URG<<RTO<QTY[not(type=\"TS\")]>>"
      }]
    },
    {
      "id" : "RatioRange.id",
      "path" : "RatioRange.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",
          "valueUrl" : "string"
        }],
        "code" : "http://hl7.org/fhirpath/System.String"
      }],
      "isModifier" : false,
      "isSummary" : false,
      "mapping" : [{
        "identity" : "rim",
        "map" : "n/a"
      }]
    },
    {
      "id" : "RatioRange.extension",
      "path" : "RatioRange.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" : "RatioRange.lowNumerator",
      "path" : "RatioRange.lowNumerator",
      "short" : "Low Numerator limit",
      "definition" : "The value of the low limit numerator.",
      "comment" : "If the low element is missing, the low boundary is not known.",
      "min" : 0,
      "max" : "1",
      "base" : {
        "path" : "RatioRange.lowNumerator",
        "min" : 0,
        "max" : "1"
      },
      "type" : [{
        "code" : "Quantity",
        "profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
      }],
      "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,
      "mapping" : [{
        "identity" : "v2",
        "map" : "NR.1"
      },
      {
        "identity" : "rim",
        "map" : "./low"
      }]
    },
    {
      "id" : "RatioRange.highNumerator",
      "path" : "RatioRange.highNumerator",
      "short" : "High Numerator limit",
      "definition" : "The value of the high limit numerator.",
      "comment" : "If the high element is missing, the high boundary is not known.",
      "min" : 0,
      "max" : "1",
      "base" : {
        "path" : "RatioRange.highNumerator",
        "min" : 0,
        "max" : "1"
      },
      "type" : [{
        "code" : "Quantity",
        "profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
      }],
      "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,
      "mapping" : [{
        "identity" : "v2",
        "map" : "NR.2"
      },
      {
        "identity" : "rim",
        "map" : "./high"
      }]
    },
    {
      "id" : "RatioRange.denominator",
      "path" : "RatioRange.denominator",
      "short" : "Denominator value",
      "definition" : "The value of the denominator.",
      "min" : 0,
      "max" : "1",
      "base" : {
        "path" : "RatioRange.denominator",
        "min" : 0,
        "max" : "1"
      },
      "type" : [{
        "code" : "Quantity",
        "profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
      }],
      "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
    }]
  },
  "differential" : {
    "element" : [{
      "id" : "RatioRange",
      "extension" : [{
        "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
        "valueCode" : "trial-use"
      }],
      "path" : "RatioRange",
      "short" : "Range of ratio values",
      "definition" : "A range of ratios expressed as a low and high numerator and a denominator.",
      "comment" : "The stated low and high value are assumed to have arbitrarily high precision when it comes to determining which values are in the range. I.e. 1.99 is not in the range 2 -> 3.",
      "min" : 0,
      "max" : "*",
      "constraint" : [{
        "key" : "inv-2",
        "severity" : "error",
        "human" : "If present, lowNumerator SHALL have a lower value than highNumerator",
        "expression" : "lowNumerator.empty() or highNumerator.empty() or (lowNumerator <= highNumerator)",
        "xpath" : "not(exists(f:lowNumerator/f:value/@value)) or not(exists(f:highNumerator/f:value/@value)) or (number(f:lowNumerator/f:value/@value) <= number(f:highNumerator/f:value/@value))",
        "source" : "http://hl7.org/fhir/StructureDefinition/RatioRange"
      },
      {
        "key" : "inv-1",
        "severity" : "error",
        "human" : "One of lowNumerator or highNumerator and denominator SHALL be present, or all are absent. If all are absent, there SHALL be some extension present",
        "expression" : "((lowNumerator.empty() and highNumerator.empty()) xor denominator.exists()) and (lowNumerator.exists() or extension.exists())",
        "xpath" : "(count(f:numerator) = count(f:denominator)) and ((count(f:numerator) > 0) or (count(f:extension) > 0))",
        "source" : "http://hl7.org/fhir/StructureDefinition/RatioRange"
      }],
      "mapping" : [{
        "identity" : "v2",
        "map" : "NR and also possibly SN (but see also quantity)"
      },
      {
        "identity" : "rim",
        "map" : "IVL<RTO<QTY[not(type=\"TS\")]>> [lowClosed=\"true\" and highClosed=\"true\"]or URG<<RTO<QTY[not(type=\"TS\")]>>"
      }]
    },
    {
      "id" : "RatioRange.lowNumerator",
      "path" : "RatioRange.lowNumerator",
      "short" : "Low Numerator limit",
      "definition" : "The value of the low limit numerator.",
      "comment" : "If the low element is missing, the low boundary is not known.",
      "min" : 0,
      "max" : "1",
      "type" : [{
        "code" : "Quantity",
        "profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
      }],
      "isSummary" : true,
      "mapping" : [{
        "identity" : "v2",
        "map" : "NR.1"
      },
      {
        "identity" : "rim",
        "map" : "./low"
      }]
    },
    {
      "id" : "RatioRange.highNumerator",
      "path" : "RatioRange.highNumerator",
      "short" : "High Numerator limit",
      "definition" : "The value of the high limit numerator.",
      "comment" : "If the high element is missing, the high boundary is not known.",
      "min" : 0,
      "max" : "1",
      "type" : [{
        "code" : "Quantity",
        "profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
      }],
      "isSummary" : true,
      "mapping" : [{
        "identity" : "v2",
        "map" : "NR.2"
      },
      {
        "identity" : "rim",
        "map" : "./high"
      }]
    },
    {
      "id" : "RatioRange.denominator",
      "path" : "RatioRange.denominator",
      "short" : "Denominator value",
      "definition" : "The value of the denominator.",
      "min" : 0,
      "max" : "1",
      "type" : [{
        "code" : "Quantity",
        "profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"]
      }],
      "isSummary" : true
    }]
  }
}

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.