This page is part of the HL7 Tools Extension IG (v0.1.0: Releases - Informative) based on FHIR (HL7® FHIR® Standard) v5.0.0. . For a full list of available versions, see the Directory of published versions
Draft as of 2023-12-19 | Maturity Level: 2 |
XML representation of the CDSHooksExtension-DaVinci-configoptions logical model.
<StructureDefinition xmlns="http://hl7.org/fhir">
<id value="CDSHooksExtension-DaVinci-configoptions"/>
<text>
<status value="extensions"/>
<div xmlns="http://www.w3.org/1999/xhtml"><table border="0" cellpadding="0" cellspacing="0" style="border: 0px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top;"><tr style="border: 1px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top"><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="The logical name of the element">Name</a></th><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Information about the use of the element">Flags</a></th><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Minimum and Maximum # of times the the element can appear in the instance">Card.</a></th><th style="width: 100px" class="hierarchy"><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Reference to the type of the element">Type</a></th><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Additional information about the element">Description & Constraints</a><span style="float: right"><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Legend for this format"><img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3goXBCwdPqAP0wAAAldJREFUOMuNk0tIlFEYhp9z/vE2jHkhxXA0zJCMitrUQlq4lnSltEqCFhFG2MJFhIvIFpkEWaTQqjaWZRkp0g26URZkTpbaaOJkDqk10szoODP//7XIMUe0elcfnPd9zsfLOYplGrpRwZaqTtw3K7PtGem7Q6FoidbGgqHVy/HRb669R+56zx7eRV1L31JGxYbBtjKK93cxeqfyQHbehkZbUkK20goELEuIzEd+dHS+qz/Y8PTSif0FnGkbiwcAjHaU1+QWOptFiyCLp/LnKptpqIuXHx6rbR26kJcBX3yLgBfnd7CxwJmflpP2wUg0HIAoUUpZBmKzELGWcN8nAr6Gpu7tLU/CkwAaoKTWRSQyt89Q8w6J+oVQkKnBoblH7V0PPvUOvDYXfopE/SJmALsxnVm6LbkotrUtNowMeIrVrBcBpaMmdS0j9df7abpSuy7HWehwJdt1lhVwi/J58U5beXGAF6c3UXLycw1wdFklArBn87xdh0ZsZtArghBdAA3+OEDVubG4UEzP6x1FOWneHh2VDAHBAt80IbdXDcesNoCvs3E5AFyNSU5nbrDPZpcUEQQTFZiEVx+51fxMhhyJEAgvlriadIJZZksRuwBYMOPBbO3hePVVqgEJhFeUuFLhIPkRP6BQLIBrmMenujm/3g4zc398awIe90Zb5A1vREALqneMcYgP/xVQWlG+Ncu5vgwwlaUNx+3799rfe96u9K0JSDXcOzOTJg4B6IgmXfsygc7/Bvg9g9E58/cDVmGIBOP/zT8Bz1zqWqpbXIsd0O9hajXfL6u4BaOS6SeWAAAAAElFTkSuQmCC" alt="doco" style="background-color: inherit"/></a></span></th></tr><tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck1.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-CDSHooksExtension-DaVinci-configoptions-definitions.html#DaVinciConfigOptions" title="The context for the patient-view hook">DaVinciConfigOptions</a><a name="DaVinciConfigOptions"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">0..*</td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/R5/types.html#Base">Base</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">The context for the patient-view hook<br/><span style="font-weight:bold">JSON Property Name for Type: </span><code>davinci-crd.configuration-options-test</code><br/><span style="font-weight:bold">Instances of this logical model are not marked to be the target of a Reference</span><br/></td></tr>
<tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7"><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_primitive.png" alt="." style="background-color: #F7F7F7; background-color: inherit" title="Primitive Data Type" class="hierarchy"/> <a href="StructureDefinition-CDSHooksExtension-DaVinci-configoptions-definitions.html#DaVinciConfigOptions.code" title="A code that will be used when setting configuration during hook invocation, and has an (extensible) binding to the CRD Card Types ValueSet.">code</a><a name="DaVinciConfigOptions.code"> </a></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">1..1</td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/R5/datatypes.html#code">code</a></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">Identifies the setting configuration when hook is invoked</td></tr>
<tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_primitive.png" alt="." style="background-color: white; background-color: inherit" title="Primitive Data Type" class="hierarchy"/> <a href="StructureDefinition-CDSHooksExtension-DaVinci-configoptions-definitions.html#DaVinciConfigOptions.type" title="A data type for the parameter. At present, allowed values are “boolean” and “integer”">type</a><a name="DaVinciConfigOptions.type"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">1..1</td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/R5/datatypes.html#code">code</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">boolean | integer (JSON types)</td></tr>
<tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7"><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_primitive.png" alt="." style="background-color: #F7F7F7; background-color: inherit" title="Primitive Data Type" class="hierarchy"/> <a href="StructureDefinition-CDSHooksExtension-DaVinci-configoptions-definitions.html#DaVinciConfigOptions.name" title="A display name for the configuration option to appear in the client’s user interface when performing configuration">name</a><a name="DaVinciConfigOptions.name"> </a></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">1..1</td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/R5/datatypes.html#string">string</a></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">A display name for the configuration option</td></tr>
<tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_primitive.png" alt="." style="background-color: white; background-color: inherit" title="Primitive Data Type" class="hierarchy"/> <a href="StructureDefinition-CDSHooksExtension-DaVinci-configoptions-definitions.html#DaVinciConfigOptions.description" title="A description providing a 1-2 sentence description of the effect of the configuration option">description</a><a name="DaVinciConfigOptions.description"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">1..1</td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/R5/datatypes.html#string">string</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">1-2 sentences - the effect of the configuration option</td></tr>
<tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7"><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck00.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin_end.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_choice.gif" alt="." style="background-color: #F7F7F7; background-color: inherit" title="Choice of Types" class="hierarchy"/> <a href="StructureDefinition-CDSHooksExtension-DaVinci-configoptions-definitions.html#DaVinciConfigOptions.default" title="A default value SHOULD also be provided to show users what to expect when an override is not specified">default</a><a name="DaVinciConfigOptions.default"> </a></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">0..1</td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/R5/datatypes.html#integer">integer</a>, <a href="http://hl7.org/fhir/R5/datatypes.html#boolean">boolean</a></td><td style="vertical-align: top; text-align : left; background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">Shows users what to expect when an override is not specified<br/>JSON: The type of this element is inferred from the JSON type in the instance</td></tr>
<tr><td colspan="5" class="hierarchy"><br/><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Legend for this format"><img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3goXBCwdPqAP0wAAAldJREFUOMuNk0tIlFEYhp9z/vE2jHkhxXA0zJCMitrUQlq4lnSltEqCFhFG2MJFhIvIFpkEWaTQqjaWZRkp0g26URZkTpbaaOJkDqk10szoODP//7XIMUe0elcfnPd9zsfLOYplGrpRwZaqTtw3K7PtGem7Q6FoidbGgqHVy/HRb669R+56zx7eRV1L31JGxYbBtjKK93cxeqfyQHbehkZbUkK20goELEuIzEd+dHS+qz/Y8PTSif0FnGkbiwcAjHaU1+QWOptFiyCLp/LnKptpqIuXHx6rbR26kJcBX3yLgBfnd7CxwJmflpP2wUg0HIAoUUpZBmKzELGWcN8nAr6Gpu7tLU/CkwAaoKTWRSQyt89Q8w6J+oVQkKnBoblH7V0PPvUOvDYXfopE/SJmALsxnVm6LbkotrUtNowMeIrVrBcBpaMmdS0j9df7abpSuy7HWehwJdt1lhVwi/J58U5beXGAF6c3UXLycw1wdFklArBn87xdh0ZsZtArghBdAA3+OEDVubG4UEzP6x1FOWneHh2VDAHBAt80IbdXDcesNoCvs3E5AFyNSU5nbrDPZpcUEQQTFZiEVx+51fxMhhyJEAgvlriadIJZZksRuwBYMOPBbO3hePVVqgEJhFeUuFLhIPkRP6BQLIBrmMenujm/3g4zc398awIe90Zb5A1vREALqneMcYgP/xVQWlG+Ncu5vgwwlaUNx+3799rfe96u9K0JSDXcOzOTJg4B6IgmXfsygc7/Bvg9g9E58/cDVmGIBOP/zT8Bz1zqWqpbXIsd0O9hajXfL6u4BaOS6SeWAAAAAElFTkSuQmCC" alt="doco" style="background-color: inherit"/> Documentation for this format</a></td></tr></table></div>
</text>
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
<valueInteger value="2"/>
</extension>
<url
value="http://hl7.org/fhir/tools/StructureDefinition/CDSHooksExtension-DaVinci-configoptions"/>
<version value="0.1.0"/>
<name value="CDSHooksExtensionDaVinciConfigOptionsTest"/>
<title
value="CDS Hook Extension Definition for DaVinci Configuration Options (Test)"/>
<status value="draft"/>
<experimental value="true"/>
<date value="2023-12-19T11:34:35+11:00"/>
<publisher value="HL7 International / FHIR Infrastructure"/>
<contact>
<telecom>
<system value="url"/>
<value value="http://hl7.org/Special/committees/fhir-i"/>
</telecom>
</contact>
<description
value="This structure is defines the CRD Configuration Options (Test only). TODO: This content will be moved to the CDS Hooks specification in the future"/>
<jurisdiction>
<coding>
<system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/>
<code value="001"/>
</coding>
</jurisdiction>
<fhirVersion value="5.0.0"/>
<mapping>
<identity value="rim"/>
<uri value="http://hl7.org/v3"/>
<name value="RIM Mapping"/>
</mapping>
<kind value="logical"/>
<abstract value="false"/>
<type
value="http://hl7.org/fhir/tools/StructureDefinition/DaVinciConfigOptions"/>
<baseDefinition value="http://hl7.org/fhir/StructureDefinition/Base"/>
<derivation value="specialization"/>
<snapshot>
<element id="DaVinciConfigOptions">
<extension
url="http://hl7.org/fhir/tools/StructureDefinition/elementdefinition-json-name">
<valueString value="davinci-crd.configuration-options-test"/>
</extension>
<path value="DaVinciConfigOptions"/>
<short value="The context for the patient-view hook"/>
<definition value="The context for the patient-view hook"/>
<min value="0"/>
<max value="*"/>
<base>
<path value="Base"/>
<min value="0"/>
<max value="*"/>
</base>
<isModifier value="false"/>
<mapping>
<identity value="rim"/>
<map value="n/a"/>
</mapping>
</element>
<element id="DaVinciConfigOptions.code">
<path value="DaVinciConfigOptions.code"/>
<short
value="Identifies the setting configuration when hook is invoked"/>
<definition
value="A code that will be used when setting configuration during hook invocation, and has an (extensible) binding to the CRD Card Types ValueSet."/>
<min value="1"/>
<max value="1"/>
<base>
<path value="DaVinciConfigOptions.code"/>
<min value="1"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
</type>
</element>
<element id="DaVinciConfigOptions.type">
<path value="DaVinciConfigOptions.type"/>
<short value="boolean | integer (JSON types)"/>
<definition
value="A data type for the parameter. At present, allowed values are “boolean” and “integer”"/>
<min value="1"/>
<max value="1"/>
<base>
<path value="DaVinciConfigOptions.type"/>
<min value="1"/>
<max value="1"/>
</base>
<type>
<code value="code"/>
</type>
</element>
<element id="DaVinciConfigOptions.name">
<path value="DaVinciConfigOptions.name"/>
<short value="A display name for the configuration option"/>
<definition
value="A display name for the configuration option to appear in the client’s user interface when performing configuration"/>
<min value="1"/>
<max value="1"/>
<base>
<path value="DaVinciConfigOptions.name"/>
<min value="1"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
</type>
</element>
<element id="DaVinciConfigOptions.description">
<path value="DaVinciConfigOptions.description"/>
<short value="1-2 sentences - the effect of the configuration option"/>
<definition
value="A description providing a 1-2 sentence description of the effect of the configuration option"/>
<min value="1"/>
<max value="1"/>
<base>
<path value="DaVinciConfigOptions.description"/>
<min value="1"/>
<max value="1"/>
</base>
<type>
<code value="string"/>
</type>
</element>
<element id="DaVinciConfigOptions.default">
<extension
url="http://hl7.org/fhir/tools/StructureDefinition/json-primitive-choice">
<valueBoolean value="true"/>
</extension>
<path value="DaVinciConfigOptions.default"/>
<short
value="Shows users what to expect when an override is not specified"/>
<definition
value="A default value SHOULD also be provided to show users what to expect when an override is not specified"/>
<min value="0"/>
<max value="1"/>
<base>
<path value="DaVinciConfigOptions.default"/>
<min value="0"/>
<max value="1"/>
</base>
<type>
<code value="integer"/>
</type>
<type>
<code value="boolean"/>
</type>
</element>
</snapshot>
<differential>
<element id="DaVinciConfigOptions">
<extension
url="http://hl7.org/fhir/tools/StructureDefinition/elementdefinition-json-name">
<valueString value="davinci-crd.configuration-options-test"/>
</extension>
<path value="DaVinciConfigOptions"/>
<short value="The context for the patient-view hook"/>
<definition value="The context for the patient-view hook"/>
<min value="0"/>
<max value="*"/>
</element>
<element id="DaVinciConfigOptions.code">
<path value="DaVinciConfigOptions.code"/>
<short
value="Identifies the setting configuration when hook is invoked"/>
<definition
value="A code that will be used when setting configuration during hook invocation, and has an (extensible) binding to the CRD Card Types ValueSet."/>
<min value="1"/>
<max value="1"/>
<type>
<code value="code"/>
</type>
</element>
<element id="DaVinciConfigOptions.type">
<path value="DaVinciConfigOptions.type"/>
<short value="boolean | integer (JSON types)"/>
<definition
value="A data type for the parameter. At present, allowed values are “boolean” and “integer”"/>
<min value="1"/>
<max value="1"/>
<type>
<code value="code"/>
</type>
</element>
<element id="DaVinciConfigOptions.name">
<path value="DaVinciConfigOptions.name"/>
<short value="A display name for the configuration option"/>
<definition
value="A display name for the configuration option to appear in the client’s user interface when performing configuration"/>
<min value="1"/>
<max value="1"/>
<type>
<code value="string"/>
</type>
</element>
<element id="DaVinciConfigOptions.description">
<path value="DaVinciConfigOptions.description"/>
<short value="1-2 sentences - the effect of the configuration option"/>
<definition
value="A description providing a 1-2 sentence description of the effect of the configuration option"/>
<min value="1"/>
<max value="1"/>
<type>
<code value="string"/>
</type>
</element>
<element id="DaVinciConfigOptions.default">
<extension
url="http://hl7.org/fhir/tools/StructureDefinition/json-primitive-choice">
<valueBoolean value="true"/>
</extension>
<path value="DaVinciConfigOptions.default"/>
<short
value="Shows users what to expect when an override is not specified"/>
<definition
value="A default value SHOULD also be provided to show users what to expect when an override is not specified"/>
<min value="0"/>
<max value="1"/>
<type>
<code value="integer"/>
</type>
<type>
<code value="boolean"/>
</type>
</element>
</differential>
</StructureDefinition>
IG © 2022+ HL7 International / FHIR Infrastructure. Package hl7.fhir.uv.tools#0.1.0 based on FHIR 5.0.0. Generated 2023-12-19
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change