StructureDefinition-ValidityPeriod.xml
  1 <?xml version="1.0" encoding="utf-8"?>
  2 <StructureDefinition xmlns="http://hl7.org/fhir">
  3   <id value="ValidityPeriod" />
  4   <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
  5     <valueCode value="oo" />
  6   </extension>
  7   <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics">
  8     <valueCode value="can-bind" />
  9   </extension>
 10   <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
 11     <valueInteger value="2">
 12       <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom">
 13         <valueCanonical value="http://hl7.org/fhir/uv/order-catalog/ImplementationGuide/ig-uv-order-catalog" />
 14       </extension>
 15     </valueInteger>
 16   </extension>
 17   <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
 18     <valueCode value="trial-use">
 19       <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom">
 20         <valueCanonical value="http://hl7.org/fhir/uv/order-catalog/ImplementationGuide/ig-uv-order-catalog" />
 21       </extension>
 22     </valueCode>
 23   </extension>
 24   <url value="http://hl7.org/fhir/uv/order-catalog/StructureDefinition/ValidityPeriod" />
 25   <identifier>
 26     <system value="urn:ietf:rfc:3986" />
 27     <value value="urn:oid:2.16.840.1.113883.4.642.40.999.42.27" />
 28   </identifier>
 29   <version value="1.0.0-ballot" />
 30   <name value="ValidityPeriod" />
 31   <title value="Period of validity of the Composition (for Order Catalog profiles)" />
 32   <status value="draft" />
 33   <date value="2025-03-06T19:13:11.0000000+01:00" />
 34   <publisher value="HL7 International / Orders and Observations" />
 35   <contact>
 36     <telecom>
 37       <system value="url" />
 38       <value value="http://www.hl7.org/Special/committees/orders" />
 39     </telecom>
 40   </contact>
 41   <description value="The period [start date, end date] in which the Composition is valid (for Order Catalog profiles)." />
 42   <jurisdiction>
 43     <coding>
 44       <system value="http://unstats.un.org/unsd/methods/m49/m49.htm" />
 45       <code value="001" />
 46     </coding>
 47   </jurisdiction>
 48   <purpose value="This extension uses the datatype Period, unlike the cqm-ValidityPeriod extension, created for Composition in 2014, which uses the datatype dateTime.
Thus this extension enables to state a start date and/or an end date" />
 49   <fhirVersion value="5.0.0" />
 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   <context>
 58     <type value="element" />
 59     <expression value="Composition" />
 60   </context>
 61   <type value="Extension" />
 62   <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" />
 63   <derivation value="constraint" />
 64   <snapshot>
 65     <extension url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version">
 66       <valueString value="5.0.0" />
 67     </extension>
 68     <element id="Extension">
 69       <path value="Extension" />
 70       <short value="Validity Period" />
 71       <definition value="The period in which the Composition is valid (for Order Catalog profiles), with optional start and end dates." />
 72       <min value="0" />
 73       <max value="1" />
 74       <base>
 75         <path value="Extension" />
 76         <min value="0" />
 77         <max value="*" />
 78       </base>
 79       <constraint>
 80         <key value="ele-1" />
 81         <severity value="error" />
 82         <human value="All FHIR elements must have a @value or children" />
 83         <expression value="hasValue() or (children().count() > id.count())" />
 84         <source value="http://hl7.org/fhir/StructureDefinition/Element" />
 85       </constraint>
 86       <constraint>
 87         <key value="ext-1" />
 88         <severity value="error" />
 89         <human value="Must have either extensions or value[x], not both" />
 90         <expression value="extension.exists() != value.exists()" />
 91         <source value="http://hl7.org/fhir/StructureDefinition/Extension" />
 92       </constraint>
 93       <isModifier value="false" />
 94     </element>
 95     <element id="Extension.id">
 96       <path value="Extension.id" />
 97       <representation value="xmlAttr" />
 98       <short value="Unique id for inter-element referencing" />
 99       <definition value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." />
