Name	Flags	Card.	Type	Description & Constraints
Specimen		0..*	Specimen	Sample for analysis
Slices for identifier		1..*	Identifier	External Identifier Slice: Unordered, Open At End by pattern:system
identifier:USID		1..1	Identifier	External Identifier
type
coding
system		0..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
code		0..1	code	Symbol in syntax defined by the system Required Pattern: USID
system		1..1	uri	The namespace for the identifier value Fixed Value: http://openhie.org/fhir/hiv-cbs/identifier/specimen-id
value		1..1	string	The value that is unique
type		1..1	CodeableConcept	Kind of material that forms the specimen Binding: Specimen Type Used In Viral Load testing (required)
subject		1..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
collection
collected[x]		1..1	dateTime	Collection time Slice: Unordered, Open by type:$this
collectedDateTime		1..1	dateTime	Collection time
note		0..1	Annotation	Comments
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet
Specimen.type	required	VSSpecimenType

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
Slices for identifier	Σ	1..*	Identifier	External Identifier Slice: Unordered, Open At End by pattern:system
identifier:USID	Σ	1..1	Identifier	External Identifier
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: http://openhie.org/fhir/hiv-cbs/identifier/specimen-id
value	Σ	1..1	string	The value that is unique Example General: 123456
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: Specimen Type Used In Viral Load testing (required)
subject	Σ	1..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
note		0..1	Annotation	Comments
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
Specimen.identifier:USID.use	required	IdentifierUse
Specimen.status	required	SpecimenStatus
Specimen.type	required	VSSpecimenType

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
Slices for identifier	Σ	1..*	Identifier	External Identifier Slice: Unordered, Open At End by pattern:system
identifier:USID	Σ	1..1	Identifier	External Identifier
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	Σ	0..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.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system Required Pattern: USID
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	Σ	1..1	uri	The namespace for the identifier value Fixed Value: http://openhie.org/fhir/hiv-cbs/identifier/specimen-id
value	Σ	1..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)
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: Specimen Type Used In Viral Load testing (required)
subject	Σ	1..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	Σ	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
Slices for collected[x]	Σ	1..1	dateTime	Collection time Slice: Unordered, Closed by type:$this
collected[x]:collectedDateTime	Σ	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		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..1	Annotation	Comments
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
Specimen.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
Specimen.identifier:USID.use	required	IdentifierUse
Specimen.identifier:USID.type	extensible	Identifier Type Codes
Specimen.status	required	SpecimenStatus
Specimen.type	required	VSSpecimenType
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()

Summary

Mandatory: 6 elements (2 nested mandatory elements)
Fixed Value: 1 element

Slices

This structure defines the following Slices:

• The element Specimen.identifier is sliced based on the value of pattern:system (Open at End)
• The element Specimen.collection.collected[x] is sliced based on the value of type:$this

Name	Flags	Card.	Type	Description & Constraints
Specimen		0..*	Specimen	Sample for analysis
Slices for identifier		1..*	Identifier	External Identifier Slice: Unordered, Open At End by pattern:system
identifier:USID		1..1	Identifier	External Identifier
type
coding
system		0..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
code		0..1	code	Symbol in syntax defined by the system Required Pattern: USID
system		1..1	uri	The namespace for the identifier value Fixed Value: http://openhie.org/fhir/hiv-cbs/identifier/specimen-id
value		1..1	string	The value that is unique
type		1..1	CodeableConcept	Kind of material that forms the specimen Binding: Specimen Type Used In Viral Load testing (required)
subject		1..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
collection
collected[x]		1..1	dateTime	Collection time Slice: Unordered, Open by type:$this
collectedDateTime		1..1	dateTime	Collection time
note		0..1	Annotation	Comments
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet
Specimen.type	required	VSSpecimenType

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
Slices for identifier	Σ	1..*	Identifier	External Identifier Slice: Unordered, Open At End by pattern:system
identifier:USID	Σ	1..1	Identifier	External Identifier
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: http://openhie.org/fhir/hiv-cbs/identifier/specimen-id
value	Σ	1..1	string	The value that is unique Example General: 123456
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: Specimen Type Used In Viral Load testing (required)
subject	Σ	1..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
note		0..1	Annotation	Comments
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
Specimen.identifier:USID.use	required	IdentifierUse
Specimen.status	required	SpecimenStatus
Specimen.type	required	VSSpecimenType

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
Slices for identifier	Σ	1..*	Identifier	External Identifier Slice: Unordered, Open At End by pattern:system
identifier:USID	Σ	1..1	Identifier	External Identifier
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	Σ	0..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.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system Required Pattern: USID
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	Σ	1..1	uri	The namespace for the identifier value Fixed Value: http://openhie.org/fhir/hiv-cbs/identifier/specimen-id
value	Σ	1..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)
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: Specimen Type Used In Viral Load testing (required)
subject	Σ	1..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	Σ	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
Slices for collected[x]	Σ	1..1	dateTime	Collection time Slice: Unordered, Closed by type:$this
collected[x]:collectedDateTime	Σ	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		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..1	Annotation	Comments
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
Specimen.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
Specimen.identifier:USID.use	required	IdentifierUse
Specimen.identifier:USID.type	extensible	Identifier Type Codes
Specimen.status	required	SpecimenStatus
Specimen.type	required	VSSpecimenType
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()

Summary

Mandatory: 6 elements (2 nested mandatory elements)
Fixed Value: 1 element

Slices

This structure defines the following Slices:

• The element Specimen.identifier is sliced based on the value of pattern:system (Open at End)
• The element Specimen.collection.collected[x] is sliced based on the value of type:$this