StructureDefinition-Ratio-uv-ips.xml
  1 <?xml version="1.0" encoding="utf-8"?>
  2 <StructureDefinition xmlns="http://hl7.org/fhir">
  3   <id value="Ratio-uv-ips" />
  4   <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
  5     <valueCode value="pc" />
  6   </extension>
  7   <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
  8     <valueInteger value="2">
  9       <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom">
 10         <valueCanonical value="http://hl7.org/fhir/uv/ips/ImplementationGuide/hl7.fhir.uv.ips" />
 11       </extension>
 12     </valueInteger>
 13   </extension>
 14   <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
 15     <valueCode value="trial-use">
 16       <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom">
 17         <valueCanonical value="http://hl7.org/fhir/uv/ips/ImplementationGuide/hl7.fhir.uv.ips" />
 18       </extension>
 19     </valueCode>
 20   </extension>
 21   <url value="http://hl7.org/fhir/uv/ips/StructureDefinition/Ratio-uv-ips" />
 22   <version value="2.0.0" />
 23   <name value="RatioIPS" />
 24   <title value="Ratio (IPS)" />
 25   <status value="active" />
 26   <date value="2024-06-19T17:50:07.0000000+02:00" />
 27   <publisher value="HL7 International / Patient Care" />
 28   <contact>
 29     <name value="HL7 International / Patient Care" />
 30     <telecom>
 31       <system value="url" />
 32       <value value="http://www.hl7.org/Special/committees/patientcare" />
 33     </telecom>
 34   </contact>
 35   <description value="Ratio data type, constrained to use UCUM as the code system for units." />
 36   <jurisdiction>
 37     <coding>
 38       <system value="http://unstats.un.org/unsd/methods/m49/m49.htm" />
 39       <code value="001" />
 40       <display value="World" />
 41     </coding>
 42   </jurisdiction>
 43   <purpose value="Allow only UCUM as the code system for units." />
 44   <fhirVersion value="4.0.1" />
 45   <mapping>
 46     <identity value="v2" />
 47     <uri value="http://hl7.org/v2" />
 48     <name value="HL7 v2 Mapping" />
 49   </mapping>
 50   <mapping>
 51     <identity value="rim" />
 52     <uri value="http://hl7.org/v3" />
 53     <name value="RIM Mapping" />
 54   </mapping>
 55   <kind value="complex-type" />
 56   <abstract value="false" />
 57   <type value="Ratio" />
 58   <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Ratio" />
 59   <derivation value="constraint" />
 60   <snapshot>
 61     <element id="Ratio">
 62       <path value="Ratio" />
 63       <short value="A ratio of two Quantity values - a numerator and a denominator" />
 64       <definition value="A relationship of two Quantity values - expressed as a numerator and a denominator." />
 65       <comment 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." />
 66       <min value="0" />
 67       <max value="*" />
 68       <base>
 69         <path value="Ratio" />
 70         <min value="0" />
 71         <max value="*" />
 72       </base>
 73       <condition value="ele-1" />
 74       <constraint>
 75         <key value="ele-1" />
 76         <severity value="error" />
 77         <human value="All FHIR elements must have a @value or children" />
 78         <expression value="hasValue() or (children().count() > id.count())" />
 79         <xpath value="@value|f:*|h:div" />
 80         <source value="http://hl7.org/fhir/StructureDefinition/Element" />
 81       </constraint>
 82       <constraint>
 83         <key value="rat-1" />
 84         <severity value="error" />
 85         <human value="Numerator and denominator SHALL both be present, or both are absent. If both are absent, there SHALL be some extension present" />
 86         <expression value="(numerator.empty() xor denominator.exists()) and (numerator.exists() or extension.exists())" />
 87         <xpath value="(count(f:numerator) = count(f:denominator)) and ((count(f:numerator) > 0) or (count(f:extension) > 0))" />
 88         <source value="http://hl7.org/fhir/StructureDefinition/Ratio" />
 89       </constraint>
 90       <isModifier value="false" />
 91       <mapping>
 92         <identity value="rim" />
 93         <map value="n/a" />
 94       </mapping>
 95       <mapping>
 96         <identity value="v2" />
 97         <map value="N/A" />
 98       </mapping>
 99       <mapping>
