Digital Referral Prescription Implementation Guide
1.0.0 - STU Belgium flag

Digital Referral Prescription Implementation Guide, published by eHealth Platform. 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: BeModelAssignment - Detailed Descriptions

Active as of 2025-10-10

Definitions for the BeModelAssignment logical model.

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

0. BeModelAssignment
Definition

Logical model with the information for the assignment to a referral prescription of a care provider.

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

Business identifier. Absent during creation by client software, otherwise always present.

ShortBusiness identifier. Absent during creation by client software, otherwise always present.
NoteThis is a business identifier, not a resource identifier (see discussion)
Control1..1
TypeIdentifier
4. BeModelAssignment.intent
Definition

Defaults to 'Order', since in this case it is always linked to a referral prescription.

ShortDefaults to 'Order', since in this case it is always linked to a referral prescription.
Control1..1
TypeCodeableConcept
6. BeModelAssignment.status
Definition

Status of the task

ShortStatus of the task
Control1..1
TypeCodeableConcept
8. BeModelAssignment.statusReason
Definition

Provides details on the status of the task

ShortProvides details on the status of the task
Control0..1
TypeCodeableConcept
10. BeModelAssignment.originRequestId
Definition

Reference to the associated referral prescription

ShortReference to the associated referral prescription
Control1..1
TypeIdentifier
12. BeModelAssignment.treatmentStatusId
Definition

Reference to the 'TreatmentStatus', the treatment tracking associated with the prescription

ShortReference to the 'TreatmentStatus', the treatment tracking associated with the prescription
Control1..1
TypeReference(BeModelTreatmentStatus)
14. BeModelAssignment.organizationID
Definition

Reference to the organization Task

ShortReference to the organization Task
Control0..1
TypeReference(BeModelOrganisationClaim)
16. BeModelAssignment.performer
Definition

Information about the intended performer of the task

