MIABIS on FHIR Implementation Guide
1.3.0 - CI Build
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
| Official URL: https://fhir.bbmri-eric.eu/StructureDefinition/miabis-sample | Version: 1.3.0 | |||
| Active as of 2026-10-12 | Computable Name: Sample | |||
Sample is a portion or quantity of biological material that is collected from a sample donor, or a digital representation of a biological entity of the sample donor, such as an image.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:  |
|---|---|---|---|---|
  Specimen |
0..* | Specimen | Sample for analysis | |
  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 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
   extension:sampleCollection |
0..1 | Identifier | Sample Collection URL: https://fhir.bbmri-eric.eu/StructureDefinition/miabis-sample-collection-extension | |
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
 identifier |
1..1 | Identifier | Sample ID | |
| status |
0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. | |
| type |
1..1 | CodeableConcept | Detailed Sample type Binding: DetailedSampleTypeVS (required) | |
 subject |
1..1 | Reference(Sample Donor) | Donor of the sample | |
| collection |
0..1 | BackboneElement | Collection details | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
 Slices for collected[x] |
0..1 | Collection time Slice: Unordered, Closed by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view | ||
 collectedDateTime |
dateTime | |||
| collectedPeriod |
Period | |||
| collected[x]:collectedDateTime |
0..1 | dateTime | Sample creation date and time | |
 bodySite |
0..1 | CodeableConcept | Anatomical collection site Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |
 coding |
C | 0..1 | Coding | Code defined by a terminology system Constraints: SpecimenOntologyInvariant |
| system |
0..1 | uri | Identity of the terminology system | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
0..1 | code | Symbol in syntax defined by the system | |
 display |
0..1 | string | Representation defined by the system | |
| processing |
0..* | BackboneElement | Processing and processing step details | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| extension:storageTemperature |
0..1 | CodeableConcept | Sample storage temperature URL: https://fhir.bbmri-eric.eu/StructureDefinition/miabis-sample-storage-temperature-extension Binding: Storage Temperature Value Set (required) | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| note |
0..* | Annotation | Use restrictions | |
| text |
1..1 | markdown | actual use restrictions | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Specimen.status | Base | required | SpecimenStatus | 📍4.0.1 | FHIR Std. |
| Specimen.type | Base | required | DetailedSampleTypeVS | 📦1.3.0 | This IG |
| Specimen.collection.bodySite | Base | example | SNOMED CT Body Structures | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| SpecimenOntologyInvariant | error | Specimen.collection.bodySite.coding | bodySite.concept.coding.system and bodySite.concept.coding.version are required if any ontology information is provided |
Specimen.collection.bodySite.concept.coding.exists() implies (Specimen.collection.bodySite.concept.coding.system.exists() and Specimen.collection.bodySite.concept.coding.version.exists())
|
| dom-2 | error | Specimen | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Specimen | 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 | Specimen | 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 | Specimen | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Specimen | 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()
|
This structure is derived from Specimen
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Specimen |
0..* | Specimen | Sample for analysis | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| extension:sampleCollection |
0..1 | Identifier | Sample Collection URL: https://fhir.bbmri-eric.eu/StructureDefinition/miabis-sample-collection-extension | |
 identifier |
1..1 | Identifier | Sample ID | |
| type |
1..1 | CodeableConcept | Detailed Sample type Binding: DetailedSampleTypeVS (required) | |
| subject |
1..1 | Reference(Sample Donor) | Donor of the sample | |
| collection |
||||
| Slices for collected[x] |
0..1 | dateTime, Period | Collection time Slice: Unordered, Open by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view | |
| collected[x]:collectedDateTime |
0..1 | dateTime | Sample creation date and time | |
| bodySite |
||||
| coding |
C | 0..1 | Coding | Code defined by a terminology system Constraints: SpecimenOntologyInvariant |
| system |
0..1 | uri | Identity of the terminology system | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
0..1 | code | Symbol in syntax defined by the system | |
| display |
0..1 | string | Representation defined by the system | |
| processing |
||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| extension:storageTemperature |
0..1 | CodeableConcept | Sample storage temperature URL: https://fhir.bbmri-eric.eu/StructureDefinition/miabis-sample-storage-temperature-extension Binding: Storage Temperature Value Set (required) | |
| note |
0..* | Annotation | Use restrictions | |
| text |
1..1 | markdown | actual use restrictions | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Specimen.type | Base | required | DetailedSampleTypeVS | 📦1.3.0 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| SpecimenOntologyInvariant | error | Specimen.collection.bodySite.coding | bodySite.concept.coding.system and bodySite.concept.coding.version are required if any ontology information is provided |
Specimen.collection.bodySite.concept.coding.exists() implies (Specimen.collection.bodySite.concept.coding.system.exists() and Specimen.collection.bodySite.concept.coding.version.exists())
|
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Specimen |
0..* | Specimen | Sample for analysis | |||||
| 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 | |||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| 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 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| extension:sampleCollection |
0..1 | Identifier | Sample Collection URL: https://fhir.bbmri-eric.eu/StructureDefinition/miabis-sample-collection-extension | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| identifier |
1..1 | Identifier | Sample ID | |||||
| accessionIdentifier |
0..1 | Identifier | Identifier assigned by the lab | |||||
| status |
0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. | |||||
| type |
1..1 | CodeableConcept | Detailed Sample type Binding: DetailedSampleTypeVS (required) | |||||
| subject |
1..1 | Reference(Sample Donor) | Donor of the sample | |||||
| receivedTime |
0..1 | dateTime | The time when specimen was received for processing | |||||
| parent |
0..* | Reference(Specimen) | Specimen from which this specimen originated | |||||
| request |
0..* | Reference(ServiceRequest) | Why the specimen was collected | |||||
| collection |
0..1 | BackboneElement | Collection details | |||||
| 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 | |||||
| collector |
0..1 | Reference(Practitioner | PractitionerRole) | Who collected the specimen | |||||
| Slices for collected[x] |
0..1 | Collection time Slice: Unordered, Closed by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view | ||||||
| collectedDateTime |
dateTime | |||||||
| collectedPeriod |
Period | |||||||
| collected[x]:collectedDateTime |
0..1 | dateTime | Sample creation date and time | |||||
| duration |
0..1 | Duration | How long it took to collect specimen | |||||
| quantity |
C | 0..1 | SimpleQuantity(4.0.1) | The quantity of specimen collected Constraints: sqty-1 | ||||
| method |
0..1 | CodeableConcept | Technique used to perform collection Binding: FHIRSpecimenCollectionMethod (example): The technique that is used to perform the procedure. | |||||
| bodySite |
0..1 | CodeableConcept | Anatomical collection site Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
C | 0..1 | Coding | Code defined by a terminology system Constraints: SpecimenOntologyInvariant | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
0..1 | uri | Identity of the terminology system | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
0..1 | code | Symbol in syntax defined by the system | |||||
| 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 | |||||
 fastingStatus[x] |
