Referral Prescription
1.0.0 - STU Belgium flag

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

Logical Model: BeModelReferralRequestGroup - Detailed Descriptions

Draft as of 2024-12-11

Definitions for the BeModelReferralRequestGroup logical model.

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

0. BeModelReferralRequestGroup
Definition

Logical model describing the model for a group of referral prescriptions. This draft is used in the HL7 Belgian workgroup for referral.

ShortBeModelReferralRequestGroup
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. BeModelReferralRequestGroup.identifier
Definition

The business identifier of the request group

ShortThe business identifier of the request group
NoteThis is a business identifier, not a resource identifier (see discussion)
Control1..1
TypeIdentifier
4. BeModelReferralRequestGroup.groupIdentifier
ShortIf the group belongs to another group, the identifier of this group
Control0..1
TypeIdentifier
6. BeModelReferralRequestGroup.action
ShortThe actions (prescriptions) that belong together in the referral request-group
Control0..*
TypeBackboneElement
8. BeModelReferralRequestGroup.action.identifier
Definition

id for local reference

Shortid for local reference
NoteThis is a business identifier, not a resource identifier (see discussion)
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. BeModelReferralRequestGroup.action.relatedAction
ShortThe actions (prescriptions) that are related to the current action
Control1..*
TypeBackboneElement
12. BeModelReferralRequestGroup.action.relatedAction.actionId
ShortThe actionId of the action the action is related to
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. BeModelReferralRequestGroup.action.relatedAction.relationShip
ShortThe description of the relationship between both actions (before, after, concurrent)
Control1..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension

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

0. BeModelReferralRequestGroup
Definition

Logical model describing the model for a group of referral prescriptions. This draft is used in the HL7 Belgian workgroup for referral.

ShortBeModelReferralRequestGroup
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. BeModelReferralRequestGroup.identifier
Definition

The business identifier of the request group

ShortThe business identifier of the request group
NoteThis is a business identifier, not a resource identifier (see discussion)
Control1..1
TypeIdentifier
4. BeModelReferralRequestGroup.groupIdentifier
ShortIf the group belongs to another group, the identifier of this group
Control0..1
TypeIdentifier
6. BeModelReferralRequestGroup.action
ShortThe actions (prescriptions) that belong together in the referral request-group
Control0..*
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. BeModelReferralRequestGroup.action.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
10. BeModelReferralRequestGroup.action.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
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 Modifierfalse
Summaryfalse
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 BeModelReferralRequestGroup.action.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 12. BeModelReferralRequestGroup.action.modifierExtension
    Definition

    May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 can 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).

    ShortExtensions that cannot be ignored even if unrecognized
    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 element that contains them
    Summarytrue
    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, modifiers
    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())
    14. BeModelReferralRequestGroup.action.identifier
    Definition

    id for local reference

    Shortid for local reference
    NoteThis is a business identifier, not a resource identifier (see discussion)
    Control1..1
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    16. BeModelReferralRequestGroup.action.relatedAction
    ShortThe actions (prescriptions) that are related to the current action
    Control1..*
    TypeBackboneElement
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    18. BeModelReferralRequestGroup.action.relatedAction.id
    Definition

    Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

    ShortUnique id for inter-element referencing
    Control0..1
    Typestring
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    20. BeModelReferralRequestGroup.action.relatedAction.extension
    Definition

    May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

    ShortAdditional content defined by implementations
    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 Modifierfalse
    Summaryfalse
    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 BeModelReferralRequestGroup.action.relatedAction.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 22. BeModelReferralRequestGroup.action.relatedAction.modifierExtension
      Definition

      May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 can 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).

      ShortExtensions that cannot be ignored even if unrecognized
      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 element that contains them
      Summarytrue
      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, modifiers
      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())
      24. BeModelReferralRequestGroup.action.relatedAction.actionId
      ShortThe actionId of the action the action is related to
      Control1..1
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      26. BeModelReferralRequestGroup.action.relatedAction.relationShip
      ShortThe description of the relationship between both actions (before, after, concurrent)
      Control1..1
      Typecode
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension

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

      0. BeModelReferralRequestGroup
      Definition

      Logical model describing the model for a group of referral prescriptions. This draft is used in the HL7 Belgian workgroup for referral.

      ShortBeModelReferralRequestGroup
      Control0..*
      Is Modifierfalse
      Logical ModelInstances of this logical model are not marked to be the target of a Reference
      2. BeModelReferralRequestGroup.identifier
      Definition

      The business identifier of the request group

      ShortThe business identifier of the request group
      NoteThis is a business identifier, not a resource identifier (see discussion)
      Control1..1
      TypeIdentifier
      4. BeModelReferralRequestGroup.groupIdentifier
      ShortIf the group belongs to another group, the identifier of this group
      Control0..1
      TypeIdentifier
      6. BeModelReferralRequestGroup.action
      ShortThe actions (prescriptions) that belong together in the referral request-group
      Control0..*
      TypeBackboneElement
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      8. BeModelReferralRequestGroup.action.id
      Definition

      Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

      ShortUnique id for inter-element referencing
      Control0..1
      Typestring
      Is Modifierfalse
      XML FormatIn the XML format, this property is represented as an attribute.
      Summaryfalse
      10. BeModelReferralRequestGroup.action.extension
      Definition

      May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

      ShortAdditional content defined by implementations
      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 Modifierfalse
      Summaryfalse
      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 BeModelReferralRequestGroup.action.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 12. BeModelReferralRequestGroup.action.modifierExtension
        Definition

        May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 can 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).

        ShortExtensions that cannot be ignored even if unrecognized
        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 element that contains them
        Summarytrue
        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, modifiers
        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())
        14. BeModelReferralRequestGroup.action.identifier
        Definition

        id for local reference

        Shortid for local reference
        NoteThis is a business identifier, not a resource identifier (see discussion)
        Control1..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        16. BeModelReferralRequestGroup.action.relatedAction
        ShortThe actions (prescriptions) that are related to the current action
        Control1..*
        TypeBackboneElement
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        18. BeModelReferralRequestGroup.action.relatedAction.id
        Definition

        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

        ShortUnique id for inter-element referencing
        Control0..1
        Typestring
        Is Modifierfalse
        XML FormatIn the XML format, this property is represented as an attribute.
        Summaryfalse
        20. BeModelReferralRequestGroup.action.relatedAction.extension
        Definition

        May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

        ShortAdditional content defined by implementations
        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 Modifierfalse
        Summaryfalse
        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 BeModelReferralRequestGroup.action.relatedAction.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 22. BeModelReferralRequestGroup.action.relatedAction.modifierExtension
          Definition

          May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 can 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).

          ShortExtensions that cannot be ignored even if unrecognized
          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 element that contains them
          Summarytrue
          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, modifiers
          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())
          24. BeModelReferralRequestGroup.action.relatedAction.actionId
          ShortThe actionId of the action the action is related to
          Control1..1
          Typestring
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          26. BeModelReferralRequestGroup.action.relatedAction.relationShip
          ShortThe description of the relationship between both actions (before, after, concurrent)
          Control1..1
          Typecode
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension