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 .
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
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
RequestGroup | 0..* | |||
subject | 1..1 | Reference(US Core Patient Profile) | ||
author | 1..1 | Reference(US Core Practitioner Profile) | ||
action | 1..* | BackboneElement | ||
resource | 1..1 | Reference(PhCP-Referral-ProcedureRequest), Reference(US Core MedicationRequest Profile) | ||
Documentation for this format |
This structure is derived from RequestGroup
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
RequestGroup | I | 0..* | A group of related requests | |
id | Σ | 0..1 | id | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 0..* | Identifier | Business 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..1 | Identifier | Composite request this is part of |
status | ?!Σ | 1..1 | code | draft | active | suspended | cancelled | completed | entered-in-error | unknown Binding: RequestStatus (required) |
intent | ?!Σ | 1..1 | code | proposal | plan | order Binding: RequestIntent (required) |
priority | Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required) |
code | Σ | 0..1 | CodeableConcept | What's being requested/ordered |
subject | 1..1 | Reference(US Core Patient Profile) | Who the request group is about | |
context | 0..1 | Reference(Encounter), Reference(EpisodeOfCare) | Encounter or Episode for the request group | |
authoredOn | 0..1 | dateTime | When the request group was authored | |
author | 1..1 | Reference(US Core Practitioner Profile) | Device or practitioner that authored the request group | |
reasonCode | 0..* | CodeableConcept | Why the request group is needed | |
reasonReference | 0..* | Reference(Resource) | Why the request group is needed | |
note | 0..* | Annotation | Additional notes about the response | |
action | I | 1..* | BackboneElement | Proposed actions, if any |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
prefix | 0..1 | string | User-visible prefix for the action (e.g. 1. or A.) | |
title | 0..1 | string | User-visible title | |
description | Σ | 0..1 | string | Short description of the action |
textEquivalent | Σ | 0..1 | string | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system |
code | 0..* | CodeableConcept | Code representing the meaning of the action or sub-actions | |
documentation | 0..* | RelatedArtifact | Supporting documentation for the intended performer of the action | |
condition | I | 0..* | BackboneElement | Whether or not the action is applicable |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
kind | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required) | |
description | 0..1 | string | Natural language description of the condition | |
language | 0..1 | string | Language of the expression | |
expression | 0..1 | string | Boolean-valued expression | |
relatedAction | I | 0..* | BackboneElement | Relationship to another action |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
actionId | 1..1 | id | What action this is related to | |
relationship | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required) | |
offset[x] | 0..1 | Duration, Range | Time offset for the relationship | |
timing[x] | 0..1 | dateTime, Period, Duration, Range, Timing | When the action should take place | |
participant | 0..* | Reference(Patient), Reference(Person), Reference(Practitioner), Reference(RelatedPerson) | Who should perform the action | |
type | 0..1 | Coding | create | update | remove | fire-event Binding: ActionType (extensible) | |
groupingBehavior | 0..1 | code | visual-group | logical-group | sentence-group Binding: ActionGroupingBehavior (required) | |
selectionBehavior | 0..1 | code | any | all | all-or-none | exactly-one | at-most-one | one-or-more Binding: ActionSelectionBehavior (required) | |
requiredBehavior | 0..1 | code | must | could | must-unless-documented Binding: ActionRequiredBehavior (required) | |
precheckBehavior | 0..1 | code | yes | no Binding: ActionPrecheckBehavior (required) | |
cardinalityBehavior | 0..1 | code | single | multiple Binding: ActionCardinalityBehavior (required) | |
resource | I | 1..1 | Reference(PhCP-Referral-ProcedureRequest), Reference(US Core MedicationRequest Profile) | The target of the action |
action | I | 0..* | Unknown reference to #RequestGroup.action Sub action | |
Documentation for this format |
This structure is derived from RequestGroup
This structure is derived from RequestGroup
Differential View
This structure is derived from RequestGroup
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
RequestGroup | 0..* | |||
subject | 1..1 | Reference(US Core Patient Profile) | ||
author | 1..1 | Reference(US Core Practitioner Profile) | ||
action | 1..* | BackboneElement | ||
resource | 1..1 | Reference(PhCP-Referral-ProcedureRequest), Reference(US Core MedicationRequest Profile) | ||
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
RequestGroup | I | 0..* | A group of related requests | |
id | Σ | 0..1 | id | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 0..* | Identifier | Business 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..1 | Identifier | Composite request this is part of |
status | ?!Σ | 1..1 | code | draft | active | suspended | cancelled | completed | entered-in-error | unknown Binding: RequestStatus (required) |
intent | ?!Σ | 1..1 | code | proposal | plan | order Binding: RequestIntent (required) |
priority | Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required) |
code | Σ | 0..1 | CodeableConcept | What's being requested/ordered |
subject | 1..1 | Reference(US Core Patient Profile) | Who the request group is about | |
context | 0..1 | Reference(Encounter), Reference(EpisodeOfCare) | Encounter or Episode for the request group | |
authoredOn | 0..1 | dateTime | When the request group was authored | |
author | 1..1 | Reference(US Core Practitioner Profile) | Device or practitioner that authored the request group | |
reasonCode | 0..* | CodeableConcept | Why the request group is needed | |
reasonReference | 0..* | Reference(Resource) | Why the request group is needed | |
note | 0..* | Annotation | Additional notes about the response | |
action | I | 1..* | BackboneElement | Proposed actions, if any |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
prefix | 0..1 | string | User-visible prefix for the action (e.g. 1. or A.) | |
title | 0..1 | string | User-visible title | |
description | Σ | 0..1 | string | Short description of the action |
textEquivalent | Σ | 0..1 | string | Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system |
code | 0..* | CodeableConcept | Code representing the meaning of the action or sub-actions | |
documentation | 0..* | RelatedArtifact | Supporting documentation for the intended performer of the action | |
condition | I | 0..* | BackboneElement | Whether or not the action is applicable |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
kind | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required) | |
description | 0..1 | string | Natural language description of the condition | |
language | 0..1 | string | Language of the expression | |
expression | 0..1 | string | Boolean-valued expression | |
relatedAction | I | 0..* | BackboneElement | Relationship to another action |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
actionId | 1..1 | id | What action this is related to | |
relationship | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end Binding: ActionRelationshipType (required) | |
offset[x] | 0..1 | Duration, Range | Time offset for the relationship | |
timing[x] | 0..1 | dateTime, Period, Duration, Range, Timing | When the action should take place | |
participant | 0..* | Reference(Patient), Reference(Person), Reference(Practitioner), Reference(RelatedPerson) | Who should perform the action | |
type | 0..1 | Coding | create | update | remove | fire-event Binding: ActionType (extensible) | |
groupingBehavior | 0..1 | code | visual-group | logical-group | sentence-group Binding: ActionGroupingBehavior (required) | |
selectionBehavior | 0..1 | code | any | all | all-or-none | exactly-one | at-most-one | one-or-more Binding: ActionSelectionBehavior (required) | |
requiredBehavior | 0..1 | code | must | could | must-unless-documented Binding: ActionRequiredBehavior (required) | |
precheckBehavior | 0..1 | code | yes | no Binding: ActionPrecheckBehavior (required) | |
cardinalityBehavior | 0..1 | code | single | multiple Binding: ActionCardinalityBehavior (required) | |
resource | I | 1..1 | Reference(PhCP-Referral-ProcedureRequest), Reference(US Core MedicationRequest Profile) | The target of the action |
action | I | 0..* | Unknown reference to #RequestGroup.action Sub action | |
Documentation for this format |
Path | Name | Conformance | ValueSet |
RequestGroup.language | Common Languages | extensible | Common Languages |
RequestGroup.status | RequestStatus | required | RequestStatus |
RequestGroup.intent | RequestIntent | required | RequestIntent |
RequestGroup.priority | RequestPriority | required | RequestPriority |
RequestGroup.action.condition.kind | ActionConditionKind | required | ActionConditionKind |
RequestGroup.action.relatedAction.relationship | ActionRelationshipType | required | ActionRelationshipType |
RequestGroup.action.type | ActionType | extensible | ActionType |
RequestGroup.action.groupingBehavior | ActionGroupingBehavior | required | ActionGroupingBehavior |
RequestGroup.action.selectionBehavior | ActionSelectionBehavior | required | ActionSelectionBehavior |
RequestGroup.action.requiredBehavior | ActionRequiredBehavior | required | ActionRequiredBehavior |
RequestGroup.action.precheckBehavior | ActionPrecheckBehavior | required | ActionPrecheckBehavior |
RequestGroup.action.cardinalityBehavior | ActionCardinalityBehavior | required | ActionCardinalityBehavior |
Id | Path | Details | Requirements |
dom-2 | RequestGroup | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-1 | RequestGroup | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty() | |
dom-4 | RequestGroup | If 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-3 | RequestGroup | If 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-1 | RequestGroup.action | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
rqg-1 | RequestGroup.action | Must have resource or action but not both : resource.exists() != action.exists() | |
ele-1 | RequestGroup.action.condition | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ele-1 | RequestGroup.action.relatedAction | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) |