0..1 | Whether or how long patient abstained from food and/or drink Binding: hl7VS-relevantClincialInformation (extensible): Codes describing the fasting status of the patient. | ||||||
| fastingStatusCodeableConcept |
CodeableConcept | |||||||
| fastingStatusDuration |
Duration | |||||||
| processing |
0..* | BackboneElement | Processing and processing step details | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| extension:storageTemperature |
0..1 | CodeableConcept | Sample storage temperature URL: https://fhir.bbmri-eric.eu/StructureDefinition/miabis-sample-storage-temperature-extension Binding: Storage Temperature Value Set (required) | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| description |
0..1 | string | Textual description of procedure | |||||
| procedure |
0..1 | CodeableConcept | Indicates the treatment step applied to the specimen Binding: SpecimenProcessingProcedure (example): Type indicating the technique used to process the specimen. | |||||
| additive |
0..* | Reference(Substance) | Material used in the processing step | |||||
| time[x] |
0..1 | Date and time of specimen processing | ||||||
| timeDateTime |
dateTime | |||||||
| timePeriod |
Period | |||||||
| container |
0..* | BackboneElement | Direct container of specimen (tube/slide, etc.) | |||||
| 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 | |||||
| identifier |
0..* | Identifier | Id for the container | |||||
| description |
0..1 | string | Textual description of the container | |||||
| type |
0..1 | CodeableConcept | Kind of container directly associated with specimen Binding: SpecimenContainerType (example): Type of specimen container. | |||||
| capacity |
C | 0..1 | SimpleQuantity(4.0.1) | Container volume or size Constraints: sqty-1 | ||||
| specimenQuantity |
C | 0..1 | SimpleQuantity(4.0.1) | Quantity of specimen within container Constraints: sqty-1 | ||||
| additive[x] |
0..1 | Additive associated with container Binding: hl7VS-additivePreservative (example): Substance added to specimen container. | ||||||
| additiveCodeableConcept |
CodeableConcept | |||||||
| additiveReference |
Reference(Substance) | |||||||
| condition |
0..* | CodeableConcept | State of the specimen Binding: hl7VS-specimenCondition (extensible): Codes describing the state of the specimen. | |||||
| note |
0..* | Annotation | Use restrictions | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| author[x] |
0..1 | Individual responsible for the annotation | ||||||
| authorReference |
Reference(Practitioner | Patient | RelatedPerson | Organization) | |||||||
| authorString |
string | |||||||
| time |
0..1 | dateTime | When the annotation was made | |||||
| text |
1..1 | markdown | actual use restrictions | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Specimen.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Specimen.status | Base | required | SpecimenStatus | 📍4.0.1 | FHIR Std. |
| Specimen.type | Base | required | DetailedSampleTypeVS | 📦1.3.0 | This IG |
| Specimen.collection.method | Base | example | FHIR Specimen Collection Method | 📍4.0.1 | FHIR Std. |
| Specimen.collection.bodySite | Base | example | SNOMED CT Body Structures | 📍4.0.1 | FHIR Std. |
| Specimen.collection.fastingStatus[x] | Base | extensible | hl7VS-relevantClincialInformation | 📦3.0.0 | THO v7.4 |
| Specimen.processing.procedure | Base | example | Specimen processing procedure | 📍4.0.1 | FHIR Std. |
| Specimen.container.type | Base | example | Specimen Container Type | 📍4.0.1 | FHIR Std. |
| Specimen.container.additive[x] | Base | example | hl7VS-additivePreservative | 📦3.0.0 | THO v7.4 |
| Specimen.condition | Base | extensible | hl7VS-specimenCondition | 📦3.0.0 | THO v7.4 |
| Id | Grade | Path(s) | Description | Expression |
| SpecimenOntologyInvariant | error | Specimen.collection.bodySite.coding | bodySite.concept.coding.system and bodySite.concept.coding.version are required if any ontology information is provided |
Specimen.collection.bodySite.concept.coding.exists() implies (Specimen.collection.bodySite.concept.coding.system.exists() and Specimen.collection.bodySite.concept.coding.version.exists())
|
| dom-2 | error | Specimen | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Specimen | 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 | Specimen | 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 | Specimen | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Specimen | 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()
|
| sqty-1 | error | Specimen.collection.quantity, Specimen.container.capacity, Specimen.container.specimenQuantity | The comparator is not used on a SimpleQuantity |
comparator.empty()
|
This structure is derived from Specimen
Summary
Mandatory: 3 elements
Must-Support: 9 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Specimen |
0..* | Specimen | Sample for analysis | |
| 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 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| extension:sampleCollection |
0..1 | Identifier | Sample Collection URL: https://fhir.bbmri-eric.eu/StructureDefinition/miabis-sample-collection-extension | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
| identifier |
1..1 | Identifier | Sample ID | |
| status |
0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. | |
| type |
1..1 | CodeableConcept | Detailed Sample type Binding: DetailedSampleTypeVS (required) | |
| subject |
1..1 | Reference(Sample Donor) | Donor of the sample | |
| collection |
0..1 | BackboneElement | Collection details | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| Slices for collected[x] |
0..1 | Collection time Slice: Unordered, Closed by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view | ||
| collectedDateTime |
dateTime | |||
| collectedPeriod |
Period | |||
| collected[x]:collectedDateTime |
0..1 | dateTime | Sample creation date and time | |
| bodySite |
0..1 | CodeableConcept | Anatomical collection site Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |
| coding |
C | 0..1 | Coding | Code defined by a terminology system Constraints: SpecimenOntologyInvariant |
| system |
0..1 | uri | Identity of the terminology system | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
0..1 | code | Symbol in syntax defined by the system | |
| display |
0..1 | string | Representation defined by the system | |
| processing |
0..* | BackboneElement | Processing and processing step details | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| extension:storageTemperature |
0..1 | CodeableConcept | Sample storage temperature URL: https://fhir.bbmri-eric.eu/StructureDefinition/miabis-sample-storage-temperature-extension Binding: Storage Temperature Value Set (required) | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| note |
0..* | Annotation | Use restrictions | |
| text |
1..1 | markdown | actual use restrictions | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Specimen.status | Base | required | SpecimenStatus | 📍4.0.1 | FHIR Std. |
| Specimen.type | Base | required | DetailedSampleTypeVS | 📦1.3.0 | This IG |
| Specimen.collection.bodySite | Base | example | SNOMED CT Body Structures | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| SpecimenOntologyInvariant | error | Specimen.collection.bodySite.coding | bodySite.concept.coding.system and bodySite.concept.coding.version are required if any ontology information is provided |
Specimen.collection.bodySite.concept.coding.exists() implies (Specimen.collection.bodySite.concept.coding.system.exists() and Specimen.collection.bodySite.concept.coding.version.exists())
|
| dom-2 | error | Specimen | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Specimen | 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 | Specimen | 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 | Specimen | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Specimen | 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()
|
Differential View
This structure is derived from Specimen
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Specimen |
0..* | Specimen | Sample for analysis | |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| extension:sampleCollection |
0..1 | Identifier | Sample Collection URL: https://fhir.bbmri-eric.eu/StructureDefinition/miabis-sample-collection-extension | |
| identifier |
1..1 | Identifier | Sample ID | |
| type |
1..1 | CodeableConcept | Detailed Sample type Binding: DetailedSampleTypeVS (required) | |
| subject |
1..1 | Reference(Sample Donor) | Donor of the sample | |
| collection |
||||
| Slices for collected[x] |
0..1 | dateTime, Period | Collection time Slice: Unordered, Open by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view | |
| collected[x]:collectedDateTime |
0..1 | dateTime | Sample creation date and time | |
| bodySite |
||||
| coding |
C | 0..1 | Coding | Code defined by a terminology system Constraints: SpecimenOntologyInvariant |
| system |
0..1 | uri | Identity of the terminology system | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
0..1 | code | Symbol in syntax defined by the system | |
| display |
0..1 | string | Representation defined by the system | |
| processing |
||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| extension:storageTemperature |
0..1 | CodeableConcept | Sample storage temperature URL: https://fhir.bbmri-eric.eu/StructureDefinition/miabis-sample-storage-temperature-extension Binding: Storage Temperature Value Set (required) | |
| note |
0..* | Annotation | Use restrictions | |
| text |
1..1 | markdown | actual use restrictions | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Specimen.type | Base | required | DetailedSampleTypeVS | 📦1.3.0 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| SpecimenOntologyInvariant | error | Specimen.collection.bodySite.coding | bodySite.concept.coding.system and bodySite.concept.coding.version are required if any ontology information is provided |
Specimen.collection.bodySite.concept.coding.exists() implies (Specimen.collection.bodySite.concept.coding.system.exists() and Specimen.collection.bodySite.concept.coding.version.exists())
|
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Specimen |
0..* | Specimen | Sample for analysis | |||||
| 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 | |||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| 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 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| extension:sampleCollection |
0..1 | Identifier | Sample Collection URL: https://fhir.bbmri-eric.eu/StructureDefinition/miabis-sample-collection-extension | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| identifier |
1..1 | Identifier | Sample ID | |||||
| accessionIdentifier |
0..1 | Identifier | Identifier assigned by the lab | |||||
| status |
0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. | |||||
| type |
1..1 | CodeableConcept | Detailed Sample type Binding: DetailedSampleTypeVS (required) | |||||
| subject |
1..1 | Reference(Sample Donor) | Donor of the sample | |||||
| receivedTime |
0..1 | dateTime | The time when specimen was received for processing | |||||
| parent |
0..* | Reference(Specimen) | Specimen from which this specimen originated | |||||
| request |
0..* | Reference(ServiceRequest) | Why the specimen was collected | |||||
| collection |
0..1 | BackboneElement | Collection details | |||||
| 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 | |||||
| collector |
0..1 | Reference(Practitioner | PractitionerRole) | Who collected the specimen | |||||
| Slices for collected[x] |
0..1 | Collection time Slice: Unordered, Closed by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view | ||||||
| collectedDateTime |
dateTime | |||||||
| collectedPeriod |
Period | |||||||
| collected[x]:collectedDateTime |
0..1 | dateTime | Sample creation date and time | |||||
| duration |
0..1 | Duration | How long it took to collect specimen | |||||
| quantity |
C | 0..1 | SimpleQuantity(4.0.1) | The quantity of specimen collected Constraints: sqty-1 | ||||
| method |
0..1 | CodeableConcept | Technique used to perform collection Binding: FHIRSpecimenCollectionMethod (example): The technique that is used to perform the procedure. | |||||
| bodySite |
0..1 | CodeableConcept | Anatomical collection site Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding |
C | 0..1 | Coding | Code defined by a terminology system Constraints: SpecimenOntologyInvariant | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
0..1 | uri | Identity of the terminology system | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
0..1 | code | Symbol in syntax defined by the system | |||||
| 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 | |||||
| fastingStatus[x] |
0..1 | Whether or how long patient abstained from food and/or drink Binding: hl7VS-relevantClincialInformation (extensible): Codes describing the fasting status of the patient. | ||||||
| fastingStatusCodeableConcept |
CodeableConcept | |||||||
| fastingStatusDuration |
Duration | |||||||
| processing |
0..* | BackboneElement | Processing and processing step details | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| extension:storageTemperature |
0..1 | CodeableConcept | Sample storage temperature URL: https://fhir.bbmri-eric.eu/StructureDefinition/miabis-sample-storage-temperature-extension Binding: Storage Temperature Value Set (required) | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| description |
0..1 | string | Textual description of procedure | |||||
| procedure |
0..1 | CodeableConcept | Indicates the treatment step applied to the specimen Binding: SpecimenProcessingProcedure (example): Type indicating the technique used to process the specimen. | |||||
| additive |
0..* | Reference(Substance) | Material used in the processing step | |||||
| time[x] |
0..1 | Date and time of specimen processing | ||||||
| timeDateTime |
dateTime | |||||||
| timePeriod |
Period | |||||||
| container |
0..* | BackboneElement | Direct container of specimen (tube/slide, etc.) | |||||
| 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 | |||||
| identifier |
0..* | Identifier | Id for the container | |||||
| description |
0..1 | string | Textual description of the container | |||||
| type |
0..1 | CodeableConcept | Kind of container directly associated with specimen Binding: SpecimenContainerType (example): Type of specimen container. | |||||
| capacity |
C | 0..1 | SimpleQuantity(4.0.1) | Container volume or size Constraints: sqty-1 | ||||
| specimenQuantity |
C | 0..1 | SimpleQuantity(4.0.1) | Quantity of specimen within container Constraints: sqty-1 | ||||
| additive[x] |
0..1 | Additive associated with container Binding: hl7VS-additivePreservative (example): Substance added to specimen container. | ||||||
| additiveCodeableConcept |
CodeableConcept | |||||||
| additiveReference |
Reference(Substance) | |||||||
| condition |
0..* | CodeableConcept | State of the specimen Binding: hl7VS-specimenCondition (extensible): Codes describing the state of the specimen. | |||||
| note |
0..* | Annotation | Use restrictions | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| author[x] |
0..1 | Individual responsible for the annotation | ||||||
| authorReference |
Reference(Practitioner | Patient | RelatedPerson | Organization) | |||||||
| authorString |
string | |||||||
| time |
0..1 | dateTime | When the annotation was made | |||||
| text |
1..1 | markdown | actual use restrictions | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Specimen.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Specimen.status | Base | required | SpecimenStatus | 📍4.0.1 | FHIR Std. |
| Specimen.type | Base | required | DetailedSampleTypeVS | 📦1.3.0 | This IG |
| Specimen.collection.method | Base | example | FHIR Specimen Collection Method | 📍4.0.1 | FHIR Std. |
| Specimen.collection.bodySite | Base | example | SNOMED CT Body Structures | 📍4.0.1 | FHIR Std. |
| Specimen.collection.fastingStatus[x] | Base | extensible | hl7VS-relevantClincialInformation | 📦3.0.0 | THO v7.4 |
| Specimen.processing.procedure | Base | example | Specimen processing procedure | 📍4.0.1 | FHIR Std. |
| Specimen.container.type | Base | example | Specimen Container Type | 📍4.0.1 | FHIR Std. |
| Specimen.container.additive[x] | Base | example | hl7VS-additivePreservative | 📦3.0.0 | THO v7.4 |
| Specimen.condition | Base | extensible | hl7VS-specimenCondition | 📦3.0.0 | THO v7.4 |
| Id | Grade | Path(s) | Description | Expression |
| SpecimenOntologyInvariant | error | Specimen.collection.bodySite.coding | bodySite.concept.coding.system and bodySite.concept.coding.version are required if any ontology information is provided |
Specimen.collection.bodySite.concept.coding.exists() implies (Specimen.collection.bodySite.concept.coding.system.exists() and Specimen.collection.bodySite.concept.coding.version.exists())
|
| dom-2 | error | Specimen | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Specimen | 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 | Specimen | 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 | Specimen | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Specimen | 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()
|
| sqty-1 | error | Specimen.collection.quantity, Specimen.container.capacity, Specimen.container.specimenQuantity | The comparator is not used on a SimpleQuantity |
comparator.empty()
|
This structure is derived from Specimen
Summary
Mandatory: 3 elements
Must-Support: 9 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron
IG © 2024+ BBMRI-ERIC. Package fhir.example#1.3.0 based on FHIR 4.0.1. Generated 2026-10-12
Links: Table of Contents |
QA Report
| 