Common Data Models Harmonization
1.0.0 - STU 1 Publication

Publication Build: This will be filled in by the publication tooling

## Resource Profile: CdmhSpecimen

Defining URL: | http://hl7.org/fhir/us/cdmh/StructureDefinition/cdmh-specimen
Version: | 1.0.0
Name: | CdmhSpecimen
Title: | CDMH Specimen
Status: | Draft as of 9/1/19
Definition: | This is the Specimen Resource profile for the IG.
Publisher: | HL7 International - Biomedical Research and Regulation Work Group
Copyright: | Used by permission of HL7, all rights reserved Creative Commons License
Source Resource: | XML / JSON / Turtle

The official URL for this profile is:

    http://hl7.org/fhir/us/cdmh/StructureDefinition/cdmh-specimen

### Formal Views of Profile Content

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

- Text Summary
- Differential Table
- Snapshot Table
- Snapshot Table (Must Support)
- All

This structure is derived from Specimen

Summary

Must-Support: 7 elements

Structures

This structure refers to these other structures:

- CDMH Patient (http://hl7.org/fhir/us/cdmh/StructureDefinition/cdmh-patient)

This structure is derived from Specimen

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Specimen |  | 0..* | Specimen | CDMH Specimen
identifier | S | 0..* | Identifier | External Identifier
type | S | 0..1 | CodeableConcept | Kind of material that forms the specimen
subject | S | 0..1 | Reference(CDMH Patient) | Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device
collection | S | 0..1 | BackboneElement | Collection details
collectedDateTime | S | 0..1 | dateTime | Collection time
quantity | S | 0..1 | SimpleQuantity | The quantity of specimen collected
bodySite | S | 0..1 | CodeableConcept | Anatomical collection site
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Specimen |  | 0..* | Specimen | CDMH Specimen
id | Σ | 0..1 | string | 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) Max Binding: AllLanguages: A human language.
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation
contained |  | 0..* | Resource | Contained, inline Resources
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | S Σ | 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 | S Σ | 0..1 | CodeableConcept | Kind of material that forms the specimen Binding: hl7VS-specimenType (example): The type of the specimen.
subject | S Σ | 0..1 | Reference(CDMH Patient) | Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device
receivedTime | Σ | 0..1 | dateTime | The time when specimen was received for processing
parent |  | 0..* | Reference(Specimen) | Specimen from which this specimen originated
request |  | 0..* | Reference(ServiceRequest) | Why the specimen was collected
collection | S | 0..1 | BackboneElement | Collection details
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
collector | Σ | 0..1 | Reference(Practitioner | PractitionerRole) | Who collected the specimen
Slices for collected[x] | Σ | 0..1 | dateTime | Collection time Slice: Unordered, Closed by type:$this
collected[x]:collectedDateTime | S Σ | 0..1 | dateTime | Collection time
duration | Σ | 0..1 | Duration | How long it took to collect specimen
quantity | S | 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 | S | 0..1 | CodeableConcept | Anatomical collection site Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
fastingStatus[x] | Σ | 0..1 |  | Whether or how long patient abstained from food and/or drink Binding: hl7VS-relevantClincialInformation (extensible): Codes describing the fasting status of the patient.
fastingStatusCodeableConcept |  |  | CodeableConcept |
fastingStatusDuration |  |  | Duration |
processing |  | 0..* | BackboneElement | Processing and processing step details
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
description |  | 0..1 | string | Textual description of procedure
procedure |  | 0..1 | CodeableConcept | Indicates the treatment step applied to the specimen Binding: SpecimenProcessingProcedure (example): Type indicating the technique used to process the specimen.
additive |  | 0..* | Reference(Substance) | Material used in the processing step
time[x] |  | 0..1 |  | Date and time of specimen processing
timeDateTime |  |  | dateTime |
timePeriod |  |  | Period |
container |  | 0..* | BackboneElement | Direct container of specimen (tube/slide, etc.)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
identifier | Σ | 0..* | Identifier | Id for the container
description |  | 0..1 | string | Textual description of the container
type |  | 0..1 | CodeableConcept | Kind of container directly associated with specimen Binding: SpecimenContainerType (example): Type of specimen container.
capacity |  | 0..1 | SimpleQuantity | Container volume or size
specimenQuantity |  | 0..1 | SimpleQuantity | Quantity of specimen within container
additive[x] |  | 0..1 |  | Additive associated with container Binding: hl7VS-additivePreservative (example): Substance added to specimen container.
additiveCodeableConcept |  |  | CodeableConcept |
additiveReference |  |  | Reference(Substance) |
condition | Σ | 0..* | CodeableConcept | State of the specimen Binding: hl7VS-specimenCondition (extensible): Codes describing the state of the specimen.
note |  | 0..* | Annotation | Comments
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Specimen |  | 0..* | Specimen | CDMH Specimen
identifier | Σ | 0..* | Identifier | External Identifier
type | Σ | 0..1 | CodeableConcept | Kind of material that forms the specimen Binding: hl7VS-specimenType (example): The type of the specimen.
subject | Σ | 0..1 | Reference(CDMH Patient) | Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device
collection |  | 0..1 | BackboneElement | Collection details
collected[x]:collectedDateTime | Σ | 0..1 | dateTime | Collection time
quantity |  | 0..1 | SimpleQuantity | The quantity of specimen collected
bodySite |  | 0..1 | CodeableConcept | Anatomical collection site Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
Documentation for this format

This structure is derived from Specimen

Summary

Must-Support: 7 elements

Structures

This structure refers to these other structures:

