Data Management with FHIR
0.1.0 - ci-build

Data Management with FHIR - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

## Logical Model: LogicalBundle - Detailed Descriptions

Draft as of 2025-10-23

Definitions for the LogicalBundle 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. LogicalBundle
Définition | The BundleLogical has the same objective as the FHIR Bundle resource but allows for the grouping of logical models.
Short | LogicalBundle
Control | 0..*
Is Modifier | false
Logical Model | Instances of this logical model are not marked to be the target of a Reference
2. LogicalBundle.logicalId
Définition | Logical id of this artifact
Short | Logical id of this artifact
Control | 1..1
Type | id
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
4. LogicalBundle.type
Définition | It's possible to use a bundle for other purposes (e.g. a document can be accepted as a transaction). This is primarily defined so that there can be specific rules for some of the bundle types.
Short | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Control | 1..1
Binding | The codes SHALL be taken from BundleType (required to `http://hl7.org/fhir/ValueSet/bundle-type` )
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
6. LogicalBundle.entry
Définition | An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).
Short | An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).
Control | 0..*
Type | BackboneElement
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
8. LogicalBundle.entry.id
Définition | 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.
Résumé | false
10. LogicalBundle.entry.extension
Définition | 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
Commentaires | 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
Résumé | 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 `LogicalBundle.entry.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
12. LogicalBundle.entry.modifierExtension
Définition | 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
Commentaires | 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
Résumé | 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. LogicalBundle.entry.person
Définition | The Person for the entry. The purpose/meaning of the person is determined by the Bundle.type.
Short | A person in the bundle
Control | 0..1
Type | https://interop.aphp.fr/ig/fhir/dm/StructureDefinition/OMOPPerson
16. LogicalBundle.entry.location
Définition | The Location for the entry. The purpose/meaning of the location is determined by the Bundle.type.
Short | A location in the bundle
Control | 0..1
Type | https://interop.aphp.fr/ig/fhir/dm/StructureDefinition/OMOPLocation
18. LogicalBundle.entry.death
Définition | The Death for the entry. The purpose/meaning of the death is determined by the Bundle.type.
Short | A death in the bundle
Control | 0..1
Type | https://interop.aphp.fr/ig/fhir/dm/StructureDefinition/OMOPDeath
20. LogicalBundle.entry.measurement
Définition | Measurement for the entry. The purpose/meaning of the measurements is determined by the Bundle.type.
Short | Measurement(s) in the bundle
Control | 0..*
Type | https://interop.aphp.fr/ig/fhir/dm/StructureDefinition/OMOPMeasurement

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

0. LogicalBundle
Définition | The BundleLogical has the same objective as the FHIR Bundle resource but allows for the grouping of logical models.
Short | LogicalBundle
Logical Model | Instances of this logical model are not marked to be the target of a Reference
2. LogicalBundle.logicalId
Définition | Logical id of this artifact
Short | Logical id of this artifact
Control | 1..1
Type | id
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
4. LogicalBundle.type
Définition | It's possible to use a bundle for other purposes (e.g. a document can be accepted as a transaction). This is primarily defined so that there can be specific rules for some of the bundle types.
Short | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Control | 1..1
Binding | The codes SHALL be taken from BundleType (required to `http://hl7.org/fhir/ValueSet/bundle-type` )
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
6. LogicalBundle.entry
Définition | An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).
Short | An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).
Control | 0..*
Type | BackboneElement
8. LogicalBundle.entry.person
Définition | The Person for the entry. The purpose/meaning of the person is determined by the Bundle.type.
Short | A person in the bundle
Control | 0..1
Type | https://interop.aphp.fr/ig/fhir/dm/StructureDefinition/OMOPPerson
10. LogicalBundle.entry.location
Définition | The Location for the entry. The purpose/meaning of the location is determined by the Bundle.type.
Short | A location in the bundle
Control | 0..1
Type | https://interop.aphp.fr/ig/fhir/dm/StructureDefinition/OMOPLocation
12. LogicalBundle.entry.death
Définition | The Death for the entry. The purpose/meaning of the death is determined by the Bundle.type.
Short | A death in the bundle
Control | 0..1
Type | https://interop.aphp.fr/ig/fhir/dm/StructureDefinition/OMOPDeath
14. LogicalBundle.entry.measurement
Définition | Measurement for the entry. The purpose/meaning of the measurements is determined by the Bundle.type.
Short | Measurement(s) in the bundle
Control | 0..*
Type | https://interop.aphp.fr/ig/fhir/dm/StructureDefinition/OMOPMeasurement

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

0. LogicalBundle
Définition | The BundleLogical has the same objective as the FHIR Bundle resource but allows for the grouping of logical models.
Short | LogicalBundle
Control | 0..*
Is Modifier | false
Logical Model | Instances of this logical model are not marked to be the target of a Reference
2. LogicalBundle.logicalId
Définition | Logical id of this artifact
Short | Logical id of this artifact
Control | 1..1
Type | id
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
4. LogicalBundle.type
Définition | It's possible to use a bundle for other purposes (e.g. a document can be accepted as a transaction). This is primarily defined so that there can be specific rules for some of the bundle types.
Short | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Control | 1..1
Binding | The codes SHALL be taken from BundleType (required to `http://hl7.org/fhir/ValueSet/bundle-type` )
Type | code
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
6. LogicalBundle.entry
Définition | An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).
Short | An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).
Control | 0..*
Type | BackboneElement
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
8. LogicalBundle.entry.id
Définition | 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.
Résumé | false
10. LogicalBundle.entry.extension
Définition | 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
Commentaires | 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
Résumé | 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 `LogicalBundle.entry.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
12. LogicalBundle.entry.modifierExtension
Définition | 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
Commentaires | 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
Résumé | 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. LogicalBundle.entry.person
Définition | The Person for the entry. The purpose/meaning of the person is determined by the Bundle.type.
Short | A person in the bundle
Control | 0..1
Type | https://interop.aphp.fr/ig/fhir/dm/StructureDefinition/OMOPPerson
16. LogicalBundle.entry.location
Définition | The Location for the entry. The purpose/meaning of the location is determined by the Bundle.type.
Short | A location in the bundle
Control | 0..1
Type | https://interop.aphp.fr/ig/fhir/dm/StructureDefinition/OMOPLocation
18. LogicalBundle.entry.death
Définition | The Death for the entry. The purpose/meaning of the death is determined by the Bundle.type.
Short | A death in the bundle
Control | 0..1
Type | https://interop.aphp.fr/ig/fhir/dm/StructureDefinition/OMOPDeath
20. LogicalBundle.entry.measurement
Définition | Measurement for the entry. The purpose/meaning of the measurements is determined by the Bundle.type.
Short | Measurement(s) in the bundle
Control | 0..*
Type | https://interop.aphp.fr/ig/fhir/dm/StructureDefinition/OMOPMeasurement