England Pathology and Laboratory Medicine (PaLM) Technical Framework
0.1.0 - ci-build United Kingdom flag

England Pathology and Laboratory Medicine (PaLM) Technical Framework - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: Specimen

Official URL: https://examplesihe.org.uk/StructureDefinition/Specimen Version: 0.1.0
Draft as of 2026-11-04 Computable Name: Specimen

Diagnostic - Laboratory Specimen Collection A specimen collected for laboratory testing (HL7 v2 SPM).

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Specimen 0..* SpecimenEu Laboratory Specimen
Specimen.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Specimen.Slices for extension Content/Rules for all slices
Specimen.Slices for extension.extension:focus 0..1 Reference(Patient | RelatedPerson | Group | Device | Substance | Location | BiologicallyDerivedProduct) The entity the specimen was collected from, when it is not the subject of record
URL: http://hl7.eu/fhir/laboratory/StructureDefinition/specimen-focus
Specimen.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Specimen.Slices for identifier This element must be supported. This element is included in summaries. 0..* Identifier External Identifier
Slice: Unordered, Open by value:type

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Specimen.Slices for identifier.identifier:placerSpecimenNumber This element must be supported. This element is included in summaries. 0..1 CorrelationIdentifier Specimen number assigned by the Order Placer, e.g. on the specimen label (HL7 v2 SPM-2.1 Placer Assigned Identifier)
Specimen.Slices for identifier.identifier:placerSpecimenNumber.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Specimen.Slices for identifier.identifier:placerSpecimenNumber.type This element must be supported. This element is included in summaries. 1..1 CodeableConcept Description of identifier
Binding: NW IdentifierType (required)
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
      "code" : "PLAC"
    }
  ]
}
Specimen.Slices for identifier.identifier:placerSpecimenNumber.system This element must be supported. This element is included in summaries. 0..1 uri Recommended. This may be defined by a EPR/LIMS system.
Example General: http://www.acme.com/identifiers/patient
Specimen.Slices for identifier.identifier:placerSpecimenNumber.value This element must be supported. This element is included in summaries. 1..1 string The value MUST be unique to the organisation
Example General: 123456
Specimen.Slices for identifier.identifier:placerSpecimenNumber.assigner This element must be supported. This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Specimen.Slices for identifier.identifier:placerSpecimenNumber.assigner.identifier This element must be supported. This element is included in summaries. 1..1 Identifier Logical reference, when literal reference is not known
Specimen.Slices for identifier.identifier:placerSpecimenNumber.assigner.identifier.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Specimen.Slices for identifier.identifier:placerSpecimenNumber.assigner.identifier.system This element must be supported. This element is included in summaries. 1..1 uri The namespace for the identifier value
Required Pattern: https://fhir.nhs.uk/Id/ods-organization-code (extensions allowed)
Specimen.Slices for identifier.identifier:placerSpecimenNumber.assigner.identifier.value This element must be supported. This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
Example Manchester University NHS Foundation Trust: R0A
Specimen.accessionIdentifier This element must be supported. This element is included in summaries. 0..1 AccessionIdentifier Laboratory number assigned when received (HL7 v2 SPM-2.2 Filler Assigned Identifier)
Specimen.status This element is a modifier element. This element is included in summaries. 0..1 code available | unavailable | unsatisfactory | entered-in-error
Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen.
Specimen.type This element must be supported. This element is included in summaries. 1..1 CodeableConcept HL7 v2 SPM-4 Specimen Type (SNOMED CT specimen)
Binding: Specimen Types (preferred)
Specimen.subject This element must be supported. This element is included in summaries. 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
Specimen.receivedTime This element must be supported. This element is included in summaries. 0..1 dateTime HL7 v2 SPM-18 Specimen Received Date/Time
Specimen.collection This element must be supported. 0..1 BackboneElement Collection details
Specimen.collection.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Specimen.collection.collected[x] This element must be supported. This element is included in summaries. 0..1 HL7 v2 SPM-17 Specimen Collection Date/Time
Specimen.collection.collected[x].collectedDateTime dateTime
Specimen.collection.collected[x].collectedPeriod Period
Specimen.collection.method 0..1 CodeableConcept HL7 v2 SPM-7 Specimen Collection Method
Binding: FHIRSpecimenCollectionMethod (example): The technique that is used to perform the procedure.
Specimen.collection.bodySite This element must be supported. 0..1 CodeableConcept HL7 v2 SPM-8 Specimen Source Site
Binding: SNOMEDCTBodyStructures (preferred)
Specimen.collection.bodySite.Slices for extension Content/Rules for all slices
Specimen.collection.bodySite.Slices for extension.extension:bodySite 0..1 (Complex) R5: bodySite additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.collection.bodySite
Specimen.collection.bodySite.Slices for extension.extension:bodySite.extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
Specimen.collection.bodySite.Slices for extension.extension:bodySite.url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.collection.bodySite"
Specimen.note 0..* Annotation HL7 v2 SPM-14 Specimen Description

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Specimen.identifier:placerSpecimenNumber.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Specimen.identifier:placerSpecimenNumber.​type Base required NW IdentifierType 📦0.1.0 This IG
Specimen.identifier:placerSpecimenNumber.​assigner.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Specimen.status Base required SpecimenStatus 📍4.0.1 FHIR Std.
Specimen.type Base preferred Specimen Types 📦2.1.0 HL7 Europe Laboratory Report v2.1
Specimen.collection.​method Base example FHIR Specimen Collection Method 📍4.0.1 FHIR Std.
Specimen.collection.​bodySite Base preferred SNOMED CT Body Structures 📦4.0.1 FHIR Std.

