RIVO-Noord Zorgviewer Implementation Guide
1.25.0 - master Netherlands flag

RIVO-Noord Zorgviewer Implementation Guide, published by RIVO-NN HL7NL. This guide is not an authorized publication; it is the continuous build for version 1.25.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/RIVO-Noord/zorgviewer-ig/ and changes regularly. See the Directory of published versions

Resource Profile: Specimen

Official URL: http://fhir.hl7.nl/zorgviewer/StructureDefinition/Specimen Version: 1.25.0
Active as of 2026-08-21 Computable Name: Specimen

Monster Materiaal

Zie LaboratoriumTestResult voor User Interface guidance en Request.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Specimen 0..* Zib LaboratoryTestResult Specimen Specimen
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!Σ 0..1 code available | unavailable | unsatisfactory | entered-in-error
Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen.
.... text SΣ 0..1 string Plain text representation of the concept
... subject Σ 1..1 Reference(nl-core-patient | Group | HCIM MedicalDevice Product | Substance) SpecimenSource
... note 0..* Annotation Comment
.... text S 1..1 string The annotation - text content

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Specimen.status Base required SpecimenStatus 📦3.0.2 FHIR Std.
Specimen.type Base extensible MonstermateriaalCodelijst 📦2017-12-31T00:00:00 Nictiz FHIR NL STU3 Zib2017 v2.3

Constraints

Id Grade Path(s) Description Expression
dom-1 error Specimen If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
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 contained.where(('#'+id in %resource.descendants().reference).not()).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()

This structure is derived from Zib LaboratoryTestResult Specimen

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Specimen 0..* Zib LaboratoryTestResult Specimen Specimen
... type 0..1 CodeableConcept SpecimenMaterial
.... text S 0..1 string Plain text representation of the concept
... note 0..* Annotation Comment
.... text S 1..1 string The annotation - text content

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Specimen 0..* Zib LaboratoryTestResult Specimen Specimen
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional Content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier SpecimenId
... 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 Σ 0..1 CodeableConcept SpecimenMaterial
Binding: MonstermateriaalCodelijst (extensible): The type of the specimen.
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 0..* Coding Code defined by a terminology system
.... text SΣ 0..1 string Plain text representation of the concept
... subject Σ 1..1 Reference(nl-core-patient | Group | HCIM MedicalDevice Product | Substance) SpecimenSource
... receivedTime Σ 0..1 dateTime ReceivedDateTime
... parent 0..* Reference(HCIM LaboratoryTestResult Specimen | HCIM LaboratoryTestResult Specimen Isolate) Specimen from which this specimen originated
... request 0..* Reference(ProcedureRequest) Why the specimen was collected
... collection 0..1 BackboneElement Collection details
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... collector Σ 0..1 Reference(Practitioner) Who collected the specimen
.... Slices for collected[x] Σ 0..1 Collection time
Slice: Unordered, Open by type:$this
..... collectedDateTime dateTime
..... collectedPeriod Period
..... collected[x]:collectedDateTime Σ 0..1 dateTime CollectionDateTime
..... collected[x]:collectedPeriod Σ 0..1 Period CollectionPeriod
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
...... Slices for extension Content/Rules for all slices
....... extension:period-duration 0..1 Duration Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/period-duration
Constraints: ext-1
...... start ΣC 0..1 dateTime Starting time with inclusive boundary
...... end ΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
.... quantity 0..1 SimpleQuantity CollectedVolume
.... method 0..1 CodeableConcept CollectionMethod
Binding: AfnameprocedureCodelijst (extensible): The technique that is used to perform the procedure
.... bodySite 0..1 CodeableConcept AnatomicalLocation
Binding: MonsterAnatomischeLocatieCodelijst (extensible): SpecimenAnatomicalLocationCodelist
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
...... extension:laterality 0..* (Complex) Laterality
URL: http://nictiz.nl/fhir/StructureDefinition/BodySite-Qualifier
Constraints: ext-1
....... id 0..1 string xml:id (or equivalent in JSON)
....... extension 0..0 Additional Content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/BodySite-Qualifier"
....... value[x] 0..1 CodeableConcept BodySite qualifier
Binding: LateraliteitCodelijst (extensible): LateralityCodelist
...... extension:morphology 0..* (Complex) Morphology
URL: http://nictiz.nl/fhir/StructureDefinition/BodySite-Morphology
Constraints: ext-1
....... id 0..1 string xml:id (or equivalent in JSON)
....... extension 0..0 Additional Content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/BodySite-Morphology"
....... Slices for value[x] Content/Rules for all slices
........ value[x]:valueCodeableConcept 0..1 CodeableConcept BodySite morphology
Binding: MorfologieCodelijst (extensible): MorphologyCodelist
..... coding Σ 0..* Coding Code defined by a terminology system
..... text Σ 0..1 string Plain text representation of the concept
... processing 0..* BackboneElement Processing and processing step details
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... 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 SpecimenContainer
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... identifier Σ 0..* Identifier SpecimenNumberExtension
.... description 0..1 string Textual description of the container
.... type 0..1 CodeableConcept ContainerType
Binding: ContainerTypeCodelijst (extensible): ContainerTypeCodelist
.... capacity 0..1 SimpleQuantity Container volume or size
.... specimenQuantity 0..1 SimpleQuantity Quantity of specimen within container
.... additive[x] 0..1 Additive associated with container
Binding: v2 Additive/Preservative (example): Substance added to specimen container
..... additiveCodeableConcept CodeableConcept
..... additiveReference Reference(Substance)
... note 0..* Annotation Comment
.... id 0..1 string xml:id (or equivalent in JSON)
.... 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)
..... authorString string
.... time Σ 0..1 dateTime When the annotation was made
.... text S 1..1 string The annotation - text content

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Specimen.language Base extensible Common Languages 📦3.0.2 FHIR Std.
Specimen.status Base required SpecimenStatus 📦3.0.2 FHIR Std.
Specimen.type Base extensible MonstermateriaalCodelijst 📦2017-12-31T00:00:00 Nictiz FHIR NL STU3 Zib2017 v2.3
Specimen.collection.​method Base extensible AfnameprocedureCodelijst 📦2017-12-31T00:00:00 Nictiz FHIR NL STU3 Zib2017 v2.3
Specimen.collection.​bodySite Base extensible MonsterAnatomischeLocatieCodelijst 📦2017-12-31T00:00:00 Nictiz FHIR NL STU3 Zib2017 v2.3
Specimen.collection.​bodySite.extension:laterality.​value[x] Base extensible LateraliteitCodelijst 📦2017-12-31T00:00:00 Nictiz FHIR NL STU3 Zib2017 v2.3
Specimen.collection.​bodySite.extension:morphology.​value[x]:valueCodeableConcept Base extensible MorfologieCodelijst 📦2017-12-31T00:00:00 Nictiz FHIR NL STU3 Zib2017 v2.3
Specimen.processing.​procedure Base example SpecimenProcessingProcedure 📦3.0.2 FHIR Std.
Specimen.container.type Base extensible ContainerTypeCodelijst 📦2017-12-31T00:00:00 Nictiz FHIR NL STU3 Zib2017 v2.3
Specimen.container.additive[x] Base example v2 Additive/Preservative 📦2.8.2 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-1 error Specimen If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
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 contained.where(('#'+id in %resource.descendants().reference).not()).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()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
ext-1 error Specimen.collection.collected[x]:collectedPeriod.extension:period-duration, Specimen.collection.bodySite.extension:laterality, Specimen.collection.bodySite.extension:morphology Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from Zib LaboratoryTestResult Specimen

