haau3 FHIR Implementation Guide (HFIG) - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

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

Resource Profile: haau3 Specimen

A sample collected from a care recipient that a test was performed on. Where the source system did not state what kind of sample it was, the record says the value is unknown rather than carrying an invented one.

Usages:

• Examples for this Profile: Specimen/haau3-specimen-unknown-type

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Specimen		0..*	USCoreSpecimenProfile(6.1.0)	Sample for analysis
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	1..*	Identifier	External Identifier
status	?!Σ	0..1	code	available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen.
type	SΣ	1..1	CodeableConcept	(USCDI) Kind of material that forms the specimen Binding: Specimen type (extensible)
subject	SΣ	0..1	Reference(US Core Patient Profile)	(USCDI) The patient where the specimen came from.
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Specimen.status	Base	required	SpecimenStatus	📍4.0.1	FHIR Std.
Specimen.type	Base	extensible	Specimen type	📦20221102	VSAC v0.11

Constraints

Id	Grade	Path(s)	Description	Expression
dom-2	error	Specimen	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	Specimen	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource	contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().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()

This structure is derived from USCoreSpecimenProfile

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Specimen		0..*	USCoreSpecimenProfile(6.1.0)	Sample for analysis
identifier	S	1..*	Identifier	External Identifier
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Specimen		0..*	USCoreSpecimenProfile(6.1.0)	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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	1..*	Identifier	External Identifier
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	SΣ	1..1	CodeableConcept	(USCDI) Kind of material that forms the specimen Binding: Specimen type (extensible)
subject	SΣ	0..1	Reference(US Core Patient Profile)	(USCDI) The patient where the specimen came from.
receivedTime	Σ	0..1	dateTime	The time when specimen was received for processing
parent		0..*	Reference(Specimen)	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
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
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	Σ	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	Status	Usage	ValueSet	Version	Source
Specimen.language	Base	preferred	Common Languages	📦4.0.1	FHIR Std.
Specimen.status	Base	required	SpecimenStatus	📍4.0.1	FHIR Std.
Specimen.type	Base	extensible	Specimen type	📦20221102	VSAC v0.11
Specimen.collection.​method	Base	example	FHIR Specimen Collection Method	📦4.0.1	FHIR Std.
Specimen.collection.​bodySite	Base	example	SNOMED CT Body Structures	📦4.0.1	FHIR Std.
Specimen.collection.​fastingStatus[x]	Base	extensible	hl7VS-relevantClincialInformation	📦3.0.0	THO v7.3
Specimen.processing.​procedure	Base	example	Specimen processing procedure	📦4.0.1	FHIR Std.
Specimen.container.type	Base	example	Specimen Container Type	📦4.0.1	FHIR Std.
Specimen.container.additive[x]	Base	example	hl7VS-additivePreservative	📦3.0.0	THO v7.3
Specimen.condition	Base	extensible	hl7VS-specimenCondition	📦3.0.0	THO v7.3

Constraints

Id	Grade	Path(s)	Description	Expression
dom-2	error	Specimen	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	Specimen	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource	contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().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()

This structure is derived from USCoreSpecimenProfile

Summary

Mandatory: 1 element
Must-Support: 1 element

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Specimen		0..*	USCoreSpecimenProfile(6.1.0)	Sample for analysis
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	1..*	Identifier	External Identifier
status	?!Σ	0..1	code	available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen.
type	SΣ	1..1	CodeableConcept	(USCDI) Kind of material that forms the specimen Binding: Specimen type (extensible)
subject	SΣ	0..1	Reference(US Core Patient Profile)	(USCDI) The patient where the specimen came from.
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Specimen.status	Base	required	SpecimenStatus	📍4.0.1	FHIR Std.
Specimen.type	Base	extensible	Specimen type	📦20221102	VSAC v0.11

Constraints

Id	Grade	Path(s)	Description	Expression
dom-2	error	Specimen	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	Specimen	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource	contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().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()

Differential View

This structure is derived from USCoreSpecimenProfile

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Specimen		0..*	USCoreSpecimenProfile(6.1.0)	Sample for analysis
identifier	S	1..*	Identifier	External Identifier
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Specimen		0..*	USCoreSpecimenProfile(6.1.0)	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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	1..*	Identifier	External Identifier
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	SΣ	1..1	CodeableConcept	(USCDI) Kind of material that forms the specimen Binding: Specimen type (extensible)
subject	SΣ	0..1	Reference(US Core Patient Profile)	(USCDI) The patient where the specimen came from.
receivedTime	Σ	0..1	dateTime	The time when specimen was received for processing
parent		0..*	Reference(Specimen)	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
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
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	Σ	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	Status	Usage	ValueSet	Version	Source
Specimen.language	Base	preferred	Common Languages	📦4.0.1	FHIR Std.
Specimen.status	Base	required	SpecimenStatus	📍4.0.1	FHIR Std.
Specimen.type	Base	extensible	Specimen type	📦20221102	VSAC v0.11
Specimen.collection.​method	Base	example	FHIR Specimen Collection Method	📦4.0.1	FHIR Std.
Specimen.collection.​bodySite	Base	example	SNOMED CT Body Structures	📦4.0.1	FHIR Std.
Specimen.collection.​fastingStatus[x]	Base	extensible	hl7VS-relevantClincialInformation	📦3.0.0	THO v7.3
Specimen.processing.​procedure	Base	example	Specimen processing procedure	📦4.0.1	FHIR Std.
Specimen.container.type	Base	example	Specimen Container Type	📦4.0.1	FHIR Std.
Specimen.container.additive[x]	Base	example	hl7VS-additivePreservative	📦3.0.0	THO v7.3
Specimen.condition	Base	extensible	hl7VS-specimenCondition	📦3.0.0	THO v7.3

Constraints

Id	Grade	Path(s)	Description	Expression
dom-2	error	Specimen	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	Specimen	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource	contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().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()

This structure is derived from USCoreSpecimenProfile

Summary

Mandatory: 1 element
Must-Support: 1 element

Other representations of profile: CSV, Excel, Schematron