FHIR IG analytics| Package | hl7.fhir.be.drp |
| Resource Type | StructureDefinition |
| Id | StructureDefinition-BeModelAssignment.json |
| FHIR Version | R4 |
| Source | https://build.fhir.org/ig/hl7-be/referral/StructureDefinition-BeModelAssignment.html |
| URL | https://www.ehealth.fgov.be/standards/fhir/drp/StructureDefinition/BeModelAssignment |
| Version | 1.0.0 |
| Status | active |
| Date | 2025-12-02T09:15:42+00:00 |
| Name | BeModelAssignment |
| Realm | be |
| Authority | hl7 |
| Description | Logical model with the information for the assignment to a referral prescription of a care provider. |
| Type | https://www.ehealth.fgov.be/standards/fhir/drp/StructureDefinition/BeModelAssignment |
| Kind | logical |
No resources found
| StructureDefinition | |
| BeModelOrganisationClaim | BeModelOrganisationClaim |
| BeModelTreatmentStatus | BeModelTreatmentStatus |
Note: links and images are rebased to the (stated) source
Generated Narrative: StructureDefinition BeModelAssignment
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  BeModelAssignment | 0..* | Base | BeModelAssignment Instances of this logical model can be the target of a Reference | |
  identifier | 1..1 | Identifier | Business identifier. Absent during creation by client software, otherwise always present. | |
| intent | 1..1 | CodeableConcept | Defaults to 'Order', since in this case it is always linked to a referral prescription. | |
| status | 1..1 | CodeableConcept | Status of the task | |
| statusReason | 0..1 | CodeableConcept | Provides details on the status of the task | |
| originRequestId | 1..1 | Identifier | Reference to the associated referral prescription | |
 treatmentStatusId | 1..1 | Reference(BeModelTreatmentStatus) | Reference to the 'TreatmentStatus', the treatment tracking associated with the prescription | |
| organizationID | 0..1 | Reference(BeModelOrganisationClaim) | Reference to the organization Task | |
 performer | 1..* | BackboneElement | Information about the intended performer of the task | |
 role | 1..1 | CodeableConcept | Role of the provider assigned to provide the requested service | |
| actor | 0..1 | Identifier | NISS of the provider assigned to provide the requested service | |
| organisation | 0..1 | Identifier | 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 | |
 startdate | 0..1 | dateTime | Start date of the prescription execution (encoded by the healthcare provider who performs the treatment) | |
