CodeableReference.xml
  1 <?xml version="1.0" encoding="utf-8"?>
  2 <StructureDefinition xmlns="http://hl7.org/fhir">
  3   <id value="CodeableReference" />
  4   <meta>
  5     <lastUpdated value="2023-03-26T06:21:02.749+02:00" />
  6   </meta>
  7   <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
  8     <valueCode value="draft" />
  9   </extension>
 10   <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics">
 11     <valueCode value="has-target" />
 12   </extension>
 13   <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics">
 14     <valueCode value="can-bind" />
 15   </extension>
 16   <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics">
 17     <valueCode value="do-translations" />
 18   </extension>
 19   <url value="http://hl7.org/fhir/StructureDefinition/CodeableReference" />
 20   <version value="5.0.0" />
 21   <name value="CodeableReference" />
 22   <status value="draft" />
 23   <experimental value="false" />
 24   <date value="2023-03-26T06:21:02.0000000+02:00" />
 25   <publisher value="HL7 FHIR Standard" />
 26   <contact>
 27     <telecom>
 28       <system value="url" />
 29       <value value="http://hl7.org/fhir" />
 30     </telecom>
 31   </contact>
 32   <description value="CodeableReference Type: A reference to a resource (by instance), or instead, a reference to a concept defined in a terminology or ontology (by class)." />
 33   <jurisdiction>
 34     <coding>
 35       <system value="http://unstats.un.org/unsd/methods/m49/m49.htm" />
 36       <code value="001" />
 37       <display value="World" />
 38     </coding>
 39   </jurisdiction>
 40   <purpose value="This is a common pattern in record keeping - a reference may be made to a specific condition, observation, plan, or definition, or a reference may be made to a general concept defined in a knowledge base somewhere." />
 41   <fhirVersion value="5.0.0" />
 42   <mapping>
 43     <identity value="rim" />
 44     <uri value="http://hl7.org/v3" />
 45     <name value="RIM Mapping" />
 46   </mapping>
 47   <kind value="complex-type" />
 48   <abstract value="false" />
 49   <type value="CodeableReference" />
 50   <baseDefinition value="http://hl7.org/fhir/StructureDefinition/DataType" />
 51   <derivation value="specialization" />
 52   <snapshot>
 53     <element id="CodeableReference">
 54       <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
 55         <valueCode value="draft" />
 56       </extension>
 57       <path value="CodeableReference" />
 58       <short value="Reference to a resource or a concept" />
 59       <definition value="A reference to a resource (by instance), or instead, a reference to a concept defined in a terminology or ontology (by class)." />
 60       <min value="0" />
 61       <max value="*" />
 62       <base>
 63         <path value="CodeableReference" />
 64         <min value="0" />
 65         <max value="*" />
 66       </base>
 67       <constraint>
 68         <key value="ele-1" />
 69         <severity value="error" />
 70         <human value="All FHIR elements must have a @value or children" />
 71         <expression value="hasValue() or (children().count() > id.count())" />
 72         <source value="http://hl7.org/fhir/StructureDefinition/Element" />
 73       </constraint>
 74       <isModifier value="false" />
 75       <mapping>
 76         <identity value="rim" />
 77         <map value="n/a" />
 78       </mapping>
 79     </element>
 80     <element id="CodeableReference.id">
 81       <path value="CodeableReference.id" />
 82       <representation value="xmlAttr" />
 83       <short value="Unique id for inter-element referencing" />
 84       <definition value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." />
 85       <min value="0" />
 86       <max value="1" />
 87       <base>
 88         <path value="Element.id" />
 89         <min value="0" />
 90         <max value="1" />
 91       </base>
 92       <type>
 93         <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
 94           <valueUrl value="id" />
 95         </extension>
 96         <code value="http://hl7.org/fhirpath/System.String" />
 97       </type>
 98       <condition value="ele-1" />
 99       <isModifier value="false" />
