codesystem-alternate.xml
  1 <?xml version="1.0" encoding="utf-8"?>
  2 <StructureDefinition xmlns="http://hl7.org/fhir">
  3   <id value="codesystem-alternate" />
  4   <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
  5     <valueCode value="vocab" />
  6   </extension>
  7   <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
  8     <valueInteger value="1" />
  9   </extension>
 10   <url value="http://hl7.org/fhir/StructureDefinition/codesystem-alternate" />
 11   <version value="4.0.1" />
 12   <name value="alternate" />
 13   <status value="draft" />
 14   <date value="2019-10-31T23:29:23.0000000+01:00" />
 15   <publisher value="HL7" />
 16   <description value="An additional code that may be used to represent the concept." />
 17   <fhirVersion value="4.0.1" />
 18   <mapping>
 19     <identity value="rim" />
 20     <uri value="http://hl7.org/v3" />
 21     <name value="RIM Mapping" />
 22   </mapping>
 23   <kind value="complex-type" />
 24   <abstract value="false" />
 25   <context>
 26     <type value="element" />
 27     <expression value="CodeSystem.concept" />
 28   </context>
 29   <type value="Extension" />
 30   <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" />
 31   <derivation value="constraint" />
 32   <snapshot>
 33     <element id="Extension">
 34       <path value="Extension" />
 35       <short value="Additional code for the concept" />
 36       <definition value="An additional code that may be used to represent the concept." />
 37       <comment value="Few coding systems define synonyms. A few more define alternate codes for special case use." />
 38       <min value="0" />
 39       <max value="*" />
 40       <base>
 41         <path value="Extension" />
 42         <min value="0" />
 43         <max value="*" />
 44       </base>
 45       <condition value="ele-1" />
 46       <constraint>
 47         <key value="ele-1" />
 48         <severity value="error" />
 49         <human value="All FHIR elements must have a @value or children" />
 50         <expression value="hasValue() or (children().count() > id.count())" />
 51         <xpath value="@value|f:*|h:div" />
 52         <source value="http://hl7.org/fhir/StructureDefinition/Element" />
 53       </constraint>
 54       <constraint>
 55         <key value="ext-1" />
 56         <severity value="error" />
 57         <human value="Must have either extensions or value[x], not both" />
 58         <expression value="extension.exists() != value.exists()" />
 59         <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" />
 60         <source value="http://hl7.org/fhir/StructureDefinition/Extension" />
 61       </constraint>
 62       <isModifier value="false" />
 63     </element>
 64     <element id="Extension.id">
 65       <path value="Extension.id" />
 66       <representation value="xmlAttr" />
 67       <short value="Unique id for inter-element referencing" />
 68       <definition value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." />
 69       <min value="0" />
 70       <max value="1" />
 71       <base>
 72         <path value="Element.id" />
 73         <min value="0" />
 74         <max value="1" />
 75       </base>
 76       <type>
 77         <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
 78           <valueUrl value="string" />
 79         </extension>
 80         <code value="http://hl7.org/fhirpath/System.String" />
 81       </type>
 82       <isModifier value="false" />
 83       <isSummary value="false" />
 84       <mapping>
 85         <identity value="rim" />
 86         <map value="n/a" />
 87       </mapping>
 88     </element>
 89     <element id="Extension.extension">
 90       <path value="Extension.extension" />
 91       <slicing>
 92         <discriminator>
 93           <type value="value" />
 94           <path value="url" />
 95         </discriminator>
 96         <description value="Extensions are always sliced by (at least) url" />
 97         <rules value="open" />
 98       </slicing>
 99       <short value="Additional content defined by implementations" />
