MIABIS on FHIR Implementation Guide
1.0.0 - CI Build

MIABIS on FHIR Implementation Guide - Local Development build (v1.0.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.0.0
Active as of 2025-05-15 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

Usage:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Group C 0..* Group Group of multiple entities
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
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
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
grp-1: Can only have members if group is "actual"
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... 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
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... 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)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:MemberEntity S 0..* (Complex) Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Group.member.entity
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... extension 0..0
..... url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-Group.member.entity"
..... value[x] 1..1 Reference(Specimen) Value of extension
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... active SΣ 0..1 boolean The state of the collection functions.
ele-1: All FHIR elements must have a @value or children
... 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.


ele-1: All FHIR elements must have a @value or children
Required Pattern: person
... actual ΣC 1..1 boolean Descriptive or actual
ele-1: All FHIR elements must have a @value or children
... name SΣ 1..1 string Name of the collection (preferably in English).
ele-1: All FHIR elements must have a @value or children
... managingEntity SΣ 1..1 Reference(Collection Organization) Organization resource containing details of this collection, such as contact information, publications, etc.
ele-1: All FHIR elements must have a @value or children
... Slices for characteristic 2..* BackboneElement Include / Exclude group members by Trait
Slice: Unordered, Open by value:code
ele-1: All FHIR elements must have a @value or children
.... characteristic:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... code 1..1 CodeableConcept Kind of characteristic
Binding Description (No ValueSet): (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.


ele-1: All FHIR elements must have a @value or children
..... value[x] 1..1 Value held by characteristic
Binding Description (No ValueSet): (example): Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc.


ele-1: All FHIR elements must have a @value or children
...... valueCodeableConcept CodeableConcept
...... valueBoolean boolean
...... valueQuantity Quantity
...... valueRange Range
...... valueReference Reference(Any)
..... exclude 1..1 boolean Group includes or excludes
ele-1: All FHIR elements must have a @value or children
.... characteristic:ageRange S 0..1 BackboneElement Age of youngest and oldest sample donor at the time of sample donation.
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... code 1..1 CodeableConcept Kind of characteristic
Binding Description (No ValueSet): (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.


ele-1: All FHIR elements must have a @value or children
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
ele-1: All FHIR elements must have a @value or children
..... exclude 1..1 boolean Group includes or excludes
ele-1: All FHIR elements must have a @value or children
.... characteristic:sex S 1..* BackboneElement The sex of the individuals in the collection.
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... code 1..1 CodeableConcept Kind of characteristic
Binding Description (No ValueSet): (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.


ele-1: All FHIR elements must have a @value or children
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)
ele-1: All FHIR elements must have a @value or children
..... exclude 1..1 boolean Group includes or excludes
ele-1: All FHIR elements must have a @value or children
.... characteristic:storageTemperature S 0..* BackboneElement The long-term storage temperature at which the sample(s) are stored after preparation, based on SPREC v3.
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... code 1..1 CodeableConcept Kind of characteristic
Binding Description (No ValueSet): (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.


ele-1: All FHIR elements must have a @value or children
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)
ele-1: All FHIR elements must have a @value or children
..... exclude 1..1 boolean Group includes or excludes
ele-1: All FHIR elements must have a @value or children
.... characteristic:materialType S 1..* BackboneElement The biospecimen saved from a biological entity for propagation e.g. testing, diagnostics, treatment or research purposes.
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... code 1..1 CodeableConcept Kind of characteristic
Binding Description (No ValueSet): (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.


ele-1: All FHIR elements must have a @value or children
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)
ele-1: All FHIR elements must have a @value or children
..... exclude 1..1 boolean Group includes or excludes
ele-1: All FHIR elements must have a @value or children
.... characteristic:diagnosis S 0..* BackboneElement The diagnosis of the individuals in the collection.
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... code 1..1 CodeableConcept Kind of characteristic
Binding Description (No ValueSet): (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.


ele-1: All FHIR elements must have a @value or children
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)
ele-1: All FHIR elements must have a @value or children
..... exclude 1..1 boolean Group includes or excludes
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Group.typerequiredPattern: person
http://hl7.org/fhir/ValueSet/group-type|4.0.1
from the FHIR Standard
Group.characteristic.codeexample
Group.characteristic.value[x]example
Group.characteristic:ageRange.codeexamplePattern: Age
Group.characteristic:sex.codeexamplePattern: Sex
Group.characteristic:sex.value[x]requiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender
from the FHIR Standard
Group.characteristic:storageTemperature.codeexamplePattern: StorageTemperature
Group.characteristic:storageTemperature.value[x]requiredStorageTemperatureVS (a valid code from MIABIS Storage Temperature Code System)
https://fhir.bbmri-eric.eu/ValueSet/miabis-storage-temperature-vs
from this IG
Group.characteristic:materialType.codeexamplePattern: MaterialType
Group.characteristic:materialType.value[x]requiredCollectionSampleTypeVS (a valid code from MIABIS Collection Sample Type Code System)
https://fhir.bbmri-eric.eu/ValueSet/miabis-collection-sample-typ-vs
from this IG
Group.characteristic:diagnosis.codeexamplePattern: Diagnosis
Group.characteristic:diagnosis.value[x]requiredDiagnosisVS
https://fhir.bbmri-eric.eu/ValueSet/miabis-diagnosis-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** extensionsMust 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)

This structure is derived from Group

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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) Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Group.member.entity
..... value[x] 1..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)