100       <isSummary value="false" />
101       <mapping>
102         <identity value="rim" />
103         <map value="n/a" />
104       </mapping>
105     </element>
106     <element id="CodeableReference.extension">
107       <path value="CodeableReference.extension" />
108       <slicing>
109         <discriminator>
110           <type value="value" />
111           <path value="url" />
112         </discriminator>
113         <description value="Extensions are always sliced by (at least) url" />
114         <rules value="open" />
115       </slicing>
116       <short value="Additional content defined by implementations" />
117       <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 managable, 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." />
118       <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." />
119       <alias value="extensions" />
120       <alias value="user content" />
121       <min value="0" />
122       <max value="*" />
123       <base>
124         <path value="Element.extension" />
125         <min value="0" />
126         <max value="*" />
127       </base>
128       <type>
129         <code value="Extension" />
130       </type>
131       <constraint>
132         <key value="ele-1" />
133         <severity value="error" />
134         <human value="All FHIR elements must have a @value or children" />
135         <expression value="hasValue() or (children().count() > id.count())" />
136         <source value="http://hl7.org/fhir/StructureDefinition/Element" />
137       </constraint>
138       <constraint>
139         <key value="ext-1" />
140         <severity value="error" />
141         <human value="Must have either extensions or value[x], not both" />
142         <expression value="extension.exists() != value.exists()" />
143         <source value="http://hl7.org/fhir/StructureDefinition/Extension" />
144       </constraint>
145       <isModifier value="false" />
146       <isSummary value="false" />
147       <mapping>
148         <identity value="rim" />
149         <map value="n/a" />
150       </mapping>
151     </element>
152     <element id="CodeableReference.concept">
153       <path value="CodeableReference.concept" />
154       <short value="Reference to a concept (by class)" />
155       <definition value="A reference to a concept - e.g. the information is identified by its general class to the degree of precision found in the terminology." />
156       <min value="0" />
157       <max value="1" />
158       <base>
159         <path value="CodeableReference.concept" />
160         <min value="0" />
161         <max value="1" />
162       </base>
163       <type>
164         <code value="CodeableConcept" />
165       </type>
166       <constraint>
167         <key value="ele-1" />
168         <severity value="error" />
169         <human value="All FHIR elements must have a @value or children" />
170         <expression value="hasValue() or (children().count() > id.count())" />
171         <source value="http://hl7.org/fhir/StructureDefinition/Element" />
172       </constraint>
173       <isModifier value="false" />
174       <isSummary value="true" />
175       <mapping>
176         <identity value="rim" />
177         <map value="N/A" />
178       </mapping>
179     </element>
180     <element id="CodeableReference.reference">
181       <path value="CodeableReference.reference" />
182       <short value="Reference to a resource (by instance)" />
183       <definition value="A reference to a resource the provides exact details about the information being referenced." />
184       <min value="0" />
185       <max value="1" />
186       <base>
187         <path value="CodeableReference.reference" />
188         <min value="0" />
189         <max value="1" />
190       </base>
191       <type>
192         <code value="Reference" />
193       </type>
194       <constraint>
195         <key value="ele-1" />
196         <severity value="error" />
197         <human value="All FHIR elements must have a @value or children" />
198         <expression value="hasValue() or (children().count() > id.count())" />
199         <source value="http://hl7.org/fhir/StructureDefinition/Element" />
200       </constraint>
201       <isModifier value="false" />
202       <isSummary value="true" />
203       <mapping>
204         <identity value="rim" />
205         <map value="N/A" />
206       </mapping>
207     </element>
208   </snapshot>
209   <differential>
210     <element id="CodeableReference">
211       <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
212         <valueCode value="draft" />
213       </extension>
214       <path value="CodeableReference" />
215       <short value="Reference to a resource or a concept" />
216       <definition value="A reference to a resource (by instance), or instead, a reference to a concept defined in a terminology or ontology (by class)." />
217       <min value="0" />
218       <max value="*" />
219     </element>
220     <element id="CodeableReference.concept">
221       <path value="CodeableReference.concept" />
222       <short value="Reference to a concept (by class)" />
223       <definition value="A reference to a concept - e.g. the information is identified by its general class to the degree of precision found in the terminology." />
224       <min value="0" />
225       <max value="1" />
226       <type>
227         <code value="CodeableConcept" />
228       </type>
229       <isSummary value="true" />
230       <mapping>
231         <identity value="rim" />
232         <map value="N/A" />
233       </mapping>
234     </element>
235     <element id="CodeableReference.reference">
236       <path value="CodeableReference.reference" />
237       <short value="Reference to a resource (by instance)" />
238       <definition value="A reference to a resource the provides exact details about the information being referenced." />
239       <min value="0" />
240       <max value="1" />
241       <type>
242         <code value="Reference" />
243       </type>
244       <isSummary value="true" />
245       <mapping>
246         <identity value="rim" />
247         <map value="N/A" />
248       </mapping>
249     </element>
250   </differential>
251 </StructureDefinition>