{
"description": "A ratio with defined units",
"_filename": "StructureDefinition-ch-emed-ratio-with-emed-units.json",
"package_name": "rs/ch.fhir.ig.ch",
"date": "2025-05-22T05:56:20+00:00",
"derivation": "constraint",
"publisher": "HL7 Switzerland",
"fhirVersion": "4.0.1",
"jurisdiction": [ {
"coding": [ {
"code": "CH",
"system": "urn:iso:std:iso:3166"
} ]
} ],
"name": "CHCoreRatioWithEmedUnits",
"mapping": [ {
"uri": "http://hl7.org/v2",
"name": "HL7 v2 Mapping",
"identity": "v2"
}, {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
} ],
"abstract": false,
"copyright": "CC0-1.0",
"type": "Ratio",
"experimental": null,
"resourceType": "StructureDefinition",
"title": "CH EMED Ratio with EMED Units",
"package_version": "core-6.0.0-ballot",
"snapshot": {
"element": [ {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "rat-1",
"human": "Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present",
"xpath": "(count(f:numerator) = count(f:denominator)) and ((count(f:numerator) > 0) or (count(f:extension) > 0))",
"source": "http://hl7.org/fhir/StructureDefinition/Ratio",
"severity": "error",
"expression": "(numerator.empty() xor denominator.exists()) and (numerator.exists() or extension.exists())"
} ],
"path": "Ratio",
"min": 0,
"definition": "A relationship of two Quantity values - expressed as a numerator and a denominator.",
"isModifier": false,
"short": "A ratio of two Quantity values - a numerator and a denominator",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "v2"
}, {
"map": "RTO",
"identity": "rim"
} ],
"max": "*",
"id": "Ratio",
"condition": [ "ele-1" ],
"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.",
"base": {
"max": "*",
"min": 0,
"path": "Ratio"
}
}, {
"path": "Ratio.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Ratio.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Ratio.extension",
"min": 0,
"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.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Ratio.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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Ratio.numerator",
"min": 1,
"definition": "The value of the numerator.",
"isModifier": false,
"short": "Numerator value",
"mapping": [ {
"map": ".numerator",
"identity": "rim"
} ],
"type": [ {
"code": "Quantity",
"profile": [ "http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-quantity-with-emed-units" ]
} ],
"max": "1",
"id": "Ratio.numerator",
"base": {
"max": "1",
"min": 0,
"path": "Ratio.numerator"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "Ratio.denominator",
"min": 1,
"definition": "The value of the denominator.",
"isModifier": false,
"short": "Denominator value",
"mapping": [ {
"map": ".denominator",
"identity": "rim"
} ],
"type": [ {
"code": "Quantity",
"profile": [ "http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-quantity-with-emed-units" ]
} ],
"max": "1",
"id": "Ratio.denominator",
"base": {
"max": "1",
"min": 0,
"path": "Ratio.denominator"
},
"isSummary": true
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString": "4.0.1"
} ]
},
"status": "active",
"id": "a45a39e5-34aa-48c7-8ae2-97b09be0a88b",
"kind": "complex-type",
"url": "http://fhir.ch/ig/ch-core/StructureDefinition/ch-emed-ratio-with-emed-units",
"version": "6.0.0-ballot",
"differential": {
"element": [ {
"id": "Ratio.numerator",
"min": 1,
"path": "Ratio.numerator",
"type": [ {
"code": "Quantity",
"profile": [ "http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-quantity-with-emed-units" ]
} ]
}, {
"id": "Ratio.denominator",
"min": 1,
"path": "Ratio.denominator",
"type": [ {
"code": "Quantity",
"profile": [ "http://fhir.ch/ig/ch-core/StructureDefinition/ch-core-quantity-with-emed-units" ]
} ]
} ]
},
"contact": [ {
"name": "HL7 Switzerland",
"telecom": [ {
"value": "https://www.hl7.ch/",
"system": "url"
} ]
}, {
"name": "HL7 Switzerland",
"telecom": [ {
"use": "work",
"value": "https://www.hl7.ch/",
"system": "url"
} ]
} ],
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Ratio"
}