Search FHIR

Essais CLiniques Accessibles Interconnectés pour la Recherche ouverts à l'Ecosystème
0.3.1 - ci-build France flag

Essais CLiniques Accessibles Interconnectés pour la Recherche ouverts à l'Ecosystème - Local Development build (v0.3.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: ECLAIREGroup - Detailed Descriptions

Draft as of 2025-11-27

Definitions for the eclaire-group resource profile.

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

0. Group
Définition

Represents a defined collection of entities that may be discussed or acted upon collectively but which are not expected to act collectively, and are not formally or legally recognized; i.e. a collection of entities that isn't an Organization.

ShortGroup of multiple entities
Commentaires

If both Group.characteristic and Group.member are present, then the members are the individuals who were found who met the characteristic. It's possible that there might be other candidate members who meet the characteristic and aren't (yet) in the list. All members SHALL have the listed characteristics.

Control0..*
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
grp-1: Can only have members if group is "actual" (member.empty() or (actual = true))
2. Group.implicitRules
Définition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

ShortA set of rules under which this content was created
Commentaires

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Control0..1
This element is affected by the following invariants: ele-1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Résumétrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. Group.modifierExtension
Définition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it 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 is allowed to 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
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.

Control0..*
This element is affected by the following invariants: ele-1
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Standard StatusNormative (from Trial Use)
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
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 Group.modifierExtension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 6. Group.type
    Définition

    Identifies the broad classification of the kind of resources the group includes.

    Shortperson | animal | practitioner | device | medication | substance
    Commentaires

    Group members SHALL be of the appropriate resource type (Patient for person or animal; or Practitioner, Device, Medication or Substance for the other types.).

    Control1..1
    This element is affected by the following invariants: ele-1
    BindingThe codes SHALL be taken from GroupTypehttp://hl7.org/fhir/ValueSet/group-type|4.0.1
    (required to http://hl7.org/fhir/ValueSet/group-type|4.0.1)

    Types of resources that are part of group.

    Typecode
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Résumétrue
    Requirements

    Identifies what type of resources the group is made up of.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    8. Group.actual
    Définition

    If true, indicates that the resource refers to a specific group of real individuals. If false, the group defines a set of intended individuals.

    ShortDescriptive or actual
    Control1..1
    This element is affected by the following invariants: ele-1, grp-1
    Typeboolean
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Résumétrue
    Requirements

    There are use-cases for groups that define specific collections of individuals, and other groups that define "types" of intended individuals. The requirements for both kinds of groups are similar, so we use a single resource, distinguished by this flag.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    10. Group.characteristic
    Définition

    Identifies traits whose presence r absence is shared by members of the group.

    ShortInclude / Exclude group members by Trait
    Commentaires

    All the identified characteristics must be true for an entity to a member of the group.

    Control0..*
    This element is affected by the following invariants: ele-1
    TypeBackboneElement
    Requirements

    Needs to be a generic mechanism for identifying what individuals can be part of a group.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    12. Group.characteristic.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).

    ShortExtensions 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.

    Control0..*
    This element is affected by the following invariants: ele-1
    TypeExtension
    Is Modifiertrue 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 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. Group.characteristic.code
    Définition

    A code that identifies the kind of trait being asserted.

    ShortKind of characteristic
    Commentaires

    Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

    Control1..1
    This element is affected by the following invariants: ele-1
    BindingUnless not suitable, these codes SHALL be taken from For example codes, see Type de caractéristique Value Set
    (extensible to https://interop.esante.gouv.fr/ig/fhir/eclaire/ValueSet/eclaire-group-characteristic-kind-vs)
    TypeCodeableConcept
    Must Supporttrue
    Requirements

    Need a formal way of identifying the characteristic being described.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    16. Group.characteristic.value[x]
    Définition

    The value of the trait that holds (or does not hold - see 'exclude') for members of the group.

    ShortValue held by characteristic
    Commentaires

    For Range, it means members of the group have a value that falls somewhere within the specified range.

    Control1..1
    This element is affected by the following invariants: ele-1
    Binding

    Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc.

    TypeChoice of: CodeableConcept, boolean, Quantity, Range, Reference
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Requirements

    The value of the characteristic is what determines group membership.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    SlicingThis element introduces a set of slices on Group.characteristic.value[x]. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • type @ $this
    • 18. Group.characteristic.value[x]:valueCodeableConcept
      Nom de la slicevalueCodeableConcept
      Définition

      The value of the trait that holds (or does not hold - see 'exclude') for members of the group.

      ShortValue held by characteristic
      Commentaires

      For Range, it means members of the group have a value that falls somewhere within the specified range.

      Control01..1
      This element is affected by the following invariants: ele-1
      BindingUnless not suitable, these codes SHALL be taken from For example codes, see Caractérisation de la population Value Set
      (extensible to https://interop.esante.gouv.fr/ig/fhir/eclaire/ValueSet/eclaire-study-population-vs)
      TypeCodeableConcept, boolean, Reference, Quantity, Range
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      Must Supporttrue
      Requirements

      The value of the characteristic is what determines group membership.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      20. Group.characteristic.exclude
      Définition

      If true, indicates the characteristic is one that is NOT held by members of the group.

      ShortGroup includes or excludes
      Commentaires

      This is labeled as "Is Modifier" because applications cannot wrongly include excluded members as included or vice versa.

      Control1..1
      This element is affected by the following invariants: ele-1
      Typeboolean
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Requirements

      Sometimes group membership is determined by characteristics not possessed.

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      22. Group.member
      Définition

      Identifies the resource instances that are members of the group.

      ShortWho or what is in group
      Control0..*
      This element is affected by the following invariants: ele-1, grp-1
      TypeBackboneElement
      Requirements

      Often the only thing of interest about a group is "who's in it".

      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      24. Group.member.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).

      ShortExtensions 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.

      Control0..*
      This element is affected by the following invariants: ele-1
      TypeExtension
      Is Modifiertrue 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 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())
      26. Group.member.entity
      Définition

      A reference to the entity that is a member of the group. Must be consistent with Group.type. If the entity is another group, then the type must be the same.

      ShortReference to the group member
      Commentaires

      References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

      Control1..1
      This element is affected by the following invariants: ele-1
      TypeReference(Patient, Practitioner, PractitionerRole, Device, Medication, Substance, Group)
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ref-1: SHALL have a contained resource if a local reference is provided (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')))

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

      0. Group
      2. Group.characteristic
      4. Group.characteristic.code
      BindingUnless not suitable, these codes SHALL be taken from Type de caractéristique Value Set
      (extensible to https://interop.esante.gouv.fr/ig/fhir/eclaire/ValueSet/eclaire-group-characteristic-kind-vs)
      Must Supporttrue
      6. Group.characteristic.value[x]
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      SlicingThis element introduces a set of slices on Group.characteristic.value[x]. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • type @ $this
      • 8. Group.characteristic.value[x]:valueCodeableConcept
        Nom de la slicevalueCodeableConcept
        Control0..1
        BindingUnless not suitable, these codes SHALL be taken from Caractérisation de la population Value Set
        (extensible to https://interop.esante.gouv.fr/ig/fhir/eclaire/ValueSet/eclaire-study-population-vs)
        TypeCodeableConcept
        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
        Must Supporttrue

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

        0. Group
        Définition

        Represents a defined collection of entities that may be discussed or acted upon collectively but which are not expected to act collectively, and are not formally or legally recognized; i.e. a collection of entities that isn't an Organization.

        ShortGroup of multiple entities
        Commentaires

        If both Group.characteristic and Group.member are present, then the members are the individuals who were found who met the characteristic. It's possible that there might be other candidate members who meet the characteristic and aren't (yet) in the list. All members SHALL have the listed characteristics.

        Control0..*
        Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
        dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
        dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
        dom-6: A resource should have narrative for robust management (text.`div`.exists())
        dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
        grp-1: Can only have members if group is "actual" (member.empty() or (actual = true))
        2. Group.id
        Définition

        The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

        ShortLogical id of this artifact
        Commentaires

        The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

        Control0..1
        Typeid
        Résumétrue
        4. Group.meta
        Définition

        The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

        ShortMetadata about the resource
        Control0..1
        This element is affected by the following invariants: ele-1
        TypeMeta
        Résumétrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        6. Group.implicitRules
        Définition

        A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

        ShortA set of rules under which this content was created
        Commentaires

        Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

        Control0..1
        This element is affected by the following invariants: ele-1
        Typeuri
        Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Résumétrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        8. Group.language
        Définition

        The base language in which the resource is written.

        ShortLanguage of the resource content
        Commentaires

        Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

        Control0..1
        This element is affected by the following invariants: ele-1
        BindingThe codes SHOULD be taken from CommonLanguages
        (preferred to http://hl7.org/fhir/ValueSet/languages|4.0.1)

        A human language.

        Bindings AdditionnelsBut
        AllLanguagesBinding Max
        Typecode
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        10. Group.text
        Définition

        A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

        ShortText summary of the resource, for human interpretation
        Commentaires

        Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

        Control0..1
        This element is affected by the following invariants: ele-1
        TypeNarrative
        Alternate Namesnarrative, html, xhtml, display
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        12. Group.contained
        Définition

        These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

        ShortContained, inline Resources
        Commentaires

        This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

        Control0..*
        TypeResource
        Alternate Namesinline resources, anonymous resources, contained resources
        14. Group.extension
        Définition

        May be used to represent additional information that is not part of the basic definition of the resource. 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
        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.

        Control0..*
        This element is affected by the following invariants: ele-1
        TypeExtension
        Standard StatusNormative (from Trial Use)
        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 Group.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 16. Group.modifierExtension
          Définition

          May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it 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 is allowed to 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
          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.

          Control0..*
          This element is affected by the following invariants: ele-1
          TypeExtension
          Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
          Standard StatusNormative (from Trial Use)
          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
          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 Group.modifierExtension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 18. Group.identifier
            Définition

            A unique business identifier for this group.

            ShortUnique id
            NoteThis is a business identifier, not a resource identifier (see discussion)
            Control0..*
            This element is affected by the following invariants: ele-1
            TypeIdentifier
            Résumétrue
            Requirements

            Allows the group to be referenced from external specifications.

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            20. Group.active
            Définition

            Indicates whether the record for the group is available for use or is merely being retained for historical purposes.

            ShortWhether this group's record is in active use
            Control0..1
            This element is affected by the following invariants: ele-1
            Typeboolean
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Résumétrue
            Requirements

            Need to be able to mark a group record as not to be used because it was created in error or is otherwise no longer available (e.g. a herd that no longer exists).

            Meaning if MissingThis resource is generally assumed to be active if no value is provided for the active element
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            22. Group.type
            Définition

            Identifies the broad classification of the kind of resources the group includes.

            Shortperson | animal | practitioner | device | medication | substance
            Commentaires

            Group members SHALL be of the appropriate resource type (Patient for person or animal; or Practitioner, Device, Medication or Substance for the other types.).

            Control1..1
            This element is affected by the following invariants: ele-1
            BindingThe codes SHALL be taken from GroupType
            (required to http://hl7.org/fhir/ValueSet/group-type|4.0.1)

            Types of resources that are part of group.

            Typecode
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Résumétrue
            Requirements

            Identifies what type of resources the group is made up of.

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            24. Group.actual
            Définition

            If true, indicates that the resource refers to a specific group of real individuals. If false, the group defines a set of intended individuals.

            ShortDescriptive or actual
            Control1..1
            This element is affected by the following invariants: ele-1, grp-1
            Typeboolean
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Résumétrue
            Requirements

            There are use-cases for groups that define specific collections of individuals, and other groups that define "types" of intended individuals. The requirements for both kinds of groups are similar, so we use a single resource, distinguished by this flag.

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            26. Group.code
            Définition

            Provides a specific type of resource the group includes; e.g. "cow", "syringe", etc.

            ShortKind of Group members
            Commentaires

            This would generally be omitted for Person resources.

            Control0..1
            This element is affected by the following invariants: ele-1
            Binding

            Kind of particular resource; e.g. cow, syringe, lake, etc.

            TypeCodeableConcept
            Résumétrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            28. Group.name
            Définition

            A label assigned to the group for human identification and communication.

            ShortLabel for Group
            Commentaires

            Note that FHIR strings SHALL NOT exceed 1MB in size

            Control0..1
            This element is affected by the following invariants: ele-1
            Typestring
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Résumétrue
            Requirements

            Used to identify the group in human communication.

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            30. Group.quantity
            Définition

            A count of the number of resource instances that are part of the group.

            ShortNumber of members
            Commentaires

            Note that the quantity may be less than the number of members if some of the members are not active.

            Control0..1
            This element is affected by the following invariants: ele-1
            TypeunsignedInt
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Résumétrue
            Requirements

            Group size is a common defining characteristic.

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            32. Group.managingEntity
            Définition

            Entity responsible for defining and maintaining Group characteristics and/or registered members.

            ShortEntity that is the custodian of the Group's definition
            Commentaires

            This does not strictly align with ownership of a herd or flock, but may suffice to represent that relationship in simple cases. More complex cases will require an extension.

            Control0..1
            This element is affected by the following invariants: ele-1
            TypeReference(Organization, RelatedPerson, Practitioner, PractitionerRole)
            Résumétrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ref-1: SHALL have a contained resource if a local reference is provided (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')))
            34. Group.characteristic
            Définition

            Identifies traits whose presence r absence is shared by members of the group.

            ShortInclude / Exclude group members by Trait
            Commentaires

            All the identified characteristics must be true for an entity to a member of the group.

            Control0..*
            This element is affected by the following invariants: ele-1
            TypeBackboneElement
            Requirements

            Needs to be a generic mechanism for identifying what individuals can be part of a group.

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            36. Group.characteristic.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.

            ShortUnique id for inter-element referencing
            Control0..1
            Typestring
            XML FormatIn the XML format, this property is represented as an attribute.
            38. Group.characteristic.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.

            ShortAdditional 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.

            Control0..*
            This element is affected by the following invariants: ele-1
            TypeExtension
            Standard StatusNormative (from Trial Use)
            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 Group.characteristic.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 40. Group.characteristic.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).

              ShortExtensions 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.

              Control0..*
              This element is affected by the following invariants: ele-1
              TypeExtension
              Is Modifiertrue 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 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())
              42. Group.characteristic.code
              Définition

              A code that identifies the kind of trait being asserted.

              ShortKind of characteristic
              Commentaires

              Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

              Control1..1
              This element is affected by the following invariants: ele-1
              BindingUnless not suitable, these codes SHALL be taken from Type de caractéristique Value Set
              (extensible to https://interop.esante.gouv.fr/ig/fhir/eclaire/ValueSet/eclaire-group-characteristic-kind-vs)
              TypeCodeableConcept
              Must Supporttrue
              Requirements

              Need a formal way of identifying the characteristic being described.

              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              44. Group.characteristic.value[x]
              Définition

              The value of the trait that holds (or does not hold - see 'exclude') for members of the group.

              ShortValue held by characteristic
              Commentaires

              For Range, it means members of the group have a value that falls somewhere within the specified range.

              Control1..1
              This element is affected by the following invariants: ele-1
              Binding

              Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc.

              TypeChoice of: CodeableConcept, boolean, Quantity, Range, Reference
              [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Requirements

              The value of the characteristic is what determines group membership.

              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              SlicingThis element introduces a set of slices on Group.characteristic.value[x]. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • type @ $this
              • 46. Group.characteristic.value[x]:valueCodeableConcept
                Nom de la slicevalueCodeableConcept
                Définition

                The value of the trait that holds (or does not hold - see 'exclude') for members of the group.

                ShortValue held by characteristic
                Commentaires

                For Range, it means members of the group have a value that falls somewhere within the specified range.

                Control0..1
                This element is affected by the following invariants: ele-1
                BindingUnless not suitable, these codes SHALL be taken from Caractérisation de la population Value Set
                (extensible to https://interop.esante.gouv.fr/ig/fhir/eclaire/ValueSet/eclaire-study-population-vs)
                TypeCodeableConcept
                [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                Must Supporttrue
                Requirements

                The value of the characteristic is what determines group membership.

                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                48. Group.characteristic.exclude
                Définition

                If true, indicates the characteristic is one that is NOT held by members of the group.

                ShortGroup includes or excludes
                Commentaires

                This is labeled as "Is Modifier" because applications cannot wrongly include excluded members as included or vice versa.

                Control1..1
                This element is affected by the following invariants: ele-1
                Typeboolean
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Requirements

                Sometimes group membership is determined by characteristics not possessed.

                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                50. Group.characteristic.period
                Définition

                The period over which the characteristic is tested; e.g. the patient had an operation during the month of June.

                ShortPeriod over which characteristic is tested
                Commentaires

                A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").

                Period is not used for a duration (a measure of elapsed time). See Duration.

                Control0..1
                This element is affected by the following invariants: ele-1
                TypePeriod
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                per-1: If present, start SHALL have a lower value than end (start.hasValue().not() or end.hasValue().not() or (start <= end))
                52. Group.member
                Définition

                Identifies the resource instances that are members of the group.

                ShortWho or what is in group
                Control0..*
                This element is affected by the following invariants: ele-1, grp-1
                TypeBackboneElement
                Requirements

                Often the only thing of interest about a group is "who's in it".

                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                54. Group.member.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.

                ShortUnique id for inter-element referencing
                Control0..1
                Typestring
                XML FormatIn the XML format, this property is represented as an attribute.
                56. Group.member.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.

                ShortAdditional 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.

                Control0..*
                This element is affected by the following invariants: ele-1
                TypeExtension
                Standard StatusNormative (from Trial Use)
                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 Group.member.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                • value @ url
                • 58. Group.member.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).

                  ShortExtensions 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.

                  Control0..*
                  This element is affected by the following invariants: ele-1
                  TypeExtension
                  Is Modifiertrue 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 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())
                  60. Group.member.entity
                  Définition

                  A reference to the entity that is a member of the group. Must be consistent with Group.type. If the entity is another group, then the type must be the same.

                  ShortReference to the group member
                  Commentaires

                  References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

                  Control1..1
                  This element is affected by the following invariants: ele-1
                  TypeReference(Patient, Practitioner, PractitionerRole, Device, Medication, Substance, Group)
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  ref-1: SHALL have a contained resource if a local reference is provided (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')))
                  62. Group.member.period
                  Définition

                  The period that the member was in the group, if known.

                  ShortPeriod member belonged to the group
                  Commentaires

                  A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").

                  Period is not used for a duration (a measure of elapsed time). See Duration.

                  Control0..1
                  This element is affected by the following invariants: ele-1
                  TypePeriod
                  Requirements

                  Need to track who was in a group at a particular time.

                  Meaning if MissingThe member is in the group at this time
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  per-1: If present, start SHALL have a lower value than end (start.hasValue().not() or end.hasValue().not() or (start <= end))
                  64. Group.member.inactive
                  Définition

                  A flag to indicate that the member is no longer in the group, but previously may have been a member.

                  ShortIf member is no longer in group
                  Control0..1
                  This element is affected by the following invariants: ele-1
                  Typeboolean
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Requirements

                  Sometimes you don't know when someone stopped being in a group, but not when.

                  Meaning if MissingMembers are considered active unless explicitly specified otherwise
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))