This page is part of the FHIR Specification (v4.3.0: R4B - STU). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4
Modeling and Methodology Work Group | Maturity Level: N/A | Standards Status: Informative |
Raw Turtle (+ also see Turtle/RDF Format Specification)
StructureDefinition for Ratio
@prefix fhir: <http://hl7.org/fhir/> . @prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> . # - resource ------------------------------------------------------------------- [] a fhir:StructureDefinition; fhir:Resource.id [ fhir:value "Ratio"]; fhir:DomainResource.text [ fhir:Narrative.status [ fhir:value "generated" ] ]; fhir:DomainResource.extension [ fhir:index 0; fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status" ]; fhir:Extension.value [ fhir:value "normative" ] ], [ fhir:index 1; fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version" ]; fhir:Extension.value [ fhir:value "4.0.0" ] ]; fhir:StructureDefinition.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/Ratio"]; fhir:StructureDefinition.version [ fhir:value "4.3.0"]; fhir:StructureDefinition.name [ fhir:value "Ratio"]; fhir:StructureDefinition.status [ fhir:value "active"]; fhir:StructureDefinition.experimental [ fhir:value "false"]; fhir:StructureDefinition.date [ fhir:value "2022-05-28T12:47:40+10:00"]; fhir:StructureDefinition.publisher [ fhir:value "HL7 FHIR Standard"]; fhir:StructureDefinition.contact [ fhir:index 0; fhir:ContactDetail.telecom [ fhir:index 0; fhir:ContactPoint.system [ fhir:value "url" ]; fhir:ContactPoint.value [ fhir:value "http://hl7.org/fhir" ] ] ]; fhir:StructureDefinition.description [ fhir:value "Base StructureDefinition for Ratio Type: A relationship of two Quantity values - expressed as a numerator and a denominator."]; fhir:StructureDefinition.purpose [ fhir:value "Need to able to capture ratios for some measurements (titers) and some rates (costs)."]; fhir:StructureDefinition.fhirVersion [ fhir:value "4.3.0"]; fhir:StructureDefinition.mapping [ fhir:index 0; fhir:StructureDefinition.identity [ fhir:value "v2" ]; fhir:StructureDefinition.uri [ fhir:value "http://hl7.org/v2" ]; fhir:StructureDefinition.name [ fhir:value "HL7 v2 Mapping" ] ], [ fhir:index 1; fhir:StructureDefinition.identity [ fhir:value "rim" ]; fhir:StructureDefinition.uri [ fhir:value "http://hl7.org/v3" ]; fhir:StructureDefinition.name [ fhir:value "RIM Mapping" ] ]; fhir:StructureDefinition.kind [ fhir:value "complex-type"]; fhir:StructureDefinition.abstract [ fhir:value "false"]; fhir:StructureDefinition.type [ fhir:value "Ratio"]; fhir:StructureDefinition.baseDefinition [ fhir:value "http://hl7.org/fhir/StructureDefinition/Element"]; fhir:StructureDefinition.derivation [ fhir:value "specialization"]; fhir:StructureDefinition.snapshot [ fhir:StructureDefinition.element [ fhir:index 0; fhir:Element.id [ fhir:value "Ratio" ]; fhir:Element.extension [ fhir:index 0; fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status" ]; fhir:Extension.value [ fhir:value "normative" ] ], [ fhir:index 1; fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version" ]; fhir:Extension.value [ fhir:value "4.0.0" ] ]; fhir:ElementDefinition.path [ fhir:value "Ratio" ]; fhir:ElementDefinition.short [ fhir:value "A ratio of two Quantity values - a numerator and a denominator" ]; fhir:ElementDefinition.definition [ fhir:value "A relationship of two Quantity values - expressed as a numerator and a denominator." ]; fhir:ElementDefinition.comment [ fhir:value "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." ]; fhir:ElementDefinition.min [ fhir:value "0" ]; fhir:ElementDefinition.max [ fhir:value "*" ]; fhir:ElementDefinition.base [ fhir:ElementDefinition.path [ fhir:value "Ratio" ]; fhir:ElementDefinition.min [ fhir:value "0" ]; fhir:ElementDefinition.max [ fhir:value "*" ] ]; fhir:ElementDefinition.condition [ fhir:value "ele-1"; fhir:index 0 ]; fhir:ElementDefinition.constraint [ fhir:index 0; fhir:ElementDefinition.key [ fhir:value "ele-1" ]; fhir:ElementDefinition.severity [ fhir:value "error" ]; fhir:ElementDefinition.human [ fhir:value "All FHIR elements must have a @value or children unless an empty Parameters resource" ]; fhir:ElementDefinition.expression [ fhir:value "hasValue() or (children().count() > id.count()) or $this is Parameters" ]; fhir:ElementDefinition.xpath [ fhir:value "@value|f:*|h:div|self::f:Parameters" ]; fhir:ElementDefinition.source [ fhir:value "http://hl7.org/fhir/StructureDefinition/Element" ] ], [ fhir:index 1; fhir:ElementDefinition.key [ fhir:value "rat-1" ]; fhir:ElementDefinition.severity [ fhir:value "error" ]; fhir:ElementDefinition.human [ fhir:value "Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present" ]; fhir:ElementDefinition.expression [ fhir:value "(numerator.exists() and denominator.exists()) or (numerator.empty() and denominator.empty() and extension.exists())" ]; fhir:ElementDefinition.xpath [ fhir:value "(count(f:numerator) = count(f:denominator)) and ((count(f:numerator) > 0) or (count(f:extension) > 0))" ]; fhir:ElementDefinition.source [ fhir:value "http://hl7.org/fhir/StructureDefinition/Ratio" ] ]; fhir:ElementDefinition.isModifier [ fhir:value "false" ]; fhir:ElementDefinition.mapping [ fhir:index 0; fhir:ElementDefinition.identity [ fhir:value "rim" ]; fhir:ElementDefinition.map [ fhir:value "n/a" ] ], [ fhir:index 1; fhir:ElementDefinition.identity [ fhir:value "v2" ]; fhir:ElementDefinition.map [ fhir:value "N/A" ] ], [ fhir:index 2; fhir:ElementDefinition.identity [ fhir:value "rim" ]; fhir:ElementDefinition.map [ fhir:value "RTO" ] ] ], [ fhir:index 1; fhir:Element.id [ fhir:value "Ratio.id" ]; fhir:ElementDefinition.path [ fhir:value "Ratio.id" ]; fhir:ElementDefinition.representation [ fhir:value "xmlAttr"; fhir:index 0 ]; fhir:ElementDefinition.short [ fhir:value "Unique id for inter-element referencing" ]; fhir:ElementDefinition.definition [ fhir:value "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." ]; fhir:ElementDefinition.min [ fhir:value "0" ]; fhir:ElementDefinition.max [ fhir:value "1" ]; fhir:ElementDefinition.base [ fhir:ElementDefinition.path [ fhir:value "Element.id" ]; fhir:ElementDefinition.min [ fhir:value "0" ]; fhir:ElementDefinition.max [ fhir:value "1" ] ]; fhir:ElementDefinition.type [ fhir:index 0; fhir:Element.extension [ fhir:index 0; fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type" ]; fhir:Extension.value [ fhir:value "id" ] ]; fhir:ElementDefinition.code [ fhir:value "http://hl7.org/fhirpath/System.String" ] ]; fhir:ElementDefinition.isModifier [ fhir:value "false" ]; fhir:ElementDefinition.isSummary [ fhir:value "false" ]; fhir:ElementDefinition.mapping [ fhir:index 0; fhir:ElementDefinition.identity [ fhir:value "rim" ]; fhir:ElementDefinition.map [ fhir:value "n/a" ] ] ], [ fhir:index 2; fhir:Element.id [ fhir:value "Ratio.extension" ]; fhir:ElementDefinition.path [ fhir:value "Ratio.extension" ]; fhir:ElementDefinition.slicing [ fhir:ElementDefinition.discriminator [ fhir:index 0; fhir:ElementDefinition.type [ fhir:value "value" ]; fhir:ElementDefinition.path [ fhir:value "url" ] ]; fhir:ElementDefinition.description [ fhir:value "Extensions are always sliced by (at least) url" ]; fhir:ElementDefinition.rules [ fhir:value "open" ] ]; fhir:ElementDefinition.short [ fhir:value "Additional content defined by implementations" ]; fhir:ElementDefinition.definition [ fhir:value "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." ]; fhir:ElementDefinition.comment [ fhir:value "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." ]; fhir:ElementDefinition.alias [ fhir:value "extensions"; fhir:index 0 ], [ fhir:value "user content"; fhir:index 1 ]; fhir:ElementDefinition.min [ fhir:value "0" ]; fhir:ElementDefinition.max [ fhir:value "*" ]; fhir:ElementDefinition.base [ fhir:ElementDefinition.path [ fhir:value "Element.extension" ]; fhir:ElementDefinition.min [ fhir:value "0" ]; fhir:ElementDefinition.max [ fhir:value "*" ] ]; fhir:ElementDefinition.type [ fhir:index 0; fhir:ElementDefinition.code [ fhir:value "Extension" ] ]; fhir:ElementDefinition.constraint [ fhir:index 0; fhir:ElementDefinition.key [ fhir:value "ele-1" ]; fhir:ElementDefinition.severity [ fhir:value "error" ]; fhir:ElementDefinition.human [ fhir:value "All FHIR elements must have a @value or children" ]; fhir:ElementDefinition.expression [ fhir:value "hasValue() or (children().count() > id.count())" ]; fhir:ElementDefinition.xpath [ fhir:value "@value|f:*|h:div" ]; fhir:ElementDefinition.source [ fhir:value "http://hl7.org/fhir/StructureDefinition/Element" ] ], [ fhir:index 1; fhir:ElementDefinition.key [ fhir:value "ext-1" ]; fhir:ElementDefinition.severity [ fhir:value "error" ]; fhir:ElementDefinition.human [ fhir:value "Must have either extensions or value[x], not both" ]; fhir:ElementDefinition.expression [ fhir:value "extension.exists() != value.exists()" ]; fhir:ElementDefinition.xpath [ fhir:value "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])" ]; fhir:ElementDefinition.source [ fhir:value "http://hl7.org/fhir/StructureDefinition/Extension" ] ]; fhir:ElementDefinition.isModifier [ fhir:value "false" ]; fhir:ElementDefinition.isSummary [ fhir:value "false" ]; fhir:ElementDefinition.mapping [ fhir:index 0; fhir:ElementDefinition.identity [ fhir:value "rim" ]; fhir:ElementDefinition.map [ fhir:value "n/a" ] ] ], [ fhir:index 3; fhir:Element.id [ fhir:value "Ratio.numerator" ]; fhir:ElementDefinition.path [ fhir:value "Ratio.numerator" ]; fhir:ElementDefinition.short [ fhir:value "Numerator value" ]; fhir:ElementDefinition.definition [ fhir:value "The value of the numerator." ]; fhir:ElementDefinition.min [ fhir:value "0" ]; fhir:ElementDefinition.max [ fhir:value "1" ]; fhir:ElementDefinition.base [ fhir:ElementDefinition.path [ fhir:value "Ratio.numerator" ]; fhir:ElementDefinition.min [ fhir:value "0" ]; fhir:ElementDefinition.max [ fhir:value "1" ] ]; fhir:ElementDefinition.type [ fhir:index 0; fhir:ElementDefinition.code [ fhir:value "Quantity" ] ]; fhir:ElementDefinition.constraint [ fhir:index 0; fhir:ElementDefinition.key [ fhir:value "ele-1" ]; fhir:ElementDefinition.severity [ fhir:value "error" ]; fhir:ElementDefinition.human [ fhir:value "All FHIR elements must have a @value or children" ]; fhir:ElementDefinition.expression [ fhir:value "hasValue() or (children().count() > id.count())" ]; fhir:ElementDefinition.xpath [ fhir:value "@value|f:*|h:div" ]; fhir:ElementDefinition.source [ fhir:value "http://hl7.org/fhir/StructureDefinition/Element" ] ]; fhir:ElementDefinition.isModifier [ fhir:value "false" ]; fhir:ElementDefinition.isSummary [ fhir:value "true" ]; fhir:ElementDefinition.mapping [ fhir:index 0; fhir:ElementDefinition.identity [ fhir:value "rim" ]; fhir:ElementDefinition.map [ fhir:value ".numerator" ] ] ], [ fhir:index 4; fhir:Element.id [ fhir:value "Ratio.denominator" ]; fhir:ElementDefinition.path [ fhir:value "Ratio.denominator" ]; fhir:ElementDefinition.short [ fhir:value "Denominator value" ]; fhir:ElementDefinition.definition [ fhir:value "The value of the denominator." ]; fhir:ElementDefinition.min [ fhir:value "0" ]; fhir:ElementDefinition.max [ fhir:value "1" ]; fhir:ElementDefinition.base [ fhir:ElementDefinition.path [ fhir:value "Ratio.denominator" ]; fhir:ElementDefinition.min [ fhir:value "0" ]; fhir:ElementDefinition.max [ fhir:value "1" ] ]; fhir:ElementDefinition.type [ fhir:index 0; fhir:ElementDefinition.code [ fhir:value "Quantity" ] ]; fhir:ElementDefinition.constraint [ fhir:index 0; fhir:ElementDefinition.key [ fhir:value "ele-1" ]; fhir:ElementDefinition.severity [ fhir:value "error" ]; fhir:ElementDefinition.human [ fhir:value "All FHIR elements must have a @value or children" ]; fhir:ElementDefinition.expression [ fhir:value "hasValue() or (children().count() > id.count())" ]; fhir:ElementDefinition.xpath [ fhir:value "@value|f:*|h:div" ]; fhir:ElementDefinition.source [ fhir:value "http://hl7.org/fhir/StructureDefinition/Element" ] ]; fhir:ElementDefinition.isModifier [ fhir:value "false" ]; fhir:ElementDefinition.isSummary [ fhir:value "true" ]; fhir:ElementDefinition.mapping [ fhir:index 0; fhir:ElementDefinition.identity [ fhir:value "rim" ]; fhir:ElementDefinition.map [ fhir:value ".denominator" ] ] ] ]; fhir:StructureDefinition.differential [ fhir:StructureDefinition.element [ fhir:index 0; fhir:Element.id [ fhir:value "Ratio" ]; fhir:Element.extension [ fhir:index 0; fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status" ]; fhir:Extension.value [ fhir:value "normative" ] ], [ fhir:index 1; fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version" ]; fhir:Extension.value [ fhir:value "4.0.0" ] ]; fhir:ElementDefinition.path [ fhir:value "Ratio" ]; fhir:ElementDefinition.short [ fhir:value "A ratio of two Quantity values - a numerator and a denominator" ]; fhir:ElementDefinition.definition [ fhir:value "A relationship of two Quantity values - expressed as a numerator and a denominator." ]; fhir:ElementDefinition.comment [ fhir:value "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." ]; fhir:ElementDefinition.min [ fhir:value "0" ]; fhir:ElementDefinition.max [ fhir:value "*" ]; fhir:ElementDefinition.constraint [ fhir:index 0; fhir:ElementDefinition.key [ fhir:value "rat-1" ]; fhir:ElementDefinition.severity [ fhir:value "error" ]; fhir:ElementDefinition.human [ fhir:value "Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present" ]; fhir:ElementDefinition.expression [ fhir:value "(numerator.exists() and denominator.exists()) or (numerator.empty() and denominator.empty() and extension.exists())" ]; fhir:ElementDefinition.xpath [ fhir:value "(count(f:numerator) = count(f:denominator)) and ((count(f:numerator) > 0) or (count(f:extension) > 0))" ]; fhir:ElementDefinition.source [ fhir:value "http://hl7.org/fhir/StructureDefinition/Ratio" ] ]; fhir:ElementDefinition.mapping [ fhir:index 0; fhir:ElementDefinition.identity [ fhir:value "v2" ]; fhir:ElementDefinition.map [ fhir:value "N/A" ] ], [ fhir:index 1; fhir:ElementDefinition.identity [ fhir:value "rim" ]; fhir:ElementDefinition.map [ fhir:value "RTO" ] ] ], [ fhir:index 1; fhir:Element.id [ fhir:value "Ratio.numerator" ]; fhir:ElementDefinition.path [ fhir:value "Ratio.numerator" ]; fhir:ElementDefinition.short [ fhir:value "Numerator value" ]; fhir:ElementDefinition.definition [ fhir:value "The value of the numerator." ]; fhir:ElementDefinition.min [ fhir:value "0" ]; fhir:ElementDefinition.max [ fhir:value "1" ]; fhir:ElementDefinition.type [ fhir:index 0; fhir:ElementDefinition.code [ fhir:value "Quantity" ] ]; fhir:ElementDefinition.isSummary [ fhir:value "true" ]; fhir:ElementDefinition.mapping [ fhir:index 0; fhir:ElementDefinition.identity [ fhir:value "rim" ]; fhir:ElementDefinition.map [ fhir:value ".numerator" ] ] ], [ fhir:index 2; fhir:Element.id [ fhir:value "Ratio.denominator" ]; fhir:ElementDefinition.path [ fhir:value "Ratio.denominator" ]; fhir:ElementDefinition.short [ fhir:value "Denominator value" ]; fhir:ElementDefinition.definition [ fhir:value "The value of the denominator." ]; fhir:ElementDefinition.min [ fhir:value "0" ]; fhir:ElementDefinition.max [ fhir:value "1" ]; fhir:ElementDefinition.type [ fhir:index 0; fhir:ElementDefinition.code [ fhir:value "Quantity" ] ]; fhir:ElementDefinition.isSummary [ fhir:value "true" ]; fhir:ElementDefinition.mapping [ fhir:index 0; fhir:ElementDefinition.identity [ fhir:value "rim" ]; fhir:ElementDefinition.map [ fhir:value ".denominator" ] ] ] ] . # -------------------------------------------------------------------------------------
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.