Connectathon 11 Snapshot

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

4.17.4 Resource OrderSet - Detailed Descriptions

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.

Control1..1
OrderSet.identifier
Definition

A logical identifier for the module such as the CMS or NQF identifiers for a measure artifact.

NoteThis is a business identifer, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Summarytrue
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.

NoteThis is a business versionId, not a resource identifier (see discussion)
Control0..1
Typestring
Summarytrue
OrderSet.moduleMetadata
Definition

A reference to a ModuleMetadata resource containing metadata for the orderset.

Control0..1
TypeReference(ModuleMetadata)
OrderSet.library
Definition

A reference to a Library resource containing any formal logic used by the orderset.

Control0..*
TypeReference(Library)
OrderSet.item
Definition

The definition of the items that make up the orderset.

Control0..*
OrderSet.item.identifier
Definition

A unique identifier for the item.

NoteThis is a business identifer, not a resource identifier (see discussion)
Control0..1
TypeIdentifier
OrderSet.item.number
Definition

A user-visible number for the item.

Control0..1
Typestring
OrderSet.item.title
Definition

The title of the item.

Control0..1
Typestring
OrderSet.item.description
Definition

A short description of the item.

Control0..1
Typestring
OrderSet.item.textEquivalent
Definition

A text equivalent of the item in the orderset.

Control0..1
Typestring
OrderSet.item.supportingEvidence
Definition

Supporting evidence for the item.

Control0..*
TypeAttachment
OrderSet.item.documentation
Definition

Supporting documentation for the item.

Control0..*
TypeAttachment
OrderSet.item.participantType
Definition

The type of participant in the item.

Control0..*
BindingOrderSetParticipantType: The type of participant for an action in the orderset (Required)
Typecode
OrderSet.item.concept
Definition

Concepts associated with the item.

Control0..*
TypeCodeableConcept
OrderSet.item.type
Definition

The type of item (create, update, remove).

Control0..1
BindingOrderSetItemType: The type of orderset item (Extensible)
Typecode
OrderSet.item.groupingBehavior
Definition

Defines organization behavior of a group: gives the reason why the items are grouped together.

Control0..1
BindingOrderSetItemGroupingBehavior: Defines organization behavior of a group (Required)
Typecode
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.

Control0..1
BindingOrderSetItemSelectionBehavior: Defines selection behavior of a group (Required)
Typecode
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.

Control0..1
BindingOrderSetItemRequiredBehavior: Defines requiredness behavior for selecting an action or an action group (Required)
Typecode
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.

Control0..1
BindingOrderSetItemPrecheckBehavior: Defines selection frequency behavior for an action or group (Required)
Typecode
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.

Control0..1
BindingOrderSetItemCardinalityBehavior: Defines behavior for an action or a group for how many times that item may be repeated (Required)
Typecode
OrderSet.item.resource
Definition

The resource that is the target of the item (e.g. CommunicationRequest).

Control0..1
TypeReference(Any)
OrderSet.item.customization
Definition

Customizations that should be applied to the statically defined resource.

Control0..*
OrderSet.item.customization.path
Definition

The path to the element to be customized.

Control1..1
Typestring
OrderSet.item.customization.expression
Definition

An expression specifying the value of the customized element.

Control1..1
Typestring
OrderSet.item.items
Definition

Sub items for the orderable.

Control0..*
TypeSee OrderSet.item