Opioid Prescribing Support Implementation Guide, published by Centers for Disease Control and Prevention (CDC). This is not an authorized publication; it is the continuous build for version 1.2.3). This version is based on the current content of https://github.com/cqframework/opioid-cds/ and changes regularly. See the Directory of published versions

D.4.1 StructureDefinition: cdc-requestgroup

D.4.1.1 Formal Views of Profile Content

The official URL for this profile is:

http://fhir.org/guides/cdc/opioid-cds/StructureDefinition/cdc-requestgroup

Profile of RequestGroup for use with CDC Opioid Prescribing Guidelines

This profile builds on RequestGroup.

This profile was published on 2017-04-21 as a draft by Centers for Disease Control and Prevention.

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

This structure is derived from RequestGroup

Summary

Mandatory: 2 elements
Must-Support: 8 elements

Extensions

This structure refers to these extensions:

This structure is derived from RequestGroup

NameFlagsCard.TypeDescription & Constraintsdoco
.. RequestGroup 0..*RequestGroupA group of related requests
... action S1..*BackboneElementProposed actions, if any
.... action-indicator S1..1codeExtension
URL: http://fhir.org/guides/cdc/opioid-cds/StructureDefinition/cdc-requestgroup-action-indicator
Binding: http://fhir.org/guides/cdc/opioid-cds/ValueSet/opioidcds-indicator (required)
.... label S0..1stringUser-visible label for the action (e.g. 1. or A.)
.... title S0..1stringUser-visible title
.... description S0..1stringShort description of the action
.... documentation S0..*RelatedArtifactSupporting documentation for the intended performer of the action
.... type S0..1Codingcreate | update | remove | fire-event
.... resource S0..1Reference(Resource)The target of the action

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. RequestGroup 0..*RequestGroupA group of related requests
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible): A human language.

Additional BindingsPurpose
All LanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness identifier
... definition 0..*Reference(Resource)Instantiates protocol or definition
... basedOn 0..*Reference(Resource)Fulfills plan, proposal, or order
... replaces 0..*Reference(Resource)Request(s) replaced by this request
... groupIdentifier Σ0..1IdentifierComposite request this is part of
... status ?!Σ1..1codedraft | active | suspended | cancelled | completed | entered-in-error | unknown
Binding: RequestStatus (required): Codes identifying the stage lifecycle stage of a request

... intent ?!Σ1..1codeproposal | plan | order
Binding: RequestIntent (required): Codes indicating the degree of authority/intentionality associated with a request

... priority Σ0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request

... subject 0..1Reference(Patient | Group)Who the request group is about
... context 0..1Reference(Encounter | EpisodeOfCare)Encounter or Episode for the request group
... authoredOn 0..1dateTimeWhen the request group was authored
... author 0..1Reference(Device | Practitioner)Device or practitioner that authored the request group
... reason[x] 0..1Reason for the request group
.... reasonCodeableConceptCodeableConcept
.... reasonReferenceReference(Resource)
... note 0..*AnnotationAdditional notes about the response
... action SI1..*BackboneElementProposed actions, if any
.... id 0..1stringxml:id (or equivalent in JSON)
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... action-indicator S1..1codeExtension
URL: http://fhir.org/guides/cdc/opioid-cds/StructureDefinition/cdc-requestgroup-action-indicator
Binding: http://fhir.org/guides/cdc/opioid-cds/ValueSet/opioidcds-indicator (required)
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... label S0..1stringUser-visible label for the action (e.g. 1. or A.)
.... title S0..1stringUser-visible title
.... description SΣ0..1stringShort description of the action
.... textEquivalent Σ0..1stringStatic text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
.... code 0..*CodeableConceptCode representing the meaning of the action or sub-actions
.... documentation S0..*RelatedArtifactSupporting documentation for the intended performer of the action
.... condition 0..*BackboneElementWhether or not the action is applicable
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... kind 1..1codeapplicability | start | stop
Binding: ActionConditionKind (required): The kind of condition for the action

..... description 0..1stringNatural language description of the condition
..... language 0..1stringLanguage of the expression
..... expression 0..1stringBoolean-valued expression
.... relatedAction 0..*BackboneElementRelationship to another action
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... actionId 1..1idWhat action this is related to
..... relationship 1..1codebefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
Binding: ActionRelationshipType (required): Defines the types of relationships between actions

