ExtendedContactDetail.xml
  1 <?xml version="1.0" encoding="utf-8"?>
  2 <StructureDefinition xmlns="http://hl7.org/fhir">
  3   <id value="ExtendedContactDetail" />
  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="trial-use" />
  9   </extension>
 10   <url value="http://hl7.org/fhir/StructureDefinition/ExtendedContactDetail" />
 11   <version value="5.0.0" />
 12   <name value="ExtendedContactDetail" />
 13   <status value="draft" />
 14   <experimental value="false" />
 15   <date value="2023-03-26T06:21:02.0000000+02:00" />
 16   <publisher value="HL7 FHIR Standard" />
 17   <contact>
 18     <telecom>
 19       <system value="url" />
 20       <value value="http://hl7.org/fhir" />
 21     </telecom>
 22   </contact>
 23   <description value="ExtendedContactDetail Type: Specifies contact information for a specific purpose over a period of time, might be handled/monitored by a specific named person or organization." />
 24   <jurisdiction>
 25     <coding>
 26       <system value="http://unstats.un.org/unsd/methods/m49/m49.htm" />
 27       <code value="001" />
 28       <display value="World" />
 29     </coding>
 30   </jurisdiction>
 31   <purpose value="Need to track contact and address information in the same way across multiple resources." />
 32   <fhirVersion value="5.0.0" />
 33   <mapping>
 34     <identity value="rim" />
 35     <uri value="http://hl7.org/v3" />
 36     <name value="RIM Mapping" />
 37   </mapping>
 38   <kind value="complex-type" />
 39   <abstract value="false" />
 40   <type value="ExtendedContactDetail" />
 41   <baseDefinition value="http://hl7.org/fhir/StructureDefinition/DataType" />
 42   <derivation value="specialization" />
 43   <snapshot>
 44     <element id="ExtendedContactDetail">
 45       <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
 46         <valueCode value="trial-use" />
 47       </extension>
 48       <path value="ExtendedContactDetail" />
 49       <short value="Contact information" />
 50       <definition value="Specifies contact information for a specific purpose over a period of time, might be handled/monitored by a specific named person or organization." />
 51       <comment value="This datatype may be sparsely populated, i.e. only contain a purpose and phone number or address, but other cases could be completed filled out." />
 52       <min value="0" />
 53       <max value="*" />
 54       <base>
 55         <path value="ExtendedContactDetail" />
 56         <min value="0" />
 57         <max value="*" />
 58       </base>
 59       <constraint>
 60         <key value="ele-1" />
 61         <severity value="error" />
 62         <human value="All FHIR elements must have a @value or children" />
 63         <expression value="hasValue() or (children().count() > id.count())" />
 64         <source value="http://hl7.org/fhir/StructureDefinition/Element" />
 65       </constraint>
 66       <isModifier value="false" />
 67       <mapping>
 68         <identity value="rim" />
 69         <map value="n/a" />
 70       </mapping>
 71     </element>
 72     <element id="ExtendedContactDetail.id">
 73       <path value="ExtendedContactDetail.id" />
 74       <representation value="xmlAttr" />
 75       <short value="Unique id for inter-element referencing" />
 76       <definition value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." />
 77       <min value="0" />
 78       <max value="1" />
 79       <base>
 80         <path value="Element.id" />
 81         <min value="0" />
 82         <max value="1" />
 83       </base>
 84       <type>
 85         <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
 86           <valueUrl value="id" />
 87         </extension>
 88         <code value="http://hl7.org/fhirpath/System.String" />
 89       </type>
 90       <condition value="ele-1" />
 91       <isModifier value="false" />
 92       <isSummary value="false" />
 93       <mapping>
 94         <identity value="rim" />
 95         <map value="n/a" />
 96       </mapping>
 97     </element>
 98     <element id="ExtendedContactDetail.extension">
 99       <path value="ExtendedContactDetail.extension" />
