Digital Referral Prescription Implementation Guide
1.0.0 - STU

Digital Referral Prescription Implementation Guide, 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: BeModelAssignment - Detailed Descriptions

Draft as of 2025-10-17

Definitions for the BeModelAssignment logical model.

- Key Elements Table
- Differential Elements Table
- Snapshot Elements Table

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.
Short | BeModelAssignment
Control | 0..*
Is Modifier | false
Logical Model | Instances 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.
Short | Business identifier. Absent during creation by client software, otherwise always present.
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 1..1
Type | Identifier
4. BeModelAssignment.intent
Definition | Defaults to 'Order', since in this case it is always linked to a referral prescription.
Short | Defaults to 'Order', since in this case it is always linked to a referral prescription.
Control | 1..1
Type | CodeableConcept
6. BeModelAssignment.status
Definition | Status of the task
Short | Status of the task
Control | 1..1
Type | CodeableConcept
8. BeModelAssignment.statusReason
Definition | Provides details on the status of the task
Short | Provides details on the status of the task
Control | 0..1
Type | CodeableConcept
10. BeModelAssignment.originRequestId
Definition | Reference to the associated referral prescription
Short | Reference to the associated referral prescription
Control | 1..1
Type | Identifier
12. BeModelAssignment.treatmentStatusId
Definition | Reference to the 'TreatmentStatus', the treatment tracking associated with the prescription
Short | Reference to the 'TreatmentStatus', the treatment tracking associated with the prescription
Control | 1..1
Type | Reference(BeModelTreatmentStatus)
14. BeModelAssignment.organizationID
Definition | Reference to the organization Task
Short | Reference to the organization Task
Control | 0..1
Type | Reference(BeModelOrganisationClaim)
16. BeModelAssignment.performer
Definition | Information about the intended performer of the task
Short | Information about the intended performer of the task
Control | 1..*
Type | BackboneElement
Invariants | ele-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.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
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.
Short | Additional 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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-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())
Slicing | This 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).
Short | Extensions 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.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
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 Names | extensions, user content, modifiers
Invariants | ele-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
Short | Role of the provider assigned to provide the requested service
Control | 1..1
Type | CodeableConcept
26. BeModelAssignment.performer.actor
Definition | NISS of the provider assigned to provide the requested service
Short | NISS of the provider assigned to provide the requested service
Control | 0..1
Type | Identifier
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
Short | 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
Control | 0..1
Type | Identifier
30. BeModelAssignment.performer.startdate
Definition | Start date of the prescription execution (encoded by the healthcare provider who performs the treatment)
Short | Start date of the prescription execution (encoded by the healthcare provider who performs the treatment)
Control | 0..1
Type | dateTime
Primitive Value | This 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)
Short | End date of the prescription execution (encoded by the healthcare provider who performs the treatment)
Control | 0..1
Type | dateTime
Primitive Value | This 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.
Short | BeModelAssignment
Logical Model | Instances 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.
Short | Business identifier. Absent during creation by client software, otherwise always present.
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 1..1
Type | Identifier
4. BeModelAssignment.intent
Definition | Defaults to 'Order', since in this case it is always linked to a referral prescription.
Short | Defaults to 'Order', since in this case it is always linked to a referral prescription.
Control | 1..1
Type | CodeableConcept
6. BeModelAssignment.status
Definition | Status of the task
Short | Status of the task
Control | 1..1
Type | CodeableConcept
8. BeModelAssignment.statusReason
Definition | Provides details on the status of the task
Short | Provides details on the status of the task
Control | 0..1
Type | CodeableConcept
10. BeModelAssignment.originRequestId
Definition | Reference to the associated referral prescription
Short | Reference to the associated referral prescription
Control | 1..1
Type | Identifier
12. BeModelAssignment.treatmentStatusId
Definition | Reference to the 'TreatmentStatus', the treatment tracking associated with the prescription
Short | Reference to the 'TreatmentStatus', the treatment tracking associated with the prescription
Control | 1..1
Type | Reference(BeModelTreatmentStatus)
14. BeModelAssignment.organizationID
Definition | Reference to the organization Task
Short | Reference to the organization Task
Control | 0..1
Type | Reference(BeModelOrganisationClaim)
16. BeModelAssignment.performer
Definition | Information about the intended performer of the task
Short | Information about the intended performer of the task
Control | 1..*
Type | BackboneElement
18. BeModelAssignment.performer.role
Definition | Role of the provider assigned to provide the requested service
Short | Role of the provider assigned to provide the requested service
Control | 1..1
Type | CodeableConcept
20. BeModelAssignment.performer.actor
Definition | NISS of the provider assigned to provide the requested service
Short | NISS of the provider assigned to provide the requested service
Control | 0..1
Type | Identifier
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
Short | 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
Control | 0..1
Type | Identifier
24. BeModelAssignment.performer.startdate
Definition | Start date of the prescription execution (encoded by the healthcare provider who performs the treatment)
Short | Start date of the prescription execution (encoded by the healthcare provider who performs the treatment)
Control | 0..1
Type | dateTime
Primitive Value | This 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)
Short | End date of the prescription execution (encoded by the healthcare provider who performs the treatment)
Control | 0..1
Type | dateTime
Primitive Value | This 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.
Short | BeModelAssignment
Control | 0..*
Is Modifier | false
Logical Model | Instances 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.
Short | Business identifier. Absent during creation by client software, otherwise always present.
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 1..1
Type | Identifier
4. BeModelAssignment.intent
Definition | Defaults to 'Order', since in this case it is always linked to a referral prescription.
Short | Defaults to 'Order', since in this case it is always linked to a referral prescription.
Control | 1..1
Type | CodeableConcept
6. BeModelAssignment.status
Definition | Status of the task
Short | Status of the task
Control | 1..1
Type | CodeableConcept
8. BeModelAssignment.statusReason
Definition | Provides details on the status of the task
Short | Provides details on the status of the task
Control | 0..1
Type | CodeableConcept
10. BeModelAssignment.originRequestId
Definition | Reference to the associated referral prescription
Short | Reference to the associated referral prescription
Control | 1..1
Type | Identifier
12. BeModelAssignment.treatmentStatusId
Definition | Reference to the 'TreatmentStatus', the treatment tracking associated with the prescription
Short | Reference to the 'TreatmentStatus', the treatment tracking associated with the prescription
Control | 1..1
Type | Reference(BeModelTreatmentStatus)
14. BeModelAssignment.organizationID
Definition | Reference to the organization Task
Short | Reference to the organization Task
Control | 0..1
Type | Reference(BeModelOrganisationClaim)
16. BeModelAssignment.performer
Definition | Information about the intended performer of the task
Short | Information about the intended performer of the task
Control | 1..*
Type | BackboneElement
Invariants | ele-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.
Short | Unique id for inter-element referencing
Control | 0..1
Type | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
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.
Short | Additional 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.
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Alternate Names | extensions, user content
Invariants | ele-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()`)
Slicing | This 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).
Short | Extensions 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.
Control | 0..*
Type | Extension
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summary | true
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 Names | extensions, user content, modifiers
Invariants | ele-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
Short | Role of the provider assigned to provide the requested service
Control | 1..1
Type | CodeableConcept
26. BeModelAssignment.performer.actor
Definition | NISS of the provider assigned to provide the requested service
Short | NISS of the provider assigned to provide the requested service
Control | 0..1
Type | Identifier
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
Short | 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
Control | 0..1
Type | Identifier
30. BeModelAssignment.performer.startdate
Definition | Start date of the prescription execution (encoded by the healthcare provider who performs the treatment)
Short | Start date of the prescription execution (encoded by the healthcare provider who performs the treatment)
Control | 0..1
Type | dateTime
Primitive Value | This 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)
Short | End date of the prescription execution (encoded by the healthcare provider who performs the treatment)
Control | 0..1
Type | dateTime
Primitive Value | This primitive element may be present, or absent, or replaced by an extension