Constraints

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

This structure is derived from SpecimenEu

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Specimen 0..* SpecimenEu Laboratory Specimen
Specimen.Slices for identifier This element must be supported. 0..* Identifier External Identifier
Slice: Unordered, Open by value:type
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Specimen.Slices for identifier.identifier:placerSpecimenNumber This element must be supported. 0..1 CorrelationIdentifier Specimen number assigned by the Order Placer, e.g. on the specimen label (HL7 v2 SPM-2.1 Placer Assigned Identifier)
Specimen.Slices for identifier.identifier:placerSpecimenNumber.type 1..1 CodeableConcept Description of identifier
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
      "code" : "PLAC"
    }
  ]
}
Specimen.accessionIdentifier This element must be supported. 0..1 AccessionIdentifier Laboratory number assigned when received (HL7 v2 SPM-2.2 Filler Assigned Identifier)
Specimen.type This element must be supported. 1..1 CodeableConcept HL7 v2 SPM-4 Specimen Type (SNOMED CT specimen)
Specimen.receivedTime This element must be supported. 0..1 dateTime HL7 v2 SPM-18 Specimen Received Date/Time
Specimen.collection This element must be supported. 0..1 BackboneElement Collection details
Specimen.collection.collected[x] This element must be supported. 0..1 dateTime, Period HL7 v2 SPM-17 Specimen Collection Date/Time
Specimen.collection.method 0..1 CodeableConcept HL7 v2 SPM-7 Specimen Collection Method
Specimen.collection.bodySite This element must be supported. 0..1 CodeableConcept HL7 v2 SPM-8 Specimen Source Site
Specimen.note 0..* Annotation HL7 v2 SPM-14 Specimen Description

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Specimen 0..* SpecimenEu Laboratory Specimen
Specimen.id This element is included in summaries. 0..1 id Logical id of this artifact
Specimen.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Specimen.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Specimen.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Specimen.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
Specimen.contained 0..* Resource Contained, inline Resources
Specimen.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Specimen.Slices for extension.extension:focus 0..1 Reference(Patient | RelatedPerson | Group | Device | Substance | Location | BiologicallyDerivedProduct) The entity the specimen was collected from, when it is not the subject of record
URL: http://hl7.eu/fhir/laboratory/StructureDefinition/specimen-focus
Specimen.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Specimen.Slices for identifier This element must be supported. This element is included in summaries. 0..* Identifier External Identifier
Slice: Unordered, Open by value:type

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Specimen.Slices for identifier.identifier:placerSpecimenNumber This element must be supported. This element is included in summaries. 0..1 CorrelationIdentifier Specimen number assigned by the Order Placer, e.g. on the specimen label (HL7 v2 SPM-2.1 Placer Assigned Identifier)
Specimen.Slices for identifier.identifier:placerSpecimenNumber.id 0..1 string Unique id for inter-element referencing
Specimen.Slices for identifier.identifier:placerSpecimenNumber.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Specimen.Slices for identifier.identifier:placerSpecimenNumber.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Specimen.Slices for identifier.identifier:placerSpecimenNumber.type This element must be supported. This element is included in summaries. 1..1 CodeableConcept Description of identifier
Binding: NW IdentifierType (required)
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
      "code" : "PLAC"
    }
  ]
}
Specimen.Slices for identifier.identifier:placerSpecimenNumber.system This element must be supported. This element is included in summaries. 0..1 uri Recommended. This may be defined by a EPR/LIMS system.
Example General: http://www.acme.com/identifiers/patient
Specimen.Slices for identifier.identifier:placerSpecimenNumber.value This element must be supported. This element is included in summaries. 1..1 string The value MUST be unique to the organisation
Example General: 123456
Specimen.Slices for identifier.identifier:placerSpecimenNumber.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Specimen.Slices for identifier.identifier:placerSpecimenNumber.assigner This element must be supported. This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Specimen.Slices for identifier.identifier:placerSpecimenNumber.assigner.id 0..1 string Unique id for inter-element referencing
Specimen.Slices for identifier.identifier:placerSpecimenNumber.assigner.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Specimen.Slices for identifier.identifier:placerSpecimenNumber.assigner.reference This element is included in summaries. C 0..1 string Literal reference, Relative, internal or absolute URL
Specimen.Slices for identifier.identifier:placerSpecimenNumber.assigner.type This element is included in summaries. 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
Specimen.Slices for identifier.identifier:placerSpecimenNumber.assigner.identifier This element must be supported. This element is included in summaries. 1..1 Identifier Logical reference, when literal reference is not known
Specimen.Slices for identifier.identifier:placerSpecimenNumber.assigner.identifier.id 0..1 string Unique id for inter-element referencing
Specimen.Slices for identifier.identifier:placerSpecimenNumber.assigner.identifier.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Specimen.Slices for identifier.identifier:placerSpecimenNumber.assigner.identifier.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Specimen.Slices for identifier.identifier:placerSpecimenNumber.assigner.identifier.type This element is included in summaries. 0..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.
Specimen.Slices for identifier.identifier:placerSpecimenNumber.assigner.identifier.system This element must be supported. This element is included in summaries. 1..1 uri The namespace for the identifier value
Required Pattern: https://fhir.nhs.uk/Id/ods-organization-code (extensions allowed)
Specimen.Slices for identifier.identifier:placerSpecimenNumber.assigner.identifier.value This element must be supported. This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
Example Manchester University NHS Foundation Trust: R0A
Specimen.Slices for identifier.identifier:placerSpecimenNumber.assigner.identifier.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Specimen.Slices for identifier.identifier:placerSpecimenNumber.assigner.identifier.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Specimen.Slices for identifier.identifier:placerSpecimenNumber.assigner.display This element is included in summaries. 0..1 string Text alternative for the resource
Specimen.accessionIdentifier This element must be supported. This element is included in summaries. 0..1 AccessionIdentifier Laboratory number assigned when received (HL7 v2 SPM-2.2 Filler Assigned Identifier)
Specimen.status This element is a modifier element. This element is included in summaries. 0..1 code available | unavailable | unsatisfactory | entered-in-error
Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen.
Specimen.type This element must be supported. This element is included in summaries. 1..1 CodeableConcept HL7 v2 SPM-4 Specimen Type (SNOMED CT specimen)
Binding: Specimen Types (preferred)
Specimen.subject This element must be supported. This element is included in summaries. 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
Specimen.receivedTime This element must be supported. This element is included in summaries. 0..1 dateTime HL7 v2 SPM-18 Specimen Received Date/Time
Specimen.parent 0..* Reference(Specimen: Laboratory) Specimen from which this specimen originated
Specimen.request 0..* Reference(ServiceRequest) Why the specimen was collected.
Specimen.collection This element must be supported. 0..1 BackboneElement Collection details
Specimen.collection.id 0..1 string Unique id for inter-element referencing
Specimen.collection.extension 0..* Extension Additional content defined by implementations
Specimen.collection.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Specimen.collection.collector This element is included in summaries. 0..1 Reference(Practitioner | PractitionerRole) Who collected the specimen
Specimen.collection.collector.id 0..1 string Unique id for inter-element referencing
Specimen.collection.collector.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Specimen.collection.collector.Slices for extension.extension:collector 0..1 (Complex) Patient or related person who collected the specimen
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Specimen.collection.collector.Slices for extension.extension:collector.id 0..1 string Unique id for inter-element referencing
Specimen.collection.collector.Slices for extension.extension:collector.extension 0..0 Extension
Slice: Unordered, Open by value:url
Specimen.collection.collector.Slices for extension.extension:collector.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/alternate-reference"
Specimen.collection.collector.Slices for extension.extension:collector.value[x] 1..1 Reference(Patient (EU core) | RelatedPerson) Value of extension
Specimen.collection.collector.reference This element is included in summaries. C 0..1 string Literal reference, Relative, internal or absolute URL
Specimen.collection.collector.type This element is included in summaries. 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
Specimen.collection.collector.identifier This element is included in summaries. 0..1 Identifier Logical reference, when literal reference is not known
Specimen.collection.collector.display This element is included in summaries. 0..1 string Text alternative for the resource
Specimen.collection.collected[x] This element must be supported. This element is included in summaries. 0..1 HL7 v2 SPM-17 Specimen Collection Date/Time
Specimen.collection.collected[x].collectedDateTime dateTime
Specimen.collection.collected[x].collectedPeriod Period
Specimen.collection.duration This element is included in summaries. 0..1 Duration How long it took to collect specimen
Specimen.collection.quantity C 0..1 SimpleQuantity(4.0.1) The quantity of specimen collected
Constraints: sqty-1
Specimen.collection.method 0..1 CodeableConcept HL7 v2 SPM-7 Specimen Collection Method
Binding: FHIRSpecimenCollectionMethod (example): The technique that is used to perform the procedure.
Specimen.collection.bodySite This element must be supported. 0..1 CodeableConcept HL7 v2 SPM-8 Specimen Source Site
Binding: SNOMEDCTBodyStructures (preferred)
Specimen.collection.bodySite.id 0..1 string Unique id for inter-element referencing
Specimen.collection.bodySite.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Specimen.collection.bodySite.Slices for extension.extension:bodySite 0..1 (Complex) R5: bodySite additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.collection.bodySite
Specimen.collection.bodySite.Slices for extension.extension:bodySite.id 0..1 string Unique id for inter-element referencing
Specimen.collection.bodySite.Slices for extension.extension:bodySite.extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
Specimen.collection.bodySite.Slices for extension.extension:bodySite.url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.collection.bodySite"
Specimen.collection.bodySite.Slices for extension.extension:bodySite.value[x] 0..1 Reference(BodyStructure (EU core)) Anatomical collection site
Specimen.collection.bodySite.coding This element is included in summaries. 0..* Coding Code defined by a terminology system
Specimen.collection.bodySite.text This element is included in summaries. 0..1 string Plain text representation of the concept
Specimen.collection.fastingStatus[x] This element is included in summaries. 0..1 Whether or how long patient abstained from food and/or drink
Binding: Hl7VSRelevantClincialInformation (3.0.0) (extensible): Codes describing the fasting status of the patient.
Specimen.collection.fastingStatus[x].fastingStatusCodeableConcept CodeableConcept
Specimen.collection.fastingStatus[x].fastingStatusDuration Duration
Specimen.processing 0..* BackboneElement Processing and processing step details
Specimen.processing.id 0..1 string Unique id for inter-element referencing
Specimen.processing.extension 0..* Extension Additional content defined by implementations
Specimen.processing.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Specimen.processing.description 0..1 string Textual description of procedure
Specimen.processing.procedure 0..1 CodeableConcept Indicates the treatment step applied to the specimen
Binding: SpecimenProcessingProcedure (example): Type indicating the technique used to process the specimen.
Specimen.processing.additive 0..* Reference(Substance | Substance: Specimen Additive Substance) Material used in the processing step
Specimen.processing.time[x] 0..1 Date and time of specimen processing
Specimen.processing.time[x].timeDateTime dateTime
Specimen.processing.time[x].timePeriod Period
Specimen.container 0..* BackboneElement Direct container of specimen (tube/slide, etc.)
Specimen.container.id 0..1 string Unique id for inter-element referencing
Specimen.container.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Specimen.container.Slices for extension.extension:device 1..1 (Complex) R5: Device resource for the container (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.container.device
Constraints: ext-1
Specimen.container.Slices for extension.extension:device.id 0..1 string Unique id for inter-element referencing
Specimen.container.Slices for extension.extension:device.extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
Specimen.container.Slices for extension.extension:device.url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.container.device"
Specimen.container.Slices for extension.extension:device.value[x] 1..1 Reference(Device) Device resource for the container
Specimen.container.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Specimen.container.identifier This element is included in summaries. 0..* Identifier Id for the container
Specimen.container.description 0..1 string Textual description of the container
Specimen.container.type 0..1 CodeableConcept Kind of container directly associated with specimen
Binding: Specimen Container (preferred)
Specimen.container.capacity C 0..1 SimpleQuantity(4.0.1) Container volume or size
Constraints: sqty-1
Specimen.container.specimenQuantity C 0..1 SimpleQuantity(4.0.1) Quantity of specimen within container
Constraints: sqty-1
Specimen.condition This element is included in summaries. 0..* CodeableConcept State of the specimen
Binding: Hl7VSSpecimenCondition (3.0.0) (extensible): Codes describing the state of the specimen.
Specimen.note 0..* Annotation HL7 v2 SPM-14 Specimen Description

doco Documentation for this format

Terminology Bindings

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 required NW IdentifierType 📦0.1.0 This IG
Specimen.identifier:placerSpecimenNumber.​assigner.type Base extensible ResourceType 📍4.0.1 FHIR Std.
Specimen.identifier:placerSpecimenNumber.​assigner.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Specimen.identifier:placerSpecimenNumber.​assigner.identifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Specimen.status Base required SpecimenStatus 📍4.0.1 FHIR Std.
Specimen.type Base preferred Specimen Types 📦2.1.0 HL7 Europe Laboratory Report v2.1
Specimen.collection.​collector.type Base extensible ResourceType 📍4.0.1 FHIR Std.
Specimen.collection.​method Base example FHIR Specimen Collection Method 📍4.0.1 FHIR Std.
Specimen.collection.​bodySite Base preferred SNOMED CT Body Structures 📦4.0.1 FHIR Std.
Specimen.collection.​fastingStatus[x] Base extensible hl7VS-relevantClincialInformation 📍3.0.0 THO v7.5
Specimen.processing.​procedure Base example Specimen processing procedure 📍4.0.1 FHIR Std.
Specimen.container.type Base preferred Specimen Container 📦2.1.0 HL7 Europe Laboratory Report v2.1
Specimen.condition Base extensible hl7VS-specimenCondition 📍3.0.0 THO v7.5

Constraints

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

This structure is derived from SpecimenEu

Summary

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

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Specimen.identifier

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Specimen 0..* SpecimenEu Laboratory Specimen
Specimen.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Specimen.Slices for extension Content/Rules for all slices
Specimen.Slices for extension.extension:focus 0..1 Reference(Patient | RelatedPerson | Group | Device | Substance | Location | BiologicallyDerivedProduct) The entity the specimen was collected from, when it is not the subject of record
URL: http://hl7.eu/fhir/laboratory/StructureDefinition/specimen-focus
Specimen.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Specimen.Slices for identifier This element must be supported. This element is included in summaries. 0..* Identifier External Identifier
Slice: Unordered, Open by value:type

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Specimen.Slices for identifier.identifier:placerSpecimenNumber This element must be supported. This element is included in summaries. 0..1 CorrelationIdentifier Specimen number assigned by the Order Placer, e.g. on the specimen label (HL7 v2 SPM-2.1 Placer Assigned Identifier)
Specimen.Slices for identifier.identifier:placerSpecimenNumber.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Specimen.Slices for identifier.identifier:placerSpecimenNumber.type This element must be supported. This element is included in summaries. 1..1 CodeableConcept Description of identifier
Binding: NW IdentifierType (required)
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
      "code" : "PLAC"
    }
  ]
}
Specimen.Slices for identifier.identifier:placerSpecimenNumber.system This element must be supported. This element is included in summaries. 0..1 uri Recommended. This may be defined by a EPR/LIMS system.
Example General: http://www.acme.com/identifiers/patient
Specimen.Slices for identifier.identifier:placerSpecimenNumber.value This element must be supported. This element is included in summaries. 1..1 string The value MUST be unique to the organisation
Example General: 123456
Specimen.Slices for identifier.identifier:placerSpecimenNumber.assigner This element must be supported. This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Specimen.Slices for identifier.identifier:placerSpecimenNumber.assigner.identifier This element must be supported. This element is included in summaries. 1..1 Identifier Logical reference, when literal reference is not known
Specimen.Slices for identifier.identifier:placerSpecimenNumber.assigner.identifier.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Specimen.Slices for identifier.identifier:placerSpecimenNumber.assigner.identifier.system This element must be supported. This element is included in summaries. 1..1 uri The namespace for the identifier value
Required Pattern: https://fhir.nhs.uk/Id/ods-organization-code (extensions allowed)
Specimen.Slices for identifier.identifier:placerSpecimenNumber.assigner.identifier.value This element must be supported. This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
Example Manchester University NHS Foundation Trust: R0A
Specimen.accessionIdentifier This element must be supported. This element is included in summaries. 0..1 AccessionIdentifier Laboratory number assigned when received (HL7 v2 SPM-2.2 Filler Assigned Identifier)
Specimen.status This element is a modifier element. This element is included in summaries. 0..1 code available | unavailable | unsatisfactory | entered-in-error
Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen.
Specimen.type This element must be supported. This element is included in summaries. 1..1 CodeableConcept HL7 v2 SPM-4 Specimen Type (SNOMED CT specimen)
Binding: Specimen Types (preferred)
Specimen.subject This element must be supported. This element is included in summaries. 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
Specimen.receivedTime This element must be supported. This element is included in summaries. 0..1 dateTime HL7 v2 SPM-18 Specimen Received Date/Time
Specimen.collection This element must be supported. 0..1 BackboneElement Collection details
Specimen.collection.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Specimen.collection.collected[x] This element must be supported. This element is included in summaries. 0..1 HL7 v2 SPM-17 Specimen Collection Date/Time
Specimen.collection.collected[x].collectedDateTime dateTime
Specimen.collection.collected[x].collectedPeriod Period
Specimen.collection.method 0..1 CodeableConcept HL7 v2 SPM-7 Specimen Collection Method
Binding: FHIRSpecimenCollectionMethod (example): The technique that is used to perform the procedure.
Specimen.collection.bodySite This element must be supported. 0..1 CodeableConcept HL7 v2 SPM-8 Specimen Source Site
Binding: SNOMEDCTBodyStructures (preferred)
Specimen.collection.bodySite.Slices for extension Content/Rules for all slices
Specimen.collection.bodySite.Slices for extension.extension:bodySite 0..1 (Complex) R5: bodySite additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.collection.bodySite
Specimen.collection.bodySite.Slices for extension.extension:bodySite.extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
Specimen.collection.bodySite.Slices for extension.extension:bodySite.url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.collection.bodySite"
Specimen.note 0..* Annotation HL7 v2 SPM-14 Specimen Description

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Specimen.identifier:placerSpecimenNumber.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Specimen.identifier:placerSpecimenNumber.​type Base required NW IdentifierType 📦0.1.0 This IG
Specimen.identifier:placerSpecimenNumber.​assigner.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Specimen.status Base required SpecimenStatus 📍4.0.1 FHIR Std.
Specimen.type Base preferred Specimen Types 📦2.1.0 HL7 Europe Laboratory Report v2.1
Specimen.collection.​method Base example FHIR Specimen Collection Method 📍4.0.1 FHIR Std.
Specimen.collection.​bodySite Base preferred SNOMED CT Body Structures 📦4.0.1 FHIR Std.