ShortInformation about the intended performer of the task
Control1..*
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
18. BeModelAssignment.performer.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. BeModelAssignment.performer.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 BeModelAssignment.performer.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 22. BeModelAssignment.performer.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. BeModelAssignment.performer.role
    Definition

    Role of the provider assigned to provide the requested service

    ShortRole of the provider assigned to provide the requested service
    Control1..1
    TypeCodeableConcept
    26. BeModelAssignment.performer.actor
    Definition

    NISS of the provider assigned to provide the requested service

    ShortNISS of the provider assigned to provide the requested service
    Control0..1
    TypeIdentifier
    28. BeModelAssignment.performer.organisation
    Definition

    Organization assigned to provide the requested service (e.g. WGK, ...). In this case, it is the organization that is responsible for assigning the correct provider

    ShortOrganization assigned to provide the requested service (e.g. WGK, ...). In this case, it is the organization that is responsible for assigning the correct provider
    Control0..1
    TypeIdentifier
    30. BeModelAssignment.performer.startdate
    Definition

    Start date of the prescription execution (encoded by the healthcare provider who performs the treatment)

    ShortStart date of the prescription execution (encoded by the healthcare provider who performs the treatment)
    Control0..1
    TypedateTime
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    32. BeModelAssignment.performer.endDate
    Definition

    End date of the prescription execution (encoded by the healthcare provider who performs the treatment)

    ShortEnd date of the prescription execution (encoded by the healthcare provider who performs the treatment)
    Control0..1
    TypedateTime
    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 foundhere

    0. BeModelAssignment
    Definition

    Logical model with the information for the assignment to a referral prescription of a care provider.

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

    Business identifier. Absent during creation by client software, otherwise always present.

    ShortBusiness identifier. Absent during creation by client software, otherwise always present.
    NoteThis is a business identifier, not a resource identifier (see discussion)
    Control1..1
    TypeIdentifier
    4. BeModelAssignment.intent
    Definition

    Defaults to 'Order', since in this case it is always linked to a referral prescription.

    ShortDefaults to 'Order', since in this case it is always linked to a referral prescription.
    Control1..1
    TypeCodeableConcept
    6. BeModelAssignment.status
    Definition

    Status of the task

    ShortStatus of the task
    Control1..1
    TypeCodeableConcept
    8. BeModelAssignment.statusReason
    Definition

    Provides details on the status of the task

    ShortProvides details on the status of the task
    Control0..1
    TypeCodeableConcept
    10. BeModelAssignment.originRequestId
    Definition

    Reference to the associated referral prescription

    ShortReference to the associated referral prescription
    Control1..1
    TypeIdentifier
    12. BeModelAssignment.treatmentStatusId
    Definition

    Reference to the 'TreatmentStatus', the treatment tracking associated with the prescription

    ShortReference to the 'TreatmentStatus', the treatment tracking associated with the prescription
    Control1..1
    TypeReference(BeModelTreatmentStatus)
    14. BeModelAssignment.organizationID
    Definition

    Reference to the organization Task

    ShortReference to the organization Task
    Control0..1
    TypeReference(BeModelOrganisationClaim)
    16. BeModelAssignment.performer
    Definition

    Information about the intended performer of the task

    ShortInformation about the intended performer of the task
    Control1..*
    TypeBackboneElement
    18. BeModelAssignment.performer.role
    Definition

    Role of the provider assigned to provide the requested service

    ShortRole of the provider assigned to provide the requested service
    Control1..1
    TypeCodeableConcept
    20. BeModelAssignment.performer.actor
    Definition

    NISS of the provider assigned to provide the requested service

    ShortNISS of the provider assigned to provide the requested service
    Control0..1
    TypeIdentifier
    22. BeModelAssignment.performer.organisation
    Definition

    Organization assigned to provide the requested service (e.g. WGK, ...). In this case, it is the organization that is responsible for assigning the correct provider

    ShortOrganization assigned to provide the requested service (e.g. WGK, ...). In this case, it is the organization that is responsible for assigning the correct provider
    Control0..1
    TypeIdentifier
    24. BeModelAssignment.performer.startdate
    Definition

    Start date of the prescription execution (encoded by the healthcare provider who performs the treatment)

    ShortStart date of the prescription execution (encoded by the healthcare provider who performs the treatment)
    Control0..1
    TypedateTime
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    26. BeModelAssignment.performer.endDate
    Definition

    End date of the prescription execution (encoded by the healthcare provider who performs the treatment)

    ShortEnd date of the prescription execution (encoded by the healthcare provider who performs the treatment)
    Control0..1
    TypedateTime
    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 foundhere

    0. BeModelAssignment
    Definition

    Logical model with the information for the assignment to a referral prescription of a care provider.

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

    Business identifier. Absent during creation by client software, otherwise always present.

    ShortBusiness identifier. Absent during creation by client software, otherwise always present.
    NoteThis is a business identifier, not a resource identifier (see discussion)
    Control1..1
    TypeIdentifier
    4. BeModelAssignment.intent
    Definition

    Defaults to 'Order', since in this case it is always linked to a referral prescription.

    ShortDefaults to 'Order', since in this case it is always linked to a referral prescription.
    Control1..1
    TypeCodeableConcept
    6. BeModelAssignment.status
    Definition

    Status of the task

    ShortStatus of the task
    Control1..1
    TypeCodeableConcept
    8. BeModelAssignment.statusReason
    Definition

    Provides details on the status of the task

    ShortProvides details on the status of the task
    Control0..1
    TypeCodeableConcept
    10. BeModelAssignment.originRequestId
    Definition

    Reference to the associated referral prescription

    ShortReference to the associated referral prescription
    Control1..1
    TypeIdentifier
    12. BeModelAssignment.treatmentStatusId
    Definition

    Reference to the 'TreatmentStatus', the treatment tracking associated with the prescription

    ShortReference to the 'TreatmentStatus', the treatment tracking associated with the prescription
    Control1..1
    TypeReference(BeModelTreatmentStatus)
    14. BeModelAssignment.organizationID
    Definition

    Reference to the organization Task

    ShortReference to the organization Task
    Control0..1
    TypeReference(BeModelOrganisationClaim)
    16. BeModelAssignment.performer
    Definition

    Information about the intended performer of the task

    ShortInformation about the intended performer of the task
    Control1..*
    TypeBackboneElement
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    18. BeModelAssignment.performer.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. BeModelAssignment.performer.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 BeModelAssignment.performer.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 22. BeModelAssignment.performer.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. BeModelAssignment.performer.role
      Definition

      Role of the provider assigned to provide the requested service

      ShortRole of the provider assigned to provide the requested service
      Control1..1
      TypeCodeableConcept
      26. BeModelAssignment.performer.actor
      Definition

      NISS of the provider assigned to provide the requested service

      ShortNISS of the provider assigned to provide the requested service
      Control0..1
      TypeIdentifier
      28. BeModelAssignment.performer.organisation
      Definition

      Organization assigned to provide the requested service (e.g. WGK, ...). In this case, it is the organization that is responsible for assigning the correct provider

      ShortOrganization assigned to provide the requested service (e.g. WGK, ...). In this case, it is the organization that is responsible for assigning the correct provider
      Control0..1
      TypeIdentifier
      30. BeModelAssignment.performer.startdate
      Definition

      Start date of the prescription execution (encoded by the healthcare provider who performs the treatment)

      ShortStart date of the prescription execution (encoded by the healthcare provider who performs the treatment)
      Control0..1
      TypedateTime
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      32. BeModelAssignment.performer.endDate
      Definition

      End date of the prescription execution (encoded by the healthcare provider who performs the treatment)

      ShortEnd date of the prescription execution (encoded by the healthcare provider who performs the treatment)
      Control0..1
      TypedateTime
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension