HL7 BE Laboratory WG Implementation Guide, published by eHealth Platform. This guide is not an authorized publication; it is the continuous build for version 1.0.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-be/lab/ and changes regularly. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON
• TTL

Resource Profile: BeSpecimenLaboratory

Belgian profile for a specimen in a laboratory report. In some laboratory reports, specimen information is allowed to be minimal as many informations concerning the specimen are implied by the observations done.

Usage:

• Refer to this Resource Profile: BeLaboratoryReport, BeObservationLaboratory and BeSpecimenLaboratory
• Examples for this Resource Profile: Specimen/urine1

Formal Views of Profile Content

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

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from Specimen

Name	Flags	Card.	Type	Description & Constraints
Specimen			Specimen
text
status		1..1	code	generated | extensions | additional | empty Required Pattern: empty
identifier	S	0..*	Identifier	External Identifier
status	S	0..1	code	available | unavailable | unsatisfactory | entered-in-error
type	S	0..1	CodeableConcept	Kind of material that forms the specimen
subject	S	0..1	Reference(Group | Device | Substance | Location | Patient core BE profile)	In the initial iteration of the Belgium lab project: when sending to eHealthBox, this is BePatient.
receivedTime	S	0..1	dateTime	The time when specimen was received for processing
parent	S	0..*	Reference(BeSpecimenLaboratory)	Specimen from which this specimen originated
request	S	0..*	Reference(ServiceRequest)	Why the specimen was collected
collection	S	0..1	BackboneElement	Collection details
collected[x]		0..1	dateTime, Period	Collection time
duration		0..1	Duration	How long it took to collect specimen
quantity		0..1	SimpleQuantity	The quantity of specimen collected
method		0..1	CodeableConcept	Technique used to perform collection
bodySite		0..1	CodeableConcept	Anatomical collection site
fastingStatus[x]		0..1	CodeableConcept, Duration	Whether or how long patient abstained from food and/or drink
processing		0..*	BackboneElement	Processing and processing step details to include when not implicit from specimen.
container		0..*	BackboneElement	Direct container of specimen (tube/slide, etc.)
condition	S	0..*	CodeableConcept	State of the specimen
note	S	0..*	Annotation	Comments
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Specimen		0..*	Specimen	Sample for analysis dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
identifier	SΣ	0..*	Identifier	External Identifier ele-1: All FHIR elements must have a @value or children
status	?!SΣ	0..1	code	available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. ele-1: All FHIR elements must have a @value or children
type	SΣ	0..1	CodeableConcept	Kind of material that forms the specimen Binding: hl7VS-specimenType (example): The type of the specimen. ele-1: All FHIR elements must have a @value or children
subject	SΣ	0..1	Reference(Group | Device | Substance | Location | Patient core BE profile)	In the initial iteration of the Belgium lab project: when sending to eHealthBox, this is BePatient. ele-1: All FHIR elements must have a @value or children
receivedTime	SΣ	0..1	dateTime	The time when specimen was received for processing ele-1: All FHIR elements must have a @value or children
parent	S	0..*	Reference(BeSpecimenLaboratory)	Specimen from which this specimen originated ele-1: All FHIR elements must have a @value or children
request	S	0..*	Reference(ServiceRequest)	Why the specimen was collected ele-1: All FHIR elements must have a @value or children
collection	S	0..1	BackboneElement	Collection details ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
collected[x]	Σ	0..1		Collection time ele-1: All FHIR elements must have a @value or children
collectedDateTime			dateTime
collectedPeriod			Period
duration	Σ	0..1	Duration	How long it took to collect specimen ele-1: All FHIR elements must have a @value or children
quantity		0..1	SimpleQuantity	The quantity of specimen collected ele-1: All FHIR elements must have a @value or children
method		0..1	CodeableConcept	Technique used to perform collection Binding: FHIRSpecimenCollectionMethod (example): The technique that is used to perform the procedure. ele-1: All FHIR elements must have a @value or children
bodySite		0..1	CodeableConcept	Anatomical collection site Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. ele-1: All FHIR elements must have a @value or children
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. ele-1: All FHIR elements must have a @value or children
fastingStatusCodeableConcept			CodeableConcept
fastingStatusDuration			Duration
processing		0..*	BackboneElement	Processing and processing step details to include when not implicit from specimen. ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
container		0..*	BackboneElement	Direct container of specimen (tube/slide, etc.) ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
condition	SΣ	0..*	CodeableConcept	State of the specimen Binding: hl7VS-specimenCondition (extensible): Codes describing the state of the specimen. ele-1: All FHIR elements must have a @value or children
note	S	0..*	Annotation	Comments ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Specimen.status	required	SpecimenStatus http://hl7.org/fhir/ValueSet/specimen-status|4.0.1 from the FHIR Standard
Specimen.type	example	Hl7VSSpecimenType http://terminology.hl7.org/ValueSet/v2-0487
Specimen.collection.method	example	FHIRSpecimenCollectionMethod http://hl7.org/fhir/ValueSet/specimen-collection-method from the FHIR Standard
Specimen.collection.bodySite	example	SNOMEDCTBodyStructures http://hl7.org/fhir/ValueSet/body-site from the FHIR Standard
Specimen.collection.fastingStatus[x]	extensible	Hl7VSRelevantClincialInformation http://terminology.hl7.org/ValueSet/v2-0916
Specimen.condition	extensible	Hl7VSSpecimenCondition http://terminology.hl7.org/ValueSet/v2-0493

Constraints

Id	Grade	Path(s)	Details	Requirements
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()

Name	Flags	Card.	Type	Description & Constraints
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. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
status		1..1	code	generated | extensions | additional | empty Binding: NarrativeStatus (required): The status of a resource narrative. Required Pattern: empty
div	C	1..1	xhtml	Limited xhtml content txt-1: The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes txt-2: The narrative SHALL have some non-whitespace content
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	0..*	Identifier	External Identifier
accessionIdentifier	Σ	0..1	Identifier	Identifier assigned by the lab
status	?!SΣ	0..1	code	available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen.
type	SΣ	0..1	CodeableConcept	Kind of material that forms the specimen Binding: hl7VS-specimenType (example): The type of the specimen.
subject	SΣ	0..1	Reference(Group | Device | Substance | Location | Patient core BE profile)	In the initial iteration of the Belgium lab project: when sending to eHealthBox, this is BePatient.
receivedTime	SΣ	0..1	dateTime	The time when specimen was received for processing
parent	S	0..*	Reference(BeSpecimenLaboratory)	Specimen from which this specimen originated
request	S	0..*	Reference(ServiceRequest)	Why the specimen was collected
collection	S	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
collected[x]	Σ	0..1		Collection time
collectedDateTime			dateTime
collectedPeriod			Period
duration	Σ	0..1	Duration	How long it took to collect specimen
quantity		0..1	SimpleQuantity	The quantity of specimen collected
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.
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 to include when not implicit from specimen.
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
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		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: hl7VS-additivePreservative (example): Substance added to specimen container.
additiveCodeableConcept			CodeableConcept
additiveReference			Reference(Substance)
condition	SΣ	0..*	CodeableConcept	State of the specimen Binding: hl7VS-specimenCondition (extensible): Codes describing the state of the specimen.
note	S	0..*	Annotation	Comments
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Specimen.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Specimen.text.status	required	Pattern: empty http://hl7.org/fhir/ValueSet/narrative-status|4.0.1 from the FHIR Standard
Specimen.status	required	SpecimenStatus http://hl7.org/fhir/ValueSet/specimen-status|4.0.1 from the FHIR Standard
Specimen.type	example	Hl7VSSpecimenType http://terminology.hl7.org/ValueSet/v2-0487
Specimen.collection.method	example	FHIRSpecimenCollectionMethod http://hl7.org/fhir/ValueSet/specimen-collection-method from the FHIR Standard
Specimen.collection.bodySite	example	SNOMEDCTBodyStructures http://hl7.org/fhir/ValueSet/body-site from the FHIR Standard
Specimen.collection.fastingStatus[x]	extensible	Hl7VSRelevantClincialInformation http://terminology.hl7.org/ValueSet/v2-0916
Specimen.processing.procedure	example	SpecimenProcessingProcedure http://hl7.org/fhir/ValueSet/specimen-processing-procedure from the FHIR Standard
Specimen.container.type	example	SpecimenContainerType http://hl7.org/fhir/ValueSet/specimen-container-type from the FHIR Standard
Specimen.container.additive[x]	example	Hl7VSAdditivePreservative http://terminology.hl7.org/ValueSet/v2-0371
Specimen.condition	extensible	Hl7VSSpecimenCondition http://terminology.hl7.org/ValueSet/v2-0493

Constraints

Id	Grade	Path(s)	Details	Requirements
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()
txt-1	error	Specimen.text.div	The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes : htmlChecks()
txt-2	error	Specimen.text.div	The narrative SHALL have some non-whitespace content : htmlChecks()

This structure is derived from Specimen

Summary

Must-Support: 10 elements

Structures

This structure refers to these other structures:

• Patient core BE profile (https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-patient)
• BeSpecimenLaboratory (https://www.ehealth.fgov.be/standards/fhir/lab/StructureDefinition/be-specimen-laboratory)

Maturity: 1

Differential View

This structure is derived from Specimen

Name	Flags	Card.	Type	Description & Constraints
Specimen			Specimen
text
status		1..1	code	generated | extensions | additional | empty Required Pattern: empty
identifier	S	0..*	Identifier	External Identifier
status	S	0..1	code	available | unavailable | unsatisfactory | entered-in-error
type	S	0..1	CodeableConcept	Kind of material that forms the specimen
subject	S	0..1	Reference(Group | Device | Substance | Location | Patient core BE profile)	In the initial iteration of the Belgium lab project: when sending to eHealthBox, this is BePatient.
receivedTime	S	0..1	dateTime	The time when specimen was received for processing
parent	S	0..*	Reference(BeSpecimenLaboratory)	Specimen from which this specimen originated
request	S	0..*	Reference(ServiceRequest)	Why the specimen was collected
collection	S	0..1	BackboneElement	Collection details
collected[x]		0..1	dateTime, Period	Collection time
duration		0..1	Duration	How long it took to collect specimen
quantity		0..1	SimpleQuantity	The quantity of specimen collected
method		0..1	CodeableConcept	Technique used to perform collection
bodySite		0..1	CodeableConcept	Anatomical collection site
fastingStatus[x]		0..1	CodeableConcept, Duration	Whether or how long patient abstained from food and/or drink
processing		0..*	BackboneElement	Processing and processing step details to include when not implicit from specimen.
container		0..*	BackboneElement	Direct container of specimen (tube/slide, etc.)
condition	S	0..*	CodeableConcept	State of the specimen
note	S	0..*	Annotation	Comments
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Specimen		0..*	Specimen	Sample for analysis dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
identifier	SΣ	0..*	Identifier	External Identifier ele-1: All FHIR elements must have a @value or children
status	?!SΣ	0..1	code	available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. ele-1: All FHIR elements must have a @value or children
type	SΣ	0..1	CodeableConcept	Kind of material that forms the specimen Binding: hl7VS-specimenType (example): The type of the specimen. ele-1: All FHIR elements must have a @value or children
subject	SΣ	0..1	Reference(Group | Device | Substance | Location | Patient core BE profile)	In the initial iteration of the Belgium lab project: when sending to eHealthBox, this is BePatient. ele-1: All FHIR elements must have a @value or children
receivedTime	SΣ	0..1	dateTime	The time when specimen was received for processing ele-1: All FHIR elements must have a @value or children
parent	S	0..*	Reference(BeSpecimenLaboratory)	Specimen from which this specimen originated ele-1: All FHIR elements must have a @value or children
request	S	0..*	Reference(ServiceRequest)	Why the specimen was collected ele-1: All FHIR elements must have a @value or children
collection	S	0..1	BackboneElement	Collection details ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
collected[x]	Σ	0..1		Collection time ele-1: All FHIR elements must have a @value or children
collectedDateTime			dateTime
collectedPeriod			Period
duration	Σ	0..1	Duration	How long it took to collect specimen ele-1: All FHIR elements must have a @value or children
quantity		0..1	SimpleQuantity	The quantity of specimen collected ele-1: All FHIR elements must have a @value or children
method		0..1	CodeableConcept	Technique used to perform collection Binding: FHIRSpecimenCollectionMethod (example): The technique that is used to perform the procedure. ele-1: All FHIR elements must have a @value or children
bodySite		0..1	CodeableConcept	Anatomical collection site Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. ele-1: All FHIR elements must have a @value or children
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. ele-1: All FHIR elements must have a @value or children
fastingStatusCodeableConcept			CodeableConcept
fastingStatusDuration			Duration
processing		0..*	BackboneElement	Processing and processing step details to include when not implicit from specimen. ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
container		0..*	BackboneElement	Direct container of specimen (tube/slide, etc.) ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
condition	SΣ	0..*	CodeableConcept	State of the specimen Binding: hl7VS-specimenCondition (extensible): Codes describing the state of the specimen. ele-1: All FHIR elements must have a @value or children
note	S	0..*	Annotation	Comments ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Specimen.status	required	SpecimenStatus http://hl7.org/fhir/ValueSet/specimen-status|4.0.1 from the FHIR Standard
Specimen.type	example	Hl7VSSpecimenType http://terminology.hl7.org/ValueSet/v2-0487
Specimen.collection.method	example	FHIRSpecimenCollectionMethod http://hl7.org/fhir/ValueSet/specimen-collection-method from the FHIR Standard
Specimen.collection.bodySite	example	SNOMEDCTBodyStructures http://hl7.org/fhir/ValueSet/body-site from the FHIR Standard
Specimen.collection.fastingStatus[x]	extensible	Hl7VSRelevantClincialInformation http://terminology.hl7.org/ValueSet/v2-0916
Specimen.condition	extensible	Hl7VSSpecimenCondition http://terminology.hl7.org/ValueSet/v2-0493

Constraints

Id	Grade	Path(s)	Details	Requirements
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()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
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. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
status		1..1	code	generated | extensions | additional | empty Binding: NarrativeStatus (required): The status of a resource narrative. Required Pattern: empty
div	C	1..1	xhtml	Limited xhtml content txt-1: The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes txt-2: The narrative SHALL have some non-whitespace content
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	0..*	Identifier	External Identifier
accessionIdentifier	Σ	0..1	Identifier	Identifier assigned by the lab
status	?!SΣ	0..1	code	available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen.
type	SΣ	0..1	CodeableConcept	Kind of material that forms the specimen Binding: hl7VS-specimenType (example): The type of the specimen.
subject	SΣ	0..1	Reference(Group | Device | Substance | Location | Patient core BE profile)	In the initial iteration of the Belgium lab project: when sending to eHealthBox, this is BePatient.
receivedTime	SΣ	0..1	dateTime	The time when specimen was received for processing
parent	S	0..*	Reference(BeSpecimenLaboratory)	Specimen from which this specimen originated
request	S	0..*	Reference(ServiceRequest)	Why the specimen was collected
collection	S	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
collected[x]	Σ	0..1		Collection time
collectedDateTime			dateTime
collectedPeriod			Period
duration	Σ	0..1	Duration	How long it took to collect specimen
quantity		0..1	SimpleQuantity	The quantity of specimen collected
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.
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 to include when not implicit from specimen.
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
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		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: hl7VS-additivePreservative (example): Substance added to specimen container.
additiveCodeableConcept			CodeableConcept
additiveReference			Reference(Substance)
condition	SΣ	0..*	CodeableConcept	State of the specimen Binding: hl7VS-specimenCondition (extensible): Codes describing the state of the specimen.
note	S	0..*	Annotation	Comments
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Specimen.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Specimen.text.status	required	Pattern: empty http://hl7.org/fhir/ValueSet/narrative-status|4.0.1 from the FHIR Standard
Specimen.status	required	SpecimenStatus http://hl7.org/fhir/ValueSet/specimen-status|4.0.1 from the FHIR Standard
Specimen.type	example	Hl7VSSpecimenType http://terminology.hl7.org/ValueSet/v2-0487
Specimen.collection.method	example	FHIRSpecimenCollectionMethod http://hl7.org/fhir/ValueSet/specimen-collection-method from the FHIR Standard
Specimen.collection.bodySite	example	SNOMEDCTBodyStructures http://hl7.org/fhir/ValueSet/body-site from the FHIR Standard
Specimen.collection.fastingStatus[x]	extensible	Hl7VSRelevantClincialInformation http://terminology.hl7.org/ValueSet/v2-0916
Specimen.processing.procedure	example	SpecimenProcessingProcedure http://hl7.org/fhir/ValueSet/specimen-processing-procedure from the FHIR Standard
Specimen.container.type	example	SpecimenContainerType http://hl7.org/fhir/ValueSet/specimen-container-type from the FHIR Standard
Specimen.container.additive[x]	example	Hl7VSAdditivePreservative http://terminology.hl7.org/ValueSet/v2-0371
Specimen.condition	extensible	Hl7VSSpecimenCondition http://terminology.hl7.org/ValueSet/v2-0493

Constraints

Id	Grade	Path(s)	Details	Requirements
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()
txt-1	error	Specimen.text.div	The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes : htmlChecks()
txt-2	error	Specimen.text.div	The narrative SHALL have some non-whitespace content : htmlChecks()

This structure is derived from Specimen

Summary

Must-Support: 10 elements

Structures

This structure refers to these other structures:

• Patient core BE profile (https://www.ehealth.fgov.be/standards/fhir/core/StructureDefinition/be-patient)
• BeSpecimenLaboratory (https://www.ehealth.fgov.be/standards/fhir/lab/StructureDefinition/be-specimen-laboratory)

Maturity: 1

Other representations of profile: CSV, Excel, Schematron