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
Official URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-referral-request-group | Version: 1.0.0 | |||
Draft as of 2021-10-07 | Computable Name: BeReferralRequestGroup |
Envelope that allows different referralprescriptions to have an order
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from RequestGroup
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
RequestGroup | RequestGroup | |||
Slices for extension | 2..* | Extension | Extension Slice: Unordered, Open by value:url | |
orderDetail | S | 0..* | CodeableConcept | Optional Extensions Element URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-ServiceRequest.orderDetail |
category | S | 1..1 | (Complex) | Optional Extensions Element URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-ServiceRequest.category |
value[x] | 1..1 | CodeableConcept | Value of extension Binding: BeReferralCategory (extensible) | |
feedback | S | 0..1 | boolean | Give feedback to the prescriber URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-feedback-to-prescriber |
coprescriber | S | 0..1 | (Complex) | Info about the other parties that have to take part in the prescription. URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-co-prescriber-info |
validity | S | 1..1 | Period | Validity period of the prescription URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-validity-period |
latest | S | 0..1 | BeYearMonthDay | Request must be executed before URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-latest-end-date |
latestDraft | S | 0..1 | BeYearMonthDay | The prescription must have left the draft status befor this moment URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-latest-draft-date |
proposalType | S | 0..1 | CodeableConcept | BeProposalType URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-proposal-type Binding: BeVsProposalType (required) |
pss | S | 0..1 | (Complex) | BePSSInfo URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-pss-info |
performerType | S | 0..* | CodeableConcept | Discipline of provider. Replaces .performerType because of wrong cardinality URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-performer-type Binding: BeVSCdHcParty (extensible) |
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 |
intent | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: BeVsRequestIntent (required) | |
code | S | 0..1 | CodeableConcept | What's being requested/ordered |
authoredOn | SC | 1..1 | dateTime | When the request group was authored be-inv-long-date: date SHALL contain a long date (YYYY-MM-DDThh:mm:ss+zz:zz) |
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(BeReferralCareServiceRequest) | The target of the action |
Documentation for this format |
Path | Conformance | ValueSet | URI |
RequestGroup.extension:category.value[x] | extensible | BeReferralCategoryhttps://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-referral-category from this IG | |
RequestGroup.intent | required | BeVsRequestIntenthttps://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-request-intent from this IG |
Id | Grade | Path(s) | Details | Requirements |
be-inv-long-date | error | RequestGroup.authoredOn | date SHALL contain a long date (YYYY-MM-DDThh:mm:ss+zz:zz) : empty() or toString().length()=25 |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
RequestGroup | 0..* | RequestGroup | A group of related requests dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
Slices for extension | 2..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
orderDetail | S | 0..* | CodeableConcept | Optional Extensions Element URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-ServiceRequest.orderDetail ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
category | S | 1..1 | (Complex) | Optional Extensions Element URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-ServiceRequest.category ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
extension | 0..0 | |||
url | 1..1 | uri | "http://hl7.org/fhir/4.0/StructureDefinition/extension-ServiceRequest.category" | |
value[x] | 1..1 | CodeableConcept | Value of extension Binding: BeReferralCategory (extensible) ele-1: All FHIR elements must have a @value or children | |
feedback | S | 0..1 | boolean | Give feedback to the prescriber URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-feedback-to-prescriber ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
coprescriber | S | 0..1 | (Complex) | Info about the other parties that have to take part in the prescription. URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-co-prescriber-info ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
validity | S | 1..1 | Period | Validity period of the prescription URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-validity-period ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
latest | S | 0..1 | BeYearMonthDay | Request must be executed before URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-latest-end-date ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
latestDraft | S | 0..1 | BeYearMonthDay | The prescription must have left the draft status befor this moment URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-latest-draft-date ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
proposalType | S | 0..1 | CodeableConcept | BeProposalType URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-proposal-type Binding: BeVsProposalType (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
pss | S | 0..1 | (Complex) | BePSSInfo URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-pss-info ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
performerType | S | 0..* | CodeableConcept | Discipline of provider. Replaces .performerType because of wrong cardinality URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-performer-type Binding: BeVSCdHcParty (extensible) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
Slices for identifier | Σ | 0..* | Identifier | Business identifier Slice: Unordered, Open by value:system ele-1: All FHIR elements must have a @value or children |
identifier:UHMEP | Σ | 0..1 | Identifier | Reference ID of the UHMEP once available there ele-1: All FHIR elements must have a @value or children |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children |
system | Σ | 1..1 | uri | The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Fixed Value: https://www.ehealth.fgov.be/standards/fhir/referral/NamingSystem/uhmep |
value | Σ | 1..1 | string | The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456 |
groupIdentifier | SΣ | 0..1 | Identifier | Composite request this is part of ele-1: All FHIR elements must have a @value or children |
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. ele-1: All FHIR elements must have a @value or children |
intent | ?!Σ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: BeVsRequestIntent (required) ele-1: All FHIR elements must have a @value or children |
code | SΣ | 0..1 | CodeableConcept | What's being requested/ordered ele-1: All FHIR elements must have a @value or children |
authoredOn | SC | 1..1 | dateTime | When the request group was authored ele-1: All FHIR elements must have a @value or children be-inv-long-date: date SHALL contain a long date (YYYY-MM-DDThh:mm:ss+zz:zz) |
action | SC | 1..* | BackboneElement | At least one referral prescription ele-1: All FHIR elements must have a @value or children rqg-1: Must have resource or action but not both |
id | S | 0..1 | string | Unique id for inter-element referencing |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
relatedAction | S | 0..* | BackboneElement | Relationship to another action ele-1: All FHIR elements must have a @value or children |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
actionId | S | 1..1 | id | What action this is related to ele-1: All FHIR elements must have a @value or children |
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. ele-1: All FHIR elements must have a @value or children |
resource | SC | 1..1 | Reference(BeReferralCareServiceRequest) | The target of the action ele-1: All FHIR elements must have a @value or children |
Documentation for this format |
Path | Conformance | ValueSet | URI |
RequestGroup.extension:category.value[x] | extensible | BeReferralCategoryhttps://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-referral-category from this IG | |
RequestGroup.identifier:UHMEP.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
RequestGroup.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1 from the FHIR Standard | |
RequestGroup.intent | required | BeVsRequestIntenthttps://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-request-intent from this IG | |
RequestGroup.action.relatedAction.relationship | required | ActionRelationshipTypehttp://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
be-inv-long-date | error | RequestGroup.authoredOn | date SHALL contain a long date (YYYY-MM-DDThh:mm:ss+zz:zz) : empty() or toString().length()=25 | |
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() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
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.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 2..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
orderDetail | S | 0..* | CodeableConcept | Optional Extensions Element URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-ServiceRequest.orderDetail | ||||
category | S | 1..1 | (Complex) | Optional Extensions Element URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-ServiceRequest.category | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "http://hl7.org/fhir/4.0/StructureDefinition/extension-ServiceRequest.category" | |||||
value[x] | 1..1 | CodeableConcept | Value of extension Binding: BeReferralCategory (extensible) | |||||
feedback | S | 0..1 | boolean | Give feedback to the prescriber URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-feedback-to-prescriber | ||||
coprescriber | S | 0..1 | (Complex) | Info about the other parties that have to take part in the prescription. URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-co-prescriber-info | ||||
validity | S | 1..1 | Period | Validity period of the prescription URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-validity-period | ||||
latest | S | 0..1 | BeYearMonthDay | Request must be executed before URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-latest-end-date | ||||
latestDraft | S | 0..1 | BeYearMonthDay | The prescription must have left the draft status befor this moment URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-latest-draft-date | ||||
proposalType | S | 0..1 | CodeableConcept | BeProposalType URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-proposal-type Binding: BeVsProposalType (required) | ||||
pss | S | 0..1 | (Complex) | BePSSInfo URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-pss-info | ||||
performerType | S | 0..* | CodeableConcept | Discipline of provider. Replaces .performerType because of wrong cardinality URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-performer-type Binding: BeVSCdHcParty (extensible) | ||||
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: BeVsRequestIntent (required) | ||||
priority | Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | ||||
code | SΣ | 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 | SC | 1..1 | dateTime | When the request group was authored be-inv-long-date: date SHALL contain a long date (YYYY-MM-DDThh:mm:ss+zz:zz) | ||||
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 | SC | 1..* | BackboneElement | At least one referral prescription rqg-1: Must have resource or action but not both | ||||
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 | SC | 1..1 | Reference(BeReferralCareServiceRequest) | The target of the action | ||||
action | C | 0..* | See action (RequestGroup) | Sub action | ||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
RequestGroup.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
RequestGroup.extension:category.value[x] | extensible | BeReferralCategoryhttps://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-referral-category from this IG | ||||
RequestGroup.identifier:UHMEP.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
RequestGroup.identifier:UHMEP.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
RequestGroup.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1 from the FHIR Standard | ||||
RequestGroup.intent | required | BeVsRequestIntenthttps://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-request-intent from this IG | ||||
RequestGroup.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1 from the FHIR Standard | ||||
RequestGroup.action.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1 from the FHIR Standard | ||||
RequestGroup.action.condition.kind | required | ActionConditionKindhttp://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1 from the FHIR Standard | ||||
RequestGroup.action.relatedAction.relationship | required | ActionRelationshipTypehttp://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1 from the FHIR Standard | ||||
RequestGroup.action.type | extensible | ActionTypehttp://hl7.org/fhir/ValueSet/action-type from the FHIR Standard | ||||
RequestGroup.action.groupingBehavior | required | ActionGroupingBehaviorhttp://hl7.org/fhir/ValueSet/action-grouping-behavior|4.0.1 from the FHIR Standard | ||||
RequestGroup.action.selectionBehavior | required | ActionSelectionBehaviorhttp://hl7.org/fhir/ValueSet/action-selection-behavior|4.0.1 from the FHIR Standard | ||||
RequestGroup.action.requiredBehavior | required | ActionRequiredBehaviorhttp://hl7.org/fhir/ValueSet/action-required-behavior|4.0.1 from the FHIR Standard | ||||
RequestGroup.action.precheckBehavior | required | ActionPrecheckBehaviorhttp://hl7.org/fhir/ValueSet/action-precheck-behavior|4.0.1 from the FHIR Standard | ||||
RequestGroup.action.cardinalityBehavior | required | ActionCardinalityBehaviorhttp://hl7.org/fhir/ValueSet/action-cardinality-behavior|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
be-inv-long-date | error | RequestGroup.authoredOn | date SHALL contain a long date (YYYY-MM-DDThh:mm:ss+zz:zz) : empty() or toString().length()=25 | |
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: 5 elements(2 nested mandatory elements)
Must-Support: 19 elements
Fixed: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from RequestGroup
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
RequestGroup | RequestGroup | |||
Slices for extension | 2..* | Extension | Extension Slice: Unordered, Open by value:url | |
orderDetail | S | 0..* | CodeableConcept | Optional Extensions Element URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-ServiceRequest.orderDetail |
category | S | 1..1 | (Complex) | Optional Extensions Element URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-ServiceRequest.category |
value[x] | 1..1 | CodeableConcept | Value of extension Binding: BeReferralCategory (extensible) | |
feedback | S | 0..1 | boolean | Give feedback to the prescriber URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-feedback-to-prescriber |
coprescriber | S | 0..1 | (Complex) | Info about the other parties that have to take part in the prescription. URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-co-prescriber-info |
validity | S | 1..1 | Period | Validity period of the prescription URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-validity-period |
latest | S | 0..1 | BeYearMonthDay | Request must be executed before URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-latest-end-date |
latestDraft | S | 0..1 | BeYearMonthDay | The prescription must have left the draft status befor this moment URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-latest-draft-date |
proposalType | S | 0..1 | CodeableConcept | BeProposalType URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-proposal-type Binding: BeVsProposalType (required) |
pss | S | 0..1 | (Complex) | BePSSInfo URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-pss-info |
performerType | S | 0..* | CodeableConcept | Discipline of provider. Replaces .performerType because of wrong cardinality URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-performer-type Binding: BeVSCdHcParty (extensible) |
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 |
intent | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: BeVsRequestIntent (required) | |
code | S | 0..1 | CodeableConcept | What's being requested/ordered |
authoredOn | SC | 1..1 | dateTime | When the request group was authored be-inv-long-date: date SHALL contain a long date (YYYY-MM-DDThh:mm:ss+zz:zz) |
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(BeReferralCareServiceRequest) | The target of the action |
Documentation for this format |
Path | Conformance | ValueSet | URI |
RequestGroup.extension:category.value[x] | extensible | BeReferralCategoryhttps://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-referral-category from this IG | |
RequestGroup.intent | required | BeVsRequestIntenthttps://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-request-intent from this IG |
Id | Grade | Path(s) | Details | Requirements |
be-inv-long-date | error | RequestGroup.authoredOn | date SHALL contain a long date (YYYY-MM-DDThh:mm:ss+zz:zz) : empty() or toString().length()=25 |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
RequestGroup | 0..* | RequestGroup | A group of related requests dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
Slices for extension | 2..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
orderDetail | S | 0..* | CodeableConcept | Optional Extensions Element URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-ServiceRequest.orderDetail ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
category | S | 1..1 | (Complex) | Optional Extensions Element URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-ServiceRequest.category ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
extension | 0..0 | |||
url | 1..1 | uri | "http://hl7.org/fhir/4.0/StructureDefinition/extension-ServiceRequest.category" | |
value[x] | 1..1 | CodeableConcept | Value of extension Binding: BeReferralCategory (extensible) ele-1: All FHIR elements must have a @value or children | |
feedback | S | 0..1 | boolean | Give feedback to the prescriber URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-feedback-to-prescriber ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
coprescriber | S | 0..1 | (Complex) | Info about the other parties that have to take part in the prescription. URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-co-prescriber-info ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
validity | S | 1..1 | Period | Validity period of the prescription URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-validity-period ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
latest | S | 0..1 | BeYearMonthDay | Request must be executed before URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-latest-end-date ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
latestDraft | S | 0..1 | BeYearMonthDay | The prescription must have left the draft status befor this moment URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-latest-draft-date ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
proposalType | S | 0..1 | CodeableConcept | BeProposalType URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-proposal-type Binding: BeVsProposalType (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
pss | S | 0..1 | (Complex) | BePSSInfo URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-pss-info ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
performerType | S | 0..* | CodeableConcept | Discipline of provider. Replaces .performerType because of wrong cardinality URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-performer-type Binding: BeVSCdHcParty (extensible) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
Slices for identifier | Σ | 0..* | Identifier | Business identifier Slice: Unordered, Open by value:system ele-1: All FHIR elements must have a @value or children |
identifier:UHMEP | Σ | 0..1 | Identifier | Reference ID of the UHMEP once available there ele-1: All FHIR elements must have a @value or children |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children |
system | Σ | 1..1 | uri | The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Fixed Value: https://www.ehealth.fgov.be/standards/fhir/referral/NamingSystem/uhmep |
value | Σ | 1..1 | string | The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456 |
groupIdentifier | SΣ | 0..1 | Identifier | Composite request this is part of ele-1: All FHIR elements must have a @value or children |
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. ele-1: All FHIR elements must have a @value or children |
intent | ?!Σ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: BeVsRequestIntent (required) ele-1: All FHIR elements must have a @value or children |
code | SΣ | 0..1 | CodeableConcept | What's being requested/ordered ele-1: All FHIR elements must have a @value or children |
authoredOn | SC | 1..1 | dateTime | When the request group was authored ele-1: All FHIR elements must have a @value or children be-inv-long-date: date SHALL contain a long date (YYYY-MM-DDThh:mm:ss+zz:zz) |
action | SC | 1..* | BackboneElement | At least one referral prescription ele-1: All FHIR elements must have a @value or children rqg-1: Must have resource or action but not both |
id | S | 0..1 | string | Unique id for inter-element referencing |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
relatedAction | S | 0..* | BackboneElement | Relationship to another action ele-1: All FHIR elements must have a @value or children |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
actionId | S | 1..1 | id | What action this is related to ele-1: All FHIR elements must have a @value or children |
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. ele-1: All FHIR elements must have a @value or children |
resource | SC | 1..1 | Reference(BeReferralCareServiceRequest) | The target of the action ele-1: All FHIR elements must have a @value or children |
Documentation for this format |
Path | Conformance | ValueSet | URI |
RequestGroup.extension:category.value[x] | extensible | BeReferralCategoryhttps://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-referral-category from this IG | |
RequestGroup.identifier:UHMEP.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
RequestGroup.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1 from the FHIR Standard | |
RequestGroup.intent | required | BeVsRequestIntenthttps://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-request-intent from this IG | |
RequestGroup.action.relatedAction.relationship | required | ActionRelationshipTypehttp://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
be-inv-long-date | error | RequestGroup.authoredOn | date SHALL contain a long date (YYYY-MM-DDThh:mm:ss+zz:zz) : empty() or toString().length()=25 | |
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() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
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.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 2..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
orderDetail | S | 0..* | CodeableConcept | Optional Extensions Element URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-ServiceRequest.orderDetail | ||||
category | S | 1..1 | (Complex) | Optional Extensions Element URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-ServiceRequest.category | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "http://hl7.org/fhir/4.0/StructureDefinition/extension-ServiceRequest.category" | |||||
value[x] | 1..1 | CodeableConcept | Value of extension Binding: BeReferralCategory (extensible) | |||||
feedback | S | 0..1 | boolean | Give feedback to the prescriber URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-feedback-to-prescriber | ||||
coprescriber | S | 0..1 | (Complex) | Info about the other parties that have to take part in the prescription. URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-co-prescriber-info | ||||
validity | S | 1..1 | Period | Validity period of the prescription URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-validity-period | ||||
latest | S | 0..1 | BeYearMonthDay | Request must be executed before URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-latest-end-date | ||||
latestDraft | S | 0..1 | BeYearMonthDay | The prescription must have left the draft status befor this moment URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-latest-draft-date | ||||
proposalType | S | 0..1 | CodeableConcept | BeProposalType URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-proposal-type Binding: BeVsProposalType (required) | ||||
pss | S | 0..1 | (Complex) | BePSSInfo URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-pss-info | ||||
performerType | S | 0..* | CodeableConcept | Discipline of provider. Replaces .performerType because of wrong cardinality URL: https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-ext-performer-type Binding: BeVSCdHcParty (extensible) | ||||
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: BeVsRequestIntent (required) | ||||
priority | Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | ||||
code | SΣ | 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 | SC | 1..1 | dateTime | When the request group was authored be-inv-long-date: date SHALL contain a long date (YYYY-MM-DDThh:mm:ss+zz:zz) | ||||
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 | SC | 1..* | BackboneElement | At least one referral prescription rqg-1: Must have resource or action but not both | ||||
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 | SC | 1..1 | Reference(BeReferralCareServiceRequest) | The target of the action | ||||
action | C | 0..* | See action (RequestGroup) | Sub action | ||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
RequestGroup.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
RequestGroup.extension:category.value[x] | extensible | BeReferralCategoryhttps://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-referral-category from this IG | ||||
RequestGroup.identifier:UHMEP.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
RequestGroup.identifier:UHMEP.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
RequestGroup.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1 from the FHIR Standard | ||||
RequestGroup.intent | required | BeVsRequestIntenthttps://www.ehealth.fgov.be/standards/fhir/referral/ValueSet/be-vs-request-intent from this IG | ||||
RequestGroup.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1 from the FHIR Standard | ||||
RequestGroup.action.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1 from the FHIR Standard | ||||
RequestGroup.action.condition.kind | required | ActionConditionKindhttp://hl7.org/fhir/ValueSet/action-condition-kind|4.0.1 from the FHIR Standard | ||||
RequestGroup.action.relatedAction.relationship | required | ActionRelationshipTypehttp://hl7.org/fhir/ValueSet/action-relationship-type|4.0.1 from the FHIR Standard | ||||
RequestGroup.action.type | extensible | ActionTypehttp://hl7.org/fhir/ValueSet/action-type from the FHIR Standard | ||||
RequestGroup.action.groupingBehavior | required | ActionGroupingBehaviorhttp://hl7.org/fhir/ValueSet/action-grouping-behavior|4.0.1 from the FHIR Standard | ||||
RequestGroup.action.selectionBehavior | required | ActionSelectionBehaviorhttp://hl7.org/fhir/ValueSet/action-selection-behavior|4.0.1 from the FHIR Standard | ||||
RequestGroup.action.requiredBehavior | required | ActionRequiredBehaviorhttp://hl7.org/fhir/ValueSet/action-required-behavior|4.0.1 from the FHIR Standard | ||||
RequestGroup.action.precheckBehavior | required | ActionPrecheckBehaviorhttp://hl7.org/fhir/ValueSet/action-precheck-behavior|4.0.1 from the FHIR Standard | ||||
RequestGroup.action.cardinalityBehavior | required | ActionCardinalityBehaviorhttp://hl7.org/fhir/ValueSet/action-cardinality-behavior|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
be-inv-long-date | error | RequestGroup.authoredOn | date SHALL contain a long date (YYYY-MM-DDThh:mm:ss+zz:zz) : empty() or toString().length()=25 | |
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: 5 elements(2 nested mandatory elements)
Must-Support: 19 elements
Fixed: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron