International Patient Summary Implementation Guide
2.0.0 -

International Patient Summary Implementation Guide, published by HL7 International / Patient Care. This guide is not an authorized publication; it is the continuous build for version 2.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-ips/ and changes regularly. See the Directory of published versions

## Resource Profile: Specimen (IPS)

Official URL: http://hl7.org/fhir/uv/ips/StructureDefinition/Specimen-uv-ips | Version: 2.0.0
Standards status: Trial-use Active as of 2024-06-19 | Maturity Level: 3 | Computable Name: SpecimenUvIps

This profile constrains the Specimen resource to represent the characteristics of a biological specimens in the context of laboratory results integrated to a patient summary.

Usages:

- Use this Profile: Bundle (IPS)
- Refer to this Profile: DiagnosticReport (IPS) and Observation Results - Laboratory/Pathology (IPS)
- Examples for this Profile: Specimen/specimen-example-1
- CapabilityStatements using this Profile: IPS Server Capability Statement

You can also check for usages in the FHIR IG Statistics

### Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

- Key Elements Table
- Differential Table
- Snapshot Table
- Obligations
- Statistics/References
- All

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
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
status | ?!Σ | 0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen.
type | SO Σ | 1..1 | CodeableConceptIPS | Kind of material that forms the specimen Binding: Results Specimen Type - IPS (preferred)
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
subject | SO Σ | 0..1 | Reference(Patient (IPS)) | 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
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
reference | SO Σ C | 1..1 | string | Literal reference, Relative, internal or absolute URL
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
Documentation for this format

Name | Creator (IPS) | Consumer (IPS)
--- | --- | ---
Specimen |  |
type | SHALL:populate-if-known | SHALL:handle SHOULD:display
subject | SHALL:populate-if-known | SHALL:handle SHOULD:display
reference | SHALL:populate-if-known | SHALL:handle
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 | preferred | Results Specimen Type - IPS | 📦2.0.0 | This IG

#### 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()`

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Specimen |  |  | Specimen |
type | SO | 1..1 | CodeableConceptIPS | Kind of material that forms the specimen Binding: Results Specimen Type - IPS (preferred)
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
subject | SO | 0..1 | Reference(Patient (IPS)) | 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
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
reference | SO | 1..1 | string | Literal reference, Relative, internal or absolute URL
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
collection |  |  |  |
method |  | 0..1 | CodeableConcept | Technique used to perform collection Binding: Results Specimen Collection Method - IPS (preferred)
bodySite |  | 0..1 | CodeableConcept | Anatomical collection site Binding: Body Site - IPS (preferred)
Documentation for this format

Name | Creator (IPS) | Consumer (IPS)
--- | --- | ---
Specimen |  |
type | SHALL:populate-if-known | SHALL:handle SHOULD:display
subject | SHALL:populate-if-known | SHALL:handle SHOULD:display
reference | SHALL:populate-if-known | SHALL:handle
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
Specimen.type | Base | preferred | Results Specimen Type - IPS | 📦2.0.0 | This IG
Specimen.collection.​method | Base | preferred | Results Specimen Collection Method - IPS | 📦2.0.0 | This IG
Specimen.collection.​bodySite | Base | preferred | Body Site - IPS | 📦2.0.0 | This IG

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
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 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 | Σ | 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 | SO Σ | 1..1 | CodeableConceptIPS | Kind of material that forms the specimen Binding: Results Specimen Type - IPS (preferred)
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
subject | SO Σ | 0..1 | Reference(Patient (IPS)) | 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
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
reference | SO Σ C | 1..1 | string | Literal reference, Relative, internal or absolute URL
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
display | Σ | 0..1 | string | Text alternative for the resource
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(4.0.1) | The quantity of specimen collected
method |  | 0..1 | CodeableConcept | Technique used to perform collection Binding: Results Specimen Collection Method - IPS (preferred)
bodySite |  | 0..1 | CodeableConcept | Anatomical collection site Binding: Body Site - IPS (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) | 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(4.0.1) | Container volume or size
specimenQuantity |  | 0..1 | SimpleQuantity(4.0.1) | 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

Name | Creator (IPS) | Consumer (IPS)
--- | --- | ---
Specimen |  |
type | SHALL:populate-if-known | SHALL:handle SHOULD:display
subject | SHALL:populate-if-known | SHALL:handle SHOULD:display
reference | SHALL:populate-if-known | SHALL:handle
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 | preferred | Results Specimen Type - IPS | 📦2.0.0 | This IG
Specimen.subject.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std.
Specimen.collection.​method | Base | preferred | Results Specimen Collection Method - IPS | 📦2.0.0 | This IG
Specimen.collection.​bodySite | Base | preferred | Body Site - IPS | 📦2.0.0 | This IG
Specimen.collection.​fastingStatus[x] | Base | extensible | hl7VS-relevantClincialInformation | 📦2.0.0 | THO v6.5
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 | 📦2.0.0 | THO v6.5
Specimen.condition | Base | extensible | hl7VS-specimenCondition | 📦2.0.0 | THO v6.5

#### 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()`

