Health eData 1 Sandbox
0.1.0 - CI Build

Health eData 1 Sandbox, published by HL7 International / Cross-Group Projects. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/argonautproject/USCDIV7/ and changes regularly. See the Directory of published versions

## Resource Profile: US Core Specimen Profile

Official URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-specimen | Version: 0.1.0
Active as of 2026-05-19 | Maturity Level: 3 | Computable Name: USCoreSpecimenProfile
Other Identifiers: OID:2.16.840.1.113883.4.642.40.2.42.64

The US Core Specimen Profile inherits from the FHIR Specimen resource; refer to it for scope and usage definitions. This profile sets minimum expectations for the Specimen resource to record, search, and fetch information about substances associated with a patient being sampled or tested (such as nasopharyngeal swab, whole blood, or serum). It specifies which core elements, extensions, vocabularies, and value sets SHALL be present and constrains how the elements are used. Providing the floor for standards development for specific use cases promotes interoperability and adoption.

Example Usage Scenarios:

The following are example usage scenarios for the US Core Specimen profile:

- Query for a patient's specimen
- [Record or update] a specimen for a patient

### Mandatory and Must Support Data Elements

The following data elements must always be present ([Mandatory] definition) or must be supported if the data is present in the sending system ([Must Support] definition). They are presented below in a simple human-readable explanation. Profile specific guidance and examples are provided as well. The [Formal Views] below provides the formal summary, definitions, and terminology requirements.

Each Specimen Must Have:

1. a specimen type code1

Each Specimen Must Support:

1. business identifier(s)2
2. an accession identifier2
3. a patient

Additional USCDI Requirements:

These [Additional USCDI Requirements] elements are not Mandatory or Must Support but are required for ONC Health IT certification testing and are included in the formal definition of the profile and the Specimen examples.

1. specimen collection method
2. specimen collection source site
3. specimen condition3

1,2,3 see guidance below

### Profile Specific Implementation Guidance

This section provides detailed implementation guidance for the US Core Profile to support implementation and certification.

- 1Since the binding is extensible when a code is unavailable, servers MAY use text.[§][CONF-0523]
- 1Although both `Specimen.identifier` and `Specimen.accessionIdentifier` are marked as Must Support, the Server system is not required to support both, but SHALL support at least one of these elements.[§][CONF-0524]
  - The Client application SHALL support both elements.[§][CONF-0525]
- 3The specimen condition is used by the laboratory to determine the acceptability of a specimen for the ordered test. An individual specimen condition may be acceptable for one test and not for another. The specimen condition is typically provided when the specimen does not meet the laboratory's criteria for acceptability, whether the test was performed or not. Examples include but are not limited to hemolyzed, clotted, container leaking, and missing patient names. This element may include information about the contents of the container, the container, and the label.
- In addition to Specimen search criteria, Clients can request Specimen resources be included with the Observation or DiagnosticReport resource query using the `_include` parameter.

### Liquid Script to Generate StructureDefinition All Nice N Pretty Like

{% include structure-table.md sd=sd source="differential" show_must_support=true show_uscdi=true %}

## USCoreSpecimenProfile — US Core Specimen Profile

The US Core Specimen Profile inherits from the FHIR Specimen resource; refer to it for scope and usage definitions. This profile sets minimum expectations for the Specimen resource to record, search, and fetch information about substances associated with a patient being sampled or tested (such as nasopharyngeal swab, whole blood, or serum). It specifies which core elements, extensions, vocabularies, and value sets SHALL be present and constrains how the elements are used. Providing the floor for standards development for specific use cases promotes interoperability and adoption.

- URL: `http://hl7.org/fhir/us/core/StructureDefinition/us-core-specimen`
- Version: 0.1.0
- Status: active
- Kind: resource
- Type: `Specimen`
- Base Definition: `http://hl7.org/fhir/StructureDefinition/Specimen`
- Derivation: constraint

### Elements (differential)

