Prescription Search Support
1.0.0 - STU1 Belgium flag

This page is part of the eHealth FHIR PSS Profiles for Belgium (v1.0.0: Release) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Resource Profile: PSSResponseCommunicationRequest - Detailed Descriptions

Active as of 2025-05-14

Definitions for the PSSResponseCommunicationRequest resource profile.

Guidance on how to interpret the contents of this table can be found here

0. CommunicationRequest
Definition

A request to convey information; e.g. the CDS system proposes that an alert be sent to a responsible provider, the CDS system proposes that the public health agency be notified about a reportable condition.

ShortA request for information to be sent to a receiver
Control0..*
Is Modifierfalse
Summaryfalse
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
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 (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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
2. CommunicationRequest.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

ShortA set of rules under which this content was created
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Control0..1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. CommunicationRequest.extension:instantiatesCanonical
Slice NameinstantiatesCanonical
Definition

A link back to the definition that produced this recommendation. Typically a Plan or Activity Definition.

ShortSource
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(Instantiates Canonical) (Extension Type: canonical(ActivityDefinition, Measure, OperationDefinition, PlanDefinition, Questionnaire))
Is Modifierfalse
Must Supporttrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
6. CommunicationRequest.extension:rationale
Slice Namerationale
Definition

A clinician-friendly explanation for the recommendation; patient-friendly if the recommendation is patient-facing.

ShortCPG Rationale Extension
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(CPG Rationale Extension) (Extension Type: markdown)
Is Modifierfalse
Must Supporttrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
8. CommunicationRequest.extension:rating
Slice Namerating
Definition

A clinician-friendly rating, or score, for the recommendation; patient-friendly if the recommendation is patient-facing.

ShortCPG Rating Extension
Control0..1
This element is affected by the following invariants: ele-1
TypeExtension(CPG Rating Extension) (Extension Type: Choice of: Quantity, Range, Ratio)
Is Modifierfalse
Must Supporttrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
10. CommunicationRequest.modifierExtension
Definition

An Extension


May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensionExtensions that cannot be ignored
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Summaryfalse
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on CommunicationRequest.modifierExtension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 12. CommunicationRequest.modifierExtension:intent
    Slice Nameintent
    Definition

    An Extension

    ShortExtension
    Control0..1
    This element is affected by the following invariants: ele-1
    TypeExtension(Extension Definition for CommunicationRequest.intent for Version 5.0) (Extension Type: code)
    Is Modifiertrue because Modifier extensions are labelled as such because they modify the meaning or interpretation of the resource or element that contains them
    Must Supporttrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    14. CommunicationRequest.identifier
    Definition

    Business identifiers assigned to this communication request by the performer or other systems which remain constant as the resource is updated and propagates from server to server.

    ShortUnique identifier
    Comments

    This is a business identifier, not a resource identifier (see discussion). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.

    NoteThis is a business identifier, not a resource identifier (see discussion)
    Control0..*
    TypeIdentifier
    Is Modifierfalse
    Must Supporttrue
    Summarytrue
    Requirements

    Allows identification of the communication request as it is known by various participating systems and in a way that remains consistent across servers.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    16. CommunicationRequest.status
    Definition

    The status of the proposal or order.

    Shortdraft | active | on-hold | revoked | completed | entered-in-error | unknown
    Control1..1
    BindingThe codes SHALL be taken from RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1
    (required to http://hl7.org/fhir/ValueSet/request-status|4.0.1)

    The status of the communication request.

    Typecode
    Is Modifiertrue because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid.
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    18. CommunicationRequest.statusReason
    Definition

    Captures the reason for the current state of the CommunicationRequest.

    ShortReason for current status
    Comments

    This is generally only used for "exception" statuses such as "suspended" or "cancelled". The reason why the CommunicationRequest was created at all is captured in reasonCode, not here. [distinct reason codes for different statuses can be enforced using invariants if they are universal bindings].

    Control0..1
    Binding

    Codes identifying the reason for the current state of a request.

    TypeCodeableConcept
    Is Modifierfalse
    Must Supporttrue
    Summaryfalse
    Alternate NamesSuspended Reason, Cancelled Reason
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    20. CommunicationRequest.category
    Definition

    The type of message to be sent such as alert, notification, reminder, instruction, etc.

    ShortMessage category
    Comments

    There may be multiple axes of categorization and one communication request may serve multiple purposes.

    Control0..*
    BindingFor example codes, see CommunicationCategoryhttp://hl7.org/fhir/ValueSet/communication-category
    (example to http://hl7.org/fhir/ValueSet/communication-category)

    Codes for general categories of communications such as alerts, instruction, etc.

    TypeCodeableConcept
    Is Modifierfalse
    Must Supporttrue
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    22. CommunicationRequest.priority
    Definition

    Characterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine.

    Shortroutine | urgent | asap | stat
    Control0..1
    BindingThe codes SHALL be taken from RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1
    (required to http://hl7.org/fhir/ValueSet/request-priority|4.0.1)

    Codes indicating the relative importance of a communication request.

    Typecode
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Summarytrue
    Meaning if MissingIf missing, this task should be performed with normal priority
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    24. CommunicationRequest.doNotPerform
    Definition

    If true indicates that the CommunicationRequest is asking for the specified action to not occur.

    ShortTrue if request is prohibiting action
    Comments

    The attributes provided with the request qualify what is not to be done.

    Control0..1
    Typeboolean
    Is Modifiertrue because If true this element negates the specified action. For Example, instead of a request for a communication, it is a request for the communication to not occur.
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Summarytrue
    Alternate Namesprohibited
    Meaning if MissingIf do not perform is not specified, the request is a positive request e.g. "do perform"
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    26. CommunicationRequest.subject
    Definition

    The patient or group that is the focus of this communication request.

    ShortFocus of message
    Control0..1
    TypeReference(PSS anonymised Patient, Patient, Group)
    Is Modifierfalse
    Must Supporttrue
    Summaryfalse
    Alternate Namespatient
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    28. CommunicationRequest.about
    Definition

    The pertinent positive or negative information relative to this recommendation.


    Other resources that pertain to this communication request and to which this communication request should be associated.

    ShortPertinent informationResources that pertain to this communication request
    Comments

    This will typically be the most relevant case features used in determining applicability, but could also be other patient-specific information relevant to interpreting or assessing appropriateness of the recommendation with respect to the patient.


    Don't use CommunicationRequest.about element when a more specific element exists, such as basedOn, reasonReference, or replaces.

    Control0..*
    TypeReference(Resource)
    Is Modifierfalse
    Must Supporttrue
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    30. CommunicationRequest.encounter
    Definition

    The Encounter during which this CommunicationRequest was created or to which the creation of this record is tightly associated.

    ShortEncounter created as part of
    Comments

    This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter.

    Control0..1
    TypeReference(Encounter)
    Is Modifierfalse
    Must Supporttrue
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    32. CommunicationRequest.requester
    Definition

    The device, individual, or organization who initiated the request and has responsibility for its activation.

    ShortWho/what is requesting service
    Control0..1
    TypeReference(Practitioner, PractitionerRole, Organization, Patient, RelatedPerson, Device)
    Is Modifierfalse
    Must Supporttrue
    Must Support TypesNo must-support rules about the choice of types/profiles
    Summarytrue
    Alternate Namesauthor
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    34. CommunicationRequest.recipient
    Definition

    The entity (e.g. person, organization, clinical information system, device, group, or care team) which is the intended target of the communication.

    ShortMessage recipient
    Control0..*
    TypeReference(Device, Organization, Patient, Practitioner, PractitionerRole, RelatedPerson, Group, CareTeam, HealthcareService)
    Is Modifierfalse
    Must Supporttrue
    Must Support TypesNo must-support rules about the choice of types/profiles
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    36. CommunicationRequest.sender
    Definition

    The entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication.

    ShortMessage sender
    Control0..1
    TypeReference(Device, Organization, Patient, Practitioner, PractitionerRole, RelatedPerson, HealthcareService)
    Is Modifierfalse
    Must Supporttrue
    Must Support TypesNo must-support rules about the choice of types/profiles
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))