NHS North West Genomics
0.2.1 - ci-build
NHS North West Genomics, published by NHS North West Genomics. This guide is not an authorized publication; it is the continuous build for version 0.2.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/nw-gmsa/nw-gmsa.github.com/ and changes regularly. See the Directory of published versions
| Official URL: https://fhir.nwgenomics.nhs.uk/StructureDefinition/Specimen | Version: 0.2.1 | |||
| Draft as of 2026-03-26 | Computable Name: Specimen | |||
| Keywords: Core, Diagnostics, Genomics | ||||
Diagnostic Workflow Specimen Collection
Reference:
Related:
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
0..* | Specimen | Sample for analysis | |||||||||||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||||||
![]() ![]() |
SΣ | 1..* | Identifier | External Identifier Slice: Unordered, Open by value:type | ||||||||||||
![]() ![]() ![]() |
SOΣ | 0..1 | Identifier | Identifier assigned by the Order Placer.
| ||||||||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||||||||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following | ||||||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||||||||
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: PLAC | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||||||||||
![]() ![]() ![]() |
SOΣ | 0..1 | Identifier | Identifier assigned by the lab (Order Filler)
| ||||||||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||||||||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following | ||||||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||||||||
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: FILL | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||||||||||
![]() ![]() ![]() |
SOΣ | 0..1 | ShipmentTrackingNumber | Identifier assigned by the Order Placer
| ||||||||||||
![]() ![]() ![]() |
Σ | 0..1 | GS1SSCC | External Identifier | ||||||||||||
![]() ![]() |
Σ | 0..1 | SpecimenAccessionNumber | Discourage - in future FHIR versions accessionIdentifier becomes an identifier, it is recommeded to follow that convention | ||||||||||||
![]() ![]() |
?!Σ | 0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. | ||||||||||||
![]() ![]() |
SΣ | 0..1 | CodeableConcept | Kind of material that forms the specimen Binding: Specimen Type (required) | ||||||||||||
![]() ![]() |
SΣ | 1..1 | Reference(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 | ||||||||||||
![]() ![]() |
0..1 | BackboneElement | Collection details | |||||||||||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||||
![]() ![]() ![]() |
SΣ | 0..1 | Reference(PractitionerRole) | Who collected the specimen | ||||||||||||
![]() ![]() ![]() |
SΣ | 0..1 | dateTime | Collection time | ||||||||||||
![]() ![]() ![]() |
S | 0..1 | SimpleQuantity(4.0.1) | The quantity of specimen collected | ||||||||||||
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Anatomical collection site Binding: Specimen Body Site (preferred) | ||||||||||||
Documentation for this format | ||||||||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Specimen.identifier:PlacerSpecimenNumber.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Specimen.identifier:PlacerSpecimenNumber.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Specimen.identifier:FillerSpecimenNumber.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Specimen.identifier:FillerSpecimenNumber.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Specimen.status | Base | required | SpecimenStatus | 📍4.0.1 | FHIR Std. |
| Specimen.type | Base | required | Specimen Type | 📦0.2.1 | This IG |
| Specimen.collection.bodySite | Base | preferred | Specimen Body Site | 📦0.2.1 | This IG |
| 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: ![]() ![]() | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
0..* | Specimen | Sample for analysis | |||||||||||||
![]() ![]() |
S | 1..* | Identifier | External Identifier Slice: Unordered, Open by value:type | ||||||||||||
![]() ![]() ![]() |
SO | 0..1 | Identifier | Identifier assigned by the Order Placer.
| ||||||||||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Description of identifier Required Pattern: At least the following | |||||||||||||
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: PLAC | |||||||||||||
![]() ![]() ![]() |
SO | 0..1 | Identifier | Identifier assigned by the lab (Order Filler)
| ||||||||||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Description of identifier Required Pattern: At least the following | |||||||||||||
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: FILL | |||||||||||||
![]() ![]() ![]() |
SO | 0..1 | ShipmentTrackingNumber | Identifier assigned by the Order Placer
| ||||||||||||
![]() ![]() ![]() |
0..1 | GS1SSCC | External Identifier | |||||||||||||
![]() ![]() |
0..1 | SpecimenAccessionNumber | Discourage - in future FHIR versions accessionIdentifier becomes an identifier, it is recommeded to follow that convention | |||||||||||||
![]() ![]() |
S | 0..1 | CodeableConcept | Kind of material that forms the specimen Binding: Specimen Type (required) | ||||||||||||
![]() ![]() |
S | 1..1 | Reference(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 | ||||||||||||
![]() ![]() |
||||||||||||||||
![]() ![]() ![]() |
S | 0..1 | Reference(PractitionerRole) | Who collected the specimen | ||||||||||||
![]() ![]() ![]() |
S | 0..1 | dateTime | Collection time | ||||||||||||
![]() ![]() ![]() |
S | 0..1 | SimpleQuantity(4.0.1) | The quantity of specimen collected | ||||||||||||
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Anatomical collection site Binding: Specimen Body Site (preferred) | ||||||||||||
Documentation for this format | ||||||||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Specimen.type | Base | required | Specimen Type | 📦0.2.1 | This IG |
| Specimen.collection.bodySite | Base | preferred | Specimen Body Site | 📦0.2.1 | This IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
0..* | Specimen | Sample for analysis | |||||||||||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||||||||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||||||||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||||||||||
![]() ![]() |
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 | |||||||||||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||||||||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||||||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||||||
![]() ![]() |
SΣ | 1..* | Identifier | External Identifier Slice: Unordered, Open by value:type | ||||||||||||
![]() ![]() ![]() |
SOΣ | 0..1 | Identifier | Identifier assigned by the Order Placer.
| ||||||||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||||||||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following | ||||||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||||||||
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: PLAC | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||||||||||
![]() ![]() ![]() |
SOΣ | 0..1 | Identifier | Identifier assigned by the lab (Order Filler)
| ||||||||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||||||||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following | ||||||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||||||||
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: FILL | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||||||||||
![]() ![]() ![]() |
SOΣ | 0..1 | ShipmentTrackingNumber | Identifier assigned by the Order Placer
| ||||||||||||
![]() ![]() ![]() |
Σ | 0..1 | GS1SSCC | External Identifier | ||||||||||||
![]() ![]() |
Σ | 0..1 | SpecimenAccessionNumber | Discourage - in future FHIR versions accessionIdentifier becomes an identifier, it is recommeded to follow that convention | ||||||||||||
![]() ![]() |
?!Σ | 0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. | ||||||||||||
![]() ![]() |
SΣ | 0..1 | CodeableConcept | Kind of material that forms the specimen Binding: Specimen Type (required) | ||||||||||||
![]() ![]() |
SΣ | 1..1 | Reference(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 | ||||||||||||
![]() ![]() |
Σ | 0..1 | dateTime | The time when specimen was received for processing | ||||||||||||
![]() ![]() |
0..* | Reference(Specimen) | Specimen from which this specimen originated | |||||||||||||
![]() ![]() |
0..* | Reference(ServiceRequest) | Why the specimen was collected | |||||||||||||
![]() ![]() |
0..1 | BackboneElement | Collection details | |||||||||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||||||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||||
![]() ![]() ![]() |
SΣ | 0..1 | Reference(PractitionerRole) | Who collected the specimen | ||||||||||||
![]() ![]() ![]() |
SΣ | 0..1 | dateTime | Collection time | ||||||||||||
![]() ![]() ![]() |
Σ | 0..1 | Duration | How long it took to collect specimen | ||||||||||||
![]() ![]() ![]() |
S | 0..1 | SimpleQuantity(4.0.1) | The quantity of specimen collected | ||||||||||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Technique used to perform collection Binding: FHIRSpecimenCollectionMethod (example): The technique that is used to perform the procedure. | |||||||||||||
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Anatomical collection site Binding: Specimen Body Site (preferred) | ||||||||||||
![]() ![]() ![]() |
Σ | 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. | |||||||||||||
![]() ![]() ![]() ![]() |
CodeableConcept | |||||||||||||||
![]() ![]() ![]() ![]() |
Duration | |||||||||||||||
![]() ![]() |
0..* | BackboneElement | Processing and processing step details | |||||||||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||||||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||||
![]() ![]() ![]() |
0..1 | string | Textual description of procedure | |||||||||||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Indicates the treatment step applied to the specimen Binding: SpecimenProcessingProcedure (example): Type indicating the technique used to process the specimen. | |||||||||||||
![]() ![]() ![]() |
0..* | Reference(Substance) | Material used in the processing step | |||||||||||||
![]() ![]() ![]() |
0..1 | Date and time of specimen processing | ||||||||||||||
![]() ![]() ![]() ![]() |
dateTime | |||||||||||||||
![]() ![]() ![]() ![]() |
Period | |||||||||||||||
![]() ![]() |
0..* | BackboneElement | Direct container of specimen (tube/slide, etc.) | |||||||||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||||||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||||
![]() ![]() ![]() |
Σ | 0..* | Identifier | Id for the container | ||||||||||||
![]() ![]() ![]() |
0..1 | string | Textual description of the container | |||||||||||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Kind of container directly associated with specimen Binding: SpecimenContainerType (example): Type of specimen container. | |||||||||||||
![]() ![]() ![]() |
0..1 | SimpleQuantity(4.0.1) | Container volume or size | |||||||||||||
![]() ![]() ![]() |
0..1 | SimpleQuantity(4.0.1) | Quantity of specimen within container | |||||||||||||
![]() ![]() ![]() |
0..1 | Additive associated with container Binding: hl7VS-additivePreservative (example): Substance added to specimen container. | ||||||||||||||
![]() ![]() ![]() ![]() |
CodeableConcept | |||||||||||||||
![]() ![]() ![]() ![]() |
Reference(Substance) | |||||||||||||||
![]() ![]() |
Σ | 0..* | CodeableConcept | State of the specimen Binding: hl7VS-specimenCondition (extensible): Codes describing the state of the specimen. | ||||||||||||
![]() ![]() |
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.identifier:PlacerSpecimenNumber.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Specimen.identifier:PlacerSpecimenNumber.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Specimen.identifier:FillerSpecimenNumber.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Specimen.identifier:FillerSpecimenNumber.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Specimen.status | Base | required | SpecimenStatus | 📍4.0.1 | FHIR Std. |
| Specimen.type | Base | required | Specimen Type | 📦0.2.1 | This IG |
| Specimen.collection.method | Base | example | FHIR Specimen Collection Method | 📍4.0.1 | FHIR Std. |
| Specimen.collection.bodySite | Base | preferred | Specimen Body Site | 📦0.2.1 | This IG |
| Specimen.collection.fastingStatus[x] | Base | extensible | hl7VS-relevantClincialInformation | 📦3.0.0 | THO v7.1 |
| 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 | 📦3.0.0 | THO v7.1 |
| Specimen.condition | Base | extensible | hl7VS-specimenCondition | 📦3.0.0 | THO v7.1 |
| 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: 2 elements(2 nested mandatory elements)
Must-Support: 10 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
0..* | Specimen | Sample for analysis | |||||||||||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||||||
![]() ![]() |
SΣ | 1..* | Identifier | External Identifier Slice: Unordered, Open by value:type | ||||||||||||
![]() ![]() ![]() |
SOΣ | 0..1 | Identifier | Identifier assigned by the Order Placer.
| ||||||||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||||||||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following | ||||||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||||||||
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: PLAC | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||||||||||
![]() ![]() ![]() |
SOΣ | 0..1 | Identifier | Identifier assigned by the lab (Order Filler)
| ||||||||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||||||||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following | ||||||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||||||||
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: FILL | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||||||||||
![]() ![]() ![]() |
SOΣ | 0..1 | ShipmentTrackingNumber | Identifier assigned by the Order Placer
| ||||||||||||
![]() ![]() ![]() |
Σ | 0..1 | GS1SSCC | External Identifier | ||||||||||||
![]() ![]() |
Σ | 0..1 | SpecimenAccessionNumber | Discourage - in future FHIR versions accessionIdentifier becomes an identifier, it is recommeded to follow that convention | ||||||||||||
![]() ![]() |
?!Σ | 0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. | ||||||||||||
![]() ![]() |
SΣ | 0..1 | CodeableConcept | Kind of material that forms the specimen Binding: Specimen Type (required) | ||||||||||||
![]() ![]() |
SΣ | 1..1 | Reference(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 | ||||||||||||
![]() ![]() |
0..1 | BackboneElement | Collection details | |||||||||||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||||
![]() ![]() ![]() |
SΣ | 0..1 | Reference(PractitionerRole) | Who collected the specimen | ||||||||||||
![]() ![]() ![]() |
SΣ | 0..1 | dateTime | Collection time | ||||||||||||
![]() ![]() ![]() |
S | 0..1 | SimpleQuantity(4.0.1) | The quantity of specimen collected | ||||||||||||
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Anatomical collection site Binding: Specimen Body Site (preferred) | ||||||||||||
Documentation for this format | ||||||||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Specimen.identifier:PlacerSpecimenNumber.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Specimen.identifier:PlacerSpecimenNumber.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Specimen.identifier:FillerSpecimenNumber.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Specimen.identifier:FillerSpecimenNumber.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Specimen.status | Base | required | SpecimenStatus | 📍4.0.1 | FHIR Std. |
| Specimen.type | Base | required | Specimen Type | 📦0.2.1 | This IG |
| Specimen.collection.bodySite | Base | preferred | Specimen Body Site | 📦0.2.1 | This IG |
| 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: ![]() ![]() | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
0..* | Specimen | Sample for analysis | |||||||||||||
![]() ![]() |
S | 1..* | Identifier | External Identifier Slice: Unordered, Open by value:type | ||||||||||||
![]() ![]() ![]() |
SO | 0..1 | Identifier | Identifier assigned by the Order Placer.
| ||||||||||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Description of identifier Required Pattern: At least the following | |||||||||||||
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: PLAC | |||||||||||||
![]() ![]() ![]() |
SO | 0..1 | Identifier | Identifier assigned by the lab (Order Filler)
| ||||||||||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Description of identifier Required Pattern: At least the following | |||||||||||||
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: FILL | |||||||||||||
![]() ![]() ![]() |
SO | 0..1 | ShipmentTrackingNumber | Identifier assigned by the Order Placer
| ||||||||||||
![]() ![]() ![]() |
0..1 | GS1SSCC | External Identifier | |||||||||||||
![]() ![]() |
0..1 | SpecimenAccessionNumber | Discourage - in future FHIR versions accessionIdentifier becomes an identifier, it is recommeded to follow that convention | |||||||||||||
![]() ![]() |
S | 0..1 | CodeableConcept | Kind of material that forms the specimen Binding: Specimen Type (required) | ||||||||||||
![]() ![]() |
S | 1..1 | Reference(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 | ||||||||||||
![]() ![]() |
||||||||||||||||
![]() ![]() ![]() |
S | 0..1 | Reference(PractitionerRole) | Who collected the specimen | ||||||||||||
![]() ![]() ![]() |
S | 0..1 | dateTime | Collection time | ||||||||||||
![]() ![]() ![]() |
S | 0..1 | SimpleQuantity(4.0.1) | The quantity of specimen collected | ||||||||||||
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Anatomical collection site Binding: Specimen Body Site (preferred) | ||||||||||||
Documentation for this format | ||||||||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Specimen.type | Base | required | Specimen Type | 📦0.2.1 | This IG |
| Specimen.collection.bodySite | Base | preferred | Specimen Body Site | 📦0.2.1 | This IG |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
0..* | Specimen | Sample for analysis | |||||||||||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||||||||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||||||||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||||||||||
![]() ![]() |
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 | |||||||||||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||||||||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||||||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||||||
![]() ![]() |
SΣ | 1..* | Identifier | External Identifier Slice: Unordered, Open by value:type | ||||||||||||
![]() ![]() ![]() |
SOΣ | 0..1 | Identifier | Identifier assigned by the Order Placer.
| ||||||||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||||||||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following | ||||||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||||||||
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: PLAC | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||||||||||
![]() ![]() ![]() |
SOΣ | 0..1 | Identifier | Identifier assigned by the lab (Order Filler)
| ||||||||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||||||||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following | ||||||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||||||||
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: FILL | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||||||||||
![]() ![]() ![]() |
SOΣ | 0..1 | ShipmentTrackingNumber | Identifier assigned by the Order Placer
| ||||||||||||
![]() ![]() ![]() |
Σ | 0..1 | GS1SSCC | External Identifier | ||||||||||||
![]() ![]() |
Σ | 0..1 | SpecimenAccessionNumber | Discourage - in future FHIR versions accessionIdentifier becomes an identifier, it is recommeded to follow that convention | ||||||||||||
![]() ![]() |
?!Σ | 0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. | ||||||||||||
![]() ![]() |
SΣ | 0..1 | CodeableConcept | Kind of material that forms the specimen Binding: Specimen Type (required) | ||||||||||||
![]() ![]() |
SΣ | 1..1 | Reference(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 | ||||||||||||
![]() ![]() |
Σ | 0..1 | dateTime | The time when specimen was received for processing | ||||||||||||
![]() ![]() |
0..* | Reference(Specimen) | Specimen from which this specimen originated | |||||||||||||
![]() ![]() |
0..* | Reference(ServiceRequest) | Why the specimen was collected | |||||||||||||
![]() ![]() |
0..1 | BackboneElement | Collection details | |||||||||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||||||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||||
![]() ![]() ![]() |
SΣ | 0..1 | Reference(PractitionerRole) | Who collected the specimen | ||||||||||||
![]() ![]() ![]() |
SΣ | 0..1 | dateTime | Collection time | ||||||||||||
![]() ![]() ![]() |
Σ | 0..1 | Duration | How long it took to collect specimen | ||||||||||||
![]() ![]() ![]() |
S | 0..1 | SimpleQuantity(4.0.1) | The quantity of specimen collected | ||||||||||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Technique used to perform collection Binding: FHIRSpecimenCollectionMethod (example): The technique that is used to perform the procedure. | |||||||||||||
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Anatomical collection site Binding: Specimen Body Site (preferred) | ||||||||||||
![]() ![]() ![]() |
Σ | 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. | |||||||||||||
![]() ![]() ![]() ![]() |
CodeableConcept | |||||||||||||||
![]() ![]() ![]() ![]() |
Duration | |||||||||||||||
![]() ![]() |
0..* | BackboneElement | Processing and processing step details | |||||||||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||||||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||||
![]() ![]() ![]() |
0..1 | string | Textual description of procedure | |||||||||||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Indicates the treatment step applied to the specimen Binding: SpecimenProcessingProcedure (example): Type indicating the technique used to process the specimen. | |||||||||||||
![]() ![]() ![]() |
0..* | Reference(Substance) | Material used in the processing step | |||||||||||||
![]() ![]() ![]() |
0..1 | Date and time of specimen processing | ||||||||||||||
![]() ![]() ![]() ![]() |
dateTime | |||||||||||||||
![]() ![]() ![]() ![]() |
Period | |||||||||||||||
![]() ![]() |
0..* | BackboneElement | Direct container of specimen (tube/slide, etc.) | |||||||||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||||||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||||
![]() ![]() ![]() |
Σ | 0..* | Identifier | Id for the container | ||||||||||||
![]() ![]() ![]() |
0..1 | string | Textual description of the container | |||||||||||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Kind of container directly associated with specimen Binding: SpecimenContainerType (example): Type of specimen container. | |||||||||||||
![]() ![]() ![]() |
0..1 | SimpleQuantity(4.0.1) | Container volume or size | |||||||||||||
![]() ![]() ![]() |
0..1 | SimpleQuantity(4.0.1) | Quantity of specimen within container | |||||||||||||
![]() ![]() ![]() |
0..1 | Additive associated with container Binding: hl7VS-additivePreservative (example): Substance added to specimen container. | ||||||||||||||
![]() ![]() ![]() ![]() |
CodeableConcept | |||||||||||||||
![]() ![]() ![]() ![]() |
Reference(Substance) | |||||||||||||||
![]() ![]() |
Σ | 0..* | CodeableConcept | State of the specimen Binding: hl7VS-specimenCondition (extensible): Codes describing the state of the specimen. | ||||||||||||
![]() ![]() |
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.identifier:PlacerSpecimenNumber.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Specimen.identifier:PlacerSpecimenNumber.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Specimen.identifier:FillerSpecimenNumber.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Specimen.identifier:FillerSpecimenNumber.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| Specimen.status | Base | required | SpecimenStatus | 📍4.0.1 | FHIR Std. |
| Specimen.type | Base | required | Specimen Type | 📦0.2.1 | This IG |
| Specimen.collection.method | Base | example | FHIR Specimen Collection Method | 📍4.0.1 | FHIR Std. |
| Specimen.collection.bodySite | Base | preferred | Specimen Body Site | 📦0.2.1 | This IG |
| Specimen.collection.fastingStatus[x] | Base | extensible | hl7VS-relevantClincialInformation | 📦3.0.0 | THO v7.1 |
| 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 | 📦3.0.0 | THO v7.1 |
| Specimen.condition | Base | extensible | hl7VS-specimenCondition | 📦3.0.0 | THO v7.1 |
| 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: 2 elements(2 nested mandatory elements)
Must-Support: 10 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron