Referral Prescription
1.0.0 - STU

Referral Prescription, published by . This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-be/referral/ and changes regularly. See the Directory of published versions

## Resource Profile: BeReferralPrescriptionRequestGroup

Official URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-referralprescription-request-group | Version: 1.0.0
Draft as of 2021-10-07 | Computable Name: BeReferralPrescriptionRequestGroup

Envelope that allows different referralprescriptions to have an order

Usages:

- Refer to this Profile: BeReferralPrescriptionRequestGroup
- Examples for this Profile: RequestGroup/uc2a and RequestGroup/ucgh222p13

You can also check for usages in the FHIR IG Statistics

### Formal Views of Profile Content

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

- Key Elements Table
- Differential Table
- Snapshot Table
- Statistics/References
- All

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
RequestGroup |  | 0..* | RequestGroup | A group of related requests
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
Slices for identifier | Σ | 0..* | Identifier | Business identifier Slice: Unordered, Open by value:system
identifier:UHMEP | Σ | 0..1 | Identifier | Reference ID of the UHMEP once available there
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://www.ehealth.fgov.be/standards/fhir/referral/NamingSystem/uhmep
value | Σ | 1..1 | string | The value that is unique Example General: 123456
groupIdentifier | S Σ | 0..1 | Identifier | Composite request this is part of
status | ?!Σ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): Codes identifying the lifecycle stage of a request.
intent | ?!Σ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): Codes indicating the degree of authority/intentionality associated with a request.
action | S C | 1..* | BackboneElement | At least one referral prescription Constraints: rqg-1
id | S | 0..1 | string | Unique id for inter-element referencing
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
relatedAction | S | 0..* | BackboneElement | Relationship to another action
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
actionId | S | 1..1 | id | What action this is related to
relationship | S | 1..1 | code | before-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.
resource | S C | 1..1 | Reference(BeReferralPrescription | BeReferralPrescriptionRequestGroup) | The target of the action
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
RequestGroup.identifier:UHMEP.​use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
RequestGroup.status | Base | required | RequestStatus | 📍4.0.1 | FHIR Std.
RequestGroup.intent | Base | required | RequestIntent | 📍4.0.1 | FHIR Std.
RequestGroup.action.​relatedAction.relationship | Base | required | ActionRelationshipType | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | RequestGroup | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | RequestGroup | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | 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-5 | error | RequestGroup | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | RequestGroup | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`
rqg-1 | error | RequestGroup.action | Must have resource or action but not both | `resource.exists() != action.exists()`

This structure is derived from RequestGroup

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
RequestGroup |  | 0..* | RequestGroup | A group of related requests
Slices for identifier |  | 0..* | Identifier | Business identifier Slice: Unordered, Open by value:system
identifier:UHMEP |  | 0..1 | Identifier | Reference ID of the UHMEP once available there
system |  | 1..1 | uri | The namespace for the identifier value Fixed Value: https://www.ehealth.fgov.be/standards/fhir/referral/NamingSystem/uhmep
value |  | 1..1 | string | The value that is unique
groupIdentifier | S | 0..1 | Identifier | Composite request this is part of
action | S | 1..* | BackboneElement | At least one referral prescription
id | S | 0..1 | string | Unique id for inter-element referencing
relatedAction | S | 0..* | BackboneElement | Relationship to another action
actionId | S | 1..1 | id | What action this is related to
relationship | S | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
resource | S | 1..1 | Reference(BeReferralPrescription | BeReferralPrescriptionRequestGroup) | The target of the action
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
RequestGroup |  | 0..* | RequestGroup | 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: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained |  | 0..* | Resource | Contained, inline Resources
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
Slices for identifier | Σ | 0..* | Identifier | Business identifier Slice: Unordered, Open by value:system
identifier:UHMEP | Σ | 0..1 | Identifier | Reference ID of the UHMEP once available there
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://www.ehealth.fgov.be/standards/fhir/referral/NamingSystem/uhmep
value | Σ | 1..1 | string | The value that is unique Example General: 123456
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
instantiatesCanonical | Σ | 0..* | canonical() | Instantiates FHIR protocol or definition
instantiatesUri | Σ | 0..* | uri | Instantiates external protocol or definition
basedOn |  | 0..* | Reference(Resource) | Fulfills plan, proposal, or order
replaces |  | 0..* | Reference(Resource) | Request(s) replaced by this request
groupIdentifier | S Σ | 0..1 | Identifier | Composite request this is part of
status | ?!Σ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): Codes identifying the lifecycle stage of a request.
intent | ?!Σ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): Codes indicating the degree of authority/intentionality associated with a request.
priority | Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
code | Σ | 0..1 | CodeableConcept | What's being requested/ordered
subject |  | 0..1 | Reference(Patient | Group) | Who the request group is about
encounter |  | 0..1 | Reference(Encounter) | Created as part of
authoredOn |  | 0..1 | dateTime | When the request group was authored
author |  | 0..1 | Reference(Device | Practitioner | PractitionerRole) | Device or practitioner that authored the request group
reasonCode |  | 0..* | CodeableConcept | Why the request group is needed
reasonReference |  | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Why the request group is needed
note |  | 0..* | Annotation | Additional notes about the response
action | S C | 1..* | BackboneElement | At least one referral prescription Constraints: rqg-1
id | S | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
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
priority |  | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
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 |  | 0..* | BackboneElement | Whether or not the action is applicable
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
kind |  | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required): The kind of condition for the action.
expression |  | 0..1 | Expression | Boolean-valued expression
relatedAction | S | 0..* | BackboneElement | Relationship to another action
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
actionId | S | 1..1 | id | What action this is related to
relationship | S | 1..1 | code | before-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..1 |  | Time offset for the relationship
offsetDuration |  |  | Duration |
offsetRange |  |  | Range |
timing[x] |  | 0..1 |  | When the action should take place
timingDateTime |  |  | dateTime |
timingAge |  |  | Age |
timingPeriod |  |  | Period |
timingDuration |  |  | Duration |
timingRange |  |  | Range |
timingTiming |  |  | Timing |
participant |  | 0..* | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device) | Who should perform the action
type |  | 0..1 | CodeableConcept | create | update | remove | fire-event Binding: ActionType (extensible): The type of action to be performed.
groupingBehavior |  | 0..1 | code | visual-group | logical-group | sentence-group Binding: ActionGroupingBehavior (required): Defines organization behavior of a group.
selectionBehavior |  | 0..1 | code | any | all | all-or-none | exactly-one | at-most-one | one-or-more Binding: ActionSelectionBehavior (required): Defines selection behavior of a group.
requiredBehavior |  | 0..1 | code | must | could | must-unless-documented Binding: ActionRequiredBehavior (required): Defines expectations around whether an action or action group is required.
precheckBehavior |  | 0..1 | code | yes | no Binding: ActionPrecheckBehavior (required): Defines selection frequency behavior for an action or group.
cardinalityBehavior |  | 0..1 | code | single | multiple Binding: ActionCardinalityBehavior (required): Defines behavior for an action or a group for how many times that item may be repeated.
resource | S C | 1..1 | Reference(BeReferralPrescription | BeReferralPrescriptionRequestGroup) | The target of the action
action | C | 0..* | See action (RequestGroup) | Sub action
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
RequestGroup.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std.
RequestGroup.identifier:UHMEP.​use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
RequestGroup.identifier:UHMEP.​type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std.
RequestGroup.status | Base | required | RequestStatus | 📍4.0.1 | FHIR Std.
RequestGroup.intent | Base | required | RequestIntent | 📍4.0.1 | FHIR Std.
RequestGroup.priority | Base | required | Request priority | 📍4.0.1 | FHIR Std.
RequestGroup.action.​priority | Base | required | Request priority | 📍4.0.1 | FHIR Std.
RequestGroup.action.​condition.kind | Base | required | ActionConditionKind | 📍4.0.1 | FHIR Std.
RequestGroup.action.​relatedAction.relationship | Base | required | ActionRelationshipType | 📍4.0.1 | FHIR Std.
RequestGroup.action.​type | Base | extensible | ActionType | 📍4.0.1 | FHIR Std.
RequestGroup.action.​groupingBehavior | Base | required | ActionGroupingBehavior | 📍4.0.1 | FHIR Std.
RequestGroup.action.​selectionBehavior | Base | required | ActionSelectionBehavior | 📍4.0.1 | FHIR Std.
RequestGroup.action.​requiredBehavior | Base | required | ActionRequiredBehavior | 📍4.0.1 | FHIR Std.
RequestGroup.action.​precheckBehavior | Base | required | ActionPrecheckBehavior | 📍4.0.1 | FHIR Std.
RequestGroup.action.​cardinalityBehavior | Base | required | ActionCardinalityBehavior | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | RequestGroup | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | RequestGroup | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | 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-5 | error | RequestGroup | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | RequestGroup | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`
rqg-1 | error | RequestGroup.action | Must have resource or action but not both | `resource.exists() != action.exists()`

