0.1.0 - ci-build

SENAITEFHIRImplementationGuide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: SenaiteSpecimen

Official URL: https://fhir.senaite.org/StructureDefinition/SenaiteSpecimen Version: 0.1.0
Draft as of 2026-11-05 Computable Name: SenaiteSpecimen

This is the specimen to accompany the ServiceRequest

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: doco
Specimen 0..* Specimen Sample for analysis
Specimen.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Specimen.contained 0..* Resource Contained, inline Resources
Specimen.Slices for extension 0..* Extension Extension
Slice: Unordered, Closed by
Specimen.Slices for extension.extension:barcode 0..1 Attachment Barcode label (base64 PDF or image) — SHALL be present when returned by SENAITE; SHALL NOT be supplied on create
URL: https://fhir.senaite.org/StructureDefinition/SenaiteSpecimenBarcode
Specimen.Slices for identifier This element is included in summaries. 0..* Identifier External Identifier
Slice: Unordered, Closed by value:use
Specimen.Slices for identifier.identifier:senaiteId This element is included in summaries. 0..1 Identifier Internal SENAITE Sample ID — matches the DiagnosticReport usual identifier
Specimen.Slices for identifier.identifier:senaiteId.extension 0..0 Extension
Slice: Unordered, Open by value:url
Specimen.Slices for identifier.identifier:senaiteId.use This element is a modifier element. This element is included in summaries. 1..1 code usual
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: usual (no extensions allowed)
Specimen.Slices for identifier.identifier:senaiteId.system This element is included in summaries. 1..1 uri Sample ID namespace — mandatory and fixed by this IG
Fixed Value: https://fhir.senaite.org/NamingSystem/sample-id (no extensions allowed)
Specimen.Slices for identifier.identifier:senaiteId.value This element is included in summaries. C 1..1 string Internal SENAITE sample identifier — alphanumeric and hyphens only
Example General: 123456
Specimen.Slices for identifier.identifier:clientSampleId This element is included in summaries. 0..1 Identifier External Client Sample ID assigned by the consumer's system — may be supplied on create
Specimen.Slices for identifier.identifier:clientSampleId.extension 0..0 Extension
Slice: Unordered, Open by value:url
Specimen.Slices for identifier.identifier:clientSampleId.use This element is a modifier element. This element is included in summaries. 1..1 code secondary
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: secondary (no extensions allowed)
Specimen.Slices for identifier.identifier:clientSampleId.system This element is included in summaries. 1..1 uri Client Sample ID namespace — mandatory and fixed by this IG
Fixed Value: https://fhir.senaite.org/NamingSystem/client-sample-id (no extensions allowed)
Specimen.Slices for identifier.identifier:clientSampleId.value This element is included in summaries. C 1..1 string Client Sample ID — alphanumeric and hyphens only
Example General: 123456
Specimen.status This element is a modifier element. This element is included in summaries. 0..1 code available | unavailable | unsatisfactory | entered-in-error
Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen.
Specimen.type This element is included in summaries. 1..1 CodeableConcept Kind of material that forms the specimen
Binding: hl7VS-specimenType (example): The type of the specimen.
Specimen.type.extension 0..0 Extension
Slice: Unordered, Open by value:url
Specimen.type.coding This element is included in summaries. 1..1 Coding Code defined by a terminology system
Binding: http://snomed.info/sct (preferred)
Specimen.type.coding.extension 0..0 Extension
Slice: Unordered, Open by value:url
Specimen.collection 1..1 BackboneElement Collection details
Specimen.collection.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Specimen.collection.collected[x] This element is included in summaries. 0..1 dateTime Collection time

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Specimen.identifier:senaiteId.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Specimen.identifier:clientSampleId.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Specimen.status Base required Specimen Status 📍5.0.0 FHIR Std.
Specimen.type Base example hl7VS-specimenType 📦3.0.0 THO v7.5
Specimen.type.coding Base preferred http://snomed.info/sct Not State Unknown
Specimen.feature.type Base example SNOMED CT Body Structures 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Specimen Specimen
Specimen.Slices for extension 0..* Extension Extension
Slice: Unordered, Closed by
Specimen.Slices for extension.extension:barcode 0..1 Attachment Barcode label (base64 PDF or image) — SHALL be present when returned by SENAITE; SHALL NOT be supplied on create
URL: https://fhir.senaite.org/StructureDefinition/SenaiteSpecimenBarcode
Specimen.modifierExtension 0..0 Extension
Specimen.Slices for identifier 0..* Identifier External Identifier
Slice: Unordered, Closed by value:use
Specimen.Slices for identifier.identifier:senaiteId 0..1 Identifier Internal SENAITE Sample ID — matches the DiagnosticReport usual identifier
Specimen.Slices for identifier.identifier:senaiteId.extension 0..0 Extension
Specimen.Slices for identifier.identifier:senaiteId.use 1..1 code usual
Fixed Value: usual (no extensions allowed)
Specimen.Slices for identifier.identifier:senaiteId.type 0..0 Description of identifier
Specimen.Slices for identifier.identifier:senaiteId.system 1..1 uri Sample ID namespace — mandatory and fixed by this IG
Fixed Value: https://fhir.senaite.org/NamingSystem/sample-id (no extensions allowed)
Specimen.Slices for identifier.identifier:senaiteId.value 1..1 string Internal SENAITE sample identifier — alphanumeric and hyphens only
Specimen.Slices for identifier.identifier:senaiteId.period 0..0 Time period when id is/was valid for use
Specimen.Slices for identifier.identifier:senaiteId.assigner 0..0 Organization that issued id (may be just text)
Specimen.Slices for identifier.identifier:clientSampleId 0..1 Identifier External Client Sample ID assigned by the consumer's system — may be supplied on create
Specimen.Slices for identifier.identifier:clientSampleId.extension 0..0 Extension
Specimen.Slices for identifier.identifier:clientSampleId.use 1..1 code secondary
Fixed Value: secondary (no extensions allowed)
Specimen.Slices for identifier.identifier:clientSampleId.system 1..1 uri Client Sample ID namespace — mandatory and fixed by this IG
Fixed Value: https://fhir.senaite.org/NamingSystem/client-sample-id (no extensions allowed)
Specimen.Slices for identifier.identifier:clientSampleId.value 1..1 string Client Sample ID — alphanumeric and hyphens only
Specimen.Slices for identifier.identifier:clientSampleId.period 0..0 Time period when id is/was valid for use
Specimen.Slices for identifier.identifier:clientSampleId.assigner 0..0 Organization that issued id (may be just text)
Specimen.type 1..1 CodeableConcept Kind of material that forms the specimen
Specimen.type.extension 0..0 Extension
Specimen.type.coding 1..1 Coding Code defined by a terminology system
Binding: http://snomed.info/sct (preferred)
Specimen.type.coding.extension 0..0 Extension
Specimen.type.coding.version 0..0 Version of the system - if relevant
Specimen.type.coding.userSelected 0..0 If this coding was chosen directly by the user
Specimen.subject 0..0 Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance, a biologically-derived product, or a device
Specimen.receivedTime 0..0 The time when specimen is received by the testing laboratory
Specimen.parent 0..0 Specimen from which this specimen originated
Specimen.request 0..0 Why the specimen was collected
Specimen.combined 0..0 grouped | pooled
Specimen.role 0..0 The role the specimen serves
Specimen.feature 0..0 The physical feature of a specimen
Specimen.collection 1..1 BackboneElement Collection details
Specimen.collection.collected[x] 0..1 dateTime Collection time
Specimen.collection.duration 0..0 How long it took to collect specimen
Specimen.collection.quantity 0..0 The quantity of specimen collected
Specimen.collection.method 0..0 Technique used to perform collection
Specimen.collection.fastingStatus[x] 0..0 Whether or how long patient abstained from food and/or drink
Specimen.processing 0..0 Processing and processing step details
Specimen.container 0..0 Direct container of specimen (tube/slide, etc.)
Specimen.condition 0..0 State of the specimen

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Specimen.type.coding Base preferred http://snomed.info/sct Not State Unknown
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Specimen 0..* Specimen Sample for analysis
Specimen.id This element is included in summaries. 0..1 id Logical id of this artifact
Specimen.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Specimen.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Specimen.language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
Specimen.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
Specimen.contained 0..* Resource Contained, inline Resources
Specimen.Slices for extension 0..* Extension Extension
Slice: Unordered, Closed by
Specimen.Slices for extension.extension:barcode 0..1 Attachment Barcode label (base64 PDF or image) — SHALL be present when returned by SENAITE; SHALL NOT be supplied on create
URL: https://fhir.senaite.org/StructureDefinition/SenaiteSpecimenBarcode
Specimen.Slices for identifier This element is included in summaries. 0..* Identifier External Identifier
Slice: Unordered, Closed by value:use
Specimen.Slices for identifier.identifier:senaiteId This element is included in summaries. 0..1 Identifier Internal SENAITE Sample ID — matches the DiagnosticReport usual identifier
Specimen.Slices for identifier.identifier:senaiteId.id 0..1 id Unique id for inter-element referencing
Specimen.Slices for identifier.identifier:senaiteId.extension 0..0 Extension
Slice: Unordered, Open by value:url
Specimen.Slices for identifier.identifier:senaiteId.use This element is a modifier element. This element is included in summaries. 1..1 code usual
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: usual (no extensions allowed)
Specimen.Slices for identifier.identifier:senaiteId.system This element is included in summaries. 1..1 uri Sample ID namespace — mandatory and fixed by this IG
Fixed Value: https://fhir.senaite.org/NamingSystem/sample-id (no extensions allowed)
Specimen.Slices for identifier.identifier:senaiteId.value This element is included in summaries. C 1..1 string Internal SENAITE sample identifier — alphanumeric and hyphens only
Example General: 123456
Specimen.Slices for identifier.identifier:clientSampleId This element is included in summaries. 0..1 Identifier External Client Sample ID assigned by the consumer's system — may be supplied on create
Specimen.Slices for identifier.identifier:clientSampleId.id 0..1 id Unique id for inter-element referencing
Specimen.Slices for identifier.identifier:clientSampleId.extension 0..0 Extension
Slice: Unordered, Open by value:url
Specimen.Slices for identifier.identifier:clientSampleId.use This element is a modifier element. This element is included in summaries. 1..1 code secondary
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: secondary (no extensions allowed)
Specimen.Slices for identifier.identifier:clientSampleId.type This element is included in summaries. 0..1 CodeableConcept Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Specimen.Slices for identifier.identifier:clientSampleId.system This element is included in summaries. 1..1 uri Client Sample ID namespace — mandatory and fixed by this IG
Fixed Value: https://fhir.senaite.org/NamingSystem/client-sample-id (no extensions allowed)
Specimen.Slices for identifier.identifier:clientSampleId.value This element is included in summaries. C 1..1 string Client Sample ID — alphanumeric and hyphens only
Example General: 123456
Specimen.status This element is a modifier element. This element is included in summaries. 0..1 code available | unavailable | unsatisfactory | entered-in-error
Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen.
Specimen.type This element is included in summaries. 1..1 CodeableConcept Kind of material that forms the specimen
Binding: hl7VS-specimenType (example): The type of the specimen.
Specimen.type.id 0..1 id Unique id for inter-element referencing
Specimen.type.extension 0..0 Extension
Slice: Unordered, Open by value:url
Specimen.type.coding This element is included in summaries. 1..1 Coding Code defined by a terminology system
Binding: http://snomed.info/sct (preferred)
Specimen.type.coding.id 0..1 id Unique id for inter-element referencing
Specimen.type.coding.extension 0..0 Extension
Slice: Unordered, Open by value:url
Specimen.type.coding.system This element is included in summaries. 0..1 uri Identity of the terminology system
Specimen.type.coding.code This element is included in summaries. C 0..1 code Symbol in syntax defined by the system
Specimen.type.coding.display This element is included in summaries. C 0..1 string Representation defined by the system
Specimen.type.text This element is included in summaries. 0..1 string Plain text representation of the concept
Specimen.collection 1..1 BackboneElement Collection details
Specimen.collection.id 0..1 string Unique id for inter-element referencing
Specimen.collection.extension 0..* Extension Additional content defined by implementations
Specimen.collection.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Specimen.collection.collector This element is included in summaries. 0..1 Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) Who collected the specimen
Specimen.collection.collected[x] This element is included in summaries. 0..1 dateTime Collection time
Specimen.collection.device 0..1 CodeableReference(Device) Device used to perform collection
Binding Description: (example): The device that was used to obtain the specimen (e.g. a catheter or catheter part used to draw the blood via a central line).
Specimen.collection.procedure 0..1 Reference(Procedure) The procedure that collects the specimen
Specimen.collection.bodySite 0..1 CodeableReference(BodyStructure) Anatomical collection site
Binding: SNOMEDCTBodyStructures (example): SNOMED CT Body site concepts
Specimen.note 0..* Annotation Comments

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Specimen.language Base required All Languages 📍5.0.0 FHIR Std.
Specimen.identifier:senaiteId.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Specimen.identifier:clientSampleId.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Specimen.identifier:clientSampleId.​type Base extensible Identifier Type Codes 📍5.0.0 FHIR Std.
Specimen.status Base required Specimen Status 📍5.0.0 FHIR Std.
Specimen.type Base example hl7VS-specimenType 📦3.0.0 THO v7.5
Specimen.type.coding Base preferred http://snomed.info/sct Not State Unknown
Specimen.feature.type Base example SNOMED CT Body Structures 📍5.0.0 FHIR Std.
Specimen.collection.​device Base example Not State Unknown
Specimen.collection.​bodySite Base example SNOMED CT Body Structures 📍5.0.0 FHIR Std.
Specimen.processing.​method Base example Specimen Processing Method 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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.container.specimenQuantity The comparator is not used on a SimpleQuantity comparator.empty()