100       <min value="0" />
101       <max value="1" />
102       <base>
103         <path value="Element.id" />
104         <min value="0" />
105         <max value="1" />
106       </base>
107       <type>
108         <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
109           <valueUrl value="id" />
110         </extension>
111         <code value="http://hl7.org/fhirpath/System.String" />
112       </type>
113       <condition value="ele-1" />
114       <isModifier value="false" />
115       <isSummary value="false" />
116       <mapping>
117         <identity value="rim" />
118         <map value="n/a" />
119       </mapping>
120     </element>
121     <element id="Extension.extension">
122       <path value="Extension.extension" />
123       <slicing>
124         <discriminator>
125           <type value="value" />
126           <path value="url" />
127         </discriminator>
128         <description value="Extensions are always sliced by (at least) url" />
129         <rules value="open" />
130       </slicing>
131       <short value="Additional content defined by implementations" />
132       <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." />
133       <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." />
134       <alias value="extensions" />
135       <alias value="user content" />
136       <min value="0" />
137       <max value="*" />
138       <base>
139         <path value="Element.extension" />
140         <min value="0" />
141         <max value="*" />
142       </base>
143       <type>
144         <code value="Extension" />
145       </type>
146       <constraint>
147         <key value="ele-1" />
148         <severity value="error" />
149         <human value="All FHIR elements must have a @value or children" />
150         <expression value="hasValue() or (children().count() > id.count())" />
151         <source value="http://hl7.org/fhir/StructureDefinition/Element" />
152       </constraint>
153       <constraint>
154         <key value="ext-1" />
155         <severity value="error" />
156         <human value="Must have either extensions or value[x], not both" />
157         <expression value="extension.exists() != value.exists()" />
158         <source value="http://hl7.org/fhir/StructureDefinition/Extension" />
159       </constraint>
160       <isModifier value="false" />
161       <isSummary value="false" />
162       <mapping>
163         <identity value="rim" />
164         <map value="n/a" />
165       </mapping>
166     </element>
167     <element id="Extension.url">
168       <path value="Extension.url" />
169       <representation value="xmlAttr" />
170       <short value="identifies the meaning of the extension" />
171       <definition value="Source of the definition for the extension code - a logical name or a URL." />
172       <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." />
173       <min value="1" />
174       <max value="1" />
175       <base>
176         <path value="Extension.url" />
177         <min value="1" />
178         <max value="1" />
179       </base>
180       <type>
181         <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
182           <valueUrl value="uri" />
183         </extension>
184         <code value="http://hl7.org/fhirpath/System.String" />
185       </type>
186       <fixedUri value="http://hl7.org/fhir/uv/order-catalog/StructureDefinition/ValidityPeriod" />
187       <isModifier value="false" />
188       <isSummary value="false" />
189       <mapping>
190         <identity value="rim" />
191         <map value="N/A" />
192       </mapping>
193     </element>
194     <element id="Extension.value[x]">
195       <path value="Extension.value[x]" />
196       <short value="Value of extension" />
197       <definition value="Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R5/extensibility.html) for a list)." />
198       <min value="1" />
199       <max value="1" />
200       <base>
201         <path value="Extension.value[x]" />
202         <min value="0" />
203         <max value="1" />
204       </base>
205       <type>
206         <code value="Period" />
207       </type>
208       <condition value="ext-1" />
209       <constraint>
210         <key value="ele-1" />
211         <severity value="error" />
212         <human value="All FHIR elements must have a @value or children" />
213         <expression value="hasValue() or (children().count() > id.count())" />
214         <source value="http://hl7.org/fhir/StructureDefinition/Element" />
215       </constraint>
216       <isModifier value="false" />
217       <isSummary value="false" />
218       <mapping>
219         <identity value="rim" />
220         <map value="N/A" />
221       </mapping>
222     </element>
223   </snapshot>
224   <differential>
225     <element id="Extension">
226       <path value="Extension" />
227       <short value="Validity Period" />
228       <definition value="The period in which the Composition is valid (for Order Catalog profiles), with optional start and end dates." />
229       <max value="1" />
230     </element>
231     <element id="Extension.url">
232       <path value="Extension.url" />
233       <fixedUri value="http://hl7.org/fhir/uv/order-catalog/StructureDefinition/ValidityPeriod" />
234     </element>
235     <element id="Extension.value[x]">
236       <path value="Extension.value[x]" />
237       <min value="1" />
238       <type>
239         <code value="Period" />
240       </type>
241     </element>
242   </differential>
243 </StructureDefinition>