GAO Ballot Package

This page is part of the FHIR Specification (v1.1.0: STU 3 Ballot 1). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

This is a frozen snapshot of the FHIR specification created for the purpose of balloting the GAO implementation Guide. It includes draft changes that may be part of the future DSTU 2.1 release but further change is expected. Readers should focus solely on the GAO implementation content, and FHIR DSTU 2 for other purposes.

4.17 Resource OrderSet - Content

Clinical Decision Support Work GroupMaturity Level: 0Compartments: Not linked to any defined compartments

This resource allows for the definition of an order set as a sharable, consumable, and executable artifact in support of clinical decision support.

4.17.1 Scope and Usage

Todo

4.17.2 Resource Content

Structure

UML Diagram

OrderSet (DomainResource)A logical identifier for the module such as the CMS or NQF identifiers for a measure artifactidentifier : Identifier [0..*]The version of the module, if any. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge modules, refer to the Decision Support Service specificationversion : string [0..1]A reference to a ModuleMetadata resource containing metadata for the ordersetmoduleMetadata : Reference [0..1] « ModuleMetadata »A reference to a Library resource containing any formal logic used by the ordersetlibrary : Reference [0..*] « Library »ItemA unique identifier for the itemidentifier : Identifier [0..1]A user-visible number for the itemnumber : string [0..1]The title of the itemtitle : string [0..1]A short description of the itemdescription : string [0..1]A text equivalent of the item in the ordersettextEquivalent : string [0..1]Supporting evidence for the itemsupportingEvidence : Attachment [0..*]Supporting documentation for the itemdocumentation : Attachment [0..*]The type of participant in the itemparticipantType : code [0..*] « The type of participant for an action in the orderset (Strength=Required)OrderSetParticipantType! »Concepts associated with the itemconcept : CodeableConcept [0..*]The type of item (create, update, remove)type : code [0..1] « The type of orderset item (Strength=Extensible)OrderSetItemType+ »Defines organization behavior of a group: gives the reason why the items are grouped togethergroupingBehavior : code [0..1] « Defines organization behavior of a group (Strength=Required)OrderSetItemGroupingBehavior! »Defines selection behavior of a group: specifies the number of selectable items in the group that may be selected by the end user when the items of the group are displayedselectionBehavior : code [0..1] « Defines selection behavior of a group (Strength=Required)OrderSetItemSelectionBehavior! »Defines requiredness behavior for selecting an action or an action group; i.e., whether the action or action group is required or optionalrequiredBehavior : code [0..1] « Defines requiredness behavior for selecting an action or an action group (Strength=Required)OrderSetItemRequiredBehavior! »Defines selection frequency behavior for an action or group; i.e., for most frequently selected items, the end-user system may provide convenience options in the UI (such as pre-selection) in order to (1) communicate to the end user what the most frequently selected item is, or should, be in a particular context, and (2) save the end user timeprecheckBehavior : code [0..1] « Defines selection frequency behavior for an action or group (Strength=Required)OrderSetItemPrecheckBehavior! »Defines behavior for an action or a group for how many times that item may be repeated, i.e., cardinality. For example, if a user is documenting lesions, the lesion element may be repeated several times, once for each occurrence of a lesion on the patient or tissue sample or imagecardinalityBehavior : code [0..1] « Defines behavior for an action or a group for how many times that item may be repeated (Strength=Required)OrderSetItemCardinalityBehavi...! »The resource that is the target of the item (e.g. CommunicationRequest)resource : Reference [0..1] « Any »CustomizationThe path to the element to be customizedpath : string [1..1]An expression specifying the value of the customized elementexpression : string [1..1]Customizations that should be applied to the statically defined resourcecustomization[0..*]Sub items for the orderableitems[0..*]The definition of the items that make up the ordersetitem[0..*]

XML Template

