Data Management with FHIR
0.1.0 - ci-build

Data Management with FHIR - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

## Data Type Profile: FrSimpleQuantityUcum - JSON Profile

Draft as of 2025-10-23

JSON representation of the FrSimpleQuantityUcum data type profile.

Raw json | Download

    {
      "resourceType" : "StructureDefinition",
      "id" : "FrSimpleQuantityUcum",
      "text" : {
        "status" : "extensions",
        "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Narratif généré : DéfinitionStructure FrSimpleQuantityUcum</b></p><a name=\"FrSimpleQuantityUcum\"> </a><a name=\"hcFrSimpleQuantityUcum\"> </a><table border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"border: 0px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top;\"><tr style=\"border: 1px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top\"><th style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom: 3px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Le nom logique de lélément\">Nom</a></th><th style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom: 3px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Information about the use of the element\">Drapeaux</a></th><th style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom: 3px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Minimum and Maximum # of times the element can appear in the instance\">Card.</a></th><th style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom: 3px; width: 100px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Reference to the type of the element\">Type</a></th><th style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom: 3px\" class=\"hierarchy\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Additional information about the element\">Description et contraintes</a><span style=\"float: right\"><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Legend for this format\"><img src=\"data:image/png;base64, \" alt=\"doco\" style=\"background-color: inherit\"/></a></span></th></tr><tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white\"><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck1.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_element.gif\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-FrSimpleQuantityUcum-definitions.html#Quantity\" title=\"The comparator is not used on a SimpleQuantity. The unit SHALL be a UCUM code.\">Quantity</a><a name=\"Quantity\"> </a></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"/><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"opacity: 0.5\">0</span><span style=\"opacity: 0.5\">..</span><span style=\"opacity: 0.5\">*</span></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a href=\"http://hl7.org/fhir/R4/datatypes.html#SimpleQuantity\">SimpleQuantity</a></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">A fixed quantity (no comparator) with UCUM unit</td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7\"><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_element.gif\" alt=\".\" style=\"background-color: #F7F7F7; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-FrSimpleQuantityUcum-definitions.html#Quantity.system\" title=\"UCUM requiered for the identification of the system that provides the coded form of the unit.\">system</a><a name=\"Quantity.system\"> </a></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"padding-left: 3px; padding-right: 3px; color: white; background-color: red\" title=\"This element must be supported\">S</span></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">1..<span style=\"opacity: 0.5\">1</span></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a style=\"opacity: 0.5; opacity: 0.5\" href=\"http://hl7.org/fhir/R4/datatypes.html#uri\">uri</a></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"opacity: 0.5\">System that defines coded unit form</span><br/><span style=\"font-weight:bold\">Fixed Value: </span><span style=\"color: darkgreen\">http://unitsofmeasure.org</span></td></tr>\r\n<tr style=\"border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white\"><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck00.png)\" class=\"hierarchy\"><img src=\"tbl_spacer.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"tbl_vjoin_end.png\" alt=\".\" style=\"background-color: inherit\" class=\"hierarchy\"/><img src=\"icon_element.gif\" alt=\".\" style=\"background-color: white; background-color: inherit\" title=\"Element\" class=\"hierarchy\"/> <a href=\"StructureDefinition-FrSimpleQuantityUcum-definitions.html#Quantity.code\">code</a><a name=\"Quantity.code\"> </a></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"padding-left: 3px; padding-right: 3px; color: white; background-color: red\" title=\"This element must be supported\">S</span></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\">1..<span style=\"opacity: 0.5\">1</span></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><a style=\"opacity: 0.5; opacity: 0.5\" href=\"http://hl7.org/fhir/R4/datatypes.html#code\">code</a></td><td style=\"vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px\" class=\"hierarchy\"><span style=\"opacity: 0.5\">Coded form of the unit</span></td></tr>\r\n<tr><td colspan=\"5\" class=\"hierarchy\"><br/><a href=\"https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views\" title=\"Legend for this format\"><img src=\"data:image/png;base64, \" alt=\"doco\" style=\"background-color: inherit\"/> Documentation for this format</a></td></tr></table></div>"
      },
      "url" : "https://interop.aphp.fr/ig/fhir/dm/StructureDefinition/FrSimpleQuantityUcum",
      "version" : "0.1.0",
      "name" : "FrSimpleQuantityUcum",
      "title" : "SimpleQuantity with UCUM quantity unit",
      "status" : "draft",
      "date" : "2025-10-23T20:49:03+00:00",
      "publisher" : "AP-HP",
      "contact" : [
        {
          "name" : "AP-HP",
          "telecom" : [
            {
              "system" : "url",
              "value" : "https://aphp.fr"
            }
          ]
        }
      ],
      "description" : "simple quantity datatype requiring a UCUM unit",
      "jurisdiction" : [
        {
          "coding" : [
            {
              "system" : "urn:iso:std:iso:3166",
              "code" : "FR",
              "display" : "France"
            }
          ]
        }
      ],
      "fhirVersion" : "4.0.1",
      "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" : "Quantity",
      "baseDefinition" : "http://hl7.org/fhir/StructureDefinition/SimpleQuantity",
      "derivation" : "constraint",
      "snapshot" : {
        "extension" : [
          {
            "url" : "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
            "valueString" : "4.0.1"
          }
        ],
        "element" : [
          {
            "id" : "Quantity",
            "path" : "Quantity",
            "short" : "A fixed quantity (no comparator) with UCUM unit",
            "definition" : "The comparator is not used on a SimpleQuantity. The unit SHALL be a UCUM code.",
            "comment" : "The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use explicitely excludes the use of the simpleQuantity \"comparator\" element.",
            "min" : 0,
            "max" : "*",
            "base" : {
              "path" : "Quantity",
              "min" : 0,
              "max" : "*"
            },
            "condition" : [
              "ele-1"
            ],
            "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" : "qty-3",
                "severity" : "error",
                "human" : "If a code for the unit is present, the system SHALL also be present",
                "expression" : "code.empty() or system.exists()",
                "xpath" : "not(exists(f:code)) or exists(f:system)",
                "source" : "http://hl7.org/fhir/StructureDefinition/Quantity"
              },
              {
                "key" : "sqty-1",
                "severity" : "error",
                "human" : "The comparator is not used on a SimpleQuantity",
                "expression" : "comparator.empty()",
                "xpath" : "not(exists(f:comparator))",
                "source" : "http://hl7.org/fhir/StructureDefinition/SimpleQuantity"
              }
            ],
            "isModifier" : false,
            "mapping" : [
              {
                "identity" : "rim",
                "map" : "n/a"
              },
              {
                "identity" : "v2",
                "map" : "SN (see also Range) or CQ"
              },
              {
                "identity" : "rim",
                "map" : "PQ, IVL<PQ>, MO, CO, depending on the values"
              }
            ]
          },
          {
            "id" : "Quantity.id",
            "path" : "Quantity.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" : "Quantity.extension",
            "path" : "Quantity.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" : "Quantity.value",
            "path" : "Quantity.value",
            "short" : "Numerical value (with implicit precision)",
            "definition" : "The value of the measured amount. The value includes an implicit precision in the presentation of the value.",
            "comment" : "The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).",
            "requirements" : "Precision is handled implicitly in almost all cases of measurement.",
            "min" : 0,
            "max" : "1",
            "base" : {
              "path" : "Quantity.value",
              "min" : 0,
              "max" : "1"
            },
            "type" : [
              {
                "code" : "decimal"
              }
            ],
            "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" : "SN.2  / CQ - N/A"
              },
              {
                "identity" : "rim",
                "map" : "PQ.value, CO.value, MO.value, IVL.high or IVL.low depending on the value"
              }
            ]
          },
          {
            "id" : "Quantity.comparator",
            "path" : "Quantity.comparator",
            "short" : "< | <= | >= | > - how to understand the value",
            "definition" : "Not allowed to be used in this context",
            "requirements" : "Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.",
            "min" : 0,
            "max" : "0",
            "base" : {
              "path" : "Quantity.comparator",
              "min" : 0,
              "max" : "1"
            },
            "type" : [
              {
                "code" : "code"
              }
            ],
            "meaningWhenMissing" : "If there is no comparator, then there is no modification of the value",
            "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" : true,
            "isModifierReason" : "This is labeled as \"Is Modifier\" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value",
            "isSummary" : true,
            "binding" : {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
                  "valueString" : "QuantityComparator"
                }
              ],
              "strength" : "required",
              "description" : "How the Quantity should be understood and represented.",
              "valueSet" : "http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1"
            },
            "mapping" : [
              {
                "identity" : "v2",
                "map" : "SN.1  / CQ.1"
              },
              {
                "identity" : "rim",
                "map" : "IVL properties"
              }
            ]
          },
          {
            "id" : "Quantity.unit",
            "extension" : [
              {
                "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
                "valueBoolean" : true
              }
            ],
            "path" : "Quantity.unit",
            "short" : "Unit representation",
            "definition" : "A human-readable form of the unit.",
            "requirements" : "There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.",
            "min" : 0,
            "max" : "1",
            "base" : {
              "path" : "Quantity.unit",
              "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" : true,
            "mapping" : [
              {
                "identity" : "v2",
                "map" : "(see OBX.6 etc.) / CQ.2"
              },
              {
                "identity" : "rim",
                "map" : "PQ.unit"
              }
            ]
          },
          {
            "id" : "Quantity.system",
            "path" : "Quantity.system",
            "short" : "System that defines coded unit form",
            "definition" : "UCUM requiered for the identification of the system that provides the coded form of the unit.",
            "requirements" : "UCUM requiered.",
            "min" : 1,
            "max" : "1",
            "base" : {
              "path" : "Quantity.system",
              "min" : 0,
              "max" : "1"
            },
            "type" : [
              {
                "code" : "uri"
              }
            ],
            "fixedUri" : "http://unitsofmeasure.org",
            "condition" : [
              "qty-3"
            ],
            "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"
              }
            ],
            "mustSupport" : true,
            "isModifier" : false,
            "isSummary" : true,
            "mapping" : [
              {
                "identity" : "v2",
                "map" : "(see OBX.6 etc.) / CQ.2"
              },
              {
                "identity" : "rim",
                "map" : "CO.codeSystem, PQ.translation.codeSystem"
              }
            ]
          },
          {
            "id" : "Quantity.code",
            "path" : "Quantity.code",
            "short" : "Coded form of the unit",
            "definition" : "A computer processable form of the unit in some unit representation system.",
            "comment" : "UCUM code required.",
            "requirements" : "Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.",
            "min" : 1,
            "max" : "1",
            "base" : {
              "path" : "Quantity.code",
              "min" : 0,
              "max" : "1"
            },
            "type" : [
              {
                "code" : "code"
              }
            ],
            "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"
              }
            ],
            "mustSupport" : true,
            "isModifier" : false,
            "isSummary" : true,
            "mapping" : [
              {
                "identity" : "v2",
                "map" : "(see OBX.6 etc.) / CQ.2"
              },
              {
                "identity" : "rim",
                "map" : "PQ.code, MO.currency, PQ.translation.code"
              }
            ]
          }
        ]
      },
      "differential" : {
        "element" : [
          {
            "id" : "Quantity",
            "path" : "Quantity",
            "short" : "A fixed quantity (no comparator) with UCUM unit",
            "definition" : "The comparator is not used on a SimpleQuantity. The unit SHALL be a UCUM code.",
            "comment" : "The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use explicitely excludes the use of the simpleQuantity \"comparator\" element."
          },
          {
            "id" : "Quantity.system",
            "path" : "Quantity.system",
            "definition" : "UCUM requiered for the identification of the system that provides the coded form of the unit.",
            "requirements" : "UCUM requiered.",
            "min" : 1,
            "fixedUri" : "http://unitsofmeasure.org",
            "mustSupport" : true
          },
          {
            "id" : "Quantity.code",
            "path" : "Quantity.code",
            "comment" : "UCUM code required.",
            "min" : 1,
            "mustSupport" : true
          }
        ]
      }
    }