VirtualServiceDetail.xml 1 <?xml version="1.0" encoding="utf-8"?> 2 <StructureDefinition xmlns="http://hl7.org/fhir"> 3 <id value="VirtualServiceDetail" /> 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/VirtualServiceDetail" /> 11 <version value="5.0.0" /> 12 <name value="VirtualServiceDetail" /> 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="VirtualServiceDetail Type: Virtual Service Contact Details." /> 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 <fhirVersion value="5.0.0" /> 32 <mapping> 33 <identity value="rim" /> 34 <uri value="http://hl7.org/v3" /> 35 <name value="RIM Mapping" /> 36 </mapping> 37 <kind value="complex-type" /> 38 <abstract value="false" /> 39 <type value="VirtualServiceDetail" /> 40 <baseDefinition value="http://hl7.org/fhir/StructureDefinition/DataType" /> 41 <derivation value="specialization" /> 42 <snapshot> 43 <element id="VirtualServiceDetail"> 44 <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> 45 <valueCode value="trial-use" /> 46 </extension> 47 <path value="VirtualServiceDetail" /> 48 <short value="Virtual Service Contact Details" /> 49 <definition value="Virtual Service Contact Details." /> 50 <min value="0" /> 51 <max value="*" /> 52 <base> 53 <path value="VirtualServiceDetail" /> 54 <min value="0" /> 55 <max value="*" /> 56 </base> 57 <constraint> 58 <key value="ele-1" /> 59 <severity value="error" /> 60 <human value="All FHIR elements must have a @value or children" /> 61 <expression value="hasValue() or (children().count() > id.count())" /> 62 <source value="http://hl7.org/fhir/StructureDefinition/Element" /> 63 </constraint> 64 <isModifier value="false" /> 65 <mapping> 66 <identity value="rim" /> 67 <map value="n/a" /> 68 </mapping> 69 </element> 70 <element id="VirtualServiceDetail.id"> 71 <path value="VirtualServiceDetail.id" /> 72 <representation value="xmlAttr" /> 73 <short value="Unique id for inter-element referencing" /> 74 <definition value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." /> 75 <min value="0" /> 76 <max value="1" /> 77 <base> 78 <path value="Element.id" /> 79 <min value="0" /> 80 <max value="1" /> 81 </base> 82 <type> 83 <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type"> 84 <valueUrl value="id" /> 85 </extension> 86 <code value="http://hl7.org/fhirpath/System.String" /> 87 </type> 88 <condition value="ele-1" /> 89 <isModifier value="false" /> 90 <isSummary value="false" /> 91 <mapping> 92 <identity value="rim" /> 93 <map value="n/a" /> 94 </mapping> 95 </element> 96 <element id="VirtualServiceDetail.extension"> 97 <path value="VirtualServiceDetail.extension" /> 98 <slicing> 99 <discriminator> 100 <type value="value" /> 101 <path value="url" /> 102 </discriminator> 103 <description value="Extensions are always sliced by (at least) url" /> 104 <rules value="open" /> 105 </slicing> 106 <short value="Additional content defined by implementations" /> 107 <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." /> 108 <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." /> 109 <alias value="extensions" /> 110 <alias value="user content" /> 111 <min value="0" /> 112 <max value="*" /> 113 <base> 114 <path value="Element.extension" /> 115 <min value="0" /> 116 <max value="*" /> 117 </base> 118 <type> 119 <code value="Extension" /> 120 </type> 121 <constraint> 122 <key value="ele-1" /> 123 <severity value="error" /> 124 <human value="All FHIR elements must have a @value or children" /> 125 <expression value="hasValue() or (children().count() > id.count())" /> 126 <source value="http://hl7.org/fhir/StructureDefinition/Element" /> 127 </constraint> 128 <constraint> 129 <key value="ext-1" /> 130 <severity value="error" /> 131 <human value="Must have either extensions or value[x], not both" /> 132 <expression value="extension.exists() != value.exists()" /> 133 <source value="http://hl7.org/fhir/StructureDefinition/Extension" /> 134 </constraint> 135 <isModifier value="false" /> 136 <isSummary value="false" /> 137 <mapping> 138 <identity value="rim" /> 139 <map value="n/a" /> 140 </mapping> 141 </element> 142 <element id="VirtualServiceDetail.channelType"> 143 <path value="VirtualServiceDetail.channelType" /> 144 <short value="Channel Type" /> 145 <definition value="The type of virtual service to connect to (i.e. Teams, Zoom, Specific VMR technology, WhatsApp)." /> 146 <comment value="As this type defines what the virtual service is, it then defines what address and additional information might be relevant. Some profiles could be used for specific types to define what the other values could/should be." /> 147 <min value="0" /> 148 <max value="1" /> 149 <base> 150 <path value="VirtualServiceDetail.channelType" /> 151 <min value="0" /> 152 <max value="1" /> 153 </base> 154 <type> 155 <code value="Coding" /> 156 </type> 157 <constraint> 158 <key value="ele-1" /> 159 <severity value="error" /> 160 <human value="All FHIR elements must have a @value or children" /> 161 <expression value="hasValue() or (children().count() > id.count())" /> 162 <source value="http://hl7.org/fhir/StructureDefinition/Element" /> 163 </constraint> 164 <isModifier value="false" /> 165 <isSummary value="true" /> 166 <binding> 167 <extension url="http://hl7.org/fhir/tools/StructureDefinition/binding-definition"> 168 <valueString value="The purpose for which an extended contact detail should be used." /> 169 </extension> 170 <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> 171 <valueString value="VirtualServiceType" /> 172 </extension> 173 <strength value="example" /> 174 <description value="The purpose for which an extended contact detail should be used." /> 175 <valueSet value="http://hl7.org/fhir/ValueSet/virtual-service-type" /> 176 </binding> 177 </element> 178 <element id="VirtualServiceDetail.address[x]"> 179 <path value="VirtualServiceDetail.address[x]" /> 180 <short value="Contact address/number" /> 181 <definition value="What address or number needs to be used for a user to connect to the virtual service to join. The channelType informs as to which datatype is appropriate to use (requires knowledge of the specific type)." /> 182 <min value="0" /> 183 <max value="1" /> 184 <base> 185 <path value="VirtualServiceDetail.address[x]" /> 186 <min value="0" /> 187 <max value="1" /> 188 </base> 189 <type> 190 <code value="url" /> 191 </type> 192 <type> 193 <code value="string" /> 194 </type> 195 <type> 196 <code value="ContactPoint" /> 197 </type> 198 <type> 199 <code value="ExtendedContactDetail" /> 200 </type> 201 <constraint> 202 <key value="ele-1" /> 203 <severity value="error" /> 204 <human value="All FHIR elements must have a @value or children" /> 205 <expression value="hasValue() or (children().count() > id.count())" /> 206 <source value="http://hl7.org/fhir/StructureDefinition/Element" /> 207 </constraint> 208 <isModifier value="false" /> 209 <isSummary value="true" /> 210 </element> 211 <element id="VirtualServiceDetail.additionalInfo"> 212 <path value="VirtualServiceDetail.additionalInfo" /> 213 <short value="Address to see alternative connection details" /> 214 <definition value="Address to see alternative connection details." /> 215 <comment value="This web address can be used to provide additional details on the call, such as alternative/regional call in numbers, or other associated services." /> 216 <min value="0" /> 217 <max value="*" /> 218 <base> 219 <path value="VirtualServiceDetail.additionalInfo" /> 220 <min value="0" /> 221 <max value="*" /> 222 </base> 223 <type> 224 <code value="url" /> 225 </type> 226 <constraint> 227 <key value="ele-1" /> 228 <severity value="error" /> 229 <human value="All FHIR elements must have a @value or children" /> 230 <expression value="hasValue() or (children().count() > id.count())" /> 231 <source value="http://hl7.org/fhir/StructureDefinition/Element" /> 232 </constraint> 233 <isModifier value="false" /> 234 <isSummary value="true" /> 235 </element> 236 <element id="VirtualServiceDetail.maxParticipants"> 237 <path value="VirtualServiceDetail.maxParticipants" /> 238 <short value="Maximum number of participants supported by the virtual service" /> 239 <definition value="Maximum number of participants supported by the virtual service." /> 240 <comment value="Some services have only a limitted number of participants permitted to connect at a time, this is typically used in "shared" virtual services that you might find on location resources. Typically on-demand services might not have these restrictions." /> 241 <min value="0" /> 242 <max value="1" /> 243 <base> 244 <path value="VirtualServiceDetail.maxParticipants" /> 245 <min value="0" /> 246 <max value="1" /> 247 </base> 248 <type> 249 <code value="positiveInt" /> 250 </type> 251 <constraint> 252 <key value="ele-1" /> 253 <severity value="error" /> 254 <human value="All FHIR elements must have a @value or children" /> 255 <expression value="hasValue() or (children().count() > id.count())" /> 256 <source value="http://hl7.org/fhir/StructureDefinition/Element" /> 257 </constraint> 258 <isModifier value="false" /> 259 <isSummary value="true" /> 260 </element> 261 <element id="VirtualServiceDetail.sessionKey"> 262 <path value="VirtualServiceDetail.sessionKey" /> 263 <short value="Session Key required by the virtual service" /> 264 <definition value="Session Key required by the virtual service." /> 265 <comment value="Some services require a session key to be able to access the service once connected. This could be in cases where a shared number is used, and a session key is added to put into a private line, or to identify the participant in a call." /> 266 <min value="0" /> 267 <max value="1" /> 268 <base> 269 <path value="VirtualServiceDetail.sessionKey" /> 270 <min value="0" /> 271 <max value="1" /> 272 </base> 273 <type> 274 <code value="string" /> 275 </type> 276 <constraint> 277 <key value="ele-1" /> 278 <severity value="error" /> 279 <human value="All FHIR elements must have a @value or children" /> 280 <expression value="hasValue() or (children().count() > id.count())" /> 281 <source value="http://hl7.org/fhir/StructureDefinition/Element" /> 282 </constraint> 283 <isModifier value="false" /> 284 <isSummary value="true" /> 285 </element> 286 </snapshot> 287 <differential> 288 <element id="VirtualServiceDetail"> 289 <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> 290 <valueCode value="trial-use" /> 291 </extension> 292 <path value="VirtualServiceDetail" /> 293 <short value="Virtual Service Contact Details" /> 294 <definition value="Virtual Service Contact Details." /> 295 <min value="0" /> 296 <max value="*" /> 297 </element> 298 <element id="VirtualServiceDetail.channelType"> 299 <path value="VirtualServiceDetail.channelType" /> 300 <short value="Channel Type" /> 301 <definition value="The type of virtual service to connect to (i.e. Teams, Zoom, Specific VMR technology, WhatsApp)." /> 302 <comment value="As this type defines what the virtual service is, it then defines what address and additional information might be relevant. Some profiles could be used for specific types to define what the other values could/should be." /> 303 <min value="0" /> 304 <max value="1" /> 305 <type> 306 <code value="Coding" /> 307 </type> 308 <isSummary value="true" /> 309 <binding> 310 <extension url="http://hl7.org/fhir/tools/StructureDefinition/binding-definition"> 311 <valueString value="The purpose for which an extended contact detail should be used." /> 312 </extension> 313 <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> 314 <valueString value="VirtualServiceType" /> 315 </extension> 316 <strength value="example" /> 317 <description value="The purpose for which an extended contact detail should be used." /> 318 <valueSet value="http://hl7.org/fhir/ValueSet/virtual-service-type" /> 319 </binding> 320 </element> 321 <element id="VirtualServiceDetail.address[x]"> 322 <path value="VirtualServiceDetail.address[x]" /> 323 <short value="Contact address/number" /> 324 <definition value="What address or number needs to be used for a user to connect to the virtual service to join. The channelType informs as to which datatype is appropriate to use (requires knowledge of the specific type)." /> 325 <min value="0" /> 326 <max value="1" /> 327 <type> 328 <code value="url" /> 329 </type> 330 <type> 331 <code value="string" /> 332 </type> 333 <type> 334 <code value="ContactPoint" /> 335 </type> 336 <type> 337 <code value="ExtendedContactDetail" /> 338 </type> 339 <isSummary value="true" /> 340 </element> 341 <element id="VirtualServiceDetail.additionalInfo"> 342 <path value="VirtualServiceDetail.additionalInfo" /> 343 <short value="Address to see alternative connection details" /> 344 <definition value="Address to see alternative connection details." /> 345 <comment value="This web address can be used to provide additional details on the call, such as alternative/regional call in numbers, or other associated services." /> 346 <min value="0" /> 347 <max value="*" /> 348 <type> 349 <code value="url" /> 350 </type> 351 <isSummary value="true" /> 352 </element> 353 <element id="VirtualServiceDetail.maxParticipants"> 354 <path value="VirtualServiceDetail.maxParticipants" /> 355 <short value="Maximum number of participants supported by the virtual service" /> 356 <definition value="Maximum number of participants supported by the virtual service." /> 357 <comment value="Some services have only a limitted number of participants permitted to connect at a time, this is typically used in "shared" virtual services that you might find on location resources. Typically on-demand services might not have these restrictions." /> 358 <min value="0" /> 359 <max value="1" /> 360 <type> 361 <code value="positiveInt" /> 362 </type> 363 <isSummary value="true" /> 364 </element> 365 <element id="VirtualServiceDetail.sessionKey"> 366 <path value="VirtualServiceDetail.sessionKey" /> 367 <short value="Session Key required by the virtual service" /> 368 <definition value="Session Key required by the virtual service." /> 369 <comment value="Some services require a session key to be able to access the service once connected. This could be in cases where a shared number is used, and a session key is added to put into a private line, or to identify the participant in a call." /> 370 <min value="0" /> 371 <max value="1" /> 372 <type> 373 <code value="string" /> 374 </type> 375 <isSummary value="true" /> 376 </element> 377 </differential> 378 </StructureDefinition>