This structure is derived from RequestGroup

Summary

Mandatory: 2 elements(2 nested mandatory elements)
Must-Support: 7 elements
Fixed: 1 element

Structures

This structure refers to these other structures:

- BeReferralPrescription (https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-referralprescription)
- BeReferralPrescriptionRequestGroup (https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-referralprescription-request-group)

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the value of RequestGroup.identifier

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
RequestGroup |  | 0..* | RequestGroup | A group of related requests
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
Slices for identifier | Σ | 0..* | Identifier | Business identifier Slice: Unordered, Open by value:system
identifier:UHMEP | Σ | 0..1 | Identifier | Reference ID of the UHMEP once available there
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://www.ehealth.fgov.be/standards/fhir/referral/NamingSystem/uhmep
value | Σ | 1..1 | string | The value that is unique Example General: 123456
groupIdentifier | S Σ | 0..1 | Identifier | Composite request this is part of
status | ?!Σ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): Codes identifying the lifecycle stage of a request.
intent | ?!Σ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): Codes indicating the degree of authority/intentionality associated with a request.
action | S C | 1..* | BackboneElement | At least one referral prescription Constraints: rqg-1
id | S | 0..1 | string | Unique id for inter-element referencing
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
relatedAction | S | 0..* | BackboneElement | Relationship to another action
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
actionId | S | 1..1 | id | What action this is related to
relationship | S | 1..1 | code | before-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.
resource | S C | 1..1 | Reference(BeReferralPrescription | BeReferralPrescriptionRequestGroup) | The target of the action
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
RequestGroup.identifier:UHMEP.​use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
RequestGroup.status | Base | required | RequestStatus | 📍4.0.1 | FHIR Std.
RequestGroup.intent | Base | required | RequestIntent | 📍4.0.1 | FHIR Std.
RequestGroup.action.​relatedAction.relationship | Base | required | ActionRelationshipType | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | RequestGroup | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | RequestGroup | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | 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-5 | error | RequestGroup | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | RequestGroup | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`
rqg-1 | error | RequestGroup.action | Must have resource or action but not both | `resource.exists() != action.exists()`

Differential View

This structure is derived from RequestGroup

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
RequestGroup |  | 0..* | RequestGroup | A group of related requests
Slices for identifier |  | 0..* | Identifier | Business identifier Slice: Unordered, Open by value:system
identifier:UHMEP |  | 0..1 | Identifier | Reference ID of the UHMEP once available there
system |  | 1..1 | uri | The namespace for the identifier value Fixed Value: https://www.ehealth.fgov.be/standards/fhir/referral/NamingSystem/uhmep
value |  | 1..1 | string | The value that is unique
groupIdentifier | S | 0..1 | Identifier | Composite request this is part of
action | S | 1..* | BackboneElement | At least one referral prescription
id | S | 0..1 | string | Unique id for inter-element referencing
relatedAction | S | 0..* | BackboneElement | Relationship to another action
actionId | S | 1..1 | id | What action this is related to
relationship | S | 1..1 | code | before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
resource | S | 1..1 | Reference(BeReferralPrescription | BeReferralPrescriptionRequestGroup) | The target of the action
Documentation for this format

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
RequestGroup |  | 0..* | RequestGroup | 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: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained |  | 0..* | Resource | Contained, inline Resources
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
Slices for identifier | Σ | 0..* | Identifier | Business identifier Slice: Unordered, Open by value:system
identifier:UHMEP | Σ | 0..1 | Identifier | Reference ID of the UHMEP once available there
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://www.ehealth.fgov.be/standards/fhir/referral/NamingSystem/uhmep
value | Σ | 1..1 | string | The value that is unique Example General: 123456
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
instantiatesCanonical | Σ | 0..* | canonical() | Instantiates FHIR protocol or definition
instantiatesUri | Σ | 0..* | uri | Instantiates external protocol or definition
basedOn |  | 0..* | Reference(Resource) | Fulfills plan, proposal, or order
replaces |  | 0..* | Reference(Resource) | Request(s) replaced by this request
groupIdentifier | S Σ | 0..1 | Identifier | Composite request this is part of
status | ?!Σ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): Codes identifying the lifecycle stage of a request.
intent | ?!Σ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): Codes indicating the degree of authority/intentionality associated with a request.
priority | Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
code | Σ | 0..1 | CodeableConcept | What's being requested/ordered
subject |  | 0..1 | Reference(Patient | Group) | Who the request group is about
encounter |  | 0..1 | Reference(Encounter) | Created as part of
authoredOn |  | 0..1 | dateTime | When the request group was authored
author |  | 0..1 | Reference(Device | Practitioner | PractitionerRole) | Device or practitioner that authored the request group
reasonCode |  | 0..* | CodeableConcept | Why the request group is needed
reasonReference |  | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Why the request group is needed
note |  | 0..* | Annotation | Additional notes about the response
action | S C | 1..* | BackboneElement | At least one referral prescription Constraints: rqg-1
id | S | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
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
priority |  | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
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 |  | 0..* | BackboneElement | Whether or not the action is applicable
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
kind |  | 1..1 | code | applicability | start | stop Binding: ActionConditionKind (required): The kind of condition for the action.
expression |  | 0..1 | Expression | Boolean-valued expression
relatedAction | S | 0..* | BackboneElement | Relationship to another action
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
actionId | S | 1..1 | id | What action this is related to
relationship | S | 1..1 | code | before-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..1 |  | Time offset for the relationship
offsetDuration |  |  | Duration |
offsetRange |  |  | Range |
timing[x] |  | 0..1 |  | When the action should take place
timingDateTime |  |  | dateTime |
timingAge |  |  | Age |
timingPeriod |  |  | Period |
timingDuration |  |  | Duration |
timingRange |  |  | Range |
timingTiming |  |  | Timing |
participant |  | 0..* | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device) | Who should perform the action
type |  | 0..1 | CodeableConcept | create | update | remove | fire-event Binding: ActionType (extensible): The type of action to be performed.
groupingBehavior |  | 0..1 | code | visual-group | logical-group | sentence-group Binding: ActionGroupingBehavior (required): Defines organization behavior of a group.
selectionBehavior |  | 0..1 | code | any | all | all-or-none | exactly-one | at-most-one | one-or-more Binding: ActionSelectionBehavior (required): Defines selection behavior of a group.
requiredBehavior |  | 0..1 | code | must | could | must-unless-documented Binding: ActionRequiredBehavior (required): Defines expectations around whether an action or action group is required.
precheckBehavior |  | 0..1 | code | yes | no Binding: ActionPrecheckBehavior (required): Defines selection frequency behavior for an action or group.
cardinalityBehavior |  | 0..1 | code | single | multiple Binding: ActionCardinalityBehavior (required): Defines behavior for an action or a group for how many times that item may be repeated.
resource | S C | 1..1 | Reference(BeReferralPrescription | BeReferralPrescriptionRequestGroup) | The target of the action
action | C | 0..* | See action (RequestGroup) | Sub action
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
RequestGroup.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std.
RequestGroup.identifier:UHMEP.​use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
RequestGroup.identifier:UHMEP.​type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std.
RequestGroup.status | Base | required | RequestStatus | 📍4.0.1 | FHIR Std.
RequestGroup.intent | Base | required | RequestIntent | 📍4.0.1 | FHIR Std.
RequestGroup.priority | Base | required | Request priority | 📍4.0.1 | FHIR Std.
RequestGroup.action.​priority | Base | required | Request priority | 📍4.0.1 | FHIR Std.
RequestGroup.action.​condition.kind | Base | required | ActionConditionKind | 📍4.0.1 | FHIR Std.
RequestGroup.action.​relatedAction.relationship | Base | required | ActionRelationshipType | 📍4.0.1 | FHIR Std.
RequestGroup.action.​type | Base | extensible | ActionType | 📍4.0.1 | FHIR Std.
RequestGroup.action.​groupingBehavior | Base | required | ActionGroupingBehavior | 📍4.0.1 | FHIR Std.
RequestGroup.action.​selectionBehavior | Base | required | ActionSelectionBehavior | 📍4.0.1 | FHIR Std.
RequestGroup.action.​requiredBehavior | Base | required | ActionRequiredBehavior | 📍4.0.1 | FHIR Std.
RequestGroup.action.​precheckBehavior | Base | required | ActionPrecheckBehavior | 📍4.0.1 | FHIR Std.
RequestGroup.action.​cardinalityBehavior | Base | required | ActionCardinalityBehavior | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | RequestGroup | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | RequestGroup | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | 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-5 | error | RequestGroup | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | RequestGroup | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`
rqg-1 | error | RequestGroup.action | Must have resource or action but not both | `resource.exists() != action.exists()`

This structure is derived from RequestGroup

Summary

Mandatory: 2 elements(2 nested mandatory elements)
Must-Support: 7 elements
Fixed: 1 element

Structures

This structure refers to these other structures:

- BeReferralPrescription (https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-referralprescription)
- BeReferralPrescriptionRequestGroup (https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-referralprescription-request-group)

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the value of RequestGroup.identifier

Other representations of profile: CSV, Excel, Schematron