Referral Prescription
1.0.0 - STU
Referral Prescription
1.0.0 - STU
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
| Draft as of 2024-03-15 |
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. |
| Logical Model | Instances 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 |
| Short | The business identifier of the request group |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 1..1 |
| Type | Identifier |
| 4. BeModelReferralRequestGroup.groupIdentifier | |
| Short | If the group belongs to another group, the identifier of this group |
| Control | 0..1 |
| Type | Identifier |
| 6. BeModelReferralRequestGroup.action | |
| Short | The actions (prescriptions) that belong together in the referral request-group |
| Control | 0..* |
| Type | BackboneElement |
| 8. BeModelReferralRequestGroup.action.identifier | |
| Definition | id for local reference |
| Short | id for local reference |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 10. BeModelReferralRequestGroup.action.relatedAction | |
| Short | The actions (prescriptions) that are related to the current action |
| Control | 1..* |
| Type | BackboneElement |
| 12. BeModelReferralRequestGroup.action.relatedAction.actionId | |
| Short | The actionId of the action the action is related to |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 14. BeModelReferralRequestGroup.action.relatedAction.relationShip | |
| Short | The description of the relationship between both actions (before, after, concurrent) |
| Control | 1..1 |
| Type | code |
| 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 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. |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances 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 |
| Short | The business identifier of the request group |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 1..1 |
| Type | Identifier |
| 4. BeModelReferralRequestGroup.groupIdentifier | |
| Short | If the group belongs to another group, the identifier of this group |
| Control | 0..1 |
| Type | Identifier |
| 6. BeModelReferralRequestGroup.action | |
| Short | The actions (prescriptions) that belong together in the referral request-group |
| Control | 0..* |
| Type | BackboneElement |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 8. 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). |
| 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()) |
| 10. BeModelReferralRequestGroup.action.identifier | |
| Definition | id for local reference |
| Short | id for local reference |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 12. BeModelReferralRequestGroup.action.relatedAction | |
| Short | The actions (prescriptions) that are related to the current action |
| Control | 1..* |
| Type | BackboneElement |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 14. 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). |
| 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()) |
| 16. BeModelReferralRequestGroup.action.relatedAction.actionId | |
| Short | The actionId of the action the action is related to |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 18. BeModelReferralRequestGroup.action.relatedAction.relationShip | |
| Short | The description of the relationship between both actions (before, after, concurrent) |
| Control | 1..1 |
| Type | code |
| 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 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. |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances 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 |
| Short | The business identifier of the request group |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 1..1 |
| Type | Identifier |
| 4. BeModelReferralRequestGroup.groupIdentifier | |
| Short | If the group belongs to another group, the identifier of this group |
| Control | 0..1 |
| Type | Identifier |
| 6. BeModelReferralRequestGroup.action | |
| Short | The actions (prescriptions) that belong together in the referral request-group |
| Control | 0..* |
| Type | BackboneElement |
| Invariants | ele-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. |
| 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 |
| 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. |
| 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 BeModelReferralRequestGroup.action.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: |
| 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). |
| 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()) |
| 14. BeModelReferralRequestGroup.action.identifier | |
| Definition | id for local reference |
| Short | id for local reference |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 16. BeModelReferralRequestGroup.action.relatedAction | |
| Short | The actions (prescriptions) that are related to the current action |
| Control | 1..* |
| Type | BackboneElement |
| Invariants | ele-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. |
| 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. 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. |
| 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 BeModelReferralRequestGroup.action.relatedAction.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: |
| 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). |
| 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. BeModelReferralRequestGroup.action.relatedAction.actionId | |
| Short | The actionId of the action the action is related to |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 26. BeModelReferralRequestGroup.action.relatedAction.relationShip | |
| Short | The description of the relationship between both actions (before, after, concurrent) |
| Control | 1..1 |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
IG © 2022+ . Package hl7.fhir.be.referral#1.0.0 based on FHIR 4.0.1. Generated 2024-03-15
Links: Table of Contents |
QA Report |
Version History |