Name | Creator (IPS) | Consumer (IPS)
--- | --- | ---
Specimen |  |
type | SHALL:populate-if-known | SHALL:handle SHOULD:display
subject | SHALL:populate-if-known | SHALL:handle SHOULD:display
reference | SHALL:populate-if-known | SHALL:handle
Documentation for this format

Summary

Mandatory: 1 element(1 nested mandatory element)
Must-Support: 3 elements

Structures

This structure refers to these other structures:

- Codeable Concept (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/CodeableConcept-uv-ips)
- Patient (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/Patient-uv-ips)

Maturity: 3

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
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
status | ?!Σ | 0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen.
type | SO Σ | 1..1 | CodeableConceptIPS | Kind of material that forms the specimen Binding: Results Specimen Type - IPS (preferred)
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
subject | SO Σ | 0..1 | Reference(Patient (IPS)) | 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
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
reference | SO Σ C | 1..1 | string | Literal reference, Relative, internal or absolute URL
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
Documentation for this format

Name | Creator (IPS) | Consumer (IPS)
--- | --- | ---
Specimen |  |
type | SHALL:populate-if-known | SHALL:handle SHOULD:display
subject | SHALL:populate-if-known | SHALL:handle SHOULD:display
reference | SHALL:populate-if-known | SHALL:handle
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 | preferred | Results Specimen Type - IPS | 📦2.0.0 | This IG

#### 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

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Specimen |  |  | Specimen |
type | SO | 1..1 | CodeableConceptIPS | Kind of material that forms the specimen Binding: Results Specimen Type - IPS (preferred)
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
subject | SO | 0..1 | Reference(Patient (IPS)) | 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
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
reference | SO | 1..1 | string | Literal reference, Relative, internal or absolute URL
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
collection |  |  |  |
method |  | 0..1 | CodeableConcept | Technique used to perform collection Binding: Results Specimen Collection Method - IPS (preferred)
bodySite |  | 0..1 | CodeableConcept | Anatomical collection site Binding: Body Site - IPS (preferred)
Documentation for this format

Name | Creator (IPS) | Consumer (IPS)
--- | --- | ---
Specimen |  |
type | SHALL:populate-if-known | SHALL:handle SHOULD:display
subject | SHALL:populate-if-known | SHALL:handle SHOULD:display
reference | SHALL:populate-if-known | SHALL:handle
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
Specimen.type | Base | preferred | Results Specimen Type - IPS | 📦2.0.0 | This IG
Specimen.collection.​method | Base | preferred | Results Specimen Collection Method - IPS | 📦2.0.0 | This IG
Specimen.collection.​bodySite | Base | preferred | Body Site - IPS | 📦2.0.0 | This IG

Snapshot ViewView

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
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 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 | Σ | 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 | SO Σ | 1..1 | CodeableConceptIPS | Kind of material that forms the specimen Binding: Results Specimen Type - IPS (preferred)
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
subject | SO Σ | 0..1 | Reference(Patient (IPS)) | 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
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
SHOULD:display | Consumer (IPS)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
reference | SO Σ C | 1..1 | string | Literal reference, Relative, internal or absolute URL
Obligations | Actor
SHALL:populate-if-known | Creator (IPS)
SHALL:handle | Consumer (IPS)
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
display | Σ | 0..1 | string | Text alternative for the resource
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(4.0.1) | The quantity of specimen collected
method |  | 0..1 | CodeableConcept | Technique used to perform collection Binding: Results Specimen Collection Method - IPS (preferred)
bodySite |  | 0..1 | CodeableConcept | Anatomical collection site Binding: Body Site - IPS (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) | 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(4.0.1) | Container volume or size
specimenQuantity |  | 0..1 | SimpleQuantity(4.0.1) | 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

Name | Creator (IPS) | Consumer (IPS)
--- | --- | ---
Specimen |  |
type | SHALL:populate-if-known | SHALL:handle SHOULD:display
subject | SHALL:populate-if-known | SHALL:handle SHOULD:display
reference | SHALL:populate-if-known | SHALL:handle
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 | preferred | Results Specimen Type - IPS | 📦2.0.0 | This IG
Specimen.subject.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std.
Specimen.collection.​method | Base | preferred | Results Specimen Collection Method - IPS | 📦2.0.0 | This IG
Specimen.collection.​bodySite | Base | preferred | Body Site - IPS | 📦2.0.0 | This IG
Specimen.collection.​fastingStatus[x] | Base | extensible | hl7VS-relevantClincialInformation | 📦2.0.0 | THO v6.5
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 | 📦2.0.0 | THO v6.5
Specimen.condition | Base | extensible | hl7VS-specimenCondition | 📦2.0.0 | THO v6.5

#### 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()`

Name | Creator (IPS) | Consumer (IPS)
--- | --- | ---
Specimen |  |
type | SHALL:populate-if-known | SHALL:handle SHOULD:display
subject | SHALL:populate-if-known | SHALL:handle SHOULD:display
reference | SHALL:populate-if-known | SHALL:handle
Documentation for this format

Summary

Mandatory: 1 element(1 nested mandatory element)
Must-Support: 3 elements

Structures

This structure refers to these other structures:

- Codeable Concept (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/CodeableConcept-uv-ips)
- Patient (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/Patient-uv-ips)

Maturity: 3

Other representations of profile: CSV, Excel, Schematron