FHIR © HL7.org  |  Server Home  |  XIG Home  |  Server Source  |  FHIR  

FHIR IG Statistics: StructureDefinition/Ratio-uv-ips

Packagehl7.fhir.uv.ips
TypeStructureDefinition
IdRatio-uv-ips
FHIR VersionR4
Sourcehttp://hl7.org/fhir/uv/ips/https://build.fhir.org/ig/costateixeira/fhir-ips/StructureDefinition-Ratio-uv-ips.html
URLhttp://hl7.org/fhir/uv/ips/StructureDefinition/Ratio-uv-ips
Version2.0.0
Statusactive
Date2024-06-19T10:50:07-05:00
NameRatioIPS
TitleRatio (IPS)
Realmuv
Authorityhl7
DescriptionRatio data type, constrained to use UCUM as the code system for units.
PurposeAllow only UCUM as the code system for units.
TypeRatio
Kindcomplex-type

Resources that use this resource

StructureDefinition
Ratio-uv-labRatio (Uv Lab)
Medicamento-cl-ipsMedicamento
Observation-resultado-radiology-cl-ipsObservación Resultado: Imagenológico
Observation-results-radiology-uv-ipsObservation Results - Radiology (IPS)
Ratio-eu-labRatio (Eu Lab)
vn-core-dosageDosage profile - VN Core R4
vn-core-medication-administrationMedicationAdministration Profile - VN Core R4
vn-core-medicationMedication Profile - VN Core R4
vn-core-observation-lab-codeObservation - Laboratory Result Code Profile - VN Core R4
vn-core-observation-pathology-codeObservation - Pathology Result Code Profile - VN Core R4
vn-core-observation-radiology-codeObservation - Radiology Result Code Profile - VN Core R4
cyehr-sd-observationresultslaboratoryCyprus EHR Observation Results Laboratory profile
cyehr-sd-observationresultspathology-r4Cyprus EHR Observation Results Pathology profile
Medication-uv-ipsMedication (IPS)
Observation-results-laboratory-uv-ipsObservation Results: laboratory (IPS)
Observation-results-pathology-uv-ipsObservation Results: pathology (IPS)
Observation-results-radiology-uv-ipsObservation Results: radiology (IPS)

Resources that this resource uses

StructureDefinition
Quantity-uv-ipsQuantity (IPS)
Quantity-uv-ipsQuantity (IPS)

Narrative

Note: links and images are rebased to the (stated) source


Source