Element | Must Support | Add'l USCDI | Cardinality | Type | Description
--- | --- | --- | --- | --- | ---
`Specimen` |  |  | 0..* |  | Sample for analysis A sample to be used for analysis.
↳ `identifier` | ✅ |  | 0..* | `Identifier` | Specimen identifier Id for specimen.
↳ `accessionIdentifier` | ✅ |  | 0..1 | `Identifier` | Identifier assigned by the lab The identifier assigned by the lab when accessioning specimen(s). This is not necessarily the same as the specimen identifier, depending on local lab procedures.
↳ `type` | ✅ |  | 1..1 | `CodeableConcept` | Kind of material that forms the specimen The kind of material that forms the specimen. Binding: `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1099.54` (extensible)
↳ `subject` | ✅ |  | 0..1 | `Reference` target: http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient target: http://hl7.org/fhir/StructureDefinition/Group target: http://hl7.org/fhir/us/core/StructureDefinition/us-core-device target: http://hl7.org/fhir/StructureDefinition/Substance target: http://hl7.org/fhir/us/core/StructureDefinition/us-core-location | The patient where the specimen came from. 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` |  | ✅ | 0..1 | `BackboneElement` | Collection details Details concerning the specimen collection.
↳ `method` |  | ✅ | 0..1 | `CodeableConcept` | Specimen Collection Method A coded value specifying the technique that is used to perform the procedure. Binding: `http://hl7.org/fhir/ValueSet/specimen-collection-method` (preferred)
↳ `bodySite` |  | ✅ | 0..1 | `CodeableConcept` | Specimen Source Site Anatomical location from which the specimen was collected (if subject is a patient). This is the target site. This element is not used for environmental specimens. Binding: `http://hl7.org/fhir/ValueSet/body-site` (extensible)
↳ `condition` |  | ✅ | 0..* | `CodeableConcept` | Specimen condition A mode or state of being that describes the nature of the specimen. Binding: `http://hl7.org/fhir/us/core/ValueSet/us-core-specimen-condition` (extensible)

    ## USCoreSpecimenProfile — US Core Specimen Profile

    The US Core Specimen Profile inherits from the FHIR [Specimen](https://hl7.org/fhir/R4/specimen.html) resource; refer to it for scope and usage definitions. This profile sets minimum expectations for the Specimen resource to record, search, and fetch information about substances associated with a patient being sampled or tested (such as nasopharyngeal swab, whole blood,  or serum). It specifies which core elements, extensions, vocabularies, and value sets **SHALL** be present and constrains how the elements are used. Providing the floor for standards development for specific use cases promotes interoperability and adoption.

    - **URL:** `http://hl7.org/fhir/us/core/StructureDefinition/us-core-specimen`
    - **Version:** 0.1.0
    - **Status:** active
    - **Kind:** resource
    - **Type:** `Specimen`
    - **Base Definition:** `http://hl7.org/fhir/StructureDefinition/Specimen`
    - **Derivation:** constraint

    ### Elements (differential)

    | Element | Must Support | Add'l USCDI | Cardinality | Type | Description |
    |---|:---:|:---:|---|---|---|
    | `Specimen` |  |  | 0..* |  | **Sample for analysis**<br/>A sample to be used for analysis. |
    | <span style="padding-left: 1.5em;">↳</span> `identifier` | ✅ |  | 0..* | `Identifier` | **Specimen identifier**<br/>Id for specimen. |
    | <span style="padding-left: 1.5em;">↳</span> `accessionIdentifier` | ✅ |  | 0..1 | `Identifier` | **Identifier assigned by the lab**<br/>The identifier assigned by the lab when accessioning specimen(s). This is not necessarily the same as the specimen identifier, depending on local lab procedures. |
    | <span style="padding-left: 1.5em;">↳</span> `type` | ✅ |  | 1..1 | `CodeableConcept` | **Kind of material that forms the specimen**<br/>The kind of material that forms the specimen.<br/><span style="font-size: 0.85em;">**Binding:** `http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1099.54` (extensible)</span> |
    | <span style="padding-left: 1.5em;">↳</span> `subject` | ✅ |  | 0..1 | `Reference`<br/><span style="font-size: 0.85em;">target: http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient</span><br/><span style="font-size: 0.85em;">target: http://hl7.org/fhir/StructureDefinition/Group</span><br/><span style="font-size: 0.85em;">target: http://hl7.org/fhir/us/core/StructureDefinition/us-core-device</span><br/><span style="font-size: 0.85em;">target: http://hl7.org/fhir/StructureDefinition/Substance</span><br/><span style="font-size: 0.85em;">target: http://hl7.org/fhir/us/core/StructureDefinition/us-core-location</span> | **The patient where the specimen came from.**<br/>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. |
    | <span style="padding-left: 1.5em;">↳</span> `collection` |  | ✅ | 0..1 | `BackboneElement` | **Collection details**<br/>Details concerning the specimen collection. |
    | <span style="padding-left: 3.0em;">↳</span> `method` |  | ✅ | 0..1 | `CodeableConcept` | **Specimen Collection Method**<br/>A coded value specifying the technique that is used to perform the procedure.<br/><span style="font-size: 0.85em;">**Binding:** `http://hl7.org/fhir/ValueSet/specimen-collection-method` (preferred)</span> |
    | <span style="padding-left: 3.0em;">↳</span> `bodySite` |  | ✅ | 0..1 | `CodeableConcept` | **Specimen Source Site**<br/>Anatomical location from which the specimen was collected (if subject is a patient). This is the target site.  This element is not used for environmental specimens.<br/><span style="font-size: 0.85em;">**Binding:** `http://hl7.org/fhir/ValueSet/body-site` (extensible)</span> |
    | <span style="padding-left: 1.5em;">↳</span> `condition` |  | ✅ | 0..* | `CodeableConcept` | **Specimen condition**<br/>A mode or state of being that describes the nature of the specimen.<br/><span style="font-size: 0.85em;">**Binding:** `http://hl7.org/fhir/us/core/ValueSet/us-core-specimen-condition` (extensible)</span> |

Usages:

- Refer to this Profile: US Core Laboratory Result Observation Profile
- Examples for this Profile: Specimen/bone-marrow-aspirate, Specimen/serum-lipemic-venipuncture, Specimen/serum-venipuncture, Specimen/throat-swab... Show 3 more, Specimen/tissue-biopsy, Specimen/urine-catheter and Specimen/whole-blood-venipuncture
- CapabilityStatements using this Profile: US Core Client CapabilityStatement and US Core Server CapabilityStatement

You can also check for usages in the FHIR IG Statistics

### Formal Views of Profile Content

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

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

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Specimen |  | 0..* | 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 Σ | 0..* | Identifier | Specimen identifier
accessionIdentifier | S Σ | 0..1 | Identifier | Identifier assigned by the lab
status | ?!Σ | 0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen.
type | S Σ | 1..1 | CodeableConcept | Kind of material that forms the specimen Binding: Specimen type (extensible)
subject | S Σ | 0..1 | Reference(US Core Patient Profile(9.0.0-ballot) S | Group | US Core Device Profile | Substance | US Core Location Profile) | The patient where the specimen came from.
collection |  | 0..1 | BackboneElement | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Collection details
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
method |  | 0..1 | CodeableConcept | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Specimen Collection Method Binding: FHIRSpecimenCollectionMethod (preferred)
bodySite |  | 0..1 | CodeableConcept | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Specimen Source Site Binding: SNOMEDCTBodyStructures (extensible)
condition | Σ | 0..* | CodeableConcept | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Specimen condition Binding: US Core Specimen Condition (extensible)
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Specimen.status | Base | required | SpecimenStatus | 📍4.0.1 | FHIR Std.
Specimen.type | Base | extensible | Specimen type | 📦20240606 | VSAC v0.24
Specimen.collection.​method | Base | preferred | FHIR Specimen Collection Method | 📦4.0.1 | FHIR Std.
Specimen.collection.​bodySite | Base | extensible | SNOMED CT Body Structures | 📦4.0.1 | FHIR Std.
Specimen.condition | Base | extensible | US Core Specimen Condition | 📦9.0.0-ballot | US Core v9.0

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | Specimen | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | Specimen | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | Specimen | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5 | error | Specimen | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | Specimen | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`

This structure is derived from Specimen

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Specimen |  | 0..* | Specimen | Sample for analysis
identifier | S | 0..* | Identifier | Specimen identifier
accessionIdentifier | S | 0..1 | Identifier | Identifier assigned by the lab
type | S | 1..1 | CodeableConcept | Kind of material that forms the specimen Binding: Specimen type (extensible)
subject | S | 0..1 | Reference(US Core Patient Profile(9.0.0-ballot) S | Group | US Core Device Profile | Substance | US Core Location Profile) | The patient where the specimen came from.
collection |  | 0..1 | BackboneElement | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Collection details
method |  | 0..1 | CodeableConcept | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Specimen Collection Method Binding: FHIRSpecimenCollectionMethod (preferred)
bodySite |  | 0..1 | CodeableConcept | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Specimen Source Site Binding: SNOMEDCTBodyStructures (extensible)
condition |  | 0..* | CodeableConcept | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Specimen condition Binding: US Core Specimen Condition (extensible)
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
Specimen.type | Base | extensible | Specimen type | 📦20240606 | VSAC v0.24
Specimen.collection.​method | Base | preferred | FHIR Specimen Collection Method | 📦4.0.1 | FHIR Std.
Specimen.collection.​bodySite | Base | extensible | SNOMED CT Body Structures | 📦4.0.1 | FHIR Std.
Specimen.condition | Base | extensible | US Core Specimen Condition | 📦9.0.0-ballot | US Core v9.0

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 | S Σ | 0..* | Identifier | Specimen identifier
accessionIdentifier | S Σ | 0..1 | Identifier | Identifier assigned by the lab
status | ?!Σ | 0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen.
type | S Σ | 1..1 | CodeableConcept | Kind of material that forms the specimen Binding: Specimen type (extensible)
subject | S Σ | 0..1 | Reference(US Core Patient Profile(9.0.0-ballot) S | Group | US Core Device Profile | Substance | US Core Location Profile) | The patient where the specimen came from.
receivedTime | Σ | 0..1 | dateTime | The time when specimen was received for processing
parent |  | 0..* | Reference(Specimen) | Specimen from which this specimen originated
request |  | 0..* | Reference(ServiceRequest) | Why the specimen was collected
collection |  | 0..1 | BackboneElement | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Collection details
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
collector | Σ | 0..1 | Reference(Practitioner | PractitionerRole) | Who collected the specimen
collected[x] | Σ | 0..1 |  | Collection time
collectedDateTime |  |  | dateTime |
collectedPeriod |  |  | Period |
duration | Σ | 0..1 | Duration | How long it took to collect specimen
quantity |  | 0..1 | SimpleQuantity(4.0.1) | The quantity of specimen collected
method |  | 0..1 | CodeableConcept | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Specimen Collection Method Binding: FHIRSpecimenCollectionMethod (preferred)
bodySite |  | 0..1 | CodeableConcept | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Specimen Source Site Binding: SNOMEDCTBodyStructures (extensible)
fastingStatus[x] | Σ | 0..1 |  | Whether or how long patient abstained from food and/or drink Binding: v2 Relevant Clincial Information (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: v2 Additive (example): Substance added to specimen container.
additiveCodeableConcept |  |  | CodeableConcept |
additiveReference |  |  | Reference(Substance) |
condition | Σ | 0..* | CodeableConcept | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Specimen condition Binding: US Core Specimen Condition (extensible)
note |  | 0..* | Annotation | Comments
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Specimen.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std.
Specimen.status | Base | required | SpecimenStatus | 📍4.0.1 | FHIR Std.
Specimen.type | Base | extensible | Specimen type | 📦20240606 | VSAC v0.24
Specimen.collection.​method | Base | preferred | FHIR Specimen Collection Method | 📦4.0.1 | FHIR Std.
Specimen.collection.​bodySite | Base | extensible | SNOMED CT Body Structures | 📦4.0.1 | FHIR Std.
Specimen.collection.​fastingStatus[x] | Base | extensible | v2 Relevant Clincial Information | 📦2.9 | FHIR Std.
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 | v2 Additive | 📦2.9 | FHIR Std.
Specimen.condition | Base | extensible | US Core Specimen Condition | 📦9.0.0-ballot | US Core v9.0

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | Specimen | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | Specimen | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | Specimen | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5 | error | Specimen | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | Specimen | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`

This structure is derived from Specimen

Summary

Mandatory: 1 element
Must-Support: 4 elements

Structures

This structure refers to these other structures:

- US Core Patient Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient)
- US Core Device Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-device)
- US Core Location Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-location)

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
identifier | S Σ | 0..* | Identifier | Specimen identifier
accessionIdentifier | S Σ | 0..1 | Identifier | Identifier assigned by the lab
status | ?!Σ | 0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen.
type | S Σ | 1..1 | CodeableConcept | Kind of material that forms the specimen Binding: Specimen type (extensible)
subject | S Σ | 0..1 | Reference(US Core Patient Profile(9.0.0-ballot) S | Group | US Core Device Profile | Substance | US Core Location Profile) | The patient where the specimen came from.
collection |  | 0..1 | BackboneElement | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Collection details
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
method |  | 0..1 | CodeableConcept | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Specimen Collection Method Binding: FHIRSpecimenCollectionMethod (preferred)
bodySite |  | 0..1 | CodeableConcept | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Specimen Source Site Binding: SNOMEDCTBodyStructures (extensible)
condition | Σ | 0..* | CodeableConcept | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Specimen condition Binding: US Core Specimen Condition (extensible)
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Specimen.status | Base | required | SpecimenStatus | 📍4.0.1 | FHIR Std.
Specimen.type | Base | extensible | Specimen type | 📦20240606 | VSAC v0.24
Specimen.collection.​method | Base | preferred | FHIR Specimen Collection Method | 📦4.0.1 | FHIR Std.
Specimen.collection.​bodySite | Base | extensible | SNOMED CT Body Structures | 📦4.0.1 | FHIR Std.
Specimen.condition | Base | extensible | US Core Specimen Condition | 📦9.0.0-ballot | US Core v9.0

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | Specimen | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | Specimen | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | Specimen | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5 | error | Specimen | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | Specimen | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`

Differential View

This structure is derived from Specimen

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Specimen |  | 0..* | Specimen | Sample for analysis
identifier | S | 0..* | Identifier | Specimen identifier
accessionIdentifier | S | 0..1 | Identifier | Identifier assigned by the lab
type | S | 1..1 | CodeableConcept | Kind of material that forms the specimen Binding: Specimen type (extensible)
subject | S | 0..1 | Reference(US Core Patient Profile(9.0.0-ballot) S | Group | US Core Device Profile | Substance | US Core Location Profile) | The patient where the specimen came from.
collection |  | 0..1 | BackboneElement | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Collection details
method |  | 0..1 | CodeableConcept | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Specimen Collection Method Binding: FHIRSpecimenCollectionMethod (preferred)
bodySite |  | 0..1 | CodeableConcept | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Specimen Source Site Binding: SNOMEDCTBodyStructures (extensible)
condition |  | 0..* | CodeableConcept | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Specimen condition Binding: US Core Specimen Condition (extensible)
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
Specimen.type | Base | extensible | Specimen type | 📦20240606 | VSAC v0.24
Specimen.collection.​method | Base | preferred | FHIR Specimen Collection Method | 📦4.0.1 | FHIR Std.
Specimen.collection.​bodySite | Base | extensible | SNOMED CT Body Structures | 📦4.0.1 | FHIR Std.
Specimen.condition | Base | extensible | US Core Specimen Condition | 📦9.0.0-ballot | US Core v9.0

Snapshot View

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 | S Σ | 0..* | Identifier | Specimen identifier
accessionIdentifier | S Σ | 0..1 | Identifier | Identifier assigned by the lab
status | ?!Σ | 0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen.
type | S Σ | 1..1 | CodeableConcept | Kind of material that forms the specimen Binding: Specimen type (extensible)
subject | S Σ | 0..1 | Reference(US Core Patient Profile(9.0.0-ballot) S | Group | US Core Device Profile | Substance | US Core Location Profile) | The patient where the specimen came from.
receivedTime | Σ | 0..1 | dateTime | The time when specimen was received for processing
parent |  | 0..* | Reference(Specimen) | Specimen from which this specimen originated
request |  | 0..* | Reference(ServiceRequest) | Why the specimen was collected
collection |  | 0..1 | BackboneElement | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Collection details
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
collector | Σ | 0..1 | Reference(Practitioner | PractitionerRole) | Who collected the specimen
collected[x] | Σ | 0..1 |  | Collection time
collectedDateTime |  |  | dateTime |
collectedPeriod |  |  | Period |
duration | Σ | 0..1 | Duration | How long it took to collect specimen
quantity |  | 0..1 | SimpleQuantity(4.0.1) | The quantity of specimen collected
method |  | 0..1 | CodeableConcept | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Specimen Collection Method Binding: FHIRSpecimenCollectionMethod (preferred)
bodySite |  | 0..1 | CodeableConcept | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Specimen Source Site Binding: SNOMEDCTBodyStructures (extensible)
fastingStatus[x] | Σ | 0..1 |  | Whether or how long patient abstained from food and/or drink Binding: v2 Relevant Clincial Information (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: v2 Additive (example): Substance added to specimen container.
additiveCodeableConcept |  |  | CodeableConcept |
additiveReference |  |  | Reference(Substance) |
condition | Σ | 0..* | CodeableConcept | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Specimen condition Binding: US Core Specimen Condition (extensible)
note |  | 0..* | Annotation | Comments
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Specimen.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std.
Specimen.status | Base | required | SpecimenStatus | 📍4.0.1 | FHIR Std.
Specimen.type | Base | extensible | Specimen type | 📦20240606 | VSAC v0.24
Specimen.collection.​method | Base | preferred | FHIR Specimen Collection Method | 📦4.0.1 | FHIR Std.
Specimen.collection.​bodySite | Base | extensible | SNOMED CT Body Structures | 📦4.0.1 | FHIR Std.
Specimen.collection.​fastingStatus[x] | Base | extensible | v2 Relevant Clincial Information | 📦2.9 | FHIR Std.
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 | v2 Additive | 📦2.9 | FHIR Std.
Specimen.condition | Base | extensible | US Core Specimen Condition | 📦9.0.0-ballot | US Core v9.0

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | Specimen | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | Specimen | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | Specimen | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5 | error | Specimen | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | Specimen | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`

This structure is derived from Specimen

Summary

Mandatory: 1 element
Must-Support: 4 elements

Structures

This structure refers to these other structures:

- US Core Patient Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient)
- US Core Device Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-device)
- US Core Location Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-location)

Maturity: 3

Other representations of profile: CSV, Excel, Schematron