RIVO-Noord Zorgviewer Implementation Guide - Local Development build (v1.7.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

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

Resource Profile: Specimen

Monster Materiaal

Usage:

• Refer to this Resource Profile: LaboratoryTestResult

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 Zib LaboratoryTestResult Specimen

Name	Flags	Card.	Type	Description & Constraints
Specimen			Zib LaboratoryTestResult 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
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
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.
type	Σ	0..1	CodeableConcept	SpecimenMaterial Binding: MonstermateriaalCodelijst (extensible)
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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Specimen.status	required	SpecimenStatus http://hl7.org/fhir/ValueSet/specimen-status from the FHIR Standard
Specimen.type	extensible	MonstermateriaalCodelijst http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.13.1.6--20171231000000

Constraints

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

Name	Flags	Card.	Type	Description & Constraints
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
language		0..1	code	Language of the resource content Binding: Common Languages (extensible): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
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)
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, Closed 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	Extension Slice: Unordered, Open by value:url
period-duration		0..1	Duration	Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/period-duration
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)
bodySite		0..1	CodeableConcept	AnatomicalLocation Binding: MonsterAnatomischeLocatieCodelijst (extensible): SpecimenAnatomicalLocationCodelist
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
laterality		0..*	(Complex)	Laterality URL: http://nictiz.nl/fhir/StructureDefinition/BodySite-Qualifier
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	"http://nictiz.nl/fhir/StructureDefinition/BodySite-Qualifier"
Slices for value[x]		0..1	CodeableConcept	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueCodeableConcept		0..1	CodeableConcept	BodySite qualifier Binding: LateraliteitCodelijst (extensible): LateralityCodelist
morphology		0..*	(Complex)	Morphology URL: http://nictiz.nl/fhir/StructureDefinition/BodySite-Morphology
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	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]		0..1	CodeableConcept	Value of extension Slice: Unordered, Closed by type:$this
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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Specimen.language	extensible	Common Languages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Specimen.status	required	SpecimenStatus http://hl7.org/fhir/ValueSet/specimen-status from the FHIR Standard
Specimen.type	extensible	MonstermateriaalCodelijst http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.13.1.6--20171231000000
Specimen.collection.method	extensible	AfnameprocedureCodelijst http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.13.1.2--20171231000000
Specimen.collection.bodySite	extensible	MonsterAnatomischeLocatieCodelijst http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.13.1.11--20171231000000
Specimen.collection.bodySite.extension:laterality.value[x]:valueCodeableConcept	extensible	LateraliteitCodelijst http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.13.1.12--20171231000000
Specimen.collection.bodySite.extension:morphology.value[x]:valueCodeableConcept	extensible	MorfologieCodelijst http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.13.1.13--20171231000000
Specimen.processing.procedure	example	SpecimenProcessingProcedure http://hl7.org/fhir/ValueSet/specimen-processing-procedure from the FHIR Standard
Specimen.container.type	extensible	ContainerTypeCodelijst http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.13.1.9--20171231000000
Specimen.container.additive[x]	example	v2 Additive/Preservative http://hl7.org/fhir/ValueSet/v2-0371 from the FHIR Standard

Constraints

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

This structure is derived from Zib LaboratoryTestResult Specimen

Summary

Must-Support: 2 elements

Differential View

This structure is derived from Zib LaboratoryTestResult Specimen

Name	Flags	Card.	Type	Description & Constraints
Specimen			Zib LaboratoryTestResult 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
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
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.
type	Σ	0..1	CodeableConcept	SpecimenMaterial Binding: MonstermateriaalCodelijst (extensible)
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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Specimen.status	required	SpecimenStatus http://hl7.org/fhir/ValueSet/specimen-status from the FHIR Standard
Specimen.type	extensible	MonstermateriaalCodelijst http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.13.1.6--20171231000000

Constraints

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

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
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
language		0..1	code	Language of the resource content Binding: Common Languages (extensible): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
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)
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, Closed 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	Extension Slice: Unordered, Open by value:url
period-duration		0..1	Duration	Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/period-duration
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)
bodySite		0..1	CodeableConcept	AnatomicalLocation Binding: MonsterAnatomischeLocatieCodelijst (extensible): SpecimenAnatomicalLocationCodelist
id		0..1	string	xml:id (or equivalent in JSON)
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
laterality		0..*	(Complex)	Laterality URL: http://nictiz.nl/fhir/StructureDefinition/BodySite-Qualifier
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	"http://nictiz.nl/fhir/StructureDefinition/BodySite-Qualifier"
Slices for value[x]		0..1	CodeableConcept	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueCodeableConcept		0..1	CodeableConcept	BodySite qualifier Binding: LateraliteitCodelijst (extensible): LateralityCodelist
morphology		0..*	(Complex)	Morphology URL: http://nictiz.nl/fhir/StructureDefinition/BodySite-Morphology
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	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]		0..1	CodeableConcept	Value of extension Slice: Unordered, Closed by type:$this
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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Specimen.language	extensible	Common Languages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Specimen.status	required	SpecimenStatus http://hl7.org/fhir/ValueSet/specimen-status from the FHIR Standard
Specimen.type	extensible	MonstermateriaalCodelijst http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.13.1.6--20171231000000
Specimen.collection.method	extensible	AfnameprocedureCodelijst http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.13.1.2--20171231000000
Specimen.collection.bodySite	extensible	MonsterAnatomischeLocatieCodelijst http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.13.1.11--20171231000000
Specimen.collection.bodySite.extension:laterality.value[x]:valueCodeableConcept	extensible	LateraliteitCodelijst http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.13.1.12--20171231000000
Specimen.collection.bodySite.extension:morphology.value[x]:valueCodeableConcept	extensible	MorfologieCodelijst http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.13.1.13--20171231000000
Specimen.processing.procedure	example	SpecimenProcessingProcedure http://hl7.org/fhir/ValueSet/specimen-processing-procedure from the FHIR Standard
Specimen.container.type	extensible	ContainerTypeCodelijst http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.13.1.9--20171231000000
Specimen.container.additive[x]	example	v2 Additive/Preservative http://hl7.org/fhir/ValueSet/v2-0371 from the FHIR Standard

Constraints

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

This structure is derived from Zib LaboratoryTestResult Specimen

Summary

Must-Support: 2 elements

Other representations of profile: CSV, Excel, Schematron