PathConformanceValueSetURI
Group.characteristic:sex.value[x]requiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender
from the FHIR Standard
Group.characteristic:storageTemperature.value[x]requiredStorageTemperatureVS (a valid code from MIABIS Storage Temperature Code System)
https://fhir.bbmri-eric.eu/ValueSet/miabis-storage-temperature-vs
from this IG
Group.characteristic:materialType.value[x]requiredCollectionSampleTypeVS (a valid code from MIABIS Collection Sample Type Code System)
https://fhir.bbmri-eric.eu/ValueSet/miabis-collection-sample-typ-vs
from this IG
Group.characteristic:diagnosis.value[x]requiredDiagnosisVS
https://fhir.bbmri-eric.eu/ValueSet/miabis-diagnosis-vs
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. Group C 0..* Group Group of multiple entities
grp-1: Can only have members if group is "actual"
... 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
... 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) Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Group.member.entity
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-Group.member.entity"
..... value[x] 1..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 (No ValueSet): (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 (No ValueSet): (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 (No ValueSet): (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 (No ValueSet): (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 (No ValueSet): (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 (No ValueSet): (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 (No ValueSet): (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 (No ValueSet): (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

PathConformanceValueSet / CodeURI
Group.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Group.typerequiredPattern: person
http://hl7.org/fhir/ValueSet/group-type|4.0.1
from the FHIR Standard
Group.codeexample
Group.characteristic.codeexample
Group.characteristic.value[x]example
Group.characteristic:ageRange.codeexamplePattern: Age
Group.characteristic:sex.codeexamplePattern: Sex
Group.characteristic:sex.value[x]requiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender
from the FHIR Standard
Group.characteristic:storageTemperature.codeexamplePattern: StorageTemperature
Group.characteristic:storageTemperature.value[x]requiredStorageTemperatureVS (a valid code from MIABIS Storage Temperature Code System)
https://fhir.bbmri-eric.eu/ValueSet/miabis-storage-temperature-vs
from this IG
Group.characteristic:materialType.codeexamplePattern: MaterialType
Group.characteristic:materialType.value[x]requiredCollectionSampleTypeVS (a valid code from MIABIS Collection Sample Type Code System)
https://fhir.bbmri-eric.eu/ValueSet/miabis-collection-sample-typ-vs
from this IG
Group.characteristic:diagnosis.codeexamplePattern: Diagnosis
Group.characteristic:diagnosis.value[x]requiredDiagnosisVS
https://fhir.bbmri-eric.eu/ValueSet/miabis-diagnosis-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** extensionsMust 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)

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 & Constraintsdoco
.. Group C 0..* Group Group of multiple entities
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
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
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
grp-1: Can only have members if group is "actual"
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... 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
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... 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)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:MemberEntity S 0..* (Complex) Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Group.member.entity
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... extension 0..0
..... url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-Group.member.entity"
..... value[x] 1..1 Reference(Specimen) Value of extension
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... active SΣ 0..1 boolean The state of the collection functions.
ele-1: All FHIR elements must have a @value or children
... 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.


ele-1: All FHIR elements must have a @value or children
Required Pattern: person
... actual ΣC 1..1 boolean Descriptive or actual
ele-1: All FHIR elements must have a @value or children
... name SΣ 1..1 string Name of the collection (preferably in English).
ele-1: All FHIR elements must have a @value or children
... managingEntity SΣ 1..1 Reference(Collection Organization) Organization resource containing details of this collection, such as contact information, publications, etc.
ele-1: All FHIR elements must have a @value or children
... Slices for characteristic 2..* BackboneElement Include / Exclude group members by Trait
Slice: Unordered, Open by value:code
ele-1: All FHIR elements must have a @value or children
.... characteristic:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... code 1..1 CodeableConcept Kind of characteristic
Binding Description (No ValueSet): (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.


ele-1: All FHIR elements must have a @value or children
..... value[x] 1..1 Value held by characteristic
Binding Description (No ValueSet): (example): Value of descriptive member characteristic; e.g. red, male, pneumonia, Caucasian, etc.


ele-1: All FHIR elements must have a @value or children
...... valueCodeableConcept CodeableConcept
...... valueBoolean boolean
...... valueQuantity Quantity
...... valueRange Range
...... valueReference Reference(Any)
..... exclude 1..1 boolean Group includes or excludes
ele-1: All FHIR elements must have a @value or children
.... characteristic:ageRange S 0..1 BackboneElement Age of youngest and oldest sample donor at the time of sample donation.
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... code 1..1 CodeableConcept Kind of characteristic
Binding Description (No ValueSet): (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.


ele-1: All FHIR elements must have a @value or children
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
ele-1: All FHIR elements must have a @value or children
..... exclude 1..1 boolean Group includes or excludes
ele-1: All FHIR elements must have a @value or children
.... characteristic:sex S 1..* BackboneElement The sex of the individuals in the collection.
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... code 1..1 CodeableConcept Kind of characteristic
Binding Description (No ValueSet): (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.


ele-1: All FHIR elements must have a @value or children
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)
ele-1: All FHIR elements must have a @value or children
..... exclude 1..1 boolean Group includes or excludes
ele-1: All FHIR elements must have a @value or children
.... characteristic:storageTemperature S 0..* BackboneElement The long-term storage temperature at which the sample(s) are stored after preparation, based on SPREC v3.
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... code 1..1 CodeableConcept Kind of characteristic
Binding Description (No ValueSet): (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.


ele-1: All FHIR elements must have a @value or children
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)
ele-1: All FHIR elements must have a @value or children
..... exclude 1..1 boolean Group includes or excludes
ele-1: All FHIR elements must have a @value or children
.... characteristic:materialType S 1..* BackboneElement The biospecimen saved from a biological entity for propagation e.g. testing, diagnostics, treatment or research purposes.
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... code 1..1 CodeableConcept Kind of characteristic
Binding Description (No ValueSet): (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.


ele-1: All FHIR elements must have a @value or children
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)
ele-1: All FHIR elements must have a @value or children
..... exclude 1..1 boolean Group includes or excludes
ele-1: All FHIR elements must have a @value or children
.... characteristic:diagnosis S 0..* BackboneElement The diagnosis of the individuals in the collection.
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... code 1..1 CodeableConcept Kind of characteristic
Binding Description (No ValueSet): (example): List of characteristics used to describe group members; e.g. gender, age, owner, location, etc.


ele-1: All FHIR elements must have a @value or children
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)
ele-1: All FHIR elements must have a @value or children
..... exclude 1..1 boolean Group includes or excludes
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Group.typerequiredPattern: person
http://hl7.org/fhir/ValueSet/group-type|4.0.1
from the FHIR Standard
Group.characteristic.codeexample
Group.characteristic.value[x]example
Group.characteristic:ageRange.codeexamplePattern: Age
Group.characteristic:sex.codeexamplePattern: Sex
Group.characteristic:sex.value[x]requiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender
from the FHIR Standard
Group.characteristic:storageTemperature.codeexamplePattern: StorageTemperature
Group.characteristic:storageTemperature.value[x]requiredStorageTemperatureVS (a valid code from MIABIS Storage Temperature Code System)
https://fhir.bbmri-eric.eu/ValueSet/miabis-storage-temperature-vs
from this IG
Group.characteristic:materialType.codeexamplePattern: MaterialType
Group.characteristic:materialType.value[x]requiredCollectionSampleTypeVS (a valid code from MIABIS Collection Sample Type Code System)
https://fhir.bbmri-eric.eu/ValueSet/miabis-collection-sample-typ-vs
from this IG
Group.characteristic:diagnosis.codeexamplePattern: Diagnosis
Group.characteristic:diagnosis.value[x]requiredDiagnosisVS
https://fhir.bbmri-eric.eu/ValueSet/miabis-diagnosis-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** extensionsMust 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)

Differential View

This structure is derived from Group

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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) Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Group.member.entity
..... value[x] 1..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)

PathConformanceValueSetURI
Group.characteristic:sex.value[x]requiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender
from the FHIR Standard
Group.characteristic:storageTemperature.value[x]requiredStorageTemperatureVS (a valid code from MIABIS Storage Temperature Code System)
https://fhir.bbmri-eric.eu/ValueSet/miabis-storage-temperature-vs
from this IG
Group.characteristic:materialType.value[x]requiredCollectionSampleTypeVS (a valid code from MIABIS Collection Sample Type Code System)
https://fhir.bbmri-eric.eu/ValueSet/miabis-collection-sample-typ-vs
from this IG
Group.characteristic:diagnosis.value[x]requiredDiagnosisVS
https://fhir.bbmri-eric.eu/ValueSet/miabis-diagnosis-vs
from this IG

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Group C 0..* Group Group of multiple entities
grp-1: Can only have members if group is "actual"
... 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
... 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) Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Group.member.entity
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-Group.member.entity"
..... value[x] 1..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 (No ValueSet): (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 (No ValueSet): (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 (No ValueSet): (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 (No ValueSet): (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 (No ValueSet): (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 (No ValueSet): (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 (No ValueSet): (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 (No ValueSet): (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

PathConformanceValueSet / CodeURI
Group.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Group.typerequiredPattern: person
http://hl7.org/fhir/ValueSet/group-type|4.0.1
from the FHIR Standard
Group.codeexample
Group.characteristic.codeexample
Group.characteristic.value[x]example
Group.characteristic:ageRange.codeexamplePattern: Age
Group.characteristic:sex.codeexamplePattern: Sex
Group.characteristic:sex.value[x]requiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender
from the FHIR Standard
Group.characteristic:storageTemperature.codeexamplePattern: StorageTemperature
Group.characteristic:storageTemperature.value[x]requiredStorageTemperatureVS (a valid code from MIABIS Storage Temperature Code System)
https://fhir.bbmri-eric.eu/ValueSet/miabis-storage-temperature-vs
from this IG
Group.characteristic:materialType.codeexamplePattern: MaterialType
Group.characteristic:materialType.value[x]requiredCollectionSampleTypeVS (a valid code from MIABIS Collection Sample Type Code System)
https://fhir.bbmri-eric.eu/ValueSet/miabis-collection-sample-typ-vs
from this IG
Group.characteristic:diagnosis.codeexamplePattern: Diagnosis
Group.characteristic:diagnosis.value[x]requiredDiagnosisVS
https://fhir.bbmri-eric.eu/ValueSet/miabis-diagnosis-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** extensionsMust 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)

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