100       <slicing>
101         <discriminator>
102           <type value="value" />
103           <path value="url" />
104         </discriminator>
105         <description value="Extensions are always sliced by (at least) url" />
106         <rules value="open" />
107       </slicing>
108       <short value="Additional content defined by implementations" />
109       <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." />
110       <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." />
111       <alias value="extensions" />
112       <alias value="user content" />
113       <min value="0" />
114       <max value="*" />
115       <base>
116         <path value="Element.extension" />
117         <min value="0" />
118         <max value="*" />
119       </base>
120       <type>
121         <code value="Extension" />
122       </type>
123       <constraint>
124         <key value="ele-1" />
125         <severity value="error" />
126         <human value="All FHIR elements must have a @value or children" />
127         <expression value="hasValue() or (children().count() > id.count())" />
128         <source value="http://hl7.org/fhir/StructureDefinition/Element" />
129       </constraint>
130       <constraint>
131         <key value="ext-1" />
132         <severity value="error" />
133         <human value="Must have either extensions or value[x], not both" />
134         <expression value="extension.exists() != value.exists()" />
135         <source value="http://hl7.org/fhir/StructureDefinition/Extension" />
136       </constraint>
137       <isModifier value="false" />
138       <isSummary value="false" />
139       <mapping>
140         <identity value="rim" />
141         <map value="n/a" />
142       </mapping>
143     </element>
144     <element id="ExtendedContactDetail.purpose">
145       <path value="ExtendedContactDetail.purpose" />
146       <short value="The type of contact" />
147       <definition value="The purpose/type of contact." />
148       <comment value="If no purpose is defined, then these contact details may be used for any purpose." />
149       <min value="0" />
150       <max value="1" />
151       <base>
152         <path value="ExtendedContactDetail.purpose" />
153         <min value="0" />
154         <max value="1" />
155       </base>
156       <type>
157         <code value="CodeableConcept" />
158       </type>
159       <constraint>
160         <key value="ele-1" />
161         <severity value="error" />
162         <human value="All FHIR elements must have a @value or children" />
163         <expression value="hasValue() or (children().count() > id.count())" />
164         <source value="http://hl7.org/fhir/StructureDefinition/Element" />
165       </constraint>
166       <isModifier value="false" />
167       <isSummary value="true" />
168       <binding>
169         <extension url="http://hl7.org/fhir/tools/StructureDefinition/binding-definition">
170           <valueString value="The purpose for which an extended contact detail should be used." />
171         </extension>
172         <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
173           <valueString value="Purpose" />
174         </extension>
175         <strength value="preferred" />
176         <description value="The purpose for which an extended contact detail should be used." />
177         <valueSet value="http://terminology.hl7.org/ValueSet/contactentity-type" />
178       </binding>
179     </element>
180     <element id="ExtendedContactDetail.name">
181       <path value="ExtendedContactDetail.name" />
182       <short value="Name of an individual to contact" />
183       <definition value="The name of an individual to contact, some types of contact detail are usually blank." />
184       <comment value="If there is no named individual, the telecom/address information is not generally monitored by a specific individual." />
185       <min value="0" />
186       <max value="*" />
187       <base>
188         <path value="ExtendedContactDetail.name" />
189         <min value="0" />
190         <max value="*" />
191       </base>
192       <type>
193         <code value="HumanName" />
194       </type>
195       <constraint>
196         <key value="ele-1" />
197         <severity value="error" />
198         <human value="All FHIR elements must have a @value or children" />
199         <expression value="hasValue() or (children().count() > id.count())" />
200         <source value="http://hl7.org/fhir/StructureDefinition/Element" />
201       </constraint>
202       <isModifier value="false" />
203       <isSummary value="true" />
204     </element>
205     <element id="ExtendedContactDetail.telecom">
206       <path value="ExtendedContactDetail.telecom" />
207       <short value="Contact details (e.g.phone/fax/url)" />
208       <definition value="The contact details application for the purpose defined." />
209       <min value="0" />
210       <max value="*" />
211       <base>
212         <path value="ExtendedContactDetail.telecom" />
213         <min value="0" />
214         <max value="*" />
215       </base>
216       <type>
217         <code value="ContactPoint" />
218       </type>
219       <constraint>
220         <key value="ele-1" />
221         <severity value="error" />
222         <human value="All FHIR elements must have a @value or children" />
223         <expression value="hasValue() or (children().count() > id.count())" />
224         <source value="http://hl7.org/fhir/StructureDefinition/Element" />
225       </constraint>
226       <isModifier value="false" />
227       <isSummary value="true" />
228     </element>
229     <element id="ExtendedContactDetail.address">
230       <path value="ExtendedContactDetail.address" />
231       <short value="Address for the contact" />
232       <definition value="Address for the contact." />
233       <comment value="More than 1 address would be for different purposes, and thus should be entered as a different entry,." />
234       <min value="0" />
235       <max value="1" />
236       <base>
237         <path value="ExtendedContactDetail.address" />
238         <min value="0" />
239         <max value="1" />
240       </base>
241       <type>
242         <code value="Address" />
243       </type>
244       <constraint>
245         <key value="ele-1" />
246         <severity value="error" />
247         <human value="All FHIR elements must have a @value or children" />
248         <expression value="hasValue() or (children().count() > id.count())" />
249         <source value="http://hl7.org/fhir/StructureDefinition/Element" />
250       </constraint>
251       <isModifier value="false" />
252       <isSummary value="true" />
253     </element>
254     <element id="ExtendedContactDetail.organization">
255       <path value="ExtendedContactDetail.organization" />
256       <short value="This contact detail is handled/monitored by a specific organization" />
257       <definition value="This contact detail is handled/monitored by a specific organization. If the name is provided in the contact, then it is referring to the named individual within this organization." />
258       <requirements value="Some specific types of contact information can be an handled by an organization (eg legal council is via a specific firm)." />
259       <min value="0" />
260       <max value="1" />
261       <base>
262         <path value="ExtendedContactDetail.organization" />
263         <min value="0" />
264         <max value="1" />
265       </base>
266       <type>
267         <code value="Reference" />
268         <targetProfile value="http://hl7.org/fhir/StructureDefinition/Organization" />
269       </type>
270       <constraint>
271         <key value="ele-1" />
272         <severity value="error" />
273         <human value="All FHIR elements must have a @value or children" />
274         <expression value="hasValue() or (children().count() > id.count())" />
275         <source value="http://hl7.org/fhir/StructureDefinition/Element" />
276       </constraint>
277       <isModifier value="false" />
278       <isSummary value="true" />
279     </element>
280     <element id="ExtendedContactDetail.period">
281       <path value="ExtendedContactDetail.period" />
282       <short value="Period that this contact was valid for usage" />
283       <definition value="Period that this contact was valid for usage." />
284       <comment value="If the details have multiple periods, then enter in a new ExtendedContact with the new period." />
285       <min value="0" />
286       <max value="1" />
287       <base>
288         <path value="ExtendedContactDetail.period" />
289         <min value="0" />
290         <max value="1" />
291       </base>
292       <type>
293         <code value="Period" />
294       </type>
295       <constraint>
296         <key value="ele-1" />
297         <severity value="error" />
298         <human value="All FHIR elements must have a @value or children" />
299         <expression value="hasValue() or (children().count() > id.count())" />
300         <source value="http://hl7.org/fhir/StructureDefinition/Element" />
301       </constraint>
302       <isModifier value="false" />
303       <isSummary value="true" />
304     </element>
305   </snapshot>
306   <differential>
307     <element id="ExtendedContactDetail">
308       <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
309         <valueCode value="trial-use" />
310       </extension>
311       <path value="ExtendedContactDetail" />
312       <short value="Contact information" />
313       <definition value="Specifies contact information for a specific purpose over a period of time, might be handled/monitored by a specific named person or organization." />
314       <comment value="This datatype may be sparsely populated, i.e. only contain a purpose and phone number or address, but other cases could be completed filled out." />
315       <min value="0" />
316       <max value="*" />
317     </element>
318     <element id="ExtendedContactDetail.purpose">
319       <path value="ExtendedContactDetail.purpose" />
320       <short value="The type of contact" />
321       <definition value="The purpose/type of contact." />
322       <comment value="If no purpose is defined, then these contact details may be used for any purpose." />
323       <min value="0" />
324       <max value="1" />
325       <type>
326         <code value="CodeableConcept" />
327       </type>
328       <isSummary value="true" />
329       <binding>
330         <extension url="http://hl7.org/fhir/tools/StructureDefinition/binding-definition">
331           <valueString value="The purpose for which an extended contact detail should be used." />
332         </extension>
333         <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
334           <valueString value="Purpose" />
335         </extension>
336         <strength value="preferred" />
337         <description value="The purpose for which an extended contact detail should be used." />
338         <valueSet value="http://terminology.hl7.org/ValueSet/contactentity-type" />
339       </binding>
340     </element>
341     <element id="ExtendedContactDetail.name">
342       <path value="ExtendedContactDetail.name" />
343       <short value="Name of an individual to contact" />
344       <definition value="The name of an individual to contact, some types of contact detail are usually blank." />
345       <comment value="If there is no named individual, the telecom/address information is not generally monitored by a specific individual." />
346       <min value="0" />
347       <max value="*" />
348       <type>
349         <code value="HumanName" />
350       </type>
351       <isSummary value="true" />
352     </element>
353     <element id="ExtendedContactDetail.telecom">
354       <path value="ExtendedContactDetail.telecom" />
355       <short value="Contact details (e.g.phone/fax/url)" />
356       <definition value="The contact details application for the purpose defined." />
357       <min value="0" />
358       <max value="*" />
359       <type>
360         <code value="ContactPoint" />
361       </type>
362       <isSummary value="true" />
363     </element>
364     <element id="ExtendedContactDetail.address">
365       <path value="ExtendedContactDetail.address" />
366       <short value="Address for the contact" />
367       <definition value="Address for the contact." />
368       <comment value="More than 1 address would be for different purposes, and thus should be entered as a different entry,." />
369       <min value="0" />
370       <max value="1" />
371       <type>
372         <code value="Address" />
373       </type>
374       <isSummary value="true" />
375     </element>
376     <element id="ExtendedContactDetail.organization">
377       <path value="ExtendedContactDetail.organization" />
378       <short value="This contact detail is handled/monitored by a specific organization" />
379       <definition value="This contact detail is handled/monitored by a specific organization. If the name is provided in the contact, then it is referring to the named individual within this organization." />
380       <requirements value="Some specific types of contact information can be an handled by an organization (eg legal council is via a specific firm)." />
381       <min value="0" />
382       <max value="1" />
383       <type>
384         <code value="Reference" />
385         <targetProfile value="http://hl7.org/fhir/StructureDefinition/Organization" />
386       </type>
387       <isSummary value="true" />
388     </element>
389     <element id="ExtendedContactDetail.period">
390       <path value="ExtendedContactDetail.period" />
391       <short value="Period that this contact was valid for usage" />
392       <definition value="Period that this contact was valid for usage." />
393       <comment value="If the details have multiple periods, then enter in a new ExtendedContact with the new period." />
394       <min value="0" />
395       <max value="1" />
396       <type>
397         <code value="Period" />
398       </type>
399       <isSummary value="true" />
400     </element>
401   </differential>
402 </StructureDefinition>