<OrderSet xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Logical identifier --></identifier>
 <version value="[string]"/><!-- 0..1 The version of the module, if any -->
 <moduleMetadata><!-- 0..1 Reference(ModuleMetadata) The metadata for the orderset --></moduleMetadata>
 <library><!-- 0..* Reference(Library) Logic used by the orderset --></library>
 <item>  <!-- 0..* -->
  <identifier><!-- 0..1 Identifier  --></identifier>
  <number value="[string]"/><!-- 0..1  -->
  <title value="[string]"/><!-- 0..1  -->
  <description value="[string]"/><!-- 0..1  -->
  <textEquivalent value="[string]"/><!-- 0..1  -->
  <supportingEvidence><!-- 0..* Attachment  --></supportingEvidence>
  <documentation><!-- 0..* Attachment  --></documentation>
  <participantType value="[code]"/><!-- 0..* patient | person | practitioner | related-person -->
  <concept><!-- 0..* CodeableConcept  --></concept>
  <type value="[code]"/><!-- 0..1 create | update | remove | fire-event -->
  <groupingBehavior value="[code]"/><!-- 0..1 visual-group | logical-group | sentence-group -->
  <selectionBehavior value="[code]"/><!-- 0..1 any | all | all-or-none | exactly-one | at-most-one | one-or-more -->
  <requiredBehavior value="[code]"/><!-- 0..1 must | could | must-unless-documented -->
  <precheckBehavior value="[code]"/><!-- 0..1 yes | no -->
  <cardinalityBehavior value="[code]"/><!-- 0..1 single | multiple -->
  <resource><!-- 0..1 Reference(Any)  --></resource>
  <customization>  <!-- 0..* -->
   <path value="[string]"/><!-- 1..1  -->
   <expression value="[string]"/><!-- 1..1  -->
  </customization>
  <items><!-- 0..* Content as for OrderSet.item  --></items>
 </item>
</OrderSet>

Structure

UML Diagram

OrderSet (DomainResource)A logical identifier for the module such as the CMS or NQF identifiers for a measure artifactidentifier : Identifier [0..*]The version of the module, if any. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge modules, refer to the Decision Support Service specificationversion : string [0..1]A reference to a ModuleMetadata resource containing metadata for the ordersetmoduleMetadata : Reference [0..1] « ModuleMetadata »A reference to a Library resource containing any formal logic used by the ordersetlibrary : Reference [0..*] « Library »ItemA unique identifier for the itemidentifier : Identifier [0..1]A user-visible number for the itemnumber : string [0..1]The title of the itemtitle : string [0..1]A short description of the itemdescription : string [0..1]A text equivalent of the item in the ordersettextEquivalent : string [0..1]Supporting evidence for the itemsupportingEvidence : Attachment [0..*]Supporting documentation for the itemdocumentation : Attachment [0..*]The type of participant in the itemparticipantType : code [0..*] « The type of participant for an action in the orderset (Strength=Required)OrderSetParticipantType! »Concepts associated with the itemconcept : CodeableConcept [0..*]The type of item (create, update, remove)type : code [0..1] « The type of orderset item (Strength=Extensible)OrderSetItemType+ »Defines organization behavior of a group: gives the reason why the items are grouped togethergroupingBehavior : code [0..1] « Defines organization behavior of a group (Strength=Required)OrderSetItemGroupingBehavior! »Defines selection behavior of a group: specifies the number of selectable items in the group that may be selected by the end user when the items of the group are displayedselectionBehavior : code [0..1] « Defines selection behavior of a group (Strength=Required)OrderSetItemSelectionBehavior! »Defines requiredness behavior for selecting an action or an action group; i.e., whether the action or action group is required or optionalrequiredBehavior : code [0..1] « Defines requiredness behavior for selecting an action or an action group (Strength=Required)OrderSetItemRequiredBehavior! »Defines selection frequency behavior for an action or group; i.e., for most frequently selected items, the end-user system may provide convenience options in the UI (such as pre-selection) in order to (1) communicate to the end user what the most frequently selected item is, or should, be in a particular context, and (2) save the end user timeprecheckBehavior : code [0..1] « Defines selection frequency behavior for an action or group (Strength=Required)OrderSetItemPrecheckBehavior! »Defines behavior for an action or a group for how many times that item may be repeated, i.e., cardinality. For example, if a user is documenting lesions, the lesion element may be repeated several times, once for each occurrence of a lesion on the patient or tissue sample or imagecardinalityBehavior : code [0..1] « Defines behavior for an action or a group for how many times that item may be repeated (Strength=Required)OrderSetItemCardinalityBehavi...! »The resource that is the target of the item (e.g. CommunicationRequest)resource : Reference [0..1] « Any »CustomizationThe path to the element to be customizedpath : string [1..1]An expression specifying the value of the customized elementexpression : string [1..1]Customizations that should be applied to the statically defined resourcecustomization[0..*]Sub items for the orderableitems[0..*]The definition of the items that make up the ordersetitem[0..*]

XML Template

<OrderSet xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier Logical identifier --></identifier>
 <version value="[string]"/><!-- 0..1 The version of the module, if any -->
 <moduleMetadata><!-- 0..1 Reference(ModuleMetadata) The metadata for the orderset --></moduleMetadata>
 <library><!-- 0..* Reference(Library) Logic used by the orderset --></library>
 <item>  <!-- 0..* -->
  <identifier><!-- 0..1 Identifier  --></identifier>
  <number value="[string]"/><!-- 0..1  -->
  <title value="[string]"/><!-- 0..1  -->
  <description value="[string]"/><!-- 0..1  -->
  <textEquivalent value="[string]"/><!-- 0..1  -->
  <supportingEvidence><!-- 0..* Attachment  --></supportingEvidence>
  <documentation><!-- 0..* Attachment  --></documentation>
  <participantType value="[code]"/><!-- 0..* patient | person | practitioner | related-person -->
  <concept><!-- 0..* CodeableConcept  --></concept>
  <type value="[code]"/><!-- 0..1 create | update | remove | fire-event -->
  <groupingBehavior value="[code]"/><!-- 0..1 visual-group | logical-group | sentence-group -->
  <selectionBehavior value="[code]"/><!-- 0..1 any | all | all-or-none | exactly-one | at-most-one | one-or-more -->
  <requiredBehavior value="[code]"/><!-- 0..1 must | could | must-unless-documented -->
  <precheckBehavior value="[code]"/><!-- 0..1 yes | no -->
  <cardinalityBehavior value="[code]"/><!-- 0..1 single | multiple -->
  <resource><!-- 0..1 Reference(Any)  --></resource>
  <customization>  <!-- 0..* -->
   <path value="[string]"/><!-- 1..1  -->
   <expression value="[string]"/><!-- 1..1  -->
  </customization>
  <items><!-- 0..* Content as for OrderSet.item  --></items>
 </item>
</OrderSet>

 

Alternate definitions: Schema/Schematron, Resource Profile (XML, JSON), Questionnaire

4.17.2.1 Terminology Bindings

PathDefinitionTypeReference
OrderSet.item.participantType The type of participant for an action in the ordersetRequiredOrderSetParticipantType
OrderSet.item.type The type of orderset itemExtensibleOrderSetItemType
OrderSet.item.groupingBehavior Defines organization behavior of a groupRequiredOrderSetItemGroupingBehavior
OrderSet.item.selectionBehavior Defines selection behavior of a groupRequiredOrderSetItemSelectionBehavior
OrderSet.item.requiredBehavior Defines requiredness behavior for selecting an action or an action groupRequiredOrderSetItemRequiredBehavior
OrderSet.item.precheckBehavior Defines selection frequency behavior for an action or groupRequiredOrderSetItemPrecheckBehavior
OrderSet.item.cardinalityBehavior Defines behavior for an action or a group for how many times that item may be repeatedRequiredOrderSetItemCardinalityBehavior