| endDate | 0..1 | dateTime | End date of the prescription execution (encoded by the healthcare provider who performs the treatment) | |
| Documentation for this format | ||||
FHIR
FHIRsmith{
"resourceType": "StructureDefinition",
"id": "BeModelAssignment",
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
"valueCode": "can-be-target"
}
],
"url": "https://www.ehealth.fgov.be/standards/fhir/drp/StructureDefinition/BeModelAssignment",
"version": "1.0.0",
"name": "BeModelAssignment",
"status": "active",
"date": "2025-12-02T09:15:42+00:00",
"publisher": "eHealth Platform",
"contact": [
{
"name": "eHealth Platform",
"telecom": [
{
"system": "url",
"value": "https://www.ehealth.fgov.be/standards/fhir"
},
{
"system": "email",
"value": "support@be-ehealth-standards.atlassian.net"
}
]
},
{
"name": "Message Structure eHealth",
"telecom": [
{
"system": "email",
"value": "support@be-ehealth-standards.atlassian.net",
"use": "work"
}
]
}
],
"description": "Logical model with the information for the assignment to a referral prescription of a care provider.",
"jurisdiction": [
{
"coding": [
{
"system": "urn:iso:std:iso:3166",
"code": "BE",
"display": "Belgium"
}
]
}
],
"fhirVersion": "4.0.1",
"kind": "logical",
"abstract": false,
"type": "https://www.ehealth.fgov.be/standards/fhir/drp/StructureDefinition/BeModelAssignment",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Base",
"derivation": "specialization",
"snapshot": {
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString": "4.0.1"
}
],
"element": [
{
"id": "BeModelAssignment",
"path": "BeModelAssignment",
"short": "BeModelAssignment",
"definition": "Logical model with the information for the assignment to a referral prescription of a care provider.",
"min": 0,
"max": "*",
"base": {
"path": "Base",
"min": 0,
"max": "*"
},
"isModifier": false
},
{
"id": "BeModelAssignment.identifier",
"path": "BeModelAssignment.identifier",
"short": "Business identifier. Absent during creation by client software, otherwise always present.",
"definition": "Business identifier. Absent during creation by client software, otherwise always present.",
"min": 1,
"max": "1",
"base": {
"path": "BeModelAssignment.identifier",
"min": 1,
"max": "1"
},
"type": [
{
"code": "Identifier"
}
]
},
{
"id": "BeModelAssignment.intent",
"path": "BeModelAssignment.intent",
"short": "Defaults to 'Order', since in this case it is always linked to a referral prescription.",
"definition": "Defaults to 'Order', since in this case it is always linked to a referral prescription.",
"min": 1,
"max": "1",
"base": {
"path": "BeModelAssignment.intent",
"min": 1,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "BeModelAssignment.status",
"path": "BeModelAssignment.status",
"short": "Status of the task",
"definition": "Status of the task",
"min": 1,
"max": "1",
"base": {
"path": "BeModelAssignment.status",
"min": 1,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "BeModelAssignment.statusReason",
"path": "BeModelAssignment.statusReason",
"short": "Provides details on the status of the task",
"definition": "Provides details on the status of the task",
"min": 0,
"max": "1",
"base": {
"path": "BeModelAssignment.statusReason",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "BeModelAssignment.originRequestId",
"path": "BeModelAssignment.originRequestId",
"short": "Reference to the associated referral prescription",
"definition": "Reference to the associated referral prescription",
"min": 1,
"max": "1",
"base": {
"path": "BeModelAssignment.originRequestId",
"min": 1,
"max": "1"
},
"type": [
{
"code": "Identifier"
}
]
},
{
"id": "BeModelAssignment.treatmentStatusId",
"path": "BeModelAssignment.treatmentStatusId",
"short": "Reference to the 'TreatmentStatus', the treatment tracking associated with the prescription",
"definition": "Reference to the 'TreatmentStatus', the treatment tracking associated with the prescription",
"min": 1,
"max": "1",
"base": {
"path": "BeModelAssignment.treatmentStatusId",
"min": 1,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"https://www.ehealth.fgov.be/standards/fhir/drp/StructureDefinition/BeModelTreatmentStatus"
]
}
]
},
{
"id": "BeModelAssignment.organizationID",
"path": "BeModelAssignment.organizationID",
"short": "Reference to the organization Task",
"definition": "Reference to the organization Task",
"min": 0,
"max": "1",
"base": {
"path": "BeModelAssignment.organizationID",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"https://www.ehealth.fgov.be/standards/fhir/drp/StructureDefinition/BeModelOrganisationClaim"
]
}
]
},
{
"id": "BeModelAssignment.performer",
"path": "BeModelAssignment.performer",
"short": "Information about the intended performer of the task",
"definition": "Information about the intended performer of the task",
"min": 1,
"max": "*",
"base": {
"path": "BeModelAssignment.performer",
"min": 1,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
]
},
{
"id": "BeModelAssignment.performer.id",
"path": "BeModelAssignment.performer.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "BeModelAssignment.performer.extension",
"path": "BeModelAssignment.performer.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"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.",
"comment": "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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "BeModelAssignment.performer.modifierExtension",
"path": "BeModelAssignment.performer.modifierExtension",
"short": "Extensions that cannot be ignored even if unrecognized",
"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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "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.",
"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](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": true,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "BeModelAssignment.performer.role",
"path": "BeModelAssignment.performer.role",
"short": "Role of the provider assigned to provide the requested service",
"definition": "Role of the provider assigned to provide the requested service",
"min": 1,
"max": "1",
"base": {
"path": "BeModelAssignment.performer.role",
"min": 1,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "BeModelAssignment.performer.actor",
"path": "BeModelAssignment.performer.actor",
"short": "NISS of the provider assigned to provide the requested service",
"definition": "NISS of the provider assigned to provide the requested service",
"min": 0,
"max": "1",
"base": {
"path": "BeModelAssignment.performer.actor",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Identifier"
}
]
},
{
"id": "BeModelAssignment.performer.organisation",
"path": "BeModelAssignment.performer.organisation",
"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",
"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",
"min": 0,
"max": "1",
"base": {
"path": "BeModelAssignment.performer.organisation",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Identifier"
}
]
},
{
"id": "BeModelAssignment.performer.startdate",
"path": "BeModelAssignment.performer.startdate",
"short": "Start date of the prescription execution (encoded by the healthcare provider who performs the treatment)",
"definition": "Start date of the prescription execution (encoded by the healthcare provider who performs the treatment)",
"min": 0,
"max": "1",
"base": {
"path": "BeModelAssignment.performer.startdate",
"min": 0,
"max": "1"
},
"type": [
{
"code": "dateTime"
}
]
},
{
"id": "BeModelAssignment.performer.endDate",
"path": "BeModelAssignment.performer.endDate",
"short": "End date of the prescription execution (encoded by the healthcare provider who performs the treatment)",
"definition": "End date of the prescription execution (encoded by the healthcare provider who performs the treatment)",
"min": 0,
"max": "1",
"base": {
"path": "BeModelAssignment.performer.endDate",
"min": 0,
"max": "1"
},
"type": [
{
"code": "dateTime"
}
]
}
]
},
"differential": {
"element": [
{
"id": "BeModelAssignment",
"path": "BeModelAssignment",
"short": "BeModelAssignment",
"definition": "Logical model with the information for the assignment to a referral prescription of a care provider."
},
{
"id": "BeModelAssignment.identifier",
"path": "BeModelAssignment.identifier",
"short": "Business identifier. Absent during creation by client software, otherwise always present.",
"definition": "Business identifier. Absent during creation by client software, otherwise always present.",
"min": 1,
"max": "1",
"type": [
{
"code": "Identifier"
}
]
},
{
"id": "BeModelAssignment.intent",
"path": "BeModelAssignment.intent",
"short": "Defaults to 'Order', since in this case it is always linked to a referral prescription.",
"definition": "Defaults to 'Order', since in this case it is always linked to a referral prescription.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "BeModelAssignment.status",
"path": "BeModelAssignment.status",
"short": "Status of the task",
"definition": "Status of the task",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "BeModelAssignment.statusReason",
"path": "BeModelAssignment.statusReason",
"short": "Provides details on the status of the task",
"definition": "Provides details on the status of the task",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "BeModelAssignment.originRequestId",
"path": "BeModelAssignment.originRequestId",
"short": "Reference to the associated referral prescription",
"definition": "Reference to the associated referral prescription",
"min": 1,
"max": "1",
"type": [
{
"code": "Identifier"
}
]
},
{
"id": "BeModelAssignment.treatmentStatusId",
"path": "BeModelAssignment.treatmentStatusId",
"short": "Reference to the 'TreatmentStatus', the treatment tracking associated with the prescription",
"definition": "Reference to the 'TreatmentStatus', the treatment tracking associated with the prescription",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": [
"https://www.ehealth.fgov.be/standards/fhir/drp/StructureDefinition/BeModelTreatmentStatus"
]
}
]
},
{
"id": "BeModelAssignment.organizationID",
"path": "BeModelAssignment.organizationID",
"short": "Reference to the organization Task",
"definition": "Reference to the organization Task",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": [
"https://www.ehealth.fgov.be/standards/fhir/drp/StructureDefinition/BeModelOrganisationClaim"
]
}
]
},
{
"id": "BeModelAssignment.performer",
"path": "BeModelAssignment.performer",
"short": "Information about the intended performer of the task",
"definition": "Information about the intended performer of the task",
"min": 1,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "BeModelAssignment.performer.role",
"path": "BeModelAssignment.performer.role",
"short": "Role of the provider assigned to provide the requested service",
"definition": "Role of the provider assigned to provide the requested service",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "BeModelAssignment.performer.actor",
"path": "BeModelAssignment.performer.actor",
"short": "NISS of the provider assigned to provide the requested service",
"definition": "NISS of the provider assigned to provide the requested service",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
]
},
{
"id": "BeModelAssignment.performer.organisation",
"path": "BeModelAssignment.performer.organisation",
"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",
"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",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
]
},
{
"id": "BeModelAssignment.performer.startdate",
"path": "BeModelAssignment.performer.startdate",
"short": "Start date of the prescription execution (encoded by the healthcare provider who performs the treatment)",
"definition": "Start date of the prescription execution (encoded by the healthcare provider who performs the treatment)",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
]
},
{
"id": "BeModelAssignment.performer.endDate",
"path": "BeModelAssignment.performer.endDate",
"short": "End date of the prescription execution (encoded by the healthcare provider who performs the treatment)",
"definition": "End date of the prescription execution (encoded by the healthcare provider who performs the treatment)",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
]
}
]
}
}