Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Specimen			SpecimenEu
Slices for identifier	S	1..*	CorrelationIdentifier	External Identifier Slice: Unordered, Open by value:type
identifier:PlacerSpecimenNumber	SO	0..1	Identifier	Identifier assigned by the Order Placer. Obligations Actor SHOULD:populate-if-known Order Filler SHALL:populate Order Placer SHOULD:populate-if-known Automation Manager
type		1..1	CodeableConcept	Description of identifier Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
code		1..1	code	Symbol in syntax defined by the system Fixed Value: PLAC
identifier:FillerSpecimenNumber	SO	0..1	Identifier	Identifier assigned by the lab (Order Filler) Obligations Actor SHALL:populate Order Filler SHOULD:populate-if-known Order Placer SHOULD:populate-if-known Automation Manager
type		1..1	CodeableConcept	Description of identifier Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
code		1..1	code	Symbol in syntax defined by the system Fixed Value: FILL
identifier:ShipmentTrackingNumber	SO	0..1	ShipmentTrackingNumber	Identifier assigned by the Order Placer Obligations Actor SHOULD:populate Order Filler SHALL:populate-if-known Order Placer SHOULD:populate-if-known Automation Manager
accessionIdentifier	S	0..1	AccessionNumber	Identifier assigned by the lab
type	S	0..1	CodeableConcept	Kind of material that forms the specimen Binding: Specimen Type (required)
subject	S	1..1	Reference(Patient)	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 or a device
collection
collector	S	0..1	Reference(PractitionerRole)	Who collected the specimen
collected[x]	S	0..1	dateTime	Collection time
quantity	S	0..1	SimpleQuantity	The quantity of specimen collected
bodySite	S	0..1	CodeableConcept	Anatomical collection site
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Specimen.type	required	SpecimenType https://nw-gmsa.github.io/ValueSet/specimen-type From this IG

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Specimen		0..*	SpecimenEu	Laboratory Specimen
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SΣ	1..*	CorrelationIdentifier	External Identifier Slice: Unordered, Open by value:type
identifier:PlacerSpecimenNumber	SOΣ	0..1	Identifier	Identifier assigned by the Order Placer. Obligations Actor SHOULD:populate-if-known Order Filler SHALL:populate Order Placer SHOULD:populate-if-known Automation Manager
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	1..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: PLAC
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
identifier:FillerSpecimenNumber	SOΣ	0..1	Identifier	Identifier assigned by the lab (Order Filler) Obligations Actor SHALL:populate Order Filler SHOULD:populate-if-known Order Placer SHOULD:populate-if-known Automation Manager
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	1..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: FILL
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
identifier:ShipmentTrackingNumber	SOΣ	0..1	ShipmentTrackingNumber	Identifier assigned by the Order Placer Obligations Actor SHOULD:populate Order Filler SHALL:populate-if-known Order Placer SHOULD:populate-if-known Automation Manager
accessionIdentifier	SΣ	0..1	AccessionNumber	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	SΣ	0..1	CodeableConcept	Kind of material that forms the specimen Binding: Specimen Type (required)
subject	SΣ	1..1	Reference(Patient)	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 or a device
collection		0..1	BackboneElement	Collection details
Slices for extension				Content/Rules for all slices
extension:bodySite		0..1	(Complex)	Target anatomic location or structure URL: http://hl7.org/fhir/StructureDefinition/bodySite
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/bodySite"
value[x]		1..1	Reference(Body structure: Laboratory)	Value of extension
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
collector	SΣ	0..1	Reference(PractitionerRole)	Who collected the specimen
collected[x]	SΣ	0..1	dateTime	Collection time
quantity	S	0..1	SimpleQuantity	The quantity of specimen collected
bodySite	S	0..1	CodeableConcept	Anatomical collection site Binding: SNOMEDCTBodyStructures (preferred)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Specimen.identifier:PlacerSpecimenNumber.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Specimen.identifier:PlacerSpecimenNumber.type	extensible	Pattern Value: PLAC http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
Specimen.identifier:FillerSpecimenNumber.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Specimen.identifier:FillerSpecimenNumber.type	extensible	Pattern Value: FILL http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
Specimen.status	required	SpecimenStatus http://hl7.org/fhir/ValueSet/specimen-status|4.0.1 From the FHIR Standard
Specimen.type	required	SpecimenType https://nw-gmsa.github.io/ValueSet/specimen-type From this IG
Specimen.collection.bodySite	preferred	SNOMEDCTBodyStructures http://hl7.org/fhir/ValueSet/body-site From the FHIR Standard

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    Filter: Bindings Constraints Obligations
Specimen		0..*	SpecimenEu	Laboratory 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: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SΣ	1..*	CorrelationIdentifier	External Identifier Slice: Unordered, Open by value:type
identifier:PlacerSpecimenNumber	SOΣ	0..1	Identifier	Identifier assigned by the Order Placer. Obligations Actor SHOULD:populate-if-known Order Filler SHALL:populate Order Placer SHOULD:populate-if-known Automation Manager
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	1..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: PLAC
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
system	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	0..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier:FillerSpecimenNumber	SOΣ	0..1	Identifier	Identifier assigned by the lab (Order Filler) Obligations Actor SHALL:populate Order Filler SHOULD:populate-if-known Order Placer SHOULD:populate-if-known Automation Manager
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	1..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: FILL
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
system	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	0..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier:ShipmentTrackingNumber	SOΣ	0..1	ShipmentTrackingNumber	Identifier assigned by the Order Placer Obligations Actor SHOULD:populate Order Filler SHALL:populate-if-known Order Placer SHOULD:populate-if-known Automation Manager
accessionIdentifier	SΣ	0..1	AccessionNumber	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	SΣ	0..1	CodeableConcept	Kind of material that forms the specimen Binding: Specimen Type (required)
subject	SΣ	1..1	Reference(Patient)	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 or a device
receivedTime	Σ	0..1	dateTime	The time when specimen was received for processing
parent		0..*	Reference(Specimen: Laboratory)	Specimen from which this specimen originated
request		0..*	Reference(ServiceRequest)	Why the specimen was collected.
collection		0..1	BackboneElement	Collection details
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:bodySite		0..1	(Complex)	Target anatomic location or structure URL: http://hl7.org/fhir/StructureDefinition/bodySite
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/bodySite"
value[x]		1..1	Reference(Body structure: Laboratory)	Value of extension
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
collector	SΣ	0..1	Reference(PractitionerRole)	Who collected the specimen
collected[x]	SΣ	0..1	dateTime	Collection time
duration	Σ	0..1	Duration	How long it took to collect specimen
quantity	S	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	S	0..1	CodeableConcept	Anatomical collection site Binding: SNOMEDCTBodyStructures (preferred)
fastingStatus[x]	Σ	0..1		Whether or how long patient abstained from food and/or drink Binding: hl7VS-relevantClincialInformation (extensible): Codes describing the fasting status of the patient.
fastingStatusCodeableConcept			CodeableConcept
fastingStatusDuration			Duration
processing		0..*	BackboneElement	Processing and processing step details
id		0..1	string	Unique id for inter-element referencing
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 | Substance: Specimen Additive 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
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:device		0..1	Reference(UK Core Device)	Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.container.device
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: Specimen Container (preferred)
capacity		0..1	SimpleQuantity	Container volume or size
specimenQuantity		0..1	SimpleQuantity	Quantity of specimen within container
condition	Σ	0..*	CodeableConcept	State of the specimen Binding: hl7VS-specimenCondition (extensible): Codes describing the state of the specimen.
note		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.identifier:PlacerSpecimenNumber.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Specimen.identifier:PlacerSpecimenNumber.type	extensible	Pattern Value: PLAC http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
Specimen.identifier:FillerSpecimenNumber.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Specimen.identifier:FillerSpecimenNumber.type	extensible	Pattern Value: FILL http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
Specimen.status	required	SpecimenStatus http://hl7.org/fhir/ValueSet/specimen-status|4.0.1 From the FHIR Standard
Specimen.type	required	SpecimenType https://nw-gmsa.github.io/ValueSet/specimen-type From this IG
Specimen.collection.method	example	FHIRSpecimenCollectionMethod http://hl7.org/fhir/ValueSet/specimen-collection-method From the FHIR Standard
Specimen.collection.bodySite	preferred	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	preferred	LabSpecimenContainerEu http://hl7.eu/fhir/laboratory/ValueSet/lab-specimenContainer-eu-lab
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()

