CRD CDS Hooks Specific Context for order-select (Logical Definition) - XML Representation - Da Vinci - Coverage Requirements Discovery v2.2.0-ballot

Da Vinci - Coverage Requirements Discovery
2.2.0-ballot - STU 2.2 Ballot United States of America flag
This page is part of the Da Vinci Coverage Requirements Discovery (CRD) FHIR IG (v2.2.0-ballot: STU 2.2 Ballot) based on FHIR (HL7® FHIR® Standard) R4. This version is a pre-release. The current official version is 2.1.0. For a full list of available versions, see the Directory of published versions
Logical Model: CRDOrderSelectContext - XML Profile

Page standards status: Informative
XML representation of the CRDOrderSelectContext logical model.
Raw xml | Download

<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="CRDOrderSelectContext"/>
  <text>
    <status value="extensions"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: StructureDefinition CRDOrderSelectContext</b></p><a name="CRDOrderSelectContext"> </a><a name="hcCRDOrderSelectContext"> </a><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 : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom: 3px" 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 : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom: 3px" 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 : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom: 3px" class="hierarchy"><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Minimum and Maximum # of times the element can appear in the instance">Card.</a></th><th style="vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom: 3px; 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 : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; padding-top: 3px; padding-bottom: 3px" class="hierarchy"><a href="https://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#table-views" title="Additional information about the element">Description &amp; 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 : var(--ig-left,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-CRDOrderSelectContext-definitions.html#CDSHookOrderSelectContext">CDSHookOrderSelectContext</a><a name="CDSHookOrderSelectContext"> </a></td><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.5">0</span><span style="opacity: 0.5">..</span><span style="opacity: 0.5">*</span></td><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/tools/0.8.0/StructureDefinition-CDSHookOrderSelectContext.html">CDSHookOrderSelectContext</a></td><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><br/>Elements defined in Ancestors:<a href="http://hl7.org/fhir/tools/0.8.0/StructureDefinition-CDSHookOrderSelectContext.html" title="For this hook, the user is expected to be of type Practitioner, PractitionerRole, Patient, or RelatedPerson. Patient or RelatedPerson are appropriate when a patient or their proxy are viewing the record. For example, Practitioner/abc or Patient/123.">userId</a>, <a href="http://hl7.org/fhir/tools/0.8.0/StructureDefinition-CDSHookOrderSelectContext.html" title="The FHIR Patient.id of the current patient in context">patientId</a>, <a href="http://hl7.org/fhir/tools/0.8.0/StructureDefinition-CDSHookOrderSelectContext.html" title="The FHIR Encounter.id of the current encounter in context">encounterId</a>, <a href="http://hl7.org/fhir/tools/0.8.0/StructureDefinition-CDSHookOrderSelectContext.html" title="The selections field references FHIR resources in the draftOrders Bundle. For example, MedicationRequest/103">selections</a>, <a href="http://hl7.org/fhir/tools/0.8.0/StructureDefinition-CDSHookOrderSelectContext.html" title="FHIR Bundle of MedicationRequest, NutritionOrder, ServiceRequest, VisionPrescription with draft status">draftOrders</a><br/><span style="opacity: 0.5">The context for the order-select hook</span></td></tr>
<tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: #F7F7F7"><td style="vertical-align: top; text-align : var(--ig-left,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_resource.png" alt="." style="background-color: #F7F7F7; background-color: inherit" title="Resource" class="hierarchy"/> <a href="StructureDefinition-CRDOrderSelectContext-definitions.html#CDSHookOrderSelectContext.draftOrders">draftOrders</a><a name="CDSHookOrderSelectContext.draftOrders"> </a></td><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.5">1</span><span style="opacity: 0.5">..</span><span style="opacity: 0.5">1</span></td><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="StructureDefinition-profile-bundle-request.html" title="Bundle">CRDRequestBundle</a></td><td style="vertical-align: top; text-align : var(--ig-left,left); background-color: #F7F7F7; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.5">Contains a collection of resources</span></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/tools/StructureDefinition/json-suppress-resourcetype">
    <valueBoolean value="true"/>
  </extension>
  <extension
             url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
    <valueCode value="fm"/>
  </extension>
  <extension
             url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
    <valueCode value="informative">
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom">
        <valueCanonical
                        value="http://hl7.org/fhir/us/davinci-crd/ImplementationGuide/davinci-crd"/>
      </extension>
    </valueCode>
  </extension>
  <url
       value="http://hl7.org/fhir/us/davinci-crd/StructureDefinition/CRDOrderSelectContext"/>
  <identifier>
    <system value="urn:ietf:rfc:3986"/>
    <value value="urn:oid:2.16.840.1.113883.4.642.40.18.42.39"/>
  </identifier>
  <version value="2.2.0-ballot"/>
  <name value="CRDOrderSelectContext"/>
  <title
         value="CRD CDS Hooks Specific Context for order-select (Logical Definition)"/>
  <status value="draft"/>
  <experimental value="true"/>
  <date value="2025-08-06T17:27:13+00:00"/>
  <publisher value="HL7 International / Financial Management"/>
  <contact>
    <telecom>
      <system value="url"/>
      <value value="http://www.hl7.org/Special/committees/fm"/>
    </telecom>
  </contact>
  <description
               value="CRD-specific constraints on the order-select CDS Hook context"/>
  <jurisdiction>
    <coding>
      <system value="urn:iso:std:iso:3166"/>
      <code value="US"/>
    </coding>
  </jurisdiction>
  <fhirVersion value="4.0.1"/>
  <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/CDSHookOrderSelectContext"/>
  <baseDefinition
                  value="http://hl7.org/fhir/tools/StructureDefinition/CDSHookOrderSelectContext"/>
  <derivation value="constraint"/>
  <snapshot>
    <extension
               url="http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version">
      <valueString value="0.8.0"/>
    </extension>
    <element id="CDSHookOrderSelectContext">
      <path value="CDSHookOrderSelectContext"/>
      <short value="The context for the order-select hook"/>
      <definition value="The context (hook specific)"/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="Base"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <isModifier value="false"/>
    </element>
    <element id="CDSHookOrderSelectContext.userId">
      <path value="CDSHookOrderSelectContext.userId"/>
      <short
             value="The id of the current user. Must be in the format [ResourceType]/[id]."/>
      <definition
                  value="For this hook, the user is expected to be of type Practitioner, PractitionerRole, Patient, or RelatedPerson. Patient or RelatedPerson are appropriate when a patient or their proxy are viewing the record. For example, Practitioner/abc or Patient/123."/>
      <min value="1"/>
      <max value="1"/>
      <base>
        <path value="CDSHookOrderSelectContext.userId"/>
        <min value="1"/>
        <max value="1"/>
      </base>
      <type>
        <code value="url"/>
      </type>
    </element>
    <element id="CDSHookOrderSelectContext.patientId">
      <path value="CDSHookOrderSelectContext.patientId"/>
      <short value="The FHIR Patient.id of the current patient in context"/>
      <definition
                  value="The FHIR Patient.id of the current patient in context"/>
      <min value="1"/>
      <max value="1"/>
      <base>
        <path value="CDSHookOrderSelectContext.patientId"/>
        <min value="1"/>
        <max value="1"/>
      </base>
      <type>
        <code value="id"/>
      </type>
    </element>
    <element id="CDSHookOrderSelectContext.encounterId">
      <path value="CDSHookOrderSelectContext.encounterId"/>
      <short
             value="The FHIR Encounter.id of the current encounter in context"/>
      <definition
                  value="The FHIR Encounter.id of the current encounter in context"/>
      <min value="0"/>
      <max value="1"/>
      <base>
        <path value="CDSHookOrderSelectContext.encounterId"/>
        <min value="0"/>
        <max value="1"/>
      </base>
      <type>
        <code value="id"/>
      </type>
    </element>
    <element id="CDSHookOrderSelectContext.selections">
      <path value="CDSHookOrderSelectContext.selections"/>
      <short value="The FHIR ids of the newly selected order(s)"/>
      <definition
                  value="The selections field references FHIR resources in the draftOrders Bundle. For example, MedicationRequest/103"/>
      <min value="0"/>
      <max value="*"/>
      <base>
        <path value="CDSHookOrderSelectContext.selections"/>
        <min value="0"/>
        <max value="*"/>
      </base>
      <type>
        <code value="uri"/>
      </type>
      <constraint>
        <key value="ord-1"/>
        <severity value="error"/>
        <human value="Must be in the format {type}/{id}"/>
        <expression value="value.matches('^[\\d\\w]+\\/[\\d\\w-.]+$')"/>
        <source
                value="http://hl7.org/fhir/tools/StructureDefinition/CDSHookOrderSelectContext"/>
      </constraint>
    </element>
    <element id="CDSHookOrderSelectContext.draftOrders">
      <extension
                 url="http://hl7.org/fhir/tools/StructureDefinition/id-expectation">
        <valueCode value="optional"/>
      </extension>
      <path value="CDSHookOrderSelectContext.draftOrders"/>
      <short value="Contains a collection of resources"/>
      <definition value="A container for a collection of resources."/>
      <min value="1"/>
      <max value="1"/>
      <base>
        <path value="CDSHookOrderSelectContext.draftOrders"/>
        <min value="1"/>
        <max value="1"/>
      </base>
      <type>
        <code value="Bundle"/>
        <profile
                 value="http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-bundle-request"/>
      </type>
      <mapping>
        <identity value="rim"/>
        <map value="Entity. Role, or Act"/>
      </mapping>
      <mapping>
        <identity value="v2"/>
        <map value="N/A"/>
      </mapping>
      <mapping>
        <identity value="rim"/>
        <map value="N/A"/>
      </mapping>
      <mapping>
        <identity value="cda"/>
        <map value="ClinicalDocument, if bundle.type = document"/>
      </mapping>
    </element>
  </snapshot>
  <differential>
    <element id="CDSHookOrderSelectContext">
      <path value="CDSHookOrderSelectContext"/>
    </element>
    <element id="CDSHookOrderSelectContext.draftOrders">
      <path value="CDSHookOrderSelectContext.draftOrders"/>
      <type>
        <code value="Bundle"/>
        <profile
                 value="http://hl7.org/fhir/us/davinci-crd/StructureDefinition/profile-bundle-request"/>
      </type>
    </element>
  </differential>
</StructureDefinition>
<prev
top
next>
IG © 2019+ HL7 International / Financial Management. Package hl7.fhir.us.davinci-crd#2.2.0-ballot based on FHIR 4.0.1. Generated 2025-08-06
Links: Table of Contents | QA Report | Version History | | Propose a change