100       <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." />
101       <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." />
102       <alias value="extensions" />
103       <alias value="user content" />
104       <min value="0" />
105       <max value="*" />
106       <base>
107         <path value="Element.extension" />
108         <min value="0" />
109         <max value="*" />
110       </base>
111       <type>
112         <code value="Extension" />
113       </type>
114       <constraint>
115         <key value="ele-1" />
116         <severity value="error" />
117         <human value="All FHIR elements must have a @value or children" />
118         <expression value="hasValue() or (children().count() > id.count())" />
119         <xpath value="@value|f:*|h:div" />
120         <source value="http://hl7.org/fhir/StructureDefinition/Element" />
121       </constraint>
122       <constraint>
123         <key value="ext-1" />
124         <severity value="error" />
125         <human value="Must have either extensions or value[x], not both" />
126         <expression value="extension.exists() != value.exists()" />
127         <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])" />
128         <source value="http://hl7.org/fhir/StructureDefinition/Extension" />
129       </constraint>
130       <isModifier value="false" />
131       <isSummary value="false" />
132       <mapping>
133         <identity value="rim" />
134         <map value="n/a" />
135       </mapping>
136     </element>
137     <element id="Extension.extension:code">
138       <path value="Extension.extension" />
139       <sliceName value="code" />
140       <short value="Code that represents the concept" />
141       <definition value="The code that may be used to represent the concept." />
142       <min value="1" />
143       <max value="1" />
144       <base>
145         <path value="Element.extension" />
146         <min value="0" />
147         <max value="*" />
148       </base>
149       <type>
150         <code value="Extension" />
151       </type>
152       <constraint>
153         <key value="ele-1" />
154         <severity value="error" />
155         <human value="All FHIR elements must have a @value or children" />
156         <expression value="hasValue() or (children().count() > id.count())" />
157         <xpath value="@value|f:*|h:div" />
158         <source value="http://hl7.org/fhir/StructureDefinition/Element" />
159       </constraint>
160       <constraint>
161         <key value="ext-1" />
162         <severity value="error" />
163         <human value="Must have either extensions or value[x], not both" />
164         <expression value="extension.exists() != value.exists()" />
165         <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])" />
166         <source value="http://hl7.org/fhir/StructureDefinition/Extension" />
167       </constraint>
168       <isModifier value="false" />
169       <isSummary value="false" />
170     </element>
171     <element id="Extension.extension:code.id">
172       <path value="Extension.extension.id" />
173       <representation value="xmlAttr" />
174       <short value="Unique id for inter-element referencing" />
175       <definition value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." />
176       <min value="0" />
177       <max value="1" />
178       <base>
179         <path value="Element.id" />
180         <min value="0" />
181         <max value="1" />
182       </base>
183       <type>
184         <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
185           <valueUrl value="string" />
186         </extension>
187         <code value="http://hl7.org/fhirpath/System.String" />
188       </type>
189       <isModifier value="false" />
190       <isSummary value="false" />
191       <mapping>
192         <identity value="rim" />
193         <map value="n/a" />
194       </mapping>
195     </element>
196     <element id="Extension.extension:code.extension">
197       <path value="Extension.extension.extension" />
198       <slicing>
199         <discriminator>
200           <type value="value" />
201           <path value="url" />
202         </discriminator>
203         <description value="Extensions are always sliced by (at least) url" />
204         <rules value="open" />
205       </slicing>
206       <short value="Extension" />
207       <definition value="An Extension" />
208       <min value="0" />
209       <max value="0" />
210       <base>
211         <path value="Element.extension" />
212         <min value="0" />
213         <max value="*" />
214       </base>
215       <type>
216         <code value="Extension" />
217       </type>
218       <constraint>
219         <key value="ele-1" />
220         <severity value="error" />
221         <human value="All FHIR elements must have a @value or children" />
222         <expression value="hasValue() or (children().count() > id.count())" />
223         <xpath value="@value|f:*|h:div" />
224         <source value="http://hl7.org/fhir/StructureDefinition/Element" />
225       </constraint>
226       <constraint>
227         <key value="ext-1" />
228         <severity value="error" />
229         <human value="Must have either extensions or value[x], not both" />
230         <expression value="extension.exists() != value.exists()" />
231         <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])" />
232         <source value="http://hl7.org/fhir/StructureDefinition/Extension" />
233       </constraint>
234       <isModifier value="false" />
235       <isSummary value="false" />
236     </element>
237     <element id="Extension.extension:code.url">
238       <path value="Extension.extension.url" />
239       <representation value="xmlAttr" />
240       <short value="identifies the meaning of the extension" />
241       <definition value="Source of the definition for the extension code - a logical name or a URL." />
242       <comment value="The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension." />
243       <min value="1" />
244       <max value="1" />
245       <base>
246         <path value="Extension.url" />
247         <min value="1" />
248         <max value="1" />
249       </base>
250       <type>
251         <code value="uri" />
252       </type>
253       <fixedUri value="code" />
254       <isModifier value="false" />
255       <isSummary value="false" />
256       <mapping>
257         <identity value="rim" />
258         <map value="N/A" />
259       </mapping>
260     </element>
261     <element id="Extension.extension:code.value[x]">
262       <path value="Extension.extension.value[x]" />
263       <short value="Value of extension" />
264       <definition value="Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/extensibility.html) for a list)." />
265       <min value="1" />
266       <max value="1" />
267       <base>
268         <path value="Extension.value[x]" />
269         <min value="0" />
270         <max value="1" />
271       </base>
272       <type>
273         <code value="code" />
274       </type>
275       <constraint>
276         <key value="ele-1" />
277         <severity value="error" />
278         <human value="All FHIR elements must have a @value or children" />
279         <expression value="hasValue() or (children().count() > id.count())" />
280         <xpath value="@value|f:*|h:div" />
281         <source value="http://hl7.org/fhir/StructureDefinition/Element" />
282       </constraint>
283       <isModifier value="false" />
284       <isSummary value="false" />
285       <mapping>
286         <identity value="rim" />
287         <map value="N/A" />
288       </mapping>
289     </element>
290     <element id="Extension.extension:use">
291       <path value="Extension.extension" />
292       <sliceName value="use" />
293       <short value="Expected use of the code" />
294       <definition value="Defines why this additional code is defined." />
295       <comment value="Further work is needed on the value set." />
296       <min value="1" />
297       <max value="1" />
298       <base>
299         <path value="Element.extension" />
300         <min value="0" />
301         <max value="*" />
302       </base>
303       <type>
304         <code value="Extension" />
305       </type>
306       <constraint>
307         <key value="ele-1" />
308         <severity value="error" />
309         <human value="All FHIR elements must have a @value or children" />
310         <expression value="hasValue() or (children().count() > id.count())" />
311         <xpath value="@value|f:*|h:div" />
312         <source value="http://hl7.org/fhir/StructureDefinition/Element" />
313       </constraint>
314       <constraint>
315         <key value="ext-1" />
316         <severity value="error" />
317         <human value="Must have either extensions or value[x], not both" />
318         <expression value="extension.exists() != value.exists()" />
319         <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])" />
320         <source value="http://hl7.org/fhir/StructureDefinition/Extension" />
321       </constraint>
322       <isModifier value="false" />
323       <isSummary value="false" />
324     </element>
325     <element id="Extension.extension:use.id">
326       <path value="Extension.extension.id" />
327       <representation value="xmlAttr" />
328       <short value="Unique id for inter-element referencing" />
329       <definition value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." />
330       <min value="0" />
331       <max value="1" />
332       <base>
333         <path value="Element.id" />
334         <min value="0" />
335         <max value="1" />
336       </base>
337       <type>
338         <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
339           <valueUrl value="string" />
340         </extension>
341         <code value="http://hl7.org/fhirpath/System.String" />
342       </type>
343       <isModifier value="false" />
344       <isSummary value="false" />
345       <mapping>
346         <identity value="rim" />
347         <map value="n/a" />
348       </mapping>
349     </element>
350     <element id="Extension.extension:use.extension">
351       <path value="Extension.extension.extension" />
352       <slicing>
353         <discriminator>
354           <type value="value" />
355           <path value="url" />
356         </discriminator>
357         <description value="Extensions are always sliced by (at least) url" />
358         <rules value="open" />
359       </slicing>
360       <short value="Extension" />
361       <definition value="An Extension" />
362       <min value="0" />
363       <max value="0" />
364       <base>
365         <path value="Element.extension" />
366         <min value="0" />
367         <max value="*" />
368       </base>
369       <type>
370         <code value="Extension" />
371       </type>
372       <constraint>
373         <key value="ele-1" />
374         <severity value="error" />
375         <human value="All FHIR elements must have a @value or children" />
376         <expression value="hasValue() or (children().count() > id.count())" />
377         <xpath value="@value|f:*|h:div" />
378         <source value="http://hl7.org/fhir/StructureDefinition/Element" />
379       </constraint>
380       <constraint>
381         <key value="ext-1" />
382         <severity value="error" />
383         <human value="Must have either extensions or value[x], not both" />
384         <expression value="extension.exists() != value.exists()" />
385         <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])" />
386         <source value="http://hl7.org/fhir/StructureDefinition/Extension" />
387       </constraint>
388       <isModifier value="false" />
389       <isSummary value="false" />
390     </element>
391     <element id="Extension.extension:use.url">
392       <path value="Extension.extension.url" />
393       <representation value="xmlAttr" />
394       <short value="identifies the meaning of the extension" />
395       <definition value="Source of the definition for the extension code - a logical name or a URL." />
396       <comment value="The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension." />
397       <min value="1" />
398       <max value="1" />
399       <base>
400         <path value="Extension.url" />
401         <min value="1" />
402         <max value="1" />
403       </base>
404       <type>
405         <code value="uri" />
406       </type>
407       <fixedUri value="use" />
408       <isModifier value="false" />
409       <isSummary value="false" />
410       <mapping>
411         <identity value="rim" />
412         <map value="N/A" />
413       </mapping>
414     </element>
415     <element id="Extension.extension:use.value[x]">
416       <path value="Extension.extension.value[x]" />
417       <short value="Value of extension" />
418       <definition value="Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/extensibility.html) for a list)." />
419       <min value="1" />
420       <max value="1" />
421       <base>
422         <path value="Extension.value[x]" />
423         <min value="0" />
424         <max value="1" />
425       </base>
426       <type>
427         <code value="Coding" />
428       </type>
429       <constraint>
430         <key value="ele-1" />
431         <severity value="error" />
432         <human value="All FHIR elements must have a @value or children" />
433         <expression value="hasValue() or (children().count() > id.count())" />
434         <xpath value="@value|f:*|h:div" />
435         <source value="http://hl7.org/fhir/StructureDefinition/Element" />
436       </constraint>
437       <isModifier value="false" />
438       <isSummary value="false" />
439       <binding>
440         <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
441           <valueString value="AlternativeCodeKind" />
442         </extension>
443         <strength value="extensible" />
444         <description value="Indicates the type of use for which the code is defined." />
445         <valueSet value="http://hl7.org/fhir/ValueSet/codesystem-altcode-kind" />
446       </binding>
447       <mapping>
448         <identity value="rim" />
449         <map value="N/A" />
450       </mapping>
451     </element>
452     <element id="Extension.url">
453       <path value="Extension.url" />
454       <representation value="xmlAttr" />
455       <short value="identifies the meaning of the extension" />
456       <definition value="Source of the definition for the extension code - a logical name or a URL." />
457       <comment value="The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension." />
458       <min value="1" />
459       <max value="1" />
460       <base>
461         <path value="Extension.url" />
462         <min value="1" />
463         <max value="1" />
464       </base>
465       <type>
466         <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
467           <valueUrl value="uri" />
468         </extension>
469         <code value="http://hl7.org/fhirpath/System.String" />
470       </type>
471       <fixedUri value="http://hl7.org/fhir/StructureDefinition/codesystem-alternate" />
472       <isModifier value="false" />
473       <isSummary value="false" />
474       <mapping>
475         <identity value="rim" />
476         <map value="N/A" />
477       </mapping>
478     </element>
479     <element id="Extension.value[x]">
480       <path value="Extension.value[x]" />
481       <short value="Value of extension" />
482       <definition value="Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/extensibility.html) for a list)." />
483       <min value="0" />
484       <max value="0" />
485       <base>
486         <path value="Extension.value[x]" />
487         <min value="0" />
488         <max value="1" />
489       </base>
490       <type>
491         <code value="base64Binary" />
492       </type>
493       <type>
494         <code value="boolean" />
495       </type>
496       <type>
497         <code value="canonical" />
498       </type>
499       <type>
500         <code value="code" />
501       </type>
502       <type>
503         <code value="date" />
504       </type>
505       <type>
506         <code value="dateTime" />
507       </type>
508       <type>
509         <code value="decimal" />
510       </type>
511       <type>
512         <code value="id" />
513       </type>
514       <type>
515         <code value="instant" />
516       </type>
517       <type>
518         <code value="integer" />
519       </type>
520       <type>
521         <code value="markdown" />
522       </type>
523       <type>
524         <code value="oid" />
525       </type>
526       <type>
527         <code value="positiveInt" />
528       </type>
529       <type>
530         <code value="string" />
531       </type>
532       <type>
533         <code value="time" />
534       </type>
535       <type>
536         <code value="unsignedInt" />
537       </type>
538       <type>
539         <code value="uri" />
540       </type>
541       <type>
542         <code value="url" />
543       </type>
544       <type>
545         <code value="uuid" />
546       </type>
547       <type>
548         <code value="Address" />
549       </type>
550       <type>
551         <code value="Age" />
552       </type>
553       <type>
554         <code value="Annotation" />
555       </type>
556       <type>
557         <code value="Attachment" />
558       </type>
559       <type>
560         <code value="CodeableConcept" />
561       </type>
562       <type>
563         <code value="Coding" />
564       </type>
565       <type>
566         <code value="ContactPoint" />
567       </type>
568       <type>
569         <code value="Count" />
570       </type>
571       <type>
572         <code value="Distance" />
573       </type>
574       <type>
575         <code value="Duration" />
576       </type>
577       <type>
578         <code value="HumanName" />
579       </type>
580       <type>
581         <code value="Identifier" />
582       </type>
583       <type>
584         <code value="Money" />
585       </type>
586       <type>
587         <code value="Period" />
588       </type>
589       <type>
590         <code value="Quantity" />
591       </type>
592       <type>
593         <code value="Range" />
594       </type>
595       <type>
596         <code value="Ratio" />
597       </type>
598       <type>
599         <code value="Reference" />
600       </type>
601       <type>
602         <code value="SampledData" />
603       </type>
604       <type>
605         <code value="Signature" />
606       </type>
607       <type>
608         <code value="Timing" />
609       </type>
610       <type>
611         <code value="ContactDetail" />
612       </type>
613       <type>
614         <code value="Contributor" />
615       </type>
616       <type>
617         <code value="DataRequirement" />
618       </type>
619       <type>
620         <code value="Expression" />
621       </type>
622       <type>
623         <code value="ParameterDefinition" />
624       </type>
625       <type>
626         <code value="RelatedArtifact" />
627       </type>
628       <type>
629         <code value="TriggerDefinition" />
630       </type>
631       <type>
632         <code value="UsageContext" />
633       </type>
634       <type>
635         <code value="Dosage" />
636       </type>
637       <type>
638         <code value="Meta" />
639       </type>
640       <constraint>
641         <key value="ele-1" />
642         <severity value="error" />
643         <human value="All FHIR elements must have a @value or children" />
644         <expression value="hasValue() or (children().count() > id.count())" />
645         <xpath value="@value|f:*|h:div" />
646         <source value="http://hl7.org/fhir/StructureDefinition/Element" />
647       </constraint>
648       <isModifier value="false" />
649       <isSummary value="false" />
650       <mapping>
651         <identity value="rim" />
652         <map value="N/A" />
653       </mapping>
654     </element>
655   </snapshot>
656   <differential>
657     <element id="Extension">
658       <path value="Extension" />
659       <short value="Additional code for the concept" />
660       <definition value="An additional code that may be used to represent the concept." />
661       <comment value="Few coding systems define synonyms. A few more define alternate codes for special case use." />
662       <min value="0" />
663       <max value="*" />
664       <isModifier value="false" />
665     </element>
666     <element id="Extension.extension:code">
667       <path value="Extension.extension" />
668       <sliceName value="code" />
669       <short value="Code that represents the concept" />
670       <definition value="The code that may be used to represent the concept." />
671       <min value="1" />
672       <max value="1" />
673       <type>
674         <code value="Extension" />
675       </type>
676     </element>
677     <element id="Extension.extension:code.extension">
678       <path value="Extension.extension.extension" />
679       <max value="0" />
680     </element>
681     <element id="Extension.extension:code.url">
682       <path value="Extension.extension.url" />
683       <type>
684         <code value="uri" />
685       </type>
686       <fixedUri value="code" />
687     </element>
688     <element id="Extension.extension:code.value[x]">
689       <path value="Extension.extension.value[x]" />
690       <min value="1" />
691       <type>
692         <code value="code" />
693       </type>
694     </element>
695     <element id="Extension.extension:use">
696       <path value="Extension.extension" />
697       <sliceName value="use" />
698       <short value="Expected use of the code" />
699       <definition value="Defines why this additional code is defined." />
700       <comment value="Further work is needed on the value set." />
701       <min value="1" />
702       <max value="1" />
703       <type>
704         <code value="Extension" />
705       </type>
706     </element>
707     <element id="Extension.extension:use.extension">
708       <path value="Extension.extension.extension" />
709       <max value="0" />
710     </element>
711     <element id="Extension.extension:use.url">
712       <path value="Extension.extension.url" />
713       <type>
714         <code value="uri" />
715       </type>
716       <fixedUri value="use" />
717     </element>
718     <element id="Extension.extension:use.value[x]">
719       <path value="Extension.extension.value[x]" />
720       <min value="1" />
721       <type>
722         <code value="Coding" />
723       </type>
724       <binding>
725         <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
726           <valueString value="AlternativeCodeKind" />
727         </extension>
728         <strength value="extensible" />
729         <description value="Indicates the type of use for which the code is defined." />
730         <valueSet value="http://hl7.org/fhir/ValueSet/codesystem-altcode-kind" />
731       </binding>
732     </element>
733     <element id="Extension.url">
734       <path value="Extension.url" />
735       <fixedUri value="http://hl7.org/fhir/StructureDefinition/codesystem-alternate" />
736     </element>
737     <element id="Extension.value[x]">
738       <path value="Extension.value[x]" />
739       <min value="0" />
740       <max value="0" />
741     </element>
742   </differential>
743 </StructureDefinition>