Constraints

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

Differential View

This structure is derived from SpecimenEu

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Specimen 0..* SpecimenEu Laboratory Specimen
Specimen.Slices for identifier This element must be supported. 0..* Identifier External Identifier
Slice: Unordered, Open by value:type
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Specimen.Slices for identifier.identifier:placerSpecimenNumber This element must be supported. 0..1 CorrelationIdentifier Specimen number assigned by the Order Placer, e.g. on the specimen label (HL7 v2 SPM-2.1 Placer Assigned Identifier)
Specimen.Slices for identifier.identifier:placerSpecimenNumber.type 1..1 CodeableConcept Description of identifier
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
      "code" : "PLAC"
    }
  ]
}
Specimen.accessionIdentifier This element must be supported. 0..1 AccessionIdentifier Laboratory number assigned when received (HL7 v2 SPM-2.2 Filler Assigned Identifier)
Specimen.type This element must be supported. 1..1 CodeableConcept HL7 v2 SPM-4 Specimen Type (SNOMED CT specimen)
Specimen.subject This element must be supported. 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
Specimen.receivedTime This element must be supported. 0..1 dateTime HL7 v2 SPM-18 Specimen Received Date/Time
Specimen.collection This element must be supported. 0..1 BackboneElement Collection details
Specimen.collection.collected[x] This element must be supported. 0..1 dateTime, Period HL7 v2 SPM-17 Specimen Collection Date/Time
Specimen.collection.method 0..1 CodeableConcept HL7 v2 SPM-7 Specimen Collection Method
Specimen.collection.bodySite This element must be supported. 0..1 CodeableConcept HL7 v2 SPM-8 Specimen Source Site
Specimen.note 0..* Annotation HL7 v2 SPM-14 Specimen Description