Summary

Mandatory: 2 elements(2 nested mandatory elements)
Must-Support: 11 elements

Structures

This structure refers to these other structures:

• Correlation Identifier (https://nw-gmsa.github.io/StructureDefinition/CorrelationIdentifier)
• Shipment Tracking Number (https://nw-gmsa.github.io/StructureDefinition/ShipmentTrackingNumber)
• Accession Number (https://nw-gmsa.github.io/StructureDefinition/AccessionNumber)
• Patient (https://nw-gmsa.github.io/StructureDefinition/Patient)
• PractitionerRole (https://nw-gmsa.github.io/StructureDefinition/PractitionerRole)

Slices

This structure defines the following Slices:

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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Specimen			SpecimenEu
Slices for identifier	S	1..*	CorrelationIdentifier	External Identifier Slice: Unordered, Open by value:type
identifier:PlacerSpecimenNumber	SO	0..1	Identifier	Identifier assigned by the Order Placer. Obligations Actor SHOULD:populate-if-known Order Filler SHALL:populate Order Placer SHOULD:populate-if-known Automation Manager
type		1..1	CodeableConcept	Description of identifier Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
code		1..1	code	Symbol in syntax defined by the system Fixed Value: PLAC
identifier:FillerSpecimenNumber	SO	0..1	Identifier	Identifier assigned by the lab (Order Filler) Obligations Actor SHALL:populate Order Filler SHOULD:populate-if-known Order Placer SHOULD:populate-if-known Automation Manager
type		1..1	CodeableConcept	Description of identifier Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
code		1..1	code	Symbol in syntax defined by the system Fixed Value: FILL
identifier:ShipmentTrackingNumber	SO	0..1	ShipmentTrackingNumber	Identifier assigned by the Order Placer Obligations Actor SHOULD:populate Order Filler SHALL:populate-if-known Order Placer SHOULD:populate-if-known Automation Manager
accessionIdentifier	S	0..1	AccessionNumber	Identifier assigned by the lab
type	S	0..1	CodeableConcept	Kind of material that forms the specimen Binding: Specimen Type (required)
subject	S	1..1	Reference(Patient)	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 or a device
collection
collector	S	0..1	Reference(PractitionerRole)	Who collected the specimen
collected[x]	S	0..1	dateTime	Collection time
quantity	S	0..1	SimpleQuantity	The quantity of specimen collected
bodySite	S	0..1	CodeableConcept	Anatomical collection site
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Specimen.type	required	SpecimenType https://nw-gmsa.github.io/ValueSet/specimen-type From this IG

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Specimen		0..*	SpecimenEu	Laboratory Specimen
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SΣ	1..*	CorrelationIdentifier	External Identifier Slice: Unordered, Open by value:type
identifier:PlacerSpecimenNumber	SOΣ	0..1	Identifier	Identifier assigned by the Order Placer. Obligations Actor SHOULD:populate-if-known Order Filler SHALL:populate Order Placer SHOULD:populate-if-known Automation Manager
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	1..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: PLAC
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
identifier:FillerSpecimenNumber	SOΣ	0..1	Identifier	Identifier assigned by the lab (Order Filler) Obligations Actor SHALL:populate Order Filler SHOULD:populate-if-known Order Placer SHOULD:populate-if-known Automation Manager
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	1..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: FILL
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
identifier:ShipmentTrackingNumber	SOΣ	0..1	ShipmentTrackingNumber	Identifier assigned by the Order Placer Obligations Actor SHOULD:populate Order Filler SHALL:populate-if-known Order Placer SHOULD:populate-if-known Automation Manager
accessionIdentifier	SΣ	0..1	AccessionNumber	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	SΣ	0..1	CodeableConcept	Kind of material that forms the specimen Binding: Specimen Type (required)
subject	SΣ	1..1	Reference(Patient)	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 or a device
collection		0..1	BackboneElement	Collection details
Slices for extension				Content/Rules for all slices
extension:bodySite		0..1	(Complex)	Target anatomic location or structure URL: http://hl7.org/fhir/StructureDefinition/bodySite
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/bodySite"
value[x]		1..1	Reference(Body structure: Laboratory)	Value of extension
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
collector	SΣ	0..1	Reference(PractitionerRole)	Who collected the specimen
collected[x]	SΣ	0..1	dateTime	Collection time
quantity	S	0..1	SimpleQuantity	The quantity of specimen collected
bodySite	S	0..1	CodeableConcept	Anatomical collection site Binding: SNOMEDCTBodyStructures (preferred)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Specimen.identifier:PlacerSpecimenNumber.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Specimen.identifier:PlacerSpecimenNumber.type	extensible	Pattern Value: PLAC http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
Specimen.identifier:FillerSpecimenNumber.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Specimen.identifier:FillerSpecimenNumber.type	extensible	Pattern Value: FILL http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
Specimen.status	required	SpecimenStatus http://hl7.org/fhir/ValueSet/specimen-status|4.0.1 From the FHIR Standard
Specimen.type	required	SpecimenType https://nw-gmsa.github.io/ValueSet/specimen-type From this IG
Specimen.collection.bodySite	preferred	SNOMEDCTBodyStructures http://hl7.org/fhir/ValueSet/body-site From the FHIR Standard

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    Filter: Bindings Constraints Obligations
Specimen		0..*	SpecimenEu	Laboratory 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: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SΣ	1..*	CorrelationIdentifier	External Identifier Slice: Unordered, Open by value:type
identifier:PlacerSpecimenNumber	SOΣ	0..1	Identifier	Identifier assigned by the Order Placer. Obligations Actor SHOULD:populate-if-known Order Filler SHALL:populate Order Placer SHOULD:populate-if-known Automation Manager
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	1..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: PLAC
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
system	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	0..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier:FillerSpecimenNumber	SOΣ	0..1	Identifier	Identifier assigned by the lab (Order Filler) Obligations Actor SHALL:populate Order Filler SHOULD:populate-if-known Order Placer SHOULD:populate-if-known Automation Manager
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	1..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: FILL
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
system	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	0..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier:ShipmentTrackingNumber	SOΣ	0..1	ShipmentTrackingNumber	Identifier assigned by the Order Placer Obligations Actor SHOULD:populate Order Filler SHALL:populate-if-known Order Placer SHOULD:populate-if-known Automation Manager
accessionIdentifier	SΣ	0..1	AccessionNumber	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	SΣ	0..1	CodeableConcept	Kind of material that forms the specimen Binding: Specimen Type (required)
subject	SΣ	1..1	Reference(Patient)	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 or a device
receivedTime	Σ	0..1	dateTime	The time when specimen was received for processing
parent		0..*	Reference(Specimen: Laboratory)	Specimen from which this specimen originated
request		0..*	Reference(ServiceRequest)	Why the specimen was collected.
collection		0..1	BackboneElement	Collection details
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:bodySite		0..1	(Complex)	Target anatomic location or structure URL: http://hl7.org/fhir/StructureDefinition/bodySite
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/bodySite"
value[x]		1..1	Reference(Body structure: Laboratory)	Value of extension
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
collector	SΣ	0..1	Reference(PractitionerRole)	Who collected the specimen
collected[x]	SΣ	0..1	dateTime	Collection time
duration	Σ	0..1	Duration	How long it took to collect specimen
quantity	S	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	S	0..1	CodeableConcept	Anatomical collection site Binding: SNOMEDCTBodyStructures (preferred)
fastingStatus[x]	Σ	0..1		Whether or how long patient abstained from food and/or drink Binding: hl7VS-relevantClincialInformation (extensible): Codes describing the fasting status of the patient.
fastingStatusCodeableConcept			CodeableConcept
fastingStatusDuration			Duration
processing		0..*	BackboneElement	Processing and processing step details
id		0..1	string	Unique id for inter-element referencing
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 | Substance: Specimen Additive 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
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:device		0..1	Reference(UK Core Device)	Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.container.device
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: Specimen Container (preferred)
capacity		0..1	SimpleQuantity	Container volume or size
specimenQuantity		0..1	SimpleQuantity	Quantity of specimen within container
condition	Σ	0..*	CodeableConcept	State of the specimen Binding: hl7VS-specimenCondition (extensible): Codes describing the state of the specimen.
note		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.identifier:PlacerSpecimenNumber.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Specimen.identifier:PlacerSpecimenNumber.type	extensible	Pattern Value: PLAC http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
Specimen.identifier:FillerSpecimenNumber.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Specimen.identifier:FillerSpecimenNumber.type	extensible	Pattern Value: FILL http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
Specimen.status	required	SpecimenStatus http://hl7.org/fhir/ValueSet/specimen-status|4.0.1 From the FHIR Standard
Specimen.type	required	SpecimenType https://nw-gmsa.github.io/ValueSet/specimen-type From this IG
Specimen.collection.method	example	FHIRSpecimenCollectionMethod http://hl7.org/fhir/ValueSet/specimen-collection-method From the FHIR Standard
Specimen.collection.bodySite	preferred	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	preferred	LabSpecimenContainerEu http://hl7.eu/fhir/laboratory/ValueSet/lab-specimenContainer-eu-lab
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()

Summary

Mandatory: 2 elements(2 nested mandatory elements)
Must-Support: 11 elements

Structures

This structure refers to these other structures:

• Correlation Identifier (https://nw-gmsa.github.io/StructureDefinition/CorrelationIdentifier)
• Shipment Tracking Number (https://nw-gmsa.github.io/StructureDefinition/ShipmentTrackingNumber)
• Accession Number (https://nw-gmsa.github.io/StructureDefinition/AccessionNumber)
• Patient (https://nw-gmsa.github.io/StructureDefinition/Patient)
• PractitionerRole (https://nw-gmsa.github.io/StructureDefinition/PractitionerRole)

Slices

This structure defines the following Slices:

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