Guide d'implémentation du GT Standards et Interopérabilité pour les EDS
0.1.0 - ci-build France flag

Guide d'implémentation du GT Standards et Interopérabilité pour les EDS - 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 2024-10-08

Definitions for the LogicalBundle logical model.

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

0. LogicalBundle
Definition

The BundleLogical has the same objective as the FHIR Bundle resource but allows for the grouping of logical models.

ShortLogicalBundle
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. LogicalBundle.id
Definition

Logical id of this artifact

ShortLogical id of this artifact
Control1..1
Typeid
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
4. LogicalBundle.type
Definition

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.

Shortdocument | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Control1..1
BindingThe codes SHALL be taken from BundleType
(required to http://hl7.org/fhir/ValueSet/bundle-type)
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. LogicalBundle.entry
Definition

An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).

ShortAn entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).
Control0..*
TypeBackboneElement
8. LogicalBundle.entry.person
Definition

The Person for the entry. The purpose/meaning of the person is determined by the Bundle.type.

ShortA person in the bundle
Control0..1
Typehttps://interop.esante.gouv.fr/ig/fhir/eds/StructureDefinition/OMOPPerson
10. LogicalBundle.entry.location
Definition

The Location for the entry. The purpose/meaning of the location is determined by the Bundle.type.

ShortA location in the bundle
Control0..1
Typehttps://interop.esante.gouv.fr/ig/fhir/eds/StructureDefinition/OMOPLocation
12. LogicalBundle.entry.death
Definition

The Death for the entry. The purpose/meaning of the death is determined by the Bundle.type.

ShortA death in the bundle
Control0..1
Typehttps://interop.esante.gouv.fr/ig/fhir/eds/StructureDefinition/OMOPDeath
14. LogicalBundle.entry.measurement
Definition

Measurement for the entry. The purpose/meaning of the measurements is determined by the Bundle.type.

ShortMasurement(s) in the bundle
Control0..*
Typehttps://interop.esante.gouv.fr/ig/fhir/eds/StructureDefinition/OMOPMeasurement

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

0. LogicalBundle
Definition

The BundleLogical has the same objective as the FHIR Bundle resource but allows for the grouping of logical models.

ShortLogicalBundle
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. LogicalBundle.id
Definition

Logical id of this artifact

ShortLogical id of this artifact
Control1..1
Typeid
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
4. LogicalBundle.type
Definition

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.

Shortdocument | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Control1..1
BindingThe codes SHALL be taken from BundleType
(required to http://hl7.org/fhir/ValueSet/bundle-type)
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. LogicalBundle.entry
Definition

An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).

ShortAn entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).
Control0..*
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. LogicalBundle.entry.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())
10. LogicalBundle.entry.person
Definition

The Person for the entry. The purpose/meaning of the person is determined by the Bundle.type.

ShortA person in the bundle
Control0..1
Typehttps://interop.esante.gouv.fr/ig/fhir/eds/StructureDefinition/OMOPPerson
12. LogicalBundle.entry.location
Definition

The Location for the entry. The purpose/meaning of the location is determined by the Bundle.type.

ShortA location in the bundle
Control0..1
Typehttps://interop.esante.gouv.fr/ig/fhir/eds/StructureDefinition/OMOPLocation
14. LogicalBundle.entry.death
Definition

The Death for the entry. The purpose/meaning of the death is determined by the Bundle.type.

ShortA death in the bundle
Control0..1
Typehttps://interop.esante.gouv.fr/ig/fhir/eds/StructureDefinition/OMOPDeath
16. LogicalBundle.entry.measurement
Definition

Measurement for the entry. The purpose/meaning of the measurements is determined by the Bundle.type.

ShortMasurement(s) in the bundle
Control0..*
Typehttps://interop.esante.gouv.fr/ig/fhir/eds/StructureDefinition/OMOPMeasurement

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

0. LogicalBundle
Definition

The BundleLogical has the same objective as the FHIR Bundle resource but allows for the grouping of logical models.

ShortLogicalBundle
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. LogicalBundle.id
Definition

Logical id of this artifact

ShortLogical id of this artifact
Control1..1
Typeid
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
4. LogicalBundle.type
Definition

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.

Shortdocument | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Control1..1
BindingThe codes SHALL be taken from BundleType
(required to http://hl7.org/fhir/ValueSet/bundle-type)
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. LogicalBundle.entry
Definition

An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).

ShortAn entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).
Control0..*
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. LogicalBundle.entry.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
10. LogicalBundle.entry.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 LogicalBundle.entry.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 12. LogicalBundle.entry.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())
    14. LogicalBundle.entry.person
    Definition

    The Person for the entry. The purpose/meaning of the person is determined by the Bundle.type.

    ShortA person in the bundle
    Control0..1
    Typehttps://interop.esante.gouv.fr/ig/fhir/eds/StructureDefinition/OMOPPerson
    16. LogicalBundle.entry.location
    Definition

    The Location for the entry. The purpose/meaning of the location is determined by the Bundle.type.

    ShortA location in the bundle
    Control0..1
    Typehttps://interop.esante.gouv.fr/ig/fhir/eds/StructureDefinition/OMOPLocation
    18. LogicalBundle.entry.death
    Definition

    The Death for the entry. The purpose/meaning of the death is determined by the Bundle.type.

    ShortA death in the bundle
    Control0..1
    Typehttps://interop.esante.gouv.fr/ig/fhir/eds/StructureDefinition/OMOPDeath
    20. LogicalBundle.entry.measurement
    Definition

    Measurement for the entry. The purpose/meaning of the measurements is determined by the Bundle.type.

    ShortMasurement(s) in the bundle
    Control0..*
    Typehttps://interop.esante.gouv.fr/ig/fhir/eds/StructureDefinition/OMOPMeasurement