This structure is derived from Specimen

Summary

Mandatory: 3 elements(6 nested mandatory elements)
Fixed: 4 elements
Prohibited: 27 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Specimen.identifier (Closed)

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Specimen 0..* Specimen Sample for analysis
Specimen.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Specimen.contained 0..* Resource Contained, inline Resources
Specimen.Slices for extension 0..* Extension Extension
Slice: Unordered, Closed by
Specimen.Slices for extension.extension:barcode 0..1 Attachment Barcode label (base64 PDF or image) — SHALL be present when returned by SENAITE; SHALL NOT be supplied on create
URL: https://fhir.senaite.org/StructureDefinition/SenaiteSpecimenBarcode
Specimen.Slices for identifier This element is included in summaries. 0..* Identifier External Identifier
Slice: Unordered, Closed by value:use
Specimen.Slices for identifier.identifier:senaiteId This element is included in summaries. 0..1 Identifier Internal SENAITE Sample ID — matches the DiagnosticReport usual identifier
Specimen.Slices for identifier.identifier:senaiteId.extension 0..0 Extension
Slice: Unordered, Open by value:url
Specimen.Slices for identifier.identifier:senaiteId.use This element is a modifier element. This element is included in summaries. 1..1 code usual
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: usual (no extensions allowed)
Specimen.Slices for identifier.identifier:senaiteId.system This element is included in summaries. 1..1 uri Sample ID namespace — mandatory and fixed by this IG
Fixed Value: https://fhir.senaite.org/NamingSystem/sample-id (no extensions allowed)
Specimen.Slices for identifier.identifier:senaiteId.value This element is included in summaries. C 1..1 string Internal SENAITE sample identifier — alphanumeric and hyphens only
Example General: 123456
Specimen.Slices for identifier.identifier:clientSampleId This element is included in summaries. 0..1 Identifier External Client Sample ID assigned by the consumer's system — may be supplied on create
Specimen.Slices for identifier.identifier:clientSampleId.extension 0..0 Extension
Slice: Unordered, Open by value:url
Specimen.Slices for identifier.identifier:clientSampleId.use This element is a modifier element. This element is included in summaries. 1..1 code secondary
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: secondary (no extensions allowed)
Specimen.Slices for identifier.identifier:clientSampleId.system This element is included in summaries. 1..1 uri Client Sample ID namespace — mandatory and fixed by this IG
Fixed Value: https://fhir.senaite.org/NamingSystem/client-sample-id (no extensions allowed)
Specimen.Slices for identifier.identifier:clientSampleId.value This element is included in summaries. C 1..1 string Client Sample ID — alphanumeric and hyphens only
Example General: 123456
Specimen.status This element is a modifier element. This element is included in summaries. 0..1 code available | unavailable | unsatisfactory | entered-in-error
Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen.
Specimen.type This element is included in summaries. 1..1 CodeableConcept Kind of material that forms the specimen
Binding: hl7VS-specimenType (example): The type of the specimen.
Specimen.type.extension 0..0 Extension
Slice: Unordered, Open by value:url
Specimen.type.coding This element is included in summaries. 1..1 Coding Code defined by a terminology system
Binding: http://snomed.info/sct (preferred)
Specimen.type.coding.extension 0..0 Extension
Slice: Unordered, Open by value:url
Specimen.collection 1..1 BackboneElement Collection details
Specimen.collection.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Specimen.collection.collected[x] This element is included in summaries. 0..1 dateTime Collection time

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Specimen.identifier:senaiteId.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Specimen.identifier:clientSampleId.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Specimen.status Base required Specimen Status 📍5.0.0 FHIR Std.
Specimen.type Base example hl7VS-specimenType 📦3.0.0 THO v7.5
Specimen.type.coding Base preferred http://snomed.info/sct Not State Unknown
Specimen.feature.type Base example SNOMED CT Body Structures 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Specimen Specimen
Specimen.Slices for extension 0..* Extension Extension
Slice: Unordered, Closed by
Specimen.Slices for extension.extension:barcode 0..1 Attachment Barcode label (base64 PDF or image) — SHALL be present when returned by SENAITE; SHALL NOT be supplied on create
URL: https://fhir.senaite.org/StructureDefinition/SenaiteSpecimenBarcode
Specimen.modifierExtension 0..0 Extension
Specimen.Slices for identifier 0..* Identifier External Identifier
Slice: Unordered, Closed by value:use
Specimen.Slices for identifier.identifier:senaiteId 0..1 Identifier Internal SENAITE Sample ID — matches the DiagnosticReport usual identifier
Specimen.Slices for identifier.identifier:senaiteId.extension 0..0 Extension
Specimen.Slices for identifier.identifier:senaiteId.use 1..1 code usual
Fixed Value: usual (no extensions allowed)
Specimen.Slices for identifier.identifier:senaiteId.type 0..0 Description of identifier
Specimen.Slices for identifier.identifier:senaiteId.system 1..1 uri Sample ID namespace — mandatory and fixed by this IG
Fixed Value: https://fhir.senaite.org/NamingSystem/sample-id (no extensions allowed)
Specimen.Slices for identifier.identifier:senaiteId.value 1..1 string Internal SENAITE sample identifier — alphanumeric and hyphens only
Specimen.Slices for identifier.identifier:senaiteId.period 0..0 Time period when id is/was valid for use
Specimen.Slices for identifier.identifier:senaiteId.assigner 0..0 Organization that issued id (may be just text)
Specimen.Slices for identifier.identifier:clientSampleId 0..1 Identifier External Client Sample ID assigned by the consumer's system — may be supplied on create
Specimen.Slices for identifier.identifier:clientSampleId.extension 0..0 Extension
Specimen.Slices for identifier.identifier:clientSampleId.use 1..1 code secondary
Fixed Value: secondary (no extensions allowed)
Specimen.Slices for identifier.identifier:clientSampleId.system 1..1 uri Client Sample ID namespace — mandatory and fixed by this IG
Fixed Value: https://fhir.senaite.org/NamingSystem/client-sample-id (no extensions allowed)
Specimen.Slices for identifier.identifier:clientSampleId.value 1..1 string Client Sample ID — alphanumeric and hyphens only
Specimen.Slices for identifier.identifier:clientSampleId.period 0..0 Time period when id is/was valid for use
Specimen.Slices for identifier.identifier:clientSampleId.assigner 0..0 Organization that issued id (may be just text)
Specimen.accessionIdentifier 0..0 Identifier assigned by the lab
Specimen.type 1..1 CodeableConcept Kind of material that forms the specimen
Specimen.type.extension 0..0 Extension
Specimen.type.coding 1..1 Coding Code defined by a terminology system
Binding: http://snomed.info/sct (preferred)
Specimen.type.coding.extension 0..0 Extension
Specimen.type.coding.version 0..0 Version of the system - if relevant
Specimen.type.coding.userSelected 0..0 If this coding was chosen directly by the user
Specimen.subject 0..0 Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance, a biologically-derived product, or a device
Specimen.receivedTime 0..0 The time when specimen is received by the testing laboratory
Specimen.parent 0..0 Specimen from which this specimen originated
Specimen.request 0..0 Why the specimen was collected
Specimen.combined 0..0 grouped | pooled
Specimen.role 0..0 The role the specimen serves
Specimen.feature 0..0 The physical feature of a specimen
Specimen.collection 1..1 BackboneElement Collection details
Specimen.collection.collected[x] 0..1 dateTime Collection time
Specimen.collection.duration 0..0 How long it took to collect specimen
Specimen.collection.quantity 0..0 The quantity of specimen collected
Specimen.collection.method 0..0 Technique used to perform collection
Specimen.collection.fastingStatus[x] 0..0 Whether or how long patient abstained from food and/or drink
Specimen.processing 0..0 Processing and processing step details
Specimen.container 0..0 Direct container of specimen (tube/slide, etc.)
Specimen.condition 0..0 State of the specimen

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Specimen.type.coding Base preferred http://snomed.info/sct Not State Unknown

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Specimen 0..* Specimen Sample for analysis
Specimen.id This element is included in summaries. 0..1 id Logical id of this artifact
Specimen.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Specimen.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Specimen.language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
Specimen.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
Specimen.contained 0..* Resource Contained, inline Resources
Specimen.Slices for extension 0..* Extension Extension
Slice: Unordered, Closed by
Specimen.Slices for extension.extension:barcode 0..1 Attachment Barcode label (base64 PDF or image) — SHALL be present when returned by SENAITE; SHALL NOT be supplied on create
URL: https://fhir.senaite.org/StructureDefinition/SenaiteSpecimenBarcode
Specimen.Slices for identifier This element is included in summaries. 0..* Identifier External Identifier
Slice: Unordered, Closed by value:use
Specimen.Slices for identifier.identifier:senaiteId This element is included in summaries. 0..1 Identifier Internal SENAITE Sample ID — matches the DiagnosticReport usual identifier
Specimen.Slices for identifier.identifier:senaiteId.id 0..1 id Unique id for inter-element referencing
Specimen.Slices for identifier.identifier:senaiteId.extension 0..0 Extension
Slice: Unordered, Open by value:url
Specimen.Slices for identifier.identifier:senaiteId.use This element is a modifier element. This element is included in summaries. 1..1 code usual
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: usual (no extensions allowed)
Specimen.Slices for identifier.identifier:senaiteId.system This element is included in summaries. 1..1 uri Sample ID namespace — mandatory and fixed by this IG
Fixed Value: https://fhir.senaite.org/NamingSystem/sample-id (no extensions allowed)
Specimen.Slices for identifier.identifier:senaiteId.value This element is included in summaries. C 1..1 string Internal SENAITE sample identifier — alphanumeric and hyphens only
Example General: 123456
Specimen.Slices for identifier.identifier:clientSampleId This element is included in summaries. 0..1 Identifier External Client Sample ID assigned by the consumer's system — may be supplied on create
Specimen.Slices for identifier.identifier:clientSampleId.id 0..1 id Unique id for inter-element referencing
Specimen.Slices for identifier.identifier:clientSampleId.extension 0..0 Extension
Slice: Unordered, Open by value:url
Specimen.Slices for identifier.identifier:clientSampleId.use This element is a modifier element. This element is included in summaries. 1..1 code secondary
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: secondary (no extensions allowed)
Specimen.Slices for identifier.identifier:clientSampleId.type This element is included in summaries. 0..1 CodeableConcept Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Specimen.Slices for identifier.identifier:clientSampleId.system This element is included in summaries. 1..1 uri Client Sample ID namespace — mandatory and fixed by this IG
Fixed Value: https://fhir.senaite.org/NamingSystem/client-sample-id (no extensions allowed)
Specimen.Slices for identifier.identifier:clientSampleId.value This element is included in summaries. C 1..1 string Client Sample ID — alphanumeric and hyphens only
Example General: 123456
Specimen.status This element is a modifier element. This element is included in summaries. 0..1 code available | unavailable | unsatisfactory | entered-in-error
Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen.
Specimen.type This element is included in summaries. 1..1 CodeableConcept Kind of material that forms the specimen
Binding: hl7VS-specimenType (example): The type of the specimen.
Specimen.type.id 0..1 id Unique id for inter-element referencing
Specimen.type.extension 0..0 Extension
Slice: Unordered, Open by value:url
Specimen.type.coding This element is included in summaries. 1..1 Coding Code defined by a terminology system
Binding: http://snomed.info/sct (preferred)
Specimen.type.coding.id 0..1 id Unique id for inter-element referencing
Specimen.type.coding.extension 0..0 Extension
Slice: Unordered, Open by value:url
Specimen.type.coding.system This element is included in summaries. 0..1 uri Identity of the terminology system
Specimen.type.coding.code This element is included in summaries. C 0..1 code Symbol in syntax defined by the system
Specimen.type.coding.display This element is included in summaries. C 0..1 string Representation defined by the system
Specimen.type.text This element is included in summaries. 0..1 string Plain text representation of the concept
Specimen.collection 1..1 BackboneElement Collection details
Specimen.collection.id 0..1 string Unique id for inter-element referencing
Specimen.collection.extension 0..* Extension Additional content defined by implementations
Specimen.collection.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Specimen.collection.collector This element is included in summaries. 0..1 Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) Who collected the specimen
Specimen.collection.collected[x] This element is included in summaries. 0..1 dateTime Collection time
Specimen.collection.device 0..1 CodeableReference(Device) Device used to perform collection
Binding Description: (example): The device that was used to obtain the specimen (e.g. a catheter or catheter part used to draw the blood via a central line).
Specimen.collection.procedure 0..1 Reference(Procedure) The procedure that collects the specimen
Specimen.collection.bodySite 0..1 CodeableReference(BodyStructure) Anatomical collection site
Binding: SNOMEDCTBodyStructures (example): SNOMED CT Body site concepts
Specimen.note 0..* Annotation Comments

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Specimen.language Base required All Languages 📍5.0.0 FHIR Std.
Specimen.identifier:senaiteId.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Specimen.identifier:clientSampleId.​use Base required IdentifierUse 📍5.0.0 FHIR Std.
Specimen.identifier:clientSampleId.​type Base extensible Identifier Type Codes 📍5.0.0 FHIR Std.
Specimen.status Base required Specimen Status 📍5.0.0 FHIR Std.
Specimen.type Base example hl7VS-specimenType 📦3.0.0 THO v7.5
Specimen.type.coding Base preferred http://snomed.info/sct Not State Unknown
Specimen.feature.type Base example SNOMED CT Body Structures 📍5.0.0 FHIR Std.
Specimen.collection.​device Base example Not State Unknown
Specimen.collection.​bodySite Base example SNOMED CT Body Structures 📍5.0.0 FHIR Std.
Specimen.processing.​method Base example Specimen Processing Method 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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.container.specimenQuantity The comparator is not used on a SimpleQuantity comparator.empty()

This structure is derived from Specimen

Summary

Mandatory: 3 elements(6 nested mandatory elements)
Fixed: 4 elements
Prohibited: 27 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Specimen.identifier (Closed)

 

Other representations of profile: CSV, Excel, Schematron