{
  "resourceType": "StructureDefinition",
  "id": "Ratio-uv-ips",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode": "pc"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger": 2,
      "_valueInteger": {
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical": "http://hl7.org/fhir/uv/ips/ImplementationGuide/hl7.fhir.uv.ips"
          }
        ]
      }
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
      "valueCode": "trial-use",
      "_valueCode": {
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical": "http://hl7.org/fhir/uv/ips/ImplementationGuide/hl7.fhir.uv.ips"
          }
        ]
      }
    }
  ],
  "url": "http://hl7.org/fhir/uv/ips/StructureDefinition/Ratio-uv-ips",
  "version": "2.0.0",
  "name": "RatioIPS",
  "title": "Ratio (IPS)",
  "status": "active",
  "date": "2024-06-19T10:50:07-05:00",
  "publisher": "HL7 International / Patient Care",
  "contact": [
    {
      "name": "HL7 International / Patient Care",
      "telecom": [
        {
          "system": "url",
          "value": "http://www.hl7.org/Special/committees/patientcare"
        }
      ]
    }
  ],
  "description": "Ratio data type, constrained to use UCUM as the code system for units.",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code": "001",
          "display": "World"
        }
      ]
    }
  ],
  "purpose": "Allow only UCUM as the code system for units.",
  "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": "Ratio",
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Ratio",
  "derivation": "constraint",
  "snapshot": {
    "extension": [
      {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
        "valueString": "4.0.1"
      }
    ],
    "element": [
      {
        "id": "Ratio",
        "path": "Ratio",
        "short": "A ratio of two Quantity values - a numerator and a denominator",
        "definition": "A relationship of two Quantity values - expressed as a numerator and a denominator.",
        "comment": "The Ratio datatype should only be used to express a relationship of two numbers if the relationship cannot be suitably expressed using a Quantity and a common unit.  Where the denominator value is known to be fixed to \"1\", Quantity should be used instead of Ratio.",
        "min": 0,
        "max": "*",
        "base": {
          "path": "Ratio",
          "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": "rat-1",
            "severity": "error",
            "human": "Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present",
            "expression": "(numerator.empty() xor denominator.exists()) and (numerator.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/Ratio"
          }
        ],
        "isModifier": false,
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          },
          {
            "identity": "v2",
            "map": "N/A"
          },
          {
            "identity": "rim",
            "map": "RTO"
          }
        ]
      },
      {
        "id": "Ratio.id",
        "path": "Ratio.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": "Ratio.extension",
        "path": "Ratio.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": "Ratio.numerator",
        "extension": [
          {
            "extension": [
              {
                "url": "code",
                "valueCode": "SHALL:populate-if-known"
              },
              {
                "url": "actor",
                "valueCanonical": "http://hl7.org/fhir/uv/ips/ActorDefinition/Producer"
              },
              {
                "url": "source",
                "valueUri": "http://hl7.org/fhir/uv/ips/StructureDefinition/Ratio-uv-ips|2.0.0"
              }
            ],
            "url": "http://hl7.org/fhir/StructureDefinition/obligation"
          },
          {
            "extension": [
              {
                "url": "code",
                "valueCode": "SHALL:handle"
              },
              {
                "url": "actor",
                "valueCanonical": "http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer"
              },
              {
                "url": "source",
                "valueUri": "http://hl7.org/fhir/uv/ips/StructureDefinition/Ratio-uv-ips|2.0.0"
              }
            ],
            "url": "http://hl7.org/fhir/StructureDefinition/obligation"
          },
          {
            "extension": [
              {
                "url": "code",
                "valueCode": "SHOULD:display"
              },
              {
                "url": "actor",
                "valueCanonical": "http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer"
              },
              {
                "url": "source",
                "valueUri": "http://hl7.org/fhir/uv/ips/StructureDefinition/Ratio-uv-ips|2.0.0"
              }
            ],
            "url": "http://hl7.org/fhir/StructureDefinition/obligation"
          }
        ],
        "path": "Ratio.numerator",
        "short": "Numerator value",
        "definition": "The value of the numerator.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "Ratio.numerator",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "Quantity",
            "profile": [
              "http://hl7.org/fhir/uv/ips/StructureDefinition/Quantity-uv-ips"
            ]
          }
        ],
        "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": "rim",
            "map": ".numerator"
          }
        ]
      },
      {
        "id": "Ratio.denominator",
        "extension": [
          {
            "extension": [
              {
                "url": "code",
                "valueCode": "SHALL:populate-if-known"
              },
              {
                "url": "actor",
                "valueCanonical": "http://hl7.org/fhir/uv/ips/ActorDefinition/Producer"
              },
              {
                "url": "source",
                "valueUri": "http://hl7.org/fhir/uv/ips/StructureDefinition/Ratio-uv-ips|2.0.0"
              }
            ],
            "url": "http://hl7.org/fhir/StructureDefinition/obligation"
          },
          {
            "extension": [
              {
                "url": "code",
                "valueCode": "SHALL:handle"
              },
              {
                "url": "actor",
                "valueCanonical": "http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer"
              },
              {
                "url": "source",
                "valueUri": "http://hl7.org/fhir/uv/ips/StructureDefinition/Ratio-uv-ips|2.0.0"
              }
            ],
            "url": "http://hl7.org/fhir/StructureDefinition/obligation"
          },
          {
            "extension": [
              {
                "url": "code",
                "valueCode": "SHOULD:display"
              },
              {
                "url": "actor",
                "valueCanonical": "http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer"
              },
              {
                "url": "source",
                "valueUri": "http://hl7.org/fhir/uv/ips/StructureDefinition/Ratio-uv-ips|2.0.0"
              }
            ],
            "url": "http://hl7.org/fhir/StructureDefinition/obligation"
          }
        ],
        "path": "Ratio.denominator",
        "short": "Denominator value",
        "definition": "The value of the denominator.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "Ratio.denominator",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "Quantity",
            "profile": [
              "http://hl7.org/fhir/uv/ips/StructureDefinition/Quantity-uv-ips"
            ]
          }
        ],
        "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": "rim",
            "map": ".denominator"
          }
        ]
      }
    ]
  },
  "differential": {
    "element": [
      {
        "id": "Ratio.numerator",
        "extension": [
          {
            "extension": [
              {
                "url": "code",
                "valueCode": "SHALL:populate-if-known"
              },
              {
                "url": "actor",
                "valueCanonical": "http://hl7.org/fhir/uv/ips/ActorDefinition/Producer"
              }
            ],
            "url": "http://hl7.org/fhir/StructureDefinition/obligation"
          },
          {
            "extension": [
              {
                "url": "code",
                "valueCode": "SHALL:handle"
              },
              {
                "url": "actor",
                "valueCanonical": "http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer"
              }
            ],
            "url": "http://hl7.org/fhir/StructureDefinition/obligation"
          },
          {
            "extension": [
              {
                "url": "code",
                "valueCode": "SHOULD:display"
              },
              {
                "url": "actor",
                "valueCanonical": "http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer"
              }
            ],
            "url": "http://hl7.org/fhir/StructureDefinition/obligation"
          }
        ],
        "path": "Ratio.numerator",
        "type": [
          {
            "code": "Quantity",
            "profile": [
              "http://hl7.org/fhir/uv/ips/StructureDefinition/Quantity-uv-ips"
            ]
          }
        ],
        "mustSupport": true
      },
      {
        "id": "Ratio.denominator",
        "extension": [
          {
            "extension": [
              {
                "url": "code",
                "valueCode": "SHALL:populate-if-known"
              },
              {
                "url": "actor",
                "valueCanonical": "http://hl7.org/fhir/uv/ips/ActorDefinition/Producer"
              }
            ],
            "url": "http://hl7.org/fhir/StructureDefinition/obligation"
          },
          {
            "extension": [
              {
                "url": "code",
                "valueCode": "SHALL:handle"
              },
              {
                "url": "actor",
                "valueCanonical": "http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer"
              }
            ],
            "url": "http://hl7.org/fhir/StructureDefinition/obligation"
          },
          {
            "extension": [
              {
                "url": "code",
                "valueCode": "SHOULD:display"
              },
              {
                "url": "actor",
                "valueCanonical": "http://hl7.org/fhir/uv/ips/ActorDefinition/Consumer"
              }
            ],
            "url": "http://hl7.org/fhir/StructureDefinition/obligation"
          }
        ],
        "path": "Ratio.denominator",
        "type": [
          {
            "code": "Quantity",
            "profile": [
              "http://hl7.org/fhir/uv/ips/StructureDefinition/Quantity-uv-ips"
            ]
          }
        ],
        "mustSupport": true
      }
    ]
  }
}