Summary

Must-Support: 2 elements

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Specimen 0..* Zib LaboratoryTestResult Specimen Specimen
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!Σ 0..1 code available | unavailable | unsatisfactory | entered-in-error
Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen.
.... text SΣ 0..1 string Plain text representation of the concept
... subject Σ 1..1 Reference(nl-core-patient | Group | HCIM MedicalDevice Product | Substance) SpecimenSource
... note 0..* Annotation Comment
.... text S 1..1 string The annotation - text content

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Specimen.status Base required SpecimenStatus 📦3.0.2 FHIR Std.
Specimen.type Base extensible MonstermateriaalCodelijst 📦2017-12-31T00:00:00 Nictiz FHIR NL STU3 Zib2017 v2.3

Constraints

Id Grade Path(s) Description Expression
dom-1 error Specimen If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
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 contained.where(('#'+id in %resource.descendants().reference).not()).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()

Differential View

This structure is derived from Zib LaboratoryTestResult Specimen

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Specimen 0..* Zib LaboratoryTestResult Specimen Specimen
... type 0..1 CodeableConcept SpecimenMaterial
.... text S 0..1 string Plain text representation of the concept
... note 0..* Annotation Comment
.... text S 1..1 string The annotation - text content

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Specimen 0..* Zib LaboratoryTestResult Specimen Specimen
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional Content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier SpecimenId
... 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 Σ 0..1 CodeableConcept SpecimenMaterial
Binding: MonstermateriaalCodelijst (extensible): The type of the specimen.
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 0..* Coding Code defined by a terminology system
.... text SΣ 0..1 string Plain text representation of the concept
... subject Σ 1..1 Reference(nl-core-patient | Group | HCIM MedicalDevice Product | Substance) SpecimenSource
... receivedTime Σ 0..1 dateTime ReceivedDateTime
... parent 0..* Reference(HCIM LaboratoryTestResult Specimen | HCIM LaboratoryTestResult Specimen Isolate) Specimen from which this specimen originated
... request 0..* Reference(ProcedureRequest) Why the specimen was collected
... collection 0..1 BackboneElement Collection details
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... collector Σ 0..1 Reference(Practitioner) Who collected the specimen
.... Slices for collected[x] Σ 0..1 Collection time
Slice: Unordered, Open by type:$this
..... collectedDateTime dateTime
..... collectedPeriod Period
..... collected[x]:collectedDateTime Σ 0..1 dateTime CollectionDateTime
..... collected[x]:collectedPeriod Σ 0..1 Period CollectionPeriod
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
...... Slices for extension Content/Rules for all slices
....... extension:period-duration 0..1 Duration Optional Extensions Element
URL: http://nictiz.nl/fhir/StructureDefinition/period-duration
Constraints: ext-1
...... start ΣC 0..1 dateTime Starting time with inclusive boundary
...... end ΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
.... quantity 0..1 SimpleQuantity CollectedVolume
.... method 0..1 CodeableConcept CollectionMethod
Binding: AfnameprocedureCodelijst (extensible): The technique that is used to perform the procedure
.... bodySite 0..1 CodeableConcept AnatomicalLocation
Binding: MonsterAnatomischeLocatieCodelijst (extensible): SpecimenAnatomicalLocationCodelist
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Additional Content defined by implementations
Slice: Unordered, Open by value:url
...... extension:laterality 0..* (Complex) Laterality
URL: http://nictiz.nl/fhir/StructureDefinition/BodySite-Qualifier
Constraints: ext-1
....... id 0..1 string xml:id (or equivalent in JSON)
....... extension 0..0 Additional Content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/BodySite-Qualifier"
....... value[x] 0..1 CodeableConcept BodySite qualifier
Binding: LateraliteitCodelijst (extensible): LateralityCodelist
...... extension:morphology 0..* (Complex) Morphology
URL: http://nictiz.nl/fhir/StructureDefinition/BodySite-Morphology
Constraints: ext-1
....... id 0..1 string xml:id (or equivalent in JSON)
....... extension 0..0 Additional Content defined by implementations
Slice: Unordered, Open by value:url
....... url 1..1 uri "http://nictiz.nl/fhir/StructureDefinition/BodySite-Morphology"
....... Slices for value[x] Content/Rules for all slices
........ value[x]:valueCodeableConcept 0..1 CodeableConcept BodySite morphology
Binding: MorfologieCodelijst (extensible): MorphologyCodelist
..... coding Σ 0..* Coding Code defined by a terminology system
..... text Σ 0..1 string Plain text representation of the concept
... processing 0..* BackboneElement Processing and processing step details
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... 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 SpecimenContainer
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... identifier Σ 0..* Identifier SpecimenNumberExtension
.... description 0..1 string Textual description of the container
.... type 0..1 CodeableConcept ContainerType
Binding: ContainerTypeCodelijst (extensible): ContainerTypeCodelist
.... capacity 0..1 SimpleQuantity Container volume or size
.... specimenQuantity 0..1 SimpleQuantity Quantity of specimen within container
.... additive[x] 0..1 Additive associated with container
Binding: v2 Additive/Preservative (example): Substance added to specimen container
..... additiveCodeableConcept CodeableConcept
..... additiveReference Reference(Substance)
... note 0..* Annotation Comment
.... id 0..1 string xml:id (or equivalent in JSON)
.... 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)
..... authorString string
.... time Σ 0..1 dateTime When the annotation was made
.... text S 1..1 string The annotation - text content

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Specimen.language Base extensible Common Languages 📦3.0.2 FHIR Std.
Specimen.status Base required SpecimenStatus 📦3.0.2 FHIR Std.
Specimen.type Base extensible MonstermateriaalCodelijst 📦2017-12-31T00:00:00 Nictiz FHIR NL STU3 Zib2017 v2.3
Specimen.collection.​method Base extensible AfnameprocedureCodelijst 📦2017-12-31T00:00:00 Nictiz FHIR NL STU3 Zib2017 v2.3
Specimen.collection.​bodySite Base extensible MonsterAnatomischeLocatieCodelijst 📦2017-12-31T00:00:00 Nictiz FHIR NL STU3 Zib2017 v2.3
Specimen.collection.​bodySite.extension:laterality.​value[x] Base extensible LateraliteitCodelijst 📦2017-12-31T00:00:00 Nictiz FHIR NL STU3 Zib2017 v2.3
Specimen.collection.​bodySite.extension:morphology.​value[x]:valueCodeableConcept Base extensible MorfologieCodelijst 📦2017-12-31T00:00:00 Nictiz FHIR NL STU3 Zib2017 v2.3
Specimen.processing.​procedure Base example SpecimenProcessingProcedure 📦3.0.2 FHIR Std.
Specimen.container.type Base extensible ContainerTypeCodelijst 📦2017-12-31T00:00:00 Nictiz FHIR NL STU3 Zib2017 v2.3
Specimen.container.additive[x] Base example v2 Additive/Preservative 📦2.8.2 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-1 error Specimen If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
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 contained.where(('#'+id in %resource.descendants().reference).not()).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()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
ext-1 error Specimen.collection.collected[x]:collectedPeriod.extension:period-duration, Specimen.collection.bodySite.extension:laterality, Specimen.collection.bodySite.extension:morphology Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from Zib LaboratoryTestResult Specimen

Summary

Must-Support: 2 elements

 

Other representations of profile: CSV, Excel, Schematron