- CDMH Patient (http://hl7.org/fhir/us/cdmh/StructureDefinition/cdmh-patient)

Differential View

This structure is derived from Specimen

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Specimen |  | 0..* | Specimen | CDMH Specimen
identifier | S | 0..* | Identifier | External Identifier
type | S | 0..1 | CodeableConcept | Kind of material that forms the specimen
subject | S | 0..1 | Reference(CDMH Patient) | Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device
collection | S | 0..1 | BackboneElement | Collection details
collectedDateTime | S | 0..1 | dateTime | Collection time
quantity | S | 0..1 | SimpleQuantity | The quantity of specimen collected
bodySite | S | 0..1 | CodeableConcept | Anatomical collection site
Documentation for this format

Snapshot View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Specimen |  | 0..* | Specimen | CDMH Specimen
id | Σ | 0..1 | string | 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) Max Binding: AllLanguages: A human language.
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation
contained |  | 0..* | Resource | Contained, inline Resources
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | S Σ | 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 | S Σ | 0..1 | CodeableConcept | Kind of material that forms the specimen Binding: hl7VS-specimenType (example): The type of the specimen.
subject | S Σ | 0..1 | Reference(CDMH Patient) | Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device
receivedTime | Σ | 0..1 | dateTime | The time when specimen was received for processing
parent |  | 0..* | Reference(Specimen) | Specimen from which this specimen originated
request |  | 0..* | Reference(ServiceRequest) | Why the specimen was collected
collection | S | 0..1 | BackboneElement | Collection details
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
collector | Σ | 0..1 | Reference(Practitioner | PractitionerRole) | Who collected the specimen
Slices for collected[x] | Σ | 0..1 | dateTime | Collection time Slice: Unordered, Closed by type:$this
collected[x]:collectedDateTime | S Σ | 0..1 | dateTime | Collection time
duration | Σ | 0..1 | Duration | How long it took to collect specimen
quantity | S | 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 | S | 0..1 | CodeableConcept | Anatomical collection site Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
fastingStatus[x] | Σ | 0..1 |  | Whether or how long patient abstained from food and/or drink Binding: hl7VS-relevantClincialInformation (extensible): Codes describing the fasting status of the patient.
fastingStatusCodeableConcept |  |  | CodeableConcept |
fastingStatusDuration |  |  | Duration |
processing |  | 0..* | BackboneElement | Processing and processing step details
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
description |  | 0..1 | string | Textual description of procedure
procedure |  | 0..1 | CodeableConcept | Indicates the treatment step applied to the specimen Binding: SpecimenProcessingProcedure (example): Type indicating the technique used to process the specimen.
additive |  | 0..* | Reference(Substance) | Material used in the processing step
time[x] |  | 0..1 |  | Date and time of specimen processing
timeDateTime |  |  | dateTime |
timePeriod |  |  | Period |
container |  | 0..* | BackboneElement | Direct container of specimen (tube/slide, etc.)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
identifier | Σ | 0..* | Identifier | Id for the container
description |  | 0..1 | string | Textual description of the container
type |  | 0..1 | CodeableConcept | Kind of container directly associated with specimen Binding: SpecimenContainerType (example): Type of specimen container.
capacity |  | 0..1 | SimpleQuantity | Container volume or size
specimenQuantity |  | 0..1 | SimpleQuantity | Quantity of specimen within container
additive[x] |  | 0..1 |  | Additive associated with container Binding: hl7VS-additivePreservative (example): Substance added to specimen container.
additiveCodeableConcept |  |  | CodeableConcept |
additiveReference |  |  | Reference(Substance) |
condition | Σ | 0..* | CodeableConcept | State of the specimen Binding: hl7VS-specimenCondition (extensible): Codes describing the state of the specimen.
note |  | 0..* | Annotation | Comments
Documentation for this format

Other representations of profile: CSV, Excel, Schematron

#### Terminology Bindings

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

#### Constraints

Id | Path | Details | Requirements
dom-2 | Specimen | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() |
dom-3 | 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 | 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 | Specimen | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() |
dom-6 | Specimen | A resource should have narrative for robust management : text.`div`.exists() |
ele-1 | Specimen.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | Specimen.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | Specimen.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | Specimen.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | Specimen.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | Specimen.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
ele-1 | Specimen.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | Specimen.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
ele-1 | Specimen.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | Specimen.accessionIdentifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | Specimen.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | Specimen.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | Specimen.subject | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | Specimen.receivedTime | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | Specimen.parent | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | Specimen.request | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | Specimen.collection | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | Specimen.collection.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | Specimen.collection.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
ele-1 | Specimen.collection.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | Specimen.collection.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
ele-1 | Specimen.collection.collector | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | Specimen.collection.collected[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | Specimen.collection.collected[x]:collectedDateTime | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | Specimen.collection.duration | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | Specimen.collection.quantity | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | Specimen.collection.method | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | Specimen.collection.bodySite | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | Specimen.collection.fastingStatus[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | Specimen.processing | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | Specimen.processing.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | Specimen.processing.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
ele-1 | Specimen.processing.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | Specimen.processing.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
ele-1 | Specimen.processing.description | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | Specimen.processing.procedure | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | Specimen.processing.additive | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | Specimen.processing.time[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | Specimen.container | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | Specimen.container.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | Specimen.container.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
ele-1 | Specimen.container.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | Specimen.container.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
ele-1 | Specimen.container.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | Specimen.container.description | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | Specimen.container.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | Specimen.container.capacity | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | Specimen.container.specimenQuantity | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | Specimen.container.additive[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | Specimen.condition | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | Specimen.note | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |