This page is part of the Sharing eCC Data from Pathology Labs to EHR (v1.0.0: STU 1) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• Examples

Resource Profile: US Pathology Specimen

Usage:

• Use this Resource Profile: US Pathology Cancer Registry Content Bundle and US Pathology Exchange Bundle
• Refer to this Resource Profile: US Pathology Diagnostic Report and US Pathology Service Request
• Examples for this Resource Profile: Specimen/adrenal-example

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		0..*	Specimen	Sample for analysis
identifier	S	1..*	Identifier	External Identifier
accessionIdentifier	S	1..1	Identifier	Identifier assigned by the lab
status	S	0..1	code	available | unavailable | unsatisfactory | entered-in-error
type	S	1..1	CodeableConcept	Kind of material that forms the specimen
receivedTime	S	0..1	dateTime	The time when specimen was received for processing
parent	S	0..*	Reference(Specimen)	Specimen from which this specimen originated
collection	S	0..1	BackboneElement	Collection details
collector	S	0..1	Reference(US Pathology Related Practitioner Roles)	Who collected the specimen
collected[x]	S	1..1	dateTime	Collection time
method	S	1..1	CodeableConcept	Technique used to perform collection
bodySite	S	0..1	CodeableConcept	Anatomical collection site
container	S	1..*	BackboneElement	Direct container of specimen (tube/slide, etc.)
id		1..1	string	Unique id for inter-element referencing
identifier		1..*	Identifier	Id for the container
note	S	0..*	Annotation	Comments
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Specimen		0..*	Specimen	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
accessionIdentifier	SΣ	1..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Σ	1..1	CodeableConcept	Kind of material that forms the specimen Binding: hl7VS-specimenType (example): The type of the specimen.
receivedTime	SΣ	0..1	dateTime	The time when specimen was received for processing
parent	S	0..*	Reference(Specimen)	Specimen from which this specimen originated
collection	S	0..1	BackboneElement	Collection details
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
collector	SΣ	0..1	Reference(US Pathology Related Practitioner Roles)	Who collected the specimen
collected[x]	SΣ	1..1	dateTime	Collection time
method	S	1..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 (example): Codes describing anatomical locations. May include laterality.
container	S	1..*	BackboneElement	Direct container of specimen (tube/slide, etc.)
id		1..1	string	Unique id for inter-element referencing
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
identifier	Σ	1..*	Identifier	Id for the container
note	S	0..*	Annotation	Comments
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
Specimen.status	required	SpecimenStatus
Specimen.type	example	Hl7VSSpecimenType
Specimen.collection.method	example	FHIRSpecimenCollectionMethod
Specimen.collection.bodySite	example	SNOMEDCTBodyStructures

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
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	SΣ	1..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Σ	1..1	CodeableConcept	Kind of material that forms the specimen Binding: hl7VS-specimenType (example): The type of the specimen.
subject	Σ	0..1	Reference(Patient | Group | Device | Substance | Location)	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	SΣ	0..1	dateTime	The time when specimen was received for processing
parent	S	0..*	Reference(Specimen)	Specimen from which this specimen originated
request		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	SΣ	0..1	Reference(US Pathology Related Practitioner Roles)	Who collected the specimen
collected[x]	SΣ	1..1	dateTime	Collection time
duration	Σ	0..1	Duration	How long it took to collect specimen
quantity		0..1	SimpleQuantity	The quantity of specimen collected
method	S	1..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 (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	S	1..*	BackboneElement	Direct container of specimen (tube/slide, etc.)
id		1..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	Σ	1..*	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	S	0..*	Annotation	Comments
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
Specimen.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
Specimen.status	required	SpecimenStatus
Specimen.type	example	Hl7VSSpecimenType
Specimen.collection.method	example	FHIRSpecimenCollectionMethod
Specimen.collection.bodySite	example	SNOMEDCTBodyStructures
Specimen.collection.fastingStatus[x]	extensible	Hl7VSRelevantClincialInformation
Specimen.processing.procedure	example	SpecimenProcessingProcedure
Specimen.container.type	example	SpecimenContainerType
Specimen.container.additive[x]	example	Hl7VSAdditivePreservative
Specimen.condition	extensible	Hl7VSSpecimenCondition

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from Specimen

Summary

Mandatory: 6 elements (2 nested mandatory elements)
Must-Support: 13 elements

Structures

This structure refers to these other structures:

• US Pathology Related Practitioner Roles (http://hl7.org/fhir/us/cancer-reporting/StructureDefinition/us-pathology-related-practitioner-role)

Differential View

This structure is derived from Specimen

Name	Flags	Card.	Type	Description & Constraints
Specimen		0..*	Specimen	Sample for analysis
identifier	S	1..*	Identifier	External Identifier
accessionIdentifier	S	1..1	Identifier	Identifier assigned by the lab
status	S	0..1	code	available | unavailable | unsatisfactory | entered-in-error
type	S	1..1	CodeableConcept	Kind of material that forms the specimen
receivedTime	S	0..1	dateTime	The time when specimen was received for processing
parent	S	0..*	Reference(Specimen)	Specimen from which this specimen originated
collection	S	0..1	BackboneElement	Collection details
collector	S	0..1	Reference(US Pathology Related Practitioner Roles)	Who collected the specimen
collected[x]	S	1..1	dateTime	Collection time
method	S	1..1	CodeableConcept	Technique used to perform collection
bodySite	S	0..1	CodeableConcept	Anatomical collection site
container	S	1..*	BackboneElement	Direct container of specimen (tube/slide, etc.)
id		1..1	string	Unique id for inter-element referencing
identifier		1..*	Identifier	Id for the container
note	S	0..*	Annotation	Comments
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Specimen		0..*	Specimen	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
accessionIdentifier	SΣ	1..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Σ	1..1	CodeableConcept	Kind of material that forms the specimen Binding: hl7VS-specimenType (example): The type of the specimen.
receivedTime	SΣ	0..1	dateTime	The time when specimen was received for processing
parent	S	0..*	Reference(Specimen)	Specimen from which this specimen originated
collection	S	0..1	BackboneElement	Collection details
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
collector	SΣ	0..1	Reference(US Pathology Related Practitioner Roles)	Who collected the specimen
collected[x]	SΣ	1..1	dateTime	Collection time
method	S	1..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 (example): Codes describing anatomical locations. May include laterality.
container	S	1..*	BackboneElement	Direct container of specimen (tube/slide, etc.)
id		1..1	string	Unique id for inter-element referencing
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
identifier	Σ	1..*	Identifier	Id for the container
note	S	0..*	Annotation	Comments
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
Specimen.status	required	SpecimenStatus
Specimen.type	example	Hl7VSSpecimenType
Specimen.collection.method	example	FHIRSpecimenCollectionMethod
Specimen.collection.bodySite	example	SNOMEDCTBodyStructures

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
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	SΣ	1..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Σ	1..1	CodeableConcept	Kind of material that forms the specimen Binding: hl7VS-specimenType (example): The type of the specimen.
subject	Σ	0..1	Reference(Patient | Group | Device | Substance | Location)	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	SΣ	0..1	dateTime	The time when specimen was received for processing
parent	S	0..*	Reference(Specimen)	Specimen from which this specimen originated
request		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	SΣ	0..1	Reference(US Pathology Related Practitioner Roles)	Who collected the specimen
collected[x]	SΣ	1..1	dateTime	Collection time
duration	Σ	0..1	Duration	How long it took to collect specimen
quantity		0..1	SimpleQuantity	The quantity of specimen collected
method	S	1..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 (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	S	1..*	BackboneElement	Direct container of specimen (tube/slide, etc.)
id		1..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	Σ	1..*	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	S	0..*	Annotation	Comments
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
Specimen.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
Specimen.status	required	SpecimenStatus
Specimen.type	example	Hl7VSSpecimenType
Specimen.collection.method	example	FHIRSpecimenCollectionMethod
Specimen.collection.bodySite	example	SNOMEDCTBodyStructures
Specimen.collection.fastingStatus[x]	extensible	Hl7VSRelevantClincialInformation
Specimen.processing.procedure	example	SpecimenProcessingProcedure
Specimen.container.type	example	SpecimenContainerType
Specimen.container.additive[x]	example	Hl7VSAdditivePreservative
Specimen.condition	extensible	Hl7VSSpecimenCondition

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from Specimen

Summary

Mandatory: 6 elements (2 nested mandatory elements)
Must-Support: 13 elements

Structures

This structure refers to these other structures:

• US Pathology Related Practitioner Roles (http://hl7.org/fhir/us/cancer-reporting/StructureDefinition/us-pathology-related-practitioner-role)

Other representations of profile: CSV, Excel, Schematron