100         <identity value="rim" />
101         <map value="RTO" />
102       </mapping>
103     </element>
104     <element id="Ratio.id">
105       <path value="Ratio.id" />
106       <representation value="xmlAttr" />
107       <short value="Unique id for inter-element referencing" />
108       <definition value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." />
109       <min value="0" />
110       <max value="1" />
111       <base>
112         <path value="Element.id" />
113         <min value="0" />
114         <max value="1" />
115       </base>
116       <type>
117         <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
118           <valueUrl value="string" />
119         </extension>
120         <code value="http://hl7.org/fhirpath/System.String" />
121       </type>
122       <isModifier value="false" />
123       <isSummary value="false" />
124       <mapping>
125         <identity value="rim" />
126         <map value="n/a" />
127       </mapping>
128     </element>
129     <element id="Ratio.extension">
130       <path value="Ratio.extension" />
131       <slicing>
132         <discriminator>
133           <type value="value" />
134           <path value="url" />
135         </discriminator>
136         <description value="Extensions are always sliced by (at least) url" />
137         <rules value="open" />
138       </slicing>
139       <short value="Additional content defined by implementations" />
140       <definition 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." />
141       <comment 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." />
142       <alias value="extensions" />
143       <alias value="user content" />
144       <min value="0" />
145       <max value="*" />
146       <base>
147         <path value="Element.extension" />
148         <min value="0" />
149         <max value="*" />
150       </base>
151       <type>
152         <code value="Extension" />
153       </type>
154       <constraint>
155         <key value="ele-1" />
156         <severity value="error" />
157         <human value="All FHIR elements must have a @value or children" />
158         <expression value="hasValue() or (children().count() > id.count())" />
159         <xpath value="@value|f:*|h:div" />
160         <source value="http://hl7.org/fhir/StructureDefinition/Element" />
161       </constraint>
162       <constraint>
163         <key value="ext-1" />
164         <severity value="error" />
165         <human value="Must have either extensions or value[x], not both" />
166         <expression value="extension.exists() != value.exists()" />
167         <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])" />
168         <source value="http://hl7.org/fhir/StructureDefinition/Extension" />
169       </constraint>
170       <isModifier value="false" />
171       <isSummary value="false" />
172       <mapping>
173         <identity value="rim" />
174         <map value="n/a" />
175       </mapping>
176     </element>
177     <element id="Ratio.numerator">
178       <path value="Ratio.numerator" />
179       <short value="Numerator value" />
180       <definition value="The value of the numerator." />
181       <min value="0" />
182       <max value="1" />
183       <base>
184         <path value="Ratio.numerator" />
185         <min value="0" />
186         <max value="1" />
187       </base>
188       <type>
189         <code value="Quantity" />
190         <profile value="http://hl7.org/fhir/uv/ips/StructureDefinition/Quantity-uv-ips" />
191       </type>
192       <constraint>
193         <key value="ele-1" />
194         <severity value="error" />
195         <human value="All FHIR elements must have a @value or children" />
196         <expression value="hasValue() or (children().count() > id.count())" />
197         <xpath value="@value|f:*|h:div" />
198         <source value="http://hl7.org/fhir/StructureDefinition/Element" />
199       </constraint>
200       <mustSupport value="true" />
201       <isModifier value="false" />
202       <isSummary value="true" />
203       <mapping>
204         <identity value="rim" />
205         <map value=".numerator" />
206       </mapping>
207     </element>
208     <element id="Ratio.denominator">
209       <path value="Ratio.denominator" />
210       <short value="Denominator value" />
211       <definition value="The value of the denominator." />
212       <min value="0" />
213       <max value="1" />
214       <base>
215         <path value="Ratio.denominator" />
216         <min value="0" />
217         <max value="1" />
218       </base>
219       <type>
220         <code value="Quantity" />
221         <profile value="http://hl7.org/fhir/uv/ips/StructureDefinition/Quantity-uv-ips" />
222       </type>
223       <constraint>
224         <key value="ele-1" />
225         <severity value="error" />
226         <human value="All FHIR elements must have a @value or children" />
227         <expression value="hasValue() or (children().count() > id.count())" />
228         <xpath value="@value|f:*|h:div" />
229         <source value="http://hl7.org/fhir/StructureDefinition/Element" />
230       </constraint>
231       <mustSupport value="true" />
232       <isModifier value="false" />
233       <isSummary value="true" />
234       <mapping>
235         <identity value="rim" />
236         <map value=".denominator" />
237       </mapping>
238     </element>
239   </snapshot>
240   <differential>
241     <element id="Ratio.numerator">
242       <path value="Ratio.numerator" />
243       <type>
244         <code value="Quantity" />
245         <profile value="http://hl7.org/fhir/uv/ips/StructureDefinition/Quantity-uv-ips" />
246       </type>
247       <mustSupport value="true" />
248     </element>
249     <element id="Ratio.denominator">
250       <path value="Ratio.denominator" />
251       <type>
252         <code value="Quantity" />
253         <profile value="http://hl7.org/fhir/uv/ips/StructureDefinition/Quantity-uv-ips" />
254       </type>
255       <mustSupport value="true" />
256     </element>
257   </differential>
258 </StructureDefinition>