US Public Health Profiles Library, published by HL7 International / Public Health. 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-us-ph-library/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-specimen | Version: 2.0.0 | |||
| Standards status: Trial-use Active as of 2025-10-23 | Maturity Level: 3 | Computable Name: USPublicHealthSpecimen | ||
| Other Identifiers: OID:2.16.840.1.113883.4.642.40.58.42.69 | ||||
This Specimen profile represents “substances being sampled or tested. (e.g., nasopharyngeal swab, whole blood, serum, urine, wound swab)” associated with a patient related to a public health event.
It is based on the US Core Specimen Profile profile and further constrains it as follows:
| Use Case | Data Class | Data Element Name |
|---|---|---|
| Case Reporting | Laboratory | Specimen Collection Date/Time |
| Case Reporting | Laboratory | Specimen Identifier |
| Case Reporting | Laboratory | Specimen Source Site |
| Case Reporting | Laboratory | Specimen Type |
Usages:
You can also check for usages in the FHIR IG Statistics
Description Differentials, Snapshots, and other representations.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  Specimen |
0..* | USCoreSpecimenProfile(6.1.0) | US Public Health Specimen Profile | |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 |
 identifier |
SΣ | 0..* | Identifier | (USCDI+) Specimen Identifier |
| accessionIdentifier |
SΣ | 0..1 | Identifier | (USCDI+) Specimen Identifier |
| 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 | (USCDI+) Specimen Type Binding: SpecimenType (20240606)  (extensible) |
 subject |
SΣ | 0..1 | Reference(US Public Health Patient(2.0.0) | US Core Patient Profile(6.1.0)) | (USCDI) The patient where the specimen came from. |
 collection |
0..1 | BackboneElement | Collection details | |
 modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 |
  collected[x] |
SΣ | 0..1 | (USCDI+) Specimen Collection Date/Time | |
 collectedDateTime |
dateTime | |||
 collectedPeriod |
Period | |||
| bodySite |
S | 0..1 | CodeableConcept | (USCDI+) Specimen Source Site Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. |
| Documentation for this format | ||||
| 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.23 |
| Specimen.collection.bodySite | Base | example | SNOMED CT Body Structures | 📍4.0.1 | FHIR Std. |
| 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 | Specimen.implicitRules, Specimen.modifierExtension, Specimen.identifier, Specimen.accessionIdentifier, Specimen.status, Specimen.type, Specimen.subject, Specimen.collection, Specimen.collection.modifierExtension, Specimen.collection.collected[x], Specimen.collection.bodySite | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Specimen.modifierExtension, Specimen.collection.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Specimen |
0..* | USCoreSpecimenProfile(6.1.0) | US Public Health Specimen Profile | |
 identifier |