..... offset[x] 0..1Time offset for the relationship
...... offsetDurationDuration
...... offsetRangeRange
.... timing[x] 0..1When the action should take place
..... timingDateTimedateTime
..... timingPeriodPeriod
..... timingDurationDuration
..... timingRangeRange
..... timingTimingTiming
.... participant 0..*Reference(Patient | Person | Practitioner | RelatedPerson)Who should perform the action
.... type S0..1Codingcreate | update | remove | fire-event
Binding: ActionType (extensible): The type of action to be performed

.... groupingBehavior 0..1codevisual-group | logical-group | sentence-group
Binding: ActionGroupingBehavior (required): Defines organization behavior of a group

.... selectionBehavior 0..1codeany | all | all-or-none | exactly-one | at-most-one | one-or-more
Binding: ActionSelectionBehavior (required): Defines selection behavior of a group

.... requiredBehavior 0..1codemust | could | must-unless-documented
Binding: ActionRequiredBehavior (required): Defines requiredness behavior for selecting an action or an action group

.... precheckBehavior 0..1codeyes | no
Binding: ActionPrecheckBehavior (required): Defines selection frequency behavior for an action or group

.... cardinalityBehavior 0..1codesingle | multiple
Binding: ActionCardinalityBehavior (required): Defines behavior for an action or a group for how many times that item may be repeated

.... resource SI0..1Reference(Resource)The target of the action
.... action I0..*See action (RequestGroup)Sub action

doco Documentation for this format

This structure is derived from http://hl7.org/fhir/STU3/requestgroup.html.

Summary

Mandatory: 2 elements
Must-Support: 8 elements

Extensions

This structure refers to these extensions:

Differential View

This structure is derived from http://hl7.org/fhir/STU3/requestgroup.html.

NameFlagsCard.TypeDescription & Constraintsdoco
.. RequestGroup 0..*RequestGroupA group of related requests
... action S1..*BackboneElementProposed actions, if any
.... action-indicator S1..1codeExtension
URL: http://fhir.org/guides/cdc/opioid-cds/StructureDefinition/cdc-requestgroup-action-indicator
Binding: http://fhir.org/guides/cdc/opioid-cds/ValueSet/opioidcds-indicator (required)
.... label S0..1stringUser-visible label for the action (e.g. 1. or A.)
.... title S0..1stringUser-visible title
.... description S0..1stringShort description of the action
.... documentation S0..*RelatedArtifactSupporting documentation for the intended performer of the action
.... type S0..1Codingcreate | update | remove | fire-event
.... resource S0..1Reference(Resource)The target of the action

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. RequestGroup 0..*RequestGroupA group of related requests
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible): A human language.

Additional BindingsPurpose
All LanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness identifier
... definition 0..*Reference(Resource)Instantiates protocol or definition
... basedOn 0..*Reference(Resource)Fulfills plan, proposal, or order
... replaces 0..*Reference(Resource)Request(s) replaced by this request
... groupIdentifier Σ0..1IdentifierComposite request this is part of
... status ?!Σ1..1codedraft | active | suspended | cancelled | completed | entered-in-error | unknown
Binding: RequestStatus (required): Codes identifying the stage lifecycle stage of a request

... intent ?!Σ1..1codeproposal | plan | order
Binding: RequestIntent (required): Codes indicating the degree of authority/intentionality associated with a request

... priority Σ0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request

