Current Build

This page is part of the Pharmacist Care Plan FHIR IG (v1.0.0: STU 1) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions

This is a pre-release of a future version of the Pharmacist Care Plan FHIR IG (expected to be STU 1). There is no current official version.
For a full list of available versions, see the Directory of published versions .

D.4.1 StructureDefinition: PhCP-Intervention-RequestGroup

D.4.1.1 Formal Views of Profile Content

The official URL for this profile is:

http://hl7.org/fhir/us/phcp/StructureDefinition/PhCP-Intervention-RequestGroup

This profile builds on RequestGroup.

This profile was published on Mon Jul 31 10:17:15 AEST 2017 as a draft by Lantana Consulting Group.

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

This structure is derived from RequestGroup

NameFlagsCard.TypeDescription & Constraintsdoco
.. RequestGroup I0..*A 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)
... text I0..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)
... intent ?!Σ1..1codeproposal | plan | order
Binding: RequestIntent (required)
... priority Σ0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required)
... code Σ0..1CodeableConceptWhat's being requested/ordered
... subject 1..1Reference(US Core Patient Profile)Who the request group is about
... context 0..1Reference(Encounter), Reference(EpisodeOfCare)Encounter or Episode for the request group
... authoredOn 0..1dateTimeWhen the request group was authored
... author 1..1Reference(US Core Practitioner Profile)Device or practitioner that authored the request group
... reasonCode 0..*CodeableConceptWhy the request group is needed
... reasonReference 0..*Reference(Resource)Why the request group is needed
... note 0..*AnnotationAdditional notes about the response
... action I1..*BackboneElementProposed actions, if any
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... prefix 0..1stringUser-visible prefix for the action (e.g. 1. or A.)
.... title 0..1stringUser-visible title
.... description Σ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 0..*RelatedArtifactSupporting documentation for the intended performer of the action
.... condition I0..*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)
..... description 0..1stringNatural language description of the condition
..... language 0..1stringLanguage of the expression
..... expression 0..1stringBoolean-valued expression
.... relatedAction I0..*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)
..... offset[x] 0..1Duration, RangeTime offset for the relationship
.... timing[x] 0..1dateTime, Period, Duration, Range, TimingWhen the action should take place
.... participant 0..*Reference(Patient), Reference(Person), Reference(Practitioner), Reference(RelatedPerson)Who should perform the action
.... type 0..1Codingcreate | update | remove | fire-event
Binding: ActionType (extensible)
.... groupingBehavior 0..1codevisual-group | logical-group | sentence-group
Binding: ActionGroupingBehavior (required)
.... selectionBehavior 0..1codeany | all | all-or-none | exactly-one | at-most-one | one-or-more
Binding: ActionSelectionBehavior (required)
.... requiredBehavior 0..1codemust | could | must-unless-documented
Binding: ActionRequiredBehavior (required)
.... precheckBehavior 0..1codeyes | no
Binding: ActionPrecheckBehavior (required)
.... cardinalityBehavior 0..1codesingle | multiple
Binding: ActionCardinalityBehavior (required)
.... resource I1..1Reference(PhCP-Referral-ProcedureRequest), Reference(US Core MedicationRequest Profile)The target of the action
.... action I0..*Unknown reference to #RequestGroup.action
Sub action

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. RequestGroup I0..*A 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)
... text I0..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)
... intent ?!Σ1..1codeproposal | plan | order
Binding: RequestIntent (required)
... priority Σ0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required)
... code Σ0..1CodeableConceptWhat's being requested/ordered
... subject 1..1Reference(US Core Patient Profile)Who the request group is about
... context 0..1Reference(Encounter), Reference(EpisodeOfCare)Encounter or Episode for the request group
... authoredOn 0..1dateTimeWhen the request group was authored
... author 1..1Reference(US Core Practitioner Profile)Device or practitioner that authored the request group
... reasonCode 0..*CodeableConceptWhy the request group is needed
... reasonReference 0..*Reference(Resource)Why the request group is needed
... note 0..*AnnotationAdditional notes about the response
... action I1..*BackboneElementProposed actions, if any
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... prefix 0..1stringUser-visible prefix for the action (e.g. 1. or A.)
.... title 0..1stringUser-visible title
.... description Σ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 0..*RelatedArtifactSupporting documentation for the intended performer of the action
.... condition I0..*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)
..... description 0..1stringNatural language description of the condition
..... language 0..1stringLanguage of the expression
..... expression 0..1stringBoolean-valued expression
.... relatedAction I0..*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)
..... offset[x] 0..1Duration, RangeTime offset for the relationship
.... timing[x] 0..1dateTime, Period, Duration, Range, TimingWhen the action should take place
.... participant 0..*Reference(Patient), Reference(Person), Reference(Practitioner), Reference(RelatedPerson)Who should perform the action
.... type 0..1Codingcreate | update | remove | fire-event
Binding: ActionType (extensible)
.... groupingBehavior 0..1codevisual-group | logical-group | sentence-group
Binding: ActionGroupingBehavior (required)
.... selectionBehavior 0..1codeany | all | all-or-none | exactly-one | at-most-one | one-or-more
Binding: ActionSelectionBehavior (required)
.... requiredBehavior 0..1codemust | could | must-unless-documented
Binding: ActionRequiredBehavior (required)
.... precheckBehavior 0..1codeyes | no
Binding: ActionPrecheckBehavior (required)
.... cardinalityBehavior 0..1codesingle | multiple
Binding: ActionCardinalityBehavior (required)
.... resource I1..1Reference(PhCP-Referral-ProcedureRequest), Reference(US Core MedicationRequest Profile)The target of the action
.... action I0..*Unknown reference to #RequestGroup.action
Sub action

doco Documentation for this format

 

D.4.1.2 Terminology Bindings

Terminology Bindings

PathNameConformanceValueSet
RequestGroup.languageCommon LanguagesextensibleCommon Languages
RequestGroup.statusRequestStatusrequiredRequestStatus
RequestGroup.intentRequestIntentrequiredRequestIntent
RequestGroup.priorityRequestPriorityrequiredRequestPriority
RequestGroup.action.condition.kindActionConditionKindrequiredActionConditionKind
RequestGroup.action.relatedAction.relationshipActionRelationshipTyperequiredActionRelationshipType
RequestGroup.action.typeActionTypeextensibleActionType
RequestGroup.action.groupingBehaviorActionGroupingBehaviorrequiredActionGroupingBehavior
RequestGroup.action.selectionBehaviorActionSelectionBehaviorrequiredActionSelectionBehavior
RequestGroup.action.requiredBehaviorActionRequiredBehaviorrequiredActionRequiredBehavior
RequestGroup.action.precheckBehaviorActionPrecheckBehaviorrequiredActionPrecheckBehavior
RequestGroup.action.cardinalityBehaviorActionCardinalityBehaviorrequiredActionCardinalityBehavior

D.4.1.3 Constraints

Constraints

IdPathDetailsRequirements
dom-2RequestGroupIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-1RequestGroupIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-4RequestGroupIf 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-3RequestGroupIf 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-1RequestGroup.actionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
rqg-1RequestGroup.actionMust have resource or action but not both
: resource.exists() != action.exists()
ele-1RequestGroup.action.conditionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ele-1RequestGroup.action.relatedActionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
.