Essais CLiniques Accessibles Interconnectés pour la Recherche ouverts à l'Ecosystème
0.3.0 - trial-use France flag

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

Resource Profile: ECLAIREGroup

Official URL: https://interop.esante.gouv.fr/ig/fhir/eclaire/StructureDefinition/eclaire-group Version: 0.3.0
Draft as of 2024-02-26 Computable Name: ECLAIREGroup

Profil de Group pour le projet ECLAIRE

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Group

NameFlagsCard.TypeDescription & Constraintsdoco
.. Group 0..*GroupGroup of multiple entities
... characteristic
.... code S1..1CodeableConceptKind of characteristic
Binding: Type de caractéristique Value Set (extensible)
.... Slices for value[x] 1..1CodeableConcept, boolean, Quantity, Range, Reference()Value held by characteristic
Slice: Unordered, Open by type:$this
..... value[x]:valueCodeableConcept S0..1CodeableConceptValue held by characteristic
Binding: Caractérisation de la population Value Set (extensible)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Group.characteristic.codeextensibleEclaireGroupCharacteristicKindVS (a valid code from Codes pour le type de caractéristique du groupe)
https://interop.esante.gouv.fr/ig/fhir/eclaire/ValueSet/eclaire-group-characteristic-kind-vs
from this IG
Group.characteristic.value[x]:valueCodeableConceptextensibleEclaireStudyPopulationVS (a valid code from Codes pour caractériser la population de l'étude)
https://interop.esante.gouv.fr/ig/fhir/eclaire/ValueSet/eclaire-study-population-vs
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. Group C0..*GroupGroup of multiple entities
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!N0..*ExtensionExtensions that cannot be ignored
Slice: Unordered, Open by value:url
... type Σ1..1codeperson | animal | practitioner | device | medication | substance
Binding: GroupType (required): Types of resources that are part of group.

... characteristic 0..*BackboneElementInclude / Exclude group members by Trait
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code S1..1CodeableConceptKind of characteristic
Binding: Type de caractéristique Value Set (extensible)
.... Slices for value[x] 1..1Value held by characteristic
Slice: Unordered, Open by type:$this
Binding: (unbound) (example): Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc.

..... valueCodeableConceptCodeableConcept
..... valueBooleanboolean
..... valueQuantityQuantity
..... valueRangeRange
..... valueReferenceReference(Any)
..... value[x]:valueCodeableConcept S0..1CodeableConceptValue held by characteristic
Binding: Caractérisation de la population Value Set (extensible)
.... exclude 1..1booleanGroup includes or excludes
... member C0..*BackboneElementWho or what is in group
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... entity C1..1Reference(Patient | Practitioner | PractitionerRole | Device | Medication | Substance | Group)Reference to the group member

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Group.typerequiredGroupType
http://hl7.org/fhir/ValueSet/group-type|4.0.1
from the FHIR Standard
Group.characteristic.codeextensibleEclaireGroupCharacteristicKindVS (a valid code from Codes pour le type de caractéristique du groupe)
https://interop.esante.gouv.fr/ig/fhir/eclaire/ValueSet/eclaire-group-characteristic-kind-vs
from this IG
Group.characteristic.value[x]example
Group.characteristic.value[x]:valueCodeableConceptextensibleEclaireStudyPopulationVS (a valid code from Codes pour caractériser la population de l'étude)
https://interop.esante.gouv.fr/ig/fhir/eclaire/ValueSet/eclaire-study-population-vs
from this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorGroupIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorGroupIf 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-4errorGroupIf 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-5errorGroupIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceGroupA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** elementsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
grp-1errorGroupCan only have members if group is "actual"
: member.empty() or (actual = true)
ref-1errorGroup.member.entitySHALL 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'))
NameFlagsCard.TypeDescription & Constraintsdoco
.. Group C0..*GroupGroup of multiple entities
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... modifierExtension ?!N0..*ExtensionExtensions that cannot be ignored
Slice: Unordered, Open by value:url
... identifier Σ0..*IdentifierUnique id
... active Σ0..1booleanWhether this group's record is in active use
... type Σ1..1codeperson | animal | practitioner | device | medication | substance
Binding: GroupType (required): Types of resources that are part of group.

... actual ΣC1..1booleanDescriptive or actual
... code Σ0..1CodeableConceptKind of Group members
Binding: (unbound) (example): Kind of particular resource; e.g. cow, syringe, lake, etc.

... name Σ0..1stringLabel for Group
... quantity Σ0..1unsignedIntNumber of members
... managingEntity ΣC0..1Reference(Organization | RelatedPerson | Practitioner | PractitionerRole)Entity that is the custodian of the Group's definition
... characteristic 0..*BackboneElementInclude / Exclude group members by Trait
.... id 0..1stringUnique id for inter-element referencing
.... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code S1..1CodeableConceptKind of characteristic
Binding: Type de caractéristique Value Set (extensible)
.... Slices for value[x] 1..1Value held by characteristic
Slice: Unordered, Open by type:$this
Binding: (unbound) (example): Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc.

..... valueCodeableConceptCodeableConcept
..... valueBooleanboolean
..... valueQuantityQuantity
..... valueRangeRange
..... valueReferenceReference(Any)
..... value[x]:valueCodeableConcept S0..1CodeableConceptValue held by characteristic
Binding: Caractérisation de la population Value Set (extensible)
.... exclude 1..1booleanGroup includes or excludes
.... period C0..1PeriodPeriod over which characteristic is tested
... member C0..*BackboneElementWho or what is in group
.... id 0..1stringUnique id for inter-element referencing
.... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... entity C1..1Reference(Patient | Practitioner | PractitionerRole | Device | Medication | Substance | Group)Reference to the group member
.... period C0..1PeriodPeriod member belonged to the group
.... inactive 0..1booleanIf member is no longer in group

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Group.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Group.typerequiredGroupType
http://hl7.org/fhir/ValueSet/group-type|4.0.1
from the FHIR Standard
Group.codeexample
Group.characteristic.codeextensibleEclaireGroupCharacteristicKindVS (a valid code from Codes pour le type de caractéristique du groupe)
https://interop.esante.gouv.fr/ig/fhir/eclaire/ValueSet/eclaire-group-characteristic-kind-vs
from this IG
Group.characteristic.value[x]example
Group.characteristic.value[x]:valueCodeableConceptextensibleEclaireStudyPopulationVS (a valid code from Codes pour caractériser la population de l'étude)
https://interop.esante.gouv.fr/ig/fhir/eclaire/ValueSet/eclaire-study-population-vs
from this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorGroupIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorGroupIf 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-4errorGroupIf 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-5errorGroupIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceGroupA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** elementsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
grp-1errorGroupCan only have members if group is "actual"
: member.empty() or (actual = true)
per-1errorGroup.characteristic.period, Group.member.periodIf present, start SHALL have a lower value than end
: start.hasValue().not() or end.hasValue().not() or (start <= end)
ref-1errorGroup.managingEntity, Group.member.entitySHALL 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'))

This structure is derived from Group

Summary

Must-Support: 2 elements

Slices

This structure defines the following Slices:

  • The element Group.characteristic.value[x] is sliced based on the value of type:$this

Differential View

This structure is derived from Group

NameFlagsCard.TypeDescription & Constraintsdoco
.. Group 0..*GroupGroup of multiple entities
... characteristic
.... code S1..1CodeableConceptKind of characteristic
Binding: Type de caractéristique Value Set (extensible)
.... Slices for value[x] 1..1CodeableConcept, boolean, Quantity, Range, Reference()Value held by characteristic
Slice: Unordered, Open by type:$this
..... value[x]:valueCodeableConcept S0..1CodeableConceptValue held by characteristic
Binding: Caractérisation de la population Value Set (extensible)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Group.characteristic.codeextensibleEclaireGroupCharacteristicKindVS (a valid code from Codes pour le type de caractéristique du groupe)
https://interop.esante.gouv.fr/ig/fhir/eclaire/ValueSet/eclaire-group-characteristic-kind-vs
from this IG
Group.characteristic.value[x]:valueCodeableConceptextensibleEclaireStudyPopulationVS (a valid code from Codes pour caractériser la population de l'étude)
https://interop.esante.gouv.fr/ig/fhir/eclaire/ValueSet/eclaire-study-population-vs
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Group C0..*GroupGroup of multiple entities
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!N0..*ExtensionExtensions that cannot be ignored
Slice: Unordered, Open by value:url
... type Σ1..1codeperson | animal | practitioner | device | medication | substance
Binding: GroupType (required): Types of resources that are part of group.

... characteristic 0..*BackboneElementInclude / Exclude group members by Trait
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code S1..1CodeableConceptKind of characteristic
Binding: Type de caractéristique Value Set (extensible)
.... Slices for value[x] 1..1Value held by characteristic
Slice: Unordered, Open by type:$this
Binding: (unbound) (example): Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc.

..... valueCodeableConceptCodeableConcept
..... valueBooleanboolean
..... valueQuantityQuantity
..... valueRangeRange
..... valueReferenceReference(Any)
..... value[x]:valueCodeableConcept S0..1CodeableConceptValue held by characteristic
Binding: Caractérisation de la population Value Set (extensible)
.... exclude 1..1booleanGroup includes or excludes
... member C0..*BackboneElementWho or what is in group
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... entity C1..1Reference(Patient | Practitioner | PractitionerRole | Device | Medication | Substance | Group)Reference to the group member

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Group.typerequiredGroupType
http://hl7.org/fhir/ValueSet/group-type|4.0.1
from the FHIR Standard
Group.characteristic.codeextensibleEclaireGroupCharacteristicKindVS (a valid code from Codes pour le type de caractéristique du groupe)
https://interop.esante.gouv.fr/ig/fhir/eclaire/ValueSet/eclaire-group-characteristic-kind-vs
from this IG
Group.characteristic.value[x]example
Group.characteristic.value[x]:valueCodeableConceptextensibleEclaireStudyPopulationVS (a valid code from Codes pour caractériser la population de l'étude)
https://interop.esante.gouv.fr/ig/fhir/eclaire/ValueSet/eclaire-study-population-vs
from this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorGroupIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorGroupIf 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-4errorGroupIf 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-5errorGroupIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceGroupA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** elementsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
grp-1errorGroupCan only have members if group is "actual"
: member.empty() or (actual = true)
ref-1errorGroup.member.entitySHALL 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'))

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Group C0..*GroupGroup of multiple entities
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... modifierExtension ?!N0..*ExtensionExtensions that cannot be ignored
Slice: Unordered, Open by value:url
... identifier Σ0..*IdentifierUnique id
... active Σ0..1booleanWhether this group's record is in active use
... type Σ1..1codeperson | animal | practitioner | device | medication | substance
Binding: GroupType (required): Types of resources that are part of group.

... actual ΣC1..1booleanDescriptive or actual
... code Σ0..1CodeableConceptKind of Group members
Binding: (unbound) (example): Kind of particular resource; e.g. cow, syringe, lake, etc.

... name Σ0..1stringLabel for Group
... quantity Σ0..1unsignedIntNumber of members
... managingEntity ΣC0..1Reference(Organization | RelatedPerson | Practitioner | PractitionerRole)Entity that is the custodian of the Group's definition
... characteristic 0..*BackboneElementInclude / Exclude group members by Trait
.... id 0..1stringUnique id for inter-element referencing
.... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code S1..1CodeableConceptKind of characteristic
Binding: Type de caractéristique Value Set (extensible)
.... Slices for value[x] 1..1Value held by characteristic
Slice: Unordered, Open by type:$this
Binding: (unbound) (example): Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc.

..... valueCodeableConceptCodeableConcept
..... valueBooleanboolean
..... valueQuantityQuantity
..... valueRangeRange
..... valueReferenceReference(Any)
..... value[x]:valueCodeableConcept S0..1CodeableConceptValue held by characteristic
Binding: Caractérisation de la population Value Set (extensible)
.... exclude 1..1booleanGroup includes or excludes
.... period C0..1PeriodPeriod over which characteristic is tested
... member C0..*BackboneElementWho or what is in group
.... id 0..1stringUnique id for inter-element referencing
.... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... entity C1..1Reference(Patient | Practitioner | PractitionerRole | Device | Medication | Substance | Group)Reference to the group member
.... period C0..1PeriodPeriod member belonged to the group
.... inactive 0..1booleanIf member is no longer in group

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Group.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Group.typerequiredGroupType
http://hl7.org/fhir/ValueSet/group-type|4.0.1
from the FHIR Standard
Group.codeexample
Group.characteristic.codeextensibleEclaireGroupCharacteristicKindVS (a valid code from Codes pour le type de caractéristique du groupe)
https://interop.esante.gouv.fr/ig/fhir/eclaire/ValueSet/eclaire-group-characteristic-kind-vs
from this IG
Group.characteristic.value[x]example
Group.characteristic.value[x]:valueCodeableConceptextensibleEclaireStudyPopulationVS (a valid code from Codes pour caractériser la population de l'étude)
https://interop.esante.gouv.fr/ig/fhir/eclaire/ValueSet/eclaire-study-population-vs
from this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorGroupIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorGroupIf 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-4errorGroupIf 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-5errorGroupIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceGroupA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** elementsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
grp-1errorGroupCan only have members if group is "actual"
: member.empty() or (actual = true)
per-1errorGroup.characteristic.period, Group.member.periodIf present, start SHALL have a lower value than end
: start.hasValue().not() or end.hasValue().not() or (start <= end)
ref-1errorGroup.managingEntity, Group.member.entitySHALL 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'))

This structure is derived from Group

Summary

Must-Support: 2 elements

Slices

This structure defines the following Slices:

  • The element Group.characteristic.value[x] is sliced based on the value of type:$this

 

Other representations of profile: CSV, Excel, Schematron