doco Documentation for this format

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Specimen 0..* SpecimenEu Laboratory Specimen
Specimen.id This element is included in summaries. 0..1 id Logical id of this artifact
Specimen.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Specimen.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Specimen.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Specimen.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
Specimen.contained 0..* Resource Contained, inline Resources
Specimen.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Specimen.Slices for extension.extension:focus 0..1 Reference(Patient | RelatedPerson | Group | Device | Substance | Location | BiologicallyDerivedProduct) The entity the specimen was collected from, when it is not the subject of record
URL: http://hl7.eu/fhir/laboratory/StructureDefinition/specimen-focus
Specimen.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Specimen.Slices for identifier This element must be supported. This element is included in summaries. 0..* Identifier External Identifier
Slice: Unordered, Open by value:type

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Specimen.Slices for identifier.identifier:placerSpecimenNumber This element must be supported. This element is included in summaries. 0..1 CorrelationIdentifier Specimen number assigned by the Order Placer, e.g. on the specimen label (HL7 v2 SPM-2.1 Placer Assigned Identifier)
Specimen.Slices for identifier.identifier:placerSpecimenNumber.id 0..1 string Unique id for inter-element referencing
Specimen.Slices for identifier.identifier:placerSpecimenNumber.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Specimen.Slices for identifier.identifier:placerSpecimenNumber.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Specimen.Slices for identifier.identifier:placerSpecimenNumber.type This element must be supported. This element is included in summaries. 1..1 CodeableConcept Description of identifier
Binding: NW IdentifierType (required)
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
      "code" : "PLAC"
    }
  ]
}
Specimen.Slices for identifier.identifier:placerSpecimenNumber.system This element must be supported. This element is included in summaries. 0..1 uri Recommended. This may be defined by a EPR/LIMS system.
Example General: http://www.acme.com/identifiers/patient
Specimen.Slices for identifier.identifier:placerSpecimenNumber.value This element must be supported. This element is included in summaries. 1..1 string The value MUST be unique to the organisation
Example General: 123456
Specimen.Slices for identifier.identifier:placerSpecimenNumber.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Specimen.Slices for identifier.identifier:placerSpecimenNumber.assigner This element must be supported. This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Specimen.Slices for identifier.identifier:placerSpecimenNumber.assigner.id 0..1 string Unique id for inter-element referencing
Specimen.Slices for identifier.identifier:placerSpecimenNumber.assigner.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Specimen.Slices for identifier.identifier:placerSpecimenNumber.assigner.reference This element is included in summaries. C 0..1 string Literal reference, Relative, internal or absolute URL
Specimen.Slices for identifier.identifier:placerSpecimenNumber.assigner.type This element is included in summaries. 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
Specimen.Slices for identifier.identifier:placerSpecimenNumber.assigner.identifier This element must be supported. This element is included in summaries. 1..1 Identifier Logical reference, when literal reference is not known
Specimen.Slices for identifier.identifier:placerSpecimenNumber.assigner.identifier.id 0..1 string Unique id for inter-element referencing
Specimen.Slices for identifier.identifier:placerSpecimenNumber.assigner.identifier.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Specimen.Slices for identifier.identifier:placerSpecimenNumber.assigner.identifier.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Specimen.Slices for identifier.identifier:placerSpecimenNumber.assigner.identifier.type This element is included in summaries. 0..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.
Specimen.Slices for identifier.identifier:placerSpecimenNumber.assigner.identifier.system This element must be supported. This element is included in summaries. 1..1 uri The namespace for the identifier value
Required Pattern: https://fhir.nhs.uk/Id/ods-organization-code (extensions allowed)
Specimen.Slices for identifier.identifier:placerSpecimenNumber.assigner.identifier.value This element must be supported. This element is included in summaries. 1..1 string The value that is unique
Example General: 123456
Example Manchester University NHS Foundation Trust: R0A
Specimen.Slices for identifier.identifier:placerSpecimenNumber.assigner.identifier.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Specimen.Slices for identifier.identifier:placerSpecimenNumber.assigner.identifier.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
Specimen.Slices for identifier.identifier:placerSpecimenNumber.assigner.display This element is included in summaries. 0..1 string Text alternative for the resource
Specimen.accessionIdentifier This element must be supported. This element is included in summaries. 0..1 AccessionIdentifier Laboratory number assigned when received (HL7 v2 SPM-2.2 Filler Assigned Identifier)
Specimen.status This element is a modifier element. This element is included in summaries. 0..1 code available | unavailable | unsatisfactory | entered-in-error
Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen.
Specimen.type This element must be supported. This element is included in summaries. 1..1 CodeableConcept HL7 v2 SPM-4 Specimen Type (SNOMED CT specimen)
Binding: Specimen Types (preferred)
Specimen.subject This element must be supported. This element is included in summaries. 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
Specimen.receivedTime This element must be supported. This element is included in summaries. 0..1 dateTime HL7 v2 SPM-18 Specimen Received Date/Time
Specimen.parent 0..* Reference(Specimen: Laboratory) Specimen from which this specimen originated
Specimen.request 0..* Reference(ServiceRequest) Why the specimen was collected.
Specimen.collection This element must be supported. 0..1 BackboneElement Collection details
Specimen.collection.id 0..1 string Unique id for inter-element referencing
Specimen.collection.extension 0..* Extension Additional content defined by implementations
Specimen.collection.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Specimen.collection.collector This element is included in summaries. 0..1 Reference(Practitioner | PractitionerRole) Who collected the specimen
Specimen.collection.collector.id 0..1 string Unique id for inter-element referencing
Specimen.collection.collector.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Specimen.collection.collector.Slices for extension.extension:collector 0..1 (Complex) Patient or related person who collected the specimen
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Specimen.collection.collector.Slices for extension.extension:collector.id 0..1 string Unique id for inter-element referencing
Specimen.collection.collector.Slices for extension.extension:collector.extension 0..0 Extension
Slice: Unordered, Open by value:url
Specimen.collection.collector.Slices for extension.extension:collector.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/alternate-reference"
Specimen.collection.collector.Slices for extension.extension:collector.value[x] 1..1 Reference(Patient (EU core) | RelatedPerson) Value of extension
Specimen.collection.collector.reference This element is included in summaries. C 0..1 string Literal reference, Relative, internal or absolute URL
Specimen.collection.collector.type This element is included in summaries. 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
Specimen.collection.collector.identifier This element is included in summaries. 0..1 Identifier Logical reference, when literal reference is not known
Specimen.collection.collector.display This element is included in summaries. 0..1 string Text alternative for the resource
Specimen.collection.collected[x] This element must be supported. This element is included in summaries. 0..1 HL7 v2 SPM-17 Specimen Collection Date/Time
Specimen.collection.collected[x].collectedDateTime dateTime
Specimen.collection.collected[x].collectedPeriod Period
Specimen.collection.duration This element is included in summaries. 0..1 Duration How long it took to collect specimen
Specimen.collection.quantity C 0..1 SimpleQuantity(4.0.1) The quantity of specimen collected
Constraints: sqty-1
Specimen.collection.method 0..1 CodeableConcept HL7 v2 SPM-7 Specimen Collection Method
Binding: FHIRSpecimenCollectionMethod (example): The technique that is used to perform the procedure.
Specimen.collection.bodySite This element must be supported. 0..1 CodeableConcept HL7 v2 SPM-8 Specimen Source Site
Binding: SNOMEDCTBodyStructures (preferred)
Specimen.collection.bodySite.id 0..1 string Unique id for inter-element referencing
Specimen.collection.bodySite.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Specimen.collection.bodySite.Slices for extension.extension:bodySite 0..1 (Complex) R5: bodySite additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.collection.bodySite
Specimen.collection.bodySite.Slices for extension.extension:bodySite.id 0..1 string Unique id for inter-element referencing
Specimen.collection.bodySite.Slices for extension.extension:bodySite.extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
Specimen.collection.bodySite.Slices for extension.extension:bodySite.url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.collection.bodySite"
Specimen.collection.bodySite.Slices for extension.extension:bodySite.value[x] 0..1 Reference(BodyStructure (EU core)) Anatomical collection site
Specimen.collection.bodySite.coding This element is included in summaries. 0..* Coding Code defined by a terminology system
Specimen.collection.bodySite.text This element is included in summaries. 0..1 string Plain text representation of the concept
Specimen.collection.fastingStatus[x] This element is included in summaries. 0..1 Whether or how long patient abstained from food and/or drink
Binding: Hl7VSRelevantClincialInformation (3.0.0) (extensible): Codes describing the fasting status of the patient.
Specimen.collection.fastingStatus[x].fastingStatusCodeableConcept CodeableConcept
Specimen.collection.fastingStatus[x].fastingStatusDuration Duration
Specimen.processing 0..* BackboneElement Processing and processing step details
Specimen.processing.id 0..1 string Unique id for inter-element referencing
Specimen.processing.extension 0..* Extension Additional content defined by implementations
Specimen.processing.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Specimen.processing.description 0..1 string Textual description of procedure
Specimen.processing.procedure 0..1 CodeableConcept Indicates the treatment step applied to the specimen
Binding: SpecimenProcessingProcedure (example): Type indicating the technique used to process the specimen.
Specimen.processing.additive 0..* Reference(Substance | Substance: Specimen Additive Substance) Material used in the processing step
Specimen.processing.time[x] 0..1 Date and time of specimen processing
Specimen.processing.time[x].timeDateTime dateTime
Specimen.processing.time[x].timePeriod Period
Specimen.container 0..* BackboneElement Direct container of specimen (tube/slide, etc.)
Specimen.container.id 0..1 string Unique id for inter-element referencing
Specimen.container.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Specimen.container.Slices for extension.extension:device 1..1 (Complex) R5: Device resource for the container (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.container.device
Constraints: ext-1
Specimen.container.Slices for extension.extension:device.id 0..1 string Unique id for inter-element referencing
Specimen.container.Slices for extension.extension:device.extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
Specimen.container.Slices for extension.extension:device.url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.container.device"
Specimen.container.Slices for extension.extension:device.value[x] 1..1 Reference(Device) Device resource for the container
Specimen.container.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Specimen.container.identifier This element is included in summaries. 0..* Identifier Id for the container
Specimen.container.description 0..1 string Textual description of the container
Specimen.container.type 0..1 CodeableConcept Kind of container directly associated with specimen
Binding: Specimen Container (preferred)
Specimen.container.capacity C 0..1 SimpleQuantity(4.0.1) Container volume or size
Constraints: sqty-1
Specimen.container.specimenQuantity C 0..1 SimpleQuantity(4.0.1) Quantity of specimen within container
Constraints: sqty-1
Specimen.condition This element is included in summaries. 0..* CodeableConcept State of the specimen
Binding: Hl7VSSpecimenCondition (3.0.0) (extensible): Codes describing the state of the specimen.
Specimen.note 0..* Annotation HL7 v2 SPM-14 Specimen Description

doco Documentation for this format

Terminology Bindings

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 required NW IdentifierType 📦0.1.0 This IG
Specimen.identifier:placerSpecimenNumber.​assigner.type Base extensible ResourceType 📍4.0.1 FHIR Std.
Specimen.identifier:placerSpecimenNumber.​assigner.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Specimen.identifier:placerSpecimenNumber.​assigner.identifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Specimen.status Base required SpecimenStatus 📍4.0.1 FHIR Std.
Specimen.type Base preferred Specimen Types 📦2.1.0 HL7 Europe Laboratory Report v2.1
Specimen.collection.​collector.type Base extensible ResourceType 📍4.0.1 FHIR Std.
Specimen.collection.​method Base example FHIR Specimen Collection Method 📍4.0.1 FHIR Std.
Specimen.collection.​bodySite Base preferred SNOMED CT Body Structures 📦4.0.1 FHIR Std.
Specimen.collection.​fastingStatus[x] Base extensible hl7VS-relevantClincialInformation 📍3.0.0 THO v7.5
Specimen.processing.​procedure Base example Specimen processing procedure 📍4.0.1 FHIR Std.
Specimen.container.type Base preferred Specimen Container 📦2.1.0 HL7 Europe Laboratory Report v2.1
Specimen.condition Base extensible hl7VS-specimenCondition 📍3.0.0 THO v7.5

Constraints

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

This structure is derived from SpecimenEu

Summary

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

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Specimen.identifier

 

Other representations of profile: CSV, Excel, Schematron