S | 0..* | Identifier | (USCDI+) Specimen Identifier |
| accessionIdentifier |
S | 0..1 | Identifier | (USCDI+) Specimen Identifier |
| type |
1..1 | CodeableConcept | (USCDI+) Specimen Type | |
| subject |
0..1 | Reference(US Public Health Patient(2.0.0) | US Core Patient Profile(6.1.0)) | (USCDI) The patient where the specimen came from. | |
| collection |
||||
| collected[x] |
S | 0..1 | dateTime, Period | (USCDI+) Specimen Collection Date/Time |
| bodySite |
S | 0..1 | CodeableConcept | (USCDI+) Specimen Source Site |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Specimen |
0..* | USCoreSpecimenProfile(6.1.0) | US Public Health Specimen Profile | |||||
| 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.
| |||||
| 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 Constraints: ext-1 | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
| identifier |
SΣ | 0..* | Identifier | (USCDI+) Specimen Identifier | ||||
| accessionIdentifier |
SΣ | 0..1 | Identifier | (USCDI+) Specimen Identifier | ||||
| 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 | (USCDI+) Specimen Type Binding: SpecimenType (20240606) (extensible) | ||||
| subject |
SΣ | 0..1 | Reference(US Public Health Patient(2.0.0) | US Core Patient Profile(6.1.0)) | (USCDI) 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 Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| collector |
Σ | 0..1 | Reference(Practitioner | PractitionerRole) | Who collected the specimen | ||||
| collected[x] |
SΣ | 0..1 | (USCDI+) Specimen Collection Date/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: FHIRSpecimenCollectionMethod (example): The technique that is used to perform the procedure. | |||||
| bodySite |
S | 0..1 | CodeableConcept | (USCDI+) Specimen Source 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: Hl7VSRelevantClincialInformation (2.0.0) (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 Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| 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 Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| 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: Hl7VSAdditivePreservative (2.0.0) (example): Substance added to specimen container. | ||||||
| additiveCodeableConcept |
CodeableConcept | |||||||
| additiveReference |
Reference(Substance) | |||||||
| condition |
Σ | 0..* | CodeableConcept | State of the specimen Binding: Hl7VSSpecimenCondition (2.0.0) (extensible): Codes describing the state of the specimen. | ||||
| note |
0..* | Annotation | Comments | |||||
| Documentation for this format | ||||||||
| 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.23 |
| Specimen.collection.method | Base | example | FHIR Specimen Collection Method | 📍4.0.1 | FHIR Std. |
| Specimen.collection.bodySite | Base | example | SNOMED CT Body Structures | 📍4.0.1 | FHIR Std. |
| 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 |
| 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 | Specimen.meta, Specimen.implicitRules, Specimen.language, Specimen.text, Specimen.extension, Specimen.modifierExtension, Specimen.identifier, Specimen.accessionIdentifier, Specimen.status, Specimen.type, Specimen.subject, Specimen.receivedTime, Specimen.parent, Specimen.request, Specimen.collection, Specimen.collection.extension, Specimen.collection.modifierExtension, Specimen.collection.collector, Specimen.collection.collected[x], Specimen.collection.duration, Specimen.collection.quantity, Specimen.collection.method, Specimen.collection.bodySite, Specimen.collection.fastingStatus[x], Specimen.processing, Specimen.processing.extension, Specimen.processing.modifierExtension, Specimen.processing.description, Specimen.processing.procedure, Specimen.processing.additive, Specimen.processing.time[x], Specimen.container, Specimen.container.extension, Specimen.container.modifierExtension, Specimen.container.identifier, Specimen.container.description, Specimen.container.type, Specimen.container.capacity, Specimen.container.specimenQuantity, Specimen.container.additive[x], Specimen.condition, Specimen.note | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Specimen.extension, Specimen.modifierExtension, Specimen.collection.extension, Specimen.collection.modifierExtension, Specimen.processing.extension, Specimen.processing.modifierExtension, Specimen.container.extension, Specimen.container.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Summary
Must-Support: 4 elements
Structures
This structure refers to these other structures:
Maturity: 3
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Specimen |
0..* | USCoreSpecimenProfile(6.1.0) | US Public Health Specimen Profile | |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 |
| identifier |
SΣ | 0..* | Identifier | (USCDI+) Specimen Identifier |
| accessionIdentifier |
SΣ | 0..1 | Identifier | (USCDI+) Specimen Identifier |
| 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 | (USCDI+) Specimen Type Binding: SpecimenType (20240606) (extensible) |
| subject |
SΣ | 0..1 | Reference(US Public Health Patient(2.0.0) | US Core Patient Profile(6.1.0)) | (USCDI) The patient where the specimen came from. |
| collection |
0..1 | BackboneElement | Collection details | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 |
| collected[x] |
SΣ | 0..1 | (USCDI+) Specimen Collection Date/Time | |
| collectedDateTime |
dateTime | |||
| collectedPeriod |
Period | |||
| bodySite |
S | 0..1 | CodeableConcept | (USCDI+) Specimen Source Site Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. |
| Documentation for this format | ||||
| 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.23 |
| Specimen.collection.bodySite | Base | example | SNOMED CT Body Structures | 📍4.0.1 | FHIR Std. |
| 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 | Specimen.implicitRules, Specimen.modifierExtension, Specimen.identifier, Specimen.accessionIdentifier, Specimen.status, Specimen.type, Specimen.subject, Specimen.collection, Specimen.collection.modifierExtension, Specimen.collection.collected[x], Specimen.collection.bodySite | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Specimen.modifierExtension, Specimen.collection.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Differential View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Specimen |
0..* | USCoreSpecimenProfile(6.1.0) | US Public Health Specimen Profile | |
| identifier |
S | 0..* | Identifier | (USCDI+) Specimen Identifier |
| accessionIdentifier |
S | 0..1 | Identifier | (USCDI+) Specimen Identifier |
| type |
1..1 | CodeableConcept | (USCDI+) Specimen Type | |
| subject |
0..1 | Reference(US Public Health Patient(2.0.0) | US Core Patient Profile(6.1.0)) | (USCDI) The patient where the specimen came from. | |
| collection |
||||
| collected[x] |
S | 0..1 | dateTime, Period | (USCDI+) Specimen Collection Date/Time |
| bodySite |
S | 0..1 | CodeableConcept | (USCDI+) Specimen Source Site |
| Documentation for this format | ||||
Snapshot ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Specimen |
0..* | USCoreSpecimenProfile(6.1.0) | US Public Health Specimen Profile | |||||
| 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.
| |||||
| 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 Constraints: ext-1 | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
| identifier |
SΣ | 0..* | Identifier | (USCDI+) Specimen Identifier | ||||
| accessionIdentifier |
SΣ | 0..1 | Identifier | (USCDI+) Specimen Identifier | ||||
| 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 | (USCDI+) Specimen Type Binding: SpecimenType (20240606) (extensible) | ||||
| subject |
SΣ | 0..1 | Reference(US Public Health Patient(2.0.0) | US Core Patient Profile(6.1.0)) | (USCDI) 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 Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| collector |
Σ | 0..1 | Reference(Practitioner | PractitionerRole) | Who collected the specimen | ||||
| collected[x] |
SΣ | 0..1 | (USCDI+) Specimen Collection Date/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: FHIRSpecimenCollectionMethod (example): The technique that is used to perform the procedure. | |||||
| bodySite |
S | 0..1 | CodeableConcept | (USCDI+) Specimen Source 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: Hl7VSRelevantClincialInformation (2.0.0) (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 Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| 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 Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| 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: Hl7VSAdditivePreservative (2.0.0) (example): Substance added to specimen container. | ||||||
| additiveCodeableConcept |
CodeableConcept | |||||||
| additiveReference |
Reference(Substance) | |||||||
| condition |
Σ | 0..* | CodeableConcept | State of the specimen Binding: Hl7VSSpecimenCondition (2.0.0) (extensible): Codes describing the state of the specimen. | ||||
| note |
0..* | Annotation | Comments | |||||
| Documentation for this format | ||||||||
| 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.23 |
| Specimen.collection.method | Base | example | FHIR Specimen Collection Method | 📍4.0.1 | FHIR Std. |
| Specimen.collection.bodySite | Base | example | SNOMED CT Body Structures | 📍4.0.1 | FHIR Std. |
| 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 |
| 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 | Specimen.meta, Specimen.implicitRules, Specimen.language, Specimen.text, Specimen.extension, Specimen.modifierExtension, Specimen.identifier, Specimen.accessionIdentifier, Specimen.status, Specimen.type, Specimen.subject, Specimen.receivedTime, Specimen.parent, Specimen.request, Specimen.collection, Specimen.collection.extension, Specimen.collection.modifierExtension, Specimen.collection.collector, Specimen.collection.collected[x], Specimen.collection.duration, Specimen.collection.quantity, Specimen.collection.method, Specimen.collection.bodySite, Specimen.collection.fastingStatus[x], Specimen.processing, Specimen.processing.extension, Specimen.processing.modifierExtension, Specimen.processing.description, Specimen.processing.procedure, Specimen.processing.additive, Specimen.processing.time[x], Specimen.container, Specimen.container.extension, Specimen.container.modifierExtension, Specimen.container.identifier, Specimen.container.description, Specimen.container.type, Specimen.container.capacity, Specimen.container.specimenQuantity, Specimen.container.additive[x], Specimen.condition, Specimen.note | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Specimen.extension, Specimen.modifierExtension, Specimen.collection.extension, Specimen.collection.modifierExtension, Specimen.processing.extension, Specimen.processing.modifierExtension, Specimen.container.extension, Specimen.container.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Summary
Must-Support: 4 elements
Structures
This structure refers to these other structures:
Maturity: 3
Other representations of profile: CSV, Excel, Schematron
IG © 2025+ HL7 International / Public Health.
Package hl7.fhir.us.ph-library#2.0.0 based on FHIR 4.0.1.
Generated 2025-10-23
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change
