Athena Core Implementation Guide - Local Development build (v4.2.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

• Content
• Detailed Descriptions
• JSON

Resource Profile: athenahealth Specimen

The specimen resource covers substances used for diagnostic and environmental testing.

To record the information of who collected the sample and lab result. ]]The specimen resource covers substances used for diagnostic and environmental testing. (i.e. GET [fhir base]/Specimen/[id]/ where [id] is a Inpatient orderId or practice-level Document ID’) to obtain a detailed set of FHIR resources.

Usage:

• This Resource Profile is not used by any profiles in this Implementation Guide

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
id		1..1	id	Logical id of this artifact
meta
lastUpdated		0..1	instant	When the resource version last changed
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:ahChartSharingGroup		0..1	Reference(Organization)	athenahealth Chart Sharing Group URL: https://fhir.athena.io/StructureDefinition/ah-chart-sharing-group
extension:ahPractice		1..1	Reference(Organization)	athenahealth Practice URL: https://fhir.athena.io/StructureDefinition/ah-practice
type		1..1	CodeableConcept	Kind of material that forms the specimen
subject		0..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		0..1	Reference(Practitioner)	Who collected the specimen
Slices for collected[x]		0..1	dateTime, Period	Collection time Slice: Unordered, Open by type:$this
collected[x]:collectedDateTime		0..1	dateTime	Collection time
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Specimen		0..*	Specimen	Sample for analysis dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
id	Σ	1..1	id	Logical id of this artifact
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:ahChartSharingGroup		0..1	Reference(Organization)	athenahealth Chart Sharing Group URL: https://fhir.athena.io/StructureDefinition/ah-chart-sharing-group ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:ahPractice		1..1	Reference(Organization)	athenahealth Practice URL: https://fhir.athena.io/StructureDefinition/ah-practice ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
status	?!Σ	0..1	code	available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. ele-1: All FHIR elements must have a @value or children
type	Σ	1..1	CodeableConcept	Kind of material that forms the specimen Binding: hl7VS-specimenType (example): The type of the specimen. ele-1: All FHIR elements must have a @value or children
subject	Σ	0..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 ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Specimen.status	required	SpecimenStatus http://hl7.org/fhir/ValueSet/specimen-status|4.0.1 from the FHIR Standard
Specimen.type	example	Hl7VSSpecimenType http://terminology.hl7.org/ValueSet/v2-0487

Name	Flags	Card.	Type	Description & Constraints
Specimen		0..*	Specimen	Sample for analysis
id	Σ	1..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
versionId	Σ	0..1	id	Version specific identifier
lastUpdated	Σ	0..1	instant	When the resource version last changed
source	Σ	0..1	uri	Identifies where the resource comes from
profile	Σ	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
security	Σ	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag	Σ	0..*	Coding	Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
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
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:ahChartSharingGroup		0..1	Reference(Organization)	athenahealth Chart Sharing Group URL: https://fhir.athena.io/StructureDefinition/ah-chart-sharing-group
extension:ahPractice		1..1	Reference(Organization)	athenahealth Practice URL: https://fhir.athena.io/StructureDefinition/ah-practice
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	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	Σ	1..1	CodeableConcept	Kind of material that forms the specimen Binding: hl7VS-specimenType (example): The type of the specimen.
subject	Σ	0..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)	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)	Who collected the specimen
Slices for collected[x]	Σ	0..1		Collection time Slice: Unordered, Open by type:$this
collectedDateTime			dateTime
collectedPeriod			Period
collected[x]:collectedDateTime	Σ	0..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		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	Conformance	ValueSet	URI
Specimen.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
Specimen.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Specimen.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Specimen.status	required	SpecimenStatus http://hl7.org/fhir/ValueSet/specimen-status|4.0.1 from the FHIR Standard
Specimen.type	example	Hl7VSSpecimenType http://terminology.hl7.org/ValueSet/v2-0487
Specimen.collection.method	example	FHIRSpecimenCollectionMethod http://hl7.org/fhir/ValueSet/specimen-collection-method from the FHIR Standard
Specimen.collection.bodySite	example	SNOMEDCTBodyStructures http://hl7.org/fhir/ValueSet/body-site from the FHIR Standard
Specimen.collection.fastingStatus[x]	extensible	Hl7VSRelevantClincialInformation http://terminology.hl7.org/ValueSet/v2-0916
Specimen.processing.procedure	example	SpecimenProcessingProcedure http://hl7.org/fhir/ValueSet/specimen-processing-procedure from the FHIR Standard
Specimen.container.type	example	SpecimenContainerType http://hl7.org/fhir/ValueSet/specimen-container-type from the FHIR Standard
Specimen.container.additive[x]	example	Hl7VSAdditivePreservative http://terminology.hl7.org/ValueSet/v2-0371
Specimen.condition	extensible	Hl7VSSpecimenCondition http://terminology.hl7.org/ValueSet/v2-0493

This structure is derived from Specimen

Summary

Mandatory: 4 elements

Extensions

This structure refers to these extensions:

• https://fhir.athena.io/StructureDefinition/ah-chart-sharing-group
• https://fhir.athena.io/StructureDefinition/ah-practice

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Specimen.collection.collected[x]

Differential View

This structure is derived from Specimen

Name	Flags	Card.	Type	Description & Constraints
Specimen		0..*	Specimen	Sample for analysis
id		1..1	id	Logical id of this artifact
meta
lastUpdated		0..1	instant	When the resource version last changed
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:ahChartSharingGroup		0..1	Reference(Organization)	athenahealth Chart Sharing Group URL: https://fhir.athena.io/StructureDefinition/ah-chart-sharing-group
extension:ahPractice		1..1	Reference(Organization)	athenahealth Practice URL: https://fhir.athena.io/StructureDefinition/ah-practice
type		1..1	CodeableConcept	Kind of material that forms the specimen
subject		0..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		0..1	Reference(Practitioner)	Who collected the specimen
Slices for collected[x]		0..1	dateTime, Period	Collection time Slice: Unordered, Open by type:$this
collected[x]:collectedDateTime		0..1	dateTime	Collection time
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Specimen		0..*	Specimen	Sample for analysis dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
id	Σ	1..1	id	Logical id of this artifact
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:ahChartSharingGroup		0..1	Reference(Organization)	athenahealth Chart Sharing Group URL: https://fhir.athena.io/StructureDefinition/ah-chart-sharing-group ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension:ahPractice		1..1	Reference(Organization)	athenahealth Practice URL: https://fhir.athena.io/StructureDefinition/ah-practice ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
status	?!Σ	0..1	code	available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. ele-1: All FHIR elements must have a @value or children
type	Σ	1..1	CodeableConcept	Kind of material that forms the specimen Binding: hl7VS-specimenType (example): The type of the specimen. ele-1: All FHIR elements must have a @value or children
subject	Σ	0..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 ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Specimen.status	required	SpecimenStatus http://hl7.org/fhir/ValueSet/specimen-status|4.0.1 from the FHIR Standard
Specimen.type	example	Hl7VSSpecimenType http://terminology.hl7.org/ValueSet/v2-0487

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Specimen		0..*	Specimen	Sample for analysis
id	Σ	1..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
versionId	Σ	0..1	id	Version specific identifier
lastUpdated	Σ	0..1	instant	When the resource version last changed
source	Σ	0..1	uri	Identifies where the resource comes from
profile	Σ	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
security	Σ	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag	Σ	0..*	Coding	Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
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
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:ahChartSharingGroup		0..1	Reference(Organization)	athenahealth Chart Sharing Group URL: https://fhir.athena.io/StructureDefinition/ah-chart-sharing-group
extension:ahPractice		1..1	Reference(Organization)	athenahealth Practice URL: https://fhir.athena.io/StructureDefinition/ah-practice
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	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	Σ	1..1	CodeableConcept	Kind of material that forms the specimen Binding: hl7VS-specimenType (example): The type of the specimen.
subject	Σ	0..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)	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)	Who collected the specimen
Slices for collected[x]	Σ	0..1		Collection time Slice: Unordered, Open by type:$this
collectedDateTime			dateTime
collectedPeriod			Period
collected[x]:collectedDateTime	Σ	0..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		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	Conformance	ValueSet	URI
Specimen.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
Specimen.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Specimen.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Specimen.status	required	SpecimenStatus http://hl7.org/fhir/ValueSet/specimen-status|4.0.1 from the FHIR Standard
Specimen.type	example	Hl7VSSpecimenType http://terminology.hl7.org/ValueSet/v2-0487
Specimen.collection.method	example	FHIRSpecimenCollectionMethod http://hl7.org/fhir/ValueSet/specimen-collection-method from the FHIR Standard
Specimen.collection.bodySite	example	SNOMEDCTBodyStructures http://hl7.org/fhir/ValueSet/body-site from the FHIR Standard
Specimen.collection.fastingStatus[x]	extensible	Hl7VSRelevantClincialInformation http://terminology.hl7.org/ValueSet/v2-0916
Specimen.processing.procedure	example	SpecimenProcessingProcedure http://hl7.org/fhir/ValueSet/specimen-processing-procedure from the FHIR Standard
Specimen.container.type	example	SpecimenContainerType http://hl7.org/fhir/ValueSet/specimen-container-type from the FHIR Standard
Specimen.container.additive[x]	example	Hl7VSAdditivePreservative http://terminology.hl7.org/ValueSet/v2-0371
Specimen.condition	extensible	Hl7VSSpecimenCondition http://terminology.hl7.org/ValueSet/v2-0493

This structure is derived from Specimen

Summary

Mandatory: 4 elements

Extensions

This structure refers to these extensions:

• https://fhir.athena.io/StructureDefinition/ah-chart-sharing-group
• https://fhir.athena.io/StructureDefinition/ah-practice

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Specimen.collection.collected[x]

​Other representations of profile: CSV, Excel, Schematron