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.
Detailed Descriptions for the elements in the OrderSet resource.
OrderSet | |
Definition | This resource allows for the definition of an order set as a sharable, consumable, and executable artifact in support of clinical decision support. |
Control | 1..1 |
OrderSet.identifier | |
Definition | A logical identifier for the module such as the CMS or NQF identifiers for a measure artifact. |
Note | This is a business identifer, not a resource identifier (see discussion) |
Control | 0..* |
Type | Identifier |
Summary | true |
OrderSet.version | |
Definition | 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 specification. |
Note | This is a business versionId, not a resource identifier (see discussion) |
Control | 0..1 |
Type | string |
Summary | true |
OrderSet.moduleMetadata | |
Definition | A reference to a ModuleMetadata resource containing metadata for the orderset. |
Control | 0..1 |
Type | Reference(ModuleMetadata) |
OrderSet.library | |
Definition | A reference to a Library resource containing any formal logic used by the orderset. |
Control | 0..* |
Type | Reference(Library) |
OrderSet.item | |
Definition | The definition of the items that make up the orderset. |
Control | 0..* |
OrderSet.item.identifier | |
Definition | A unique identifier for the item. |
Note | This is a business identifer, not a resource identifier (see discussion) |
Control | 0..1 |
Type | Identifier |
OrderSet.item.number | |
Definition | A user-visible number for the item. |
Control | 0..1 |
Type | string |
OrderSet.item.title | |
Definition | The title of the item. |
Control | 0..1 |
Type | string |
OrderSet.item.description | |
Definition | A short description of the item. |
Control | 0..1 |
Type | string |
OrderSet.item.textEquivalent | |
Definition | A text equivalent of the item in the orderset. |
Control | 0..1 |
Type | string |
OrderSet.item.supportingEvidence | |
Definition | Supporting evidence for the item. |
Control | 0..* |
Type | Attachment |
OrderSet.item.documentation | |
Definition | Supporting documentation for the item. |
Control | 0..* |
Type | Attachment |
OrderSet.item.participantType | |
Definition | The type of participant in the item. |
Control | 0..* |
Binding | OrderSetParticipantType: The type of participant for an action in the orderset (Required) |
Type | code |
OrderSet.item.concept | |
Definition | Concepts associated with the item. |
Control | 0..* |
Type | CodeableConcept |
OrderSet.item.type | |
Definition | The type of item (create, update, remove). |
Control | 0..1 |
Binding | OrderSetItemType: The type of orderset item (Extensible) |
Type | code |
OrderSet.item.groupingBehavior | |
Definition | Defines organization behavior of a group: gives the reason why the items are grouped together. |
Control | 0..1 |
Binding | OrderSetItemGroupingBehavior: Defines organization behavior of a group (Required) |
Type | code |
OrderSet.item.selectionBehavior | |
Definition | 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 displayed. |
Control | 0..1 |
Binding | OrderSetItemSelectionBehavior: Defines selection behavior of a group (Required) |
Type | code |
OrderSet.item.requiredBehavior | |
Definition | Defines requiredness behavior for selecting an action or an action group; i.e., whether the action or action group is required or optional. |
Control | 0..1 |
Binding | OrderSetItemRequiredBehavior: Defines requiredness behavior for selecting an action or an action group (Required) |
Type | code |
OrderSet.item.precheckBehavior | |
Definition | 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 time. |
Control | 0..1 |
Binding | OrderSetItemPrecheckBehavior: Defines selection frequency behavior for an action or group (Required) |
Type | code |
OrderSet.item.cardinalityBehavior | |
Definition | 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 image. |
Control | 0..1 |
Binding | OrderSetItemCardinalityBehavior: Defines behavior for an action or a group for how many times that item may be repeated (Required) |
Type | code |
OrderSet.item.resource | |
Definition | The resource that is the target of the item (e.g. CommunicationRequest). |
Control | 0..1 |
Type | Reference(Any) |
OrderSet.item.customization | |
Definition | Customizations that should be applied to the statically defined resource. |
Control | 0..* |
OrderSet.item.customization.path | |
Definition | The path to the element to be customized. |
Control | 1..1 |
Type | string |
OrderSet.item.customization.expression | |
Definition | An expression specifying the value of the customized element. |
Control | 1..1 |
Type | string |
OrderSet.item.items | |
Definition | Sub items for the orderable. |
Control | 0..* |
Type | See OrderSet.item |