MIABIS on FHIR Implementation Guide
1.3.0 - CI Build

MIABIS on FHIR Implementation Guide - Local Development build (v1.3.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: Collection

Official URL: https://fhir.bbmri-eric.eu/StructureDefinition/miabis-collection Version: 1.3.0
Active as of 2026-06-22 Computable Name: Collection

Collection represents a set of samples and/or data items collected and/or derived in a common context and stored under a common stewardship and available for future research

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Group C 0..* Group Group of multiple entities
Constraints: grp-1
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:numberOfSubjects S 0..1 integer Total number of subjects included in the collection.
URL: https://fhir.bbmri-eric.eu/StructureDefinition/miabis-number-of-subjects-extension
.... extension:inclusionCriteria S 0..* CodeableConcept Information on type of parameters that determine which subjects will become collection participants.
URL: https://fhir.bbmri-eric.eu/StructureDefinition/miabis-inclusion-criteria-extension
Binding: Inclusion Criteria ValueSet (required)
.... extension:MemberEntity S 0..* (Complex) Member Entity
URL: https://fhir.bbmri-eric.eu/StructureDefinition/miabis-member-entity-extension
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "https://fhir.bbmri-eric.eu/StructureDefinition/miabis-member-entity-extension"
..... value[x] 0..1 Reference(Specimen) Value of extension
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... active SΣ 0..1 boolean The state of the collection functions.
... type Σ 1..1 code The type of resources this group contains. For this resource type, this is always set to person. (should be specimen, but this is only supported in R5)
Binding: GroupType (required): Types of resources that are part of group.
Required Pattern: person
... actual ΣC 1..1 boolean Descriptive or actual
... name SΣ 1..1 string Name of the collection (preferably in English).
... managingEntity SΣ 1..1 Reference(Collection Organization) Organization resource containing details of this collection, such as contact information, publications, etc.
... Slices for characteristic 2..* BackboneElement Include / Exclude group members by Trait
Slice: Unordered, Open by value:code
.... characteristic:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code 1..1 CodeableConcept Kind of characteristic
Binding Description: (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.
..... value[x] 1..1 Value held by characteristic
Binding Description: (example): Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc.
...... valueCodeableConcept CodeableConcept
...... valueBoolean boolean
...... valueQuantity Quantity
...... valueRange Range
...... valueReference Reference(Any)
..... exclude 1..1 boolean Group includes or excludes
.... characteristic:ageRange S 0..1 BackboneElement Age of youngest and oldest sample donor at the time of sample donation.
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code 1..1 CodeableConcept Kind of characteristic
Binding Description: (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.bbmri-eric.eu/CodeSystem/miabis-characteristicCS
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: Age
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value[x] 1..1 Range Value held by characteristic
..... exclude 1..1 boolean Group includes or excludes
.... characteristic:sex S 1..* BackboneElement The sex of the individuals in the collection.
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code 1..1 CodeableConcept Kind of characteristic
Binding Description: (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.bbmri-eric.eu/CodeSystem/miabis-characteristicCS
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: Sex
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value[x] 1..1 CodeableConcept Value held by characteristic
Binding: AdministrativeGender (required)
..... exclude 1..1 boolean Group includes or excludes
.... characteristic:storageTemperature S 0..* BackboneElement The long-term storage temperature at which the sample(s) are stored after preparation, based on SPREC v3.
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code 1..1 CodeableConcept Kind of characteristic
Binding Description: (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.bbmri-eric.eu/CodeSystem/miabis-characteristicCS
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: StorageTemperature
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value[x] 1..1 CodeableConcept Value held by characteristic
Binding: Storage Temperature Value Set (required)
..... exclude 1..1 boolean Group includes or excludes
.... characteristic:materialType S 1..* BackboneElement The biospecimen saved from a biological entity for propagation e.g. testing, diagnostics, treatment or research purposes.
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code 1..1 CodeableConcept Kind of characteristic
Binding Description: (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.bbmri-eric.eu/CodeSystem/miabis-characteristicCS
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: MaterialType
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value[x] 1..1 CodeableConcept Value held by characteristic
Binding: Collection Sample Type Value Set (required)
..... exclude 1..1 boolean Group includes or excludes
.... characteristic:diagnosis S 0..* BackboneElement The diagnosis of the individuals in the collection.
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code 1..1 CodeableConcept Kind of characteristic
Binding Description: (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.bbmri-eric.eu/CodeSystem/miabis-characteristicCS
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: Diagnosis
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value[x] 1..1 CodeableConcept Value held by characteristic
Binding: DiagnosisVS (required)
..... exclude 1..1 boolean Group includes or excludes

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Group.type Base required GroupType 📍4.0.1 FHIR Std.
Group.characteristic.​code Base example Not State Unknown
Group.characteristic.​value[x] Base example Not State Unknown
Group.characteristic:ageRange.​code Base example Not State Unknown
Group.characteristic:sex.​code Base example Not State Unknown
Group.characteristic:sex.​value[x] Base required AdministrativeGender 📦4.0.1 FHIR Std.
Group.characteristic:storageTemperature.​code Base example Not State Unknown
Group.characteristic:storageTemperature.​value[x] Base required Storage Temperature Value Set 📦1.3.0 This IG
Group.characteristic:materialType.​code Base example Not State Unknown
Group.characteristic:materialType.​value[x] Base required Collection Sample Type Value Set 📦1.3.0 This IG
Group.characteristic:diagnosis.​code Base example Not State Unknown
Group.characteristic:diagnosis.​value[x] Base required DiagnosisVS 📦1.3.0 This IG

Constraints

Id Grade Path(s) Description Expression
dom-2 error Group If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Group 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-4 error Group 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-5 error Group If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Group A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
grp-1 error Group Can only have members if group is "actual" member.empty() or (actual = true)

This structure is derived from Group

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Group 0..* Group Group of multiple entities
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:numberOfSubjects S 0..1 integer Total number of subjects included in the collection.
URL: https://fhir.bbmri-eric.eu/StructureDefinition/miabis-number-of-subjects-extension
.... extension:inclusionCriteria S 0..* CodeableConcept Information on type of parameters that determine which subjects will become collection participants.
URL: https://fhir.bbmri-eric.eu/StructureDefinition/miabis-inclusion-criteria-extension
Binding: Inclusion Criteria ValueSet (required)
.... extension:MemberEntity S 0..* (Complex) Member Entity
URL: https://fhir.bbmri-eric.eu/StructureDefinition/miabis-member-entity-extension
..... value[x] 0..1 Reference(Specimen) Value of extension
... identifier S 1..1 Identifier ID of the collection.
... active S 0..1 boolean The state of the collection functions.
... name S 1..1 string Name of the collection (preferably in English).
... managingEntity S 1..1 Reference(Collection Organization) Organization resource containing details of this collection, such as contact information, publications, etc.
... Slices for characteristic 2..* BackboneElement Include / Exclude group members by Trait
Slice: Unordered, Open by value:code
.... characteristic:ageRange S 0..1 BackboneElement Age of youngest and oldest sample donor at the time of sample donation.
..... code 1..1 CodeableConcept Kind of characteristic
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.bbmri-eric.eu/CodeSystem/miabis-characteristicCS
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: Age
..... value[x] 1..1 Range Value held by characteristic
.... characteristic:sex S 1..* BackboneElement The sex of the individuals in the collection.
..... code 1..1 CodeableConcept Kind of characteristic
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.bbmri-eric.eu/CodeSystem/miabis-characteristicCS
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: Sex
..... value[x] 1..1 CodeableConcept Value held by characteristic
Binding: AdministrativeGender (required)
.... characteristic:storageTemperature S 0..* BackboneElement The long-term storage temperature at which the sample(s) are stored after preparation, based on SPREC v3.
..... code 1..1 CodeableConcept Kind of characteristic
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.bbmri-eric.eu/CodeSystem/miabis-characteristicCS
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: StorageTemperature
..... value[x] 1..1 CodeableConcept Value held by characteristic
Binding: Storage Temperature Value Set (required)
.... characteristic:materialType S 1..* BackboneElement The biospecimen saved from a biological entity for propagation e.g. testing, diagnostics, treatment or research purposes.
..... code 1..1 CodeableConcept Kind of characteristic
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.bbmri-eric.eu/CodeSystem/miabis-characteristicCS
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: MaterialType
..... value[x] 1..1 CodeableConcept Value held by characteristic
Binding: Collection Sample Type Value Set (required)
.... characteristic:diagnosis S 0..* BackboneElement The diagnosis of the individuals in the collection.
..... code 1..1 CodeableConcept Kind of characteristic
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.bbmri-eric.eu/CodeSystem/miabis-characteristicCS
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: Diagnosis
..... value[x] 1..1 CodeableConcept Value held by characteristic
Binding: DiagnosisVS (required)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Group.characteristic:sex.​value[x] Base required AdministrativeGender 📦4.0.1 FHIR Std.
Group.characteristic:storageTemperature.​value[x] Base required Storage Temperature Value Set 📦1.3.0 This IG
Group.characteristic:materialType.​value[x] Base required Collection Sample Type Value Set 📦1.3.0 This IG
Group.characteristic:diagnosis.​value[x] Base required DiagnosisVS 📦1.3.0 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Group C 0..* Group Group of multiple entities
Constraints: grp-1
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:numberOfSubjects S 0..1 integer Total number of subjects included in the collection.
URL: https://fhir.bbmri-eric.eu/StructureDefinition/miabis-number-of-subjects-extension
.... extension:inclusionCriteria S 0..* CodeableConcept Information on type of parameters that determine which subjects will become collection participants.
URL: https://fhir.bbmri-eric.eu/StructureDefinition/miabis-inclusion-criteria-extension
Binding: Inclusion Criteria ValueSet (required)
.... extension:MemberEntity S 0..* (Complex) Member Entity
URL: https://fhir.bbmri-eric.eu/StructureDefinition/miabis-member-entity-extension
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "https://fhir.bbmri-eric.eu/StructureDefinition/miabis-member-entity-extension"
..... value[x] 0..1 Reference(Specimen) Value of extension
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 1..1 Identifier ID of the collection.
... active SΣ 0..1 boolean The state of the collection functions.
... type Σ 1..1 code The type of resources this group contains. For this resource type, this is always set to person. (should be specimen, but this is only supported in R5)
Binding: GroupType (required): Types of resources that are part of group.
Required Pattern: person
... actual ΣC 1..1 boolean Descriptive or actual
... code Σ 0..1 CodeableConcept Kind of Group members
Binding Description: (example): Kind of particular resource; e.g. cow, syringe, lake, etc.
... name SΣ 1..1 string Name of the collection (preferably in English).
... quantity Σ 0..1 unsignedInt Number of members
... managingEntity SΣ 1..1 Reference(Collection Organization) Organization resource containing details of this collection, such as contact information, publications, etc.
... Slices for characteristic 2..* BackboneElement Include / Exclude group members by Trait
Slice: Unordered, Open by value:code
.... characteristic:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code 1..1 CodeableConcept Kind of characteristic
Binding Description: (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.
..... value[x] 1..1 Value held by characteristic
Binding Description: (example): Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc.
...... valueCodeableConcept CodeableConcept
...... valueBoolean boolean
...... valueQuantity Quantity
...... valueRange Range
...... valueReference Reference(Any)
..... exclude 1..1 boolean Group includes or excludes
..... period 0..1 Period Period over which characteristic is tested
.... characteristic:ageRange S 0..1 BackboneElement Age of youngest and oldest sample donor at the time of sample donation.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code 1..1 CodeableConcept Kind of characteristic
Binding Description: (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.bbmri-eric.eu/CodeSystem/miabis-characteristicCS
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: Age
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value[x] 1..1 Range Value held by characteristic
..... exclude 1..1 boolean Group includes or excludes
..... period 0..1 Period Period over which characteristic is tested
.... characteristic:sex S 1..* BackboneElement The sex of the individuals in the collection.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code 1..1 CodeableConcept Kind of characteristic
Binding Description: (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.bbmri-eric.eu/CodeSystem/miabis-characteristicCS
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: Sex
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value[x] 1..1 CodeableConcept Value held by characteristic
Binding: AdministrativeGender (required)
..... exclude 1..1 boolean Group includes or excludes
..... period 0..1 Period Period over which characteristic is tested
.... characteristic:storageTemperature S 0..* BackboneElement The long-term storage temperature at which the sample(s) are stored after preparation, based on SPREC v3.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code 1..1 CodeableConcept Kind of characteristic
Binding Description: (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.bbmri-eric.eu/CodeSystem/miabis-characteristicCS
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: StorageTemperature
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value[x] 1..1 CodeableConcept Value held by characteristic
Binding: Storage Temperature Value Set (required)
..... exclude 1..1 boolean Group includes or excludes
..... period 0..1 Period Period over which characteristic is tested
.... characteristic:materialType S 1..* BackboneElement The biospecimen saved from a biological entity for propagation e.g. testing, diagnostics, treatment or research purposes.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code 1..1 CodeableConcept Kind of characteristic
Binding Description: (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.bbmri-eric.eu/CodeSystem/miabis-characteristicCS
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: MaterialType
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value[x] 1..1 CodeableConcept Value held by characteristic
Binding: Collection Sample Type Value Set (required)
..... exclude 1..1 boolean Group includes or excludes
..... period 0..1 Period Period over which characteristic is tested
.... characteristic:diagnosis S 0..* BackboneElement The diagnosis of the individuals in the collection.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code 1..1 CodeableConcept Kind of characteristic
Binding Description: (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.bbmri-eric.eu/CodeSystem/miabis-characteristicCS
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: Diagnosis
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value[x] 1..1 CodeableConcept Value held by characteristic
Binding: DiagnosisVS (required)
..... exclude 1..1 boolean Group includes or excludes
..... period 0..1 Period Period over which characteristic is tested
... member C 0..* BackboneElement Who or what is in group
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... entity 1..1 Reference(Patient | Practitioner | PractitionerRole | Device | Medication | Substance | Group) Reference to the group member
.... period 0..1 Period Period member belonged to the group
.... inactive 0..1 boolean If member is no longer in group

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Group.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Group.type Base required GroupType 📍4.0.1 FHIR Std.
Group.code Base example Not State Unknown
Group.characteristic.​code Base example Not State Unknown
Group.characteristic.​value[x] Base example Not State Unknown
Group.characteristic:ageRange.​code Base example Not State Unknown
Group.characteristic:sex.​code Base example Not State Unknown
Group.characteristic:sex.​value[x] Base required AdministrativeGender 📦4.0.1 FHIR Std.
Group.characteristic:storageTemperature.​code Base example Not State Unknown
Group.characteristic:storageTemperature.​value[x] Base required Storage Temperature Value Set 📦1.3.0 This IG
Group.characteristic:materialType.​code Base example Not State Unknown
Group.characteristic:materialType.​value[x] Base required Collection Sample Type Value Set 📦1.3.0 This IG
Group.characteristic:diagnosis.​code Base example Not State Unknown
Group.characteristic:diagnosis.​value[x] Base required DiagnosisVS 📦1.3.0 This IG

Constraints

Id Grade Path(s) Description Expression
dom-2 error Group If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Group 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-4 error Group 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-5 error Group If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Group A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
grp-1 error Group Can only have members if group is "actual" member.empty() or (actual = true)

This structure is derived from Group

Summary

Mandatory: 5 elements
Must-Support: 12 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Group.characteristic

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Group C 0..* Group Group of multiple entities
Constraints: grp-1
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:numberOfSubjects S 0..1 integer Total number of subjects included in the collection.
URL: https://fhir.bbmri-eric.eu/StructureDefinition/miabis-number-of-subjects-extension
.... extension:inclusionCriteria S 0..* CodeableConcept Information on type of parameters that determine which subjects will become collection participants.
URL: https://fhir.bbmri-eric.eu/StructureDefinition/miabis-inclusion-criteria-extension
Binding: Inclusion Criteria ValueSet (required)
.... extension:MemberEntity S 0..* (Complex) Member Entity
URL: https://fhir.bbmri-eric.eu/StructureDefinition/miabis-member-entity-extension
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "https://fhir.bbmri-eric.eu/StructureDefinition/miabis-member-entity-extension"
..... value[x] 0..1 Reference(Specimen) Value of extension
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... active SΣ 0..1 boolean The state of the collection functions.
... type Σ 1..1 code The type of resources this group contains. For this resource type, this is always set to person. (should be specimen, but this is only supported in R5)
Binding: GroupType (required): Types of resources that are part of group.
Required Pattern: person
... actual ΣC 1..1 boolean Descriptive or actual
... name SΣ 1..1 string Name of the collection (preferably in English).
... managingEntity SΣ 1..1 Reference(Collection Organization) Organization resource containing details of this collection, such as contact information, publications, etc.
... Slices for characteristic 2..* BackboneElement Include / Exclude group members by Trait
Slice: Unordered, Open by value:code
.... characteristic:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code 1..1 CodeableConcept Kind of characteristic
Binding Description: (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.
..... value[x] 1..1 Value held by characteristic
Binding Description: (example): Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc.
...... valueCodeableConcept CodeableConcept
...... valueBoolean boolean
...... valueQuantity Quantity
...... valueRange Range
...... valueReference Reference(Any)
..... exclude 1..1 boolean Group includes or excludes
.... characteristic:ageRange S 0..1 BackboneElement Age of youngest and oldest sample donor at the time of sample donation.
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code 1..1 CodeableConcept Kind of characteristic
Binding Description: (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.bbmri-eric.eu/CodeSystem/miabis-characteristicCS
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: Age
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value[x] 1..1 Range Value held by characteristic
..... exclude 1..1 boolean Group includes or excludes
.... characteristic:sex S 1..* BackboneElement The sex of the individuals in the collection.
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code 1..1 CodeableConcept Kind of characteristic
Binding Description: (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.bbmri-eric.eu/CodeSystem/miabis-characteristicCS
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: Sex
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value[x] 1..1 CodeableConcept Value held by characteristic
Binding: AdministrativeGender (required)
..... exclude 1..1 boolean Group includes or excludes
.... characteristic:storageTemperature S 0..* BackboneElement The long-term storage temperature at which the sample(s) are stored after preparation, based on SPREC v3.
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code 1..1 CodeableConcept Kind of characteristic
Binding Description: (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.bbmri-eric.eu/CodeSystem/miabis-characteristicCS
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: StorageTemperature
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value[x] 1..1 CodeableConcept Value held by characteristic
Binding: Storage Temperature Value Set (required)
..... exclude 1..1 boolean Group includes or excludes
.... characteristic:materialType S 1..* BackboneElement The biospecimen saved from a biological entity for propagation e.g. testing, diagnostics, treatment or research purposes.
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code 1..1 CodeableConcept Kind of characteristic
Binding Description: (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.bbmri-eric.eu/CodeSystem/miabis-characteristicCS
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: MaterialType
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value[x] 1..1 CodeableConcept Value held by characteristic
Binding: Collection Sample Type Value Set (required)
..... exclude 1..1 boolean Group includes or excludes
.... characteristic:diagnosis S 0..* BackboneElement The diagnosis of the individuals in the collection.
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code 1..1 CodeableConcept Kind of characteristic
Binding Description: (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.bbmri-eric.eu/CodeSystem/miabis-characteristicCS
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: Diagnosis
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value[x] 1..1 CodeableConcept Value held by characteristic
Binding: DiagnosisVS (required)
..... exclude 1..1 boolean Group includes or excludes

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Group.type Base required GroupType 📍4.0.1 FHIR Std.
Group.characteristic.​code Base example Not State Unknown
Group.characteristic.​value[x] Base example Not State Unknown
Group.characteristic:ageRange.​code Base example Not State Unknown
Group.characteristic:sex.​code Base example Not State Unknown
Group.characteristic:sex.​value[x] Base required AdministrativeGender 📦4.0.1 FHIR Std.
Group.characteristic:storageTemperature.​code Base example Not State Unknown
Group.characteristic:storageTemperature.​value[x] Base required Storage Temperature Value Set 📦1.3.0 This IG
Group.characteristic:materialType.​code Base example Not State Unknown
Group.characteristic:materialType.​value[x] Base required Collection Sample Type Value Set 📦1.3.0 This IG
Group.characteristic:diagnosis.​code Base example Not State Unknown
Group.characteristic:diagnosis.​value[x] Base required DiagnosisVS 📦1.3.0 This IG

Constraints

Id Grade Path(s) Description Expression
dom-2 error Group If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Group 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-4 error Group 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-5 error Group If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Group A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
grp-1 error Group Can only have members if group is "actual" member.empty() or (actual = true)

Differential View

This structure is derived from Group

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Group 0..* Group Group of multiple entities
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:numberOfSubjects S 0..1 integer Total number of subjects included in the collection.
URL: https://fhir.bbmri-eric.eu/StructureDefinition/miabis-number-of-subjects-extension
.... extension:inclusionCriteria S 0..* CodeableConcept Information on type of parameters that determine which subjects will become collection participants.
URL: https://fhir.bbmri-eric.eu/StructureDefinition/miabis-inclusion-criteria-extension
Binding: Inclusion Criteria ValueSet (required)
.... extension:MemberEntity S 0..* (Complex) Member Entity
URL: https://fhir.bbmri-eric.eu/StructureDefinition/miabis-member-entity-extension
..... value[x] 0..1 Reference(Specimen) Value of extension
... identifier S 1..1 Identifier ID of the collection.
... active S 0..1 boolean The state of the collection functions.
... name S 1..1 string Name of the collection (preferably in English).
... managingEntity S 1..1 Reference(Collection Organization) Organization resource containing details of this collection, such as contact information, publications, etc.
... Slices for characteristic 2..* BackboneElement Include / Exclude group members by Trait
Slice: Unordered, Open by value:code
.... characteristic:ageRange S 0..1 BackboneElement Age of youngest and oldest sample donor at the time of sample donation.
..... code 1..1 CodeableConcept Kind of characteristic
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.bbmri-eric.eu/CodeSystem/miabis-characteristicCS
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: Age
..... value[x] 1..1 Range Value held by characteristic
.... characteristic:sex S 1..* BackboneElement The sex of the individuals in the collection.
..... code 1..1 CodeableConcept Kind of characteristic
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.bbmri-eric.eu/CodeSystem/miabis-characteristicCS
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: Sex
..... value[x] 1..1 CodeableConcept Value held by characteristic
Binding: AdministrativeGender (required)
.... characteristic:storageTemperature S 0..* BackboneElement The long-term storage temperature at which the sample(s) are stored after preparation, based on SPREC v3.
..... code 1..1 CodeableConcept Kind of characteristic
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.bbmri-eric.eu/CodeSystem/miabis-characteristicCS
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: StorageTemperature
..... value[x] 1..1 CodeableConcept Value held by characteristic
Binding: Storage Temperature Value Set (required)
.... characteristic:materialType S 1..* BackboneElement The biospecimen saved from a biological entity for propagation e.g. testing, diagnostics, treatment or research purposes.
..... code 1..1 CodeableConcept Kind of characteristic
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.bbmri-eric.eu/CodeSystem/miabis-characteristicCS
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: MaterialType
..... value[x] 1..1 CodeableConcept Value held by characteristic
Binding: Collection Sample Type Value Set (required)
.... characteristic:diagnosis S 0..* BackboneElement The diagnosis of the individuals in the collection.
..... code 1..1 CodeableConcept Kind of characteristic
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.bbmri-eric.eu/CodeSystem/miabis-characteristicCS
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: Diagnosis
..... value[x] 1..1 CodeableConcept Value held by characteristic
Binding: DiagnosisVS (required)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Group.characteristic:sex.​value[x] Base required AdministrativeGender 📦4.0.1 FHIR Std.
Group.characteristic:storageTemperature.​value[x] Base required Storage Temperature Value Set 📦1.3.0 This IG
Group.characteristic:materialType.​value[x] Base required Collection Sample Type Value Set 📦1.3.0 This IG
Group.characteristic:diagnosis.​value[x] Base required DiagnosisVS 📦1.3.0 This IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Group C 0..* Group Group of multiple entities
Constraints: grp-1
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:numberOfSubjects S 0..1 integer Total number of subjects included in the collection.
URL: https://fhir.bbmri-eric.eu/StructureDefinition/miabis-number-of-subjects-extension
.... extension:inclusionCriteria S 0..* CodeableConcept Information on type of parameters that determine which subjects will become collection participants.
URL: https://fhir.bbmri-eric.eu/StructureDefinition/miabis-inclusion-criteria-extension
Binding: Inclusion Criteria ValueSet (required)
.... extension:MemberEntity S 0..* (Complex) Member Entity
URL: https://fhir.bbmri-eric.eu/StructureDefinition/miabis-member-entity-extension
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "https://fhir.bbmri-eric.eu/StructureDefinition/miabis-member-entity-extension"
..... value[x] 0..1 Reference(Specimen) Value of extension
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 1..1 Identifier ID of the collection.
... active SΣ 0..1 boolean The state of the collection functions.
... type Σ 1..1 code The type of resources this group contains. For this resource type, this is always set to person. (should be specimen, but this is only supported in R5)
Binding: GroupType (required): Types of resources that are part of group.
Required Pattern: person
... actual ΣC 1..1 boolean Descriptive or actual
... code Σ 0..1 CodeableConcept Kind of Group members
Binding Description: (example): Kind of particular resource; e.g. cow, syringe, lake, etc.
... name SΣ 1..1 string Name of the collection (preferably in English).
... quantity Σ 0..1 unsignedInt Number of members
... managingEntity SΣ 1..1 Reference(Collection Organization) Organization resource containing details of this collection, such as contact information, publications, etc.
... Slices for characteristic 2..* BackboneElement Include / Exclude group members by Trait
Slice: Unordered, Open by value:code
.... characteristic:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code 1..1 CodeableConcept Kind of characteristic
Binding Description: (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.
..... value[x] 1..1 Value held by characteristic
Binding Description: (example): Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc.
...... valueCodeableConcept CodeableConcept
...... valueBoolean boolean
...... valueQuantity Quantity
...... valueRange Range
...... valueReference Reference(Any)
..... exclude 1..1 boolean Group includes or excludes
..... period 0..1 Period Period over which characteristic is tested
.... characteristic:ageRange S 0..1 BackboneElement Age of youngest and oldest sample donor at the time of sample donation.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code 1..1 CodeableConcept Kind of characteristic
Binding Description: (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.bbmri-eric.eu/CodeSystem/miabis-characteristicCS
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: Age
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value[x] 1..1 Range Value held by characteristic
..... exclude 1..1 boolean Group includes or excludes
..... period 0..1 Period Period over which characteristic is tested
.... characteristic:sex S 1..* BackboneElement The sex of the individuals in the collection.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code 1..1 CodeableConcept Kind of characteristic
Binding Description: (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.bbmri-eric.eu/CodeSystem/miabis-characteristicCS
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: Sex
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value[x] 1..1 CodeableConcept Value held by characteristic
Binding: AdministrativeGender (required)
..... exclude 1..1 boolean Group includes or excludes
..... period 0..1 Period Period over which characteristic is tested
.... characteristic:storageTemperature S 0..* BackboneElement The long-term storage temperature at which the sample(s) are stored after preparation, based on SPREC v3.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code 1..1 CodeableConcept Kind of characteristic
Binding Description: (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.bbmri-eric.eu/CodeSystem/miabis-characteristicCS
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: StorageTemperature
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value[x] 1..1 CodeableConcept Value held by characteristic
Binding: Storage Temperature Value Set (required)
..... exclude 1..1 boolean Group includes or excludes
..... period 0..1 Period Period over which characteristic is tested
.... characteristic:materialType S 1..* BackboneElement The biospecimen saved from a biological entity for propagation e.g. testing, diagnostics, treatment or research purposes.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code 1..1 CodeableConcept Kind of characteristic
Binding Description: (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.bbmri-eric.eu/CodeSystem/miabis-characteristicCS
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: MaterialType
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value[x] 1..1 CodeableConcept Value held by characteristic
Binding: Collection Sample Type Value Set (required)
..... exclude 1..1 boolean Group includes or excludes
..... period 0..1 Period Period over which characteristic is tested
.... characteristic:diagnosis S 0..* BackboneElement The diagnosis of the individuals in the collection.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code 1..1 CodeableConcept Kind of characteristic
Binding Description: (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.bbmri-eric.eu/CodeSystem/miabis-characteristicCS
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: Diagnosis
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value[x] 1..1 CodeableConcept Value held by characteristic
Binding: DiagnosisVS (required)
..... exclude 1..1 boolean Group includes or excludes
..... period 0..1 Period Period over which characteristic is tested
... member C 0..* BackboneElement Who or what is in group
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... entity 1..1 Reference(Patient | Practitioner | PractitionerRole | Device | Medication | Substance | Group) Reference to the group member
.... period 0..1 Period Period member belonged to the group
.... inactive 0..1 boolean If member is no longer in group

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Group.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Group.type Base required GroupType 📍4.0.1 FHIR Std.
Group.code Base example Not State Unknown
Group.characteristic.​code Base example Not State Unknown
Group.characteristic.​value[x] Base example Not State Unknown
Group.characteristic:ageRange.​code Base example Not State Unknown
Group.characteristic:sex.​code Base example Not State Unknown
Group.characteristic:sex.​value[x] Base required AdministrativeGender 📦4.0.1 FHIR Std.
Group.characteristic:storageTemperature.​code Base example Not State Unknown
Group.characteristic:storageTemperature.​value[x] Base required Storage Temperature Value Set 📦1.3.0 This IG
Group.characteristic:materialType.​code Base example Not State Unknown
Group.characteristic:materialType.​value[x] Base required Collection Sample Type Value Set 📦1.3.0 This IG
Group.characteristic:diagnosis.​code Base example Not State Unknown
Group.characteristic:diagnosis.​value[x] Base required DiagnosisVS 📦1.3.0 This IG

Constraints

Id Grade Path(s) Description Expression
dom-2 error Group If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Group 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-4 error Group 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-5 error Group If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Group A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
grp-1 error Group Can only have members if group is "actual" member.empty() or (actual = true)

This structure is derived from Group

Summary

Mandatory: 5 elements
Must-Support: 12 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Group.characteristic

 

Other representations of profile: CSV, Excel, Schematron