... subject 0..1Reference(Patient | Group)Who the request group is about
... context 0..1Reference(Encounter | EpisodeOfCare)Encounter or Episode for the request group
... authoredOn 0..1dateTimeWhen the request group was authored
... author 0..1Reference(Device | Practitioner)Device or practitioner that authored the request group
... reason[x] 0..1Reason for the request group
.... reasonCodeableConceptCodeableConcept
.... reasonReferenceReference(Resource)
... note 0..*AnnotationAdditional notes about the response
... action SI1..*BackboneElementProposed actions, if any
.... id 0..1stringxml:id (or equivalent in JSON)
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... action-indicator S1..1codeExtension
URL: http://fhir.org/guides/cdc/opioid-cds/StructureDefinition/cdc-requestgroup-action-indicator
Binding: http://fhir.org/guides/cdc/opioid-cds/ValueSet/opioidcds-indicator (required)
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... label S0..1stringUser-visible label for the action (e.g. 1. or A.)
.... title S0..1stringUser-visible title
.... description SΣ0..1stringShort description of the action
.... textEquivalent Σ0..1stringStatic text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
.... code 0..*CodeableConceptCode representing the meaning of the action or sub-actions
.... documentation S0..*RelatedArtifactSupporting documentation for the intended performer of the action
.... condition 0..*BackboneElementWhether or not the action is applicable
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... kind 1..1codeapplicability | start | stop
Binding: ActionConditionKind (required): The kind of condition for the action

..... description 0..1stringNatural language description of the condition
..... language 0..1stringLanguage of the expression
..... expression 0..1stringBoolean-valued expression
.... relatedAction 0..*BackboneElementRelationship to another action
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... actionId 1..1idWhat action this is related to
..... relationship 1..1codebefore-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
Binding: ActionRelationshipType (required): Defines the types of relationships between actions

..... offset[x] 0..1Time offset for the relationship
...... offsetDurationDuration
...... offsetRangeRange
.... timing[x] 0..1When the action should take place
..... timingDateTimedateTime
..... timingPeriodPeriod
..... timingDurationDuration
..... timingRangeRange
..... timingTimingTiming
.... participant 0..*Reference(Patient | Person | Practitioner | RelatedPerson)Who should perform the action
.... type S0..1Codingcreate | update | remove | fire-event
Binding: ActionType (extensible): The type of action to be performed

.... groupingBehavior 0..1codevisual-group | logical-group | sentence-group
Binding: ActionGroupingBehavior (required): Defines organization behavior of a group

.... selectionBehavior 0..1codeany | all | all-or-none | exactly-one | at-most-one | one-or-more
Binding: ActionSelectionBehavior (required): Defines selection behavior of a group

.... requiredBehavior 0..1codemust | could | must-unless-documented
Binding: ActionRequiredBehavior (required): Defines requiredness behavior for selecting an action or an action group

.... precheckBehavior 0..1codeyes | no
Binding: ActionPrecheckBehavior (required): Defines selection frequency behavior for an action or group

.... cardinalityBehavior 0..1codesingle | multiple
Binding: ActionCardinalityBehavior (required): Defines behavior for an action or a group for how many times that item may be repeated

.... resource SI0..1Reference(Resource)The target of the action
.... action I0..*See action (RequestGroup)Sub action

doco Documentation for this format

 

D.4.1.2 Terminology Bindings

Terminology Bindings

PathConformanceValueSet
RequestGroup.languageextensibleCommon Languages
Max Binding: All Languages
RequestGroup.statusrequiredRequestStatus
RequestGroup.intentrequiredRequestIntent
RequestGroup.priorityrequiredRequestPriority
RequestGroup.action.condition.kindrequiredActionConditionKind
RequestGroup.action.relatedAction.relationshiprequiredActionRelationshipType
RequestGroup.action.typeextensibleActionType
RequestGroup.action.groupingBehaviorrequiredActionGroupingBehavior
RequestGroup.action.selectionBehaviorrequiredActionSelectionBehavior
RequestGroup.action.requiredBehaviorrequiredActionRequiredBehavior
RequestGroup.action.precheckBehaviorrequiredActionPrecheckBehavior
RequestGroup.action.cardinalityBehaviorrequiredActionCardinalityBehavior

D.4.1.3 Constraints

Constraints

IdGradePathDetailsRequirements
dom-2errorRequestGroupIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-1errorRequestGroupIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-4errorRequestGroupIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-3errorRequestGroupIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
: contained.where(('#'+id in %resource.descendants().reference).not()).empty()
ele-1errorRequestGroup.actionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
rqg-1errorRequestGroup.actionMust have resource or action but not both
: resource.exists() != action.exists()
ele-1errorRequestGroup.action.extension:action-indicatorAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1errorRequestGroup.action.extension:action-indicatorMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorRequestGroup.action.conditionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ele-1errorRequestGroup.action.relatedActionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
.

s