North West Genomics Testing Workflow (GTW)
0.0.1 - ci-build
DRAFT Implementation Guide
This is for collaboration and discussion purposes and is subject to change.
North West Genomics Testing Workflow (GTW) - Local Development build (v0.0.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Official URL: https://hl7.mft.nhs.uk/StructureDefinition/Specimen | Version: 0.0.1 | |||
Draft as of 2025-02-22 | Computable Name: Specimen |
DRAFT Extension of UKCore-Specimen which includes constraints from:
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from UKCoreSpecimen
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | UKCoreSpecimen | Sample for analysis | |
![]() ![]() ![]() |
S | 1..* | CorrelationIdentifier | External Identifier |
![]() ![]() ![]() |
S | 0..1 | AccessionNumber | Identifier assigned by the lab |
![]() ![]() ![]() |
1..1 | Reference(Patient) | Where the specimen came from. | |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
S | 0..1 | Reference(PractitionerRole) | Who collected the specimen |
![]() ![]() ![]() ![]() |
S | 0..1 | dateTime | Collection time |
![]() |
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | UKCoreSpecimen | Sample for analysis dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-3: 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 dom-6: A resource should have narrative for robust management dom-5: If a resource is contained in another resource, it SHALL NOT have a security label | |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
N | 0..1 | CodeableConcept | An extension to record the category of a sample. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-SampleCategory Binding: UK Core Sample Category (extensible): A set of codes to record the category of the sample ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() |
?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() |
SΣ | 1..* | CorrelationIdentifier | External Identifier ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 0..1 | AccessionNumber | Identifier assigned by the lab ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
?!SΣ | 0..1 | code | The availability of the specimen sample. Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 0..1 | CodeableConcept | The kind of material that forms the specimen. Binding: UK Core Specimen Type (preferred): A code from the SNOMED CT UK Clinical Terminology coding system ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣC | 1..1 | Reference(Patient) | Where the specimen came from. ele-1: All FHIR elements must have a @value or children ref-1: SHALL have a contained resource if a local reference is provided |
![]() ![]() ![]() |
SΣ | 0..1 | dateTime | The time when specimen was received for processing. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
C | 0..1 | BackboneElement | Collection details ele-1: All FHIR elements must have a @value or children ukcore-spec-001: Only one of Specimen.collection.collector or Specimen.collection.extension:collectorR5 can be populated at a time. |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
N | 0..* | CodeableConcept | This SHOULD be included if there is a high contamination risk reason for a sample / biopsy. URL: http://hl7.org/fhir/StructureDefinition/specimen-specialHandling ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() ![]() |
N | 0..1 | Reference(Patient | RelatedPerson) | Person who collected the specimen. URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.collection.collector ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
SΣC | 0..1 | Reference(PractitionerRole) | Who collected the specimen ele-1: All FHIR elements must have a @value or children ref-1: SHALL have a contained resource if a local reference is provided |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | dateTime | Collection time ele-1: All FHIR elements must have a @value or children |
![]() |
Path | Conformance | ValueSet | URI |
Specimen.status | required | SpecimenStatushttp://hl7.org/fhir/ValueSet/specimen-status|4.0.1 from the FHIR Standard | |
Specimen.type | preferred | UKCoreSpecimenTypehttps://fhir.hl7.org.uk/ValueSet/UKCore-SpecimenType |
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | UKCoreSpecimen | 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 | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() |
N | 0..1 | CodeableConcept | An extension to record the category of a sample. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-SampleCategory Binding: UK Core Sample Category (extensible): A set of codes to record the category of the sample | ||||
![]() ![]() ![]() |
?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() |
SΣ | 1..* | CorrelationIdentifier | External Identifier | ||||
![]() ![]() ![]() |
SΣ | 0..1 | AccessionNumber | Identifier assigned by the lab | ||||
![]() ![]() ![]() |
?!SΣ | 0..1 | code | The availability of the specimen sample. Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. | ||||
![]() ![]() ![]() |
SΣ | 0..1 | CodeableConcept | The kind of material that forms the specimen. Binding: UK Core Specimen Type (preferred): A code from the SNOMED CT UK Clinical Terminology coding system | ||||
![]() ![]() ![]() |
SΣC | 1..1 | Reference(Patient) | Where the specimen came from. ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() |
SΣ | 0..1 | dateTime | The time when specimen was received for processing. | ||||
![]() ![]() ![]() |
C | 0..* | Reference(Specimen) | Specimen from which this specimen originated ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() |
C | 0..* | Reference(ServiceRequest) | Why the specimen was collected ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() |
C | 0..1 | BackboneElement | Collection details ukcore-spec-001: Only one of Specimen.collection.collector or Specimen.collection.extension:collectorR5 can be populated at a time. | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() ![]() |
N | 0..* | CodeableConcept | This SHOULD be included if there is a high contamination risk reason for a sample / biopsy. URL: http://hl7.org/fhir/StructureDefinition/specimen-specialHandling | ||||
![]() ![]() ![]() ![]() ![]() |
N | 0..1 | Reference(Patient | RelatedPerson) | Person who collected the specimen. URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.collection.collector | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
SΣC | 0..1 | Reference(PractitionerRole) | Who collected the specimen ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | dateTime | Collection time | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | Duration | How long it took to collect specimen qty-3: If a code for the unit is present, the system SHALL also be present drt-1: There SHALL be a code if there is a value and it SHALL be an expression of time. If system is present, it SHALL be UCUM. | ||||
![]() ![]() ![]() ![]() |
C | 0..1 | SimpleQuantity | The quantity of specimen collected qty-3: If a code for the unit is present, the system SHALL also be present sqty-1: The comparator is not used on a SimpleQuantity | ||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Technique used to perform collection Binding: FHIRSpecimenCollectionMethod (example): The technique that is used to perform the procedure. | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Anatomical collection site Binding: UK Core Specimen Body Site (preferred): Codes describing anatomical locations. May include laterality. | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
N | 0..1 | (Complex) | An extension to allow referencing to a BodyStructure. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BodySiteReference | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BodySiteReference" | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
N | 1..1 | Reference(BodyStructure) | A reference to a BodyStructure | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() ![]() |
Σ | 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 | |||||
![]() ![]() ![]() ![]() |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() |
?!Σ | 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. | |||||
![]() ![]() ![]() ![]() |
C | 0..* | Reference(Substance) | Material used in the processing step ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() ![]() |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() ![]() |
N | 0..1 | Reference(UK Core Device) | Device resource for the container. URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.container.device | ||||
![]() ![]() ![]() ![]() ![]() |
N | 0..1 | Reference(UK Core Location) | Where the container is. URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.container.location | ||||
![]() ![]() ![]() ![]() |
?!Σ | 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 (preferred): Type of specimen container. | |||||
![]() ![]() ![]() ![]() |
C | 0..1 | SimpleQuantity | Container volume or size qty-3: If a code for the unit is present, the system SHALL also be present sqty-1: The comparator is not used on a SimpleQuantity | ||||
![]() ![]() ![]() ![]() |
C | 0..1 | SimpleQuantity | Quantity of specimen within container qty-3: If a code for the unit is present, the system SHALL also be present sqty-1: The comparator is not used on a SimpleQuantity | ||||
![]() ![]() ![]() ![]() |
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: UK Core Sample State (extensible): Codes describing the state of the specimen. | ||||
![]() ![]() ![]() |
0..* | Annotation | Comments | |||||
![]() |
Path | Conformance | ValueSet | URI | |||
Specimen.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
Specimen.status | required | SpecimenStatushttp://hl7.org/fhir/ValueSet/specimen-status|4.0.1 from the FHIR Standard | ||||
Specimen.type | preferred | UKCoreSpecimenTypehttps://fhir.hl7.org.uk/ValueSet/UKCore-SpecimenType | ||||
Specimen.collection.method | example | FHIRSpecimenCollectionMethodhttp://hl7.org/fhir/ValueSet/specimen-collection-method from the FHIR Standard | ||||
Specimen.collection.bodySite | preferred | UKCoreSpecimenBodySitehttps://fhir.hl7.org.uk/ValueSet/UKCore-SpecimenBodySite | ||||
Specimen.collection.fastingStatus[x] | extensible | Hl7VSRelevantClincialInformationhttp://terminology.hl7.org/ValueSet/v2-0916 | ||||
Specimen.processing.procedure | example | SpecimenProcessingProcedurehttp://hl7.org/fhir/ValueSet/specimen-processing-procedure from the FHIR Standard | ||||
Specimen.container.type | preferred | SpecimenContainerTypehttp://hl7.org/fhir/ValueSet/specimen-container-type from the FHIR Standard | ||||
Specimen.container.additive[x] | example | Hl7VSAdditivePreservativehttp://terminology.hl7.org/ValueSet/v2-0371 | ||||
Specimen.condition | extensible | UKCoreSampleStatehttps://fhir.hl7.org.uk/ValueSet/UKCore-SampleState |
This structure is derived from UKCoreSpecimen
Summary
Mandatory: 2 elements
Must-Support: 4 elements
Structures
This structure refers to these other structures:
Differential View
This structure is derived from UKCoreSpecimen
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | UKCoreSpecimen | Sample for analysis | |
![]() ![]() ![]() |
S | 1..* | CorrelationIdentifier | External Identifier |
![]() ![]() ![]() |
S | 0..1 | AccessionNumber | Identifier assigned by the lab |
![]() ![]() ![]() |
1..1 | Reference(Patient) | Where the specimen came from. | |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
S | 0..1 | Reference(PractitionerRole) | Who collected the specimen |
![]() ![]() ![]() ![]() |
S | 0..1 | dateTime | Collection time |
![]() |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | UKCoreSpecimen | Sample for analysis dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-3: 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 dom-6: A resource should have narrative for robust management dom-5: If a resource is contained in another resource, it SHALL NOT have a security label | |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
N | 0..1 | CodeableConcept | An extension to record the category of a sample. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-SampleCategory Binding: UK Core Sample Category (extensible): A set of codes to record the category of the sample ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() |
?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() |
SΣ | 1..* | CorrelationIdentifier | External Identifier ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 0..1 | AccessionNumber | Identifier assigned by the lab ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
?!SΣ | 0..1 | code | The availability of the specimen sample. Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 0..1 | CodeableConcept | The kind of material that forms the specimen. Binding: UK Core Specimen Type (preferred): A code from the SNOMED CT UK Clinical Terminology coding system ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣC | 1..1 | Reference(Patient) | Where the specimen came from. ele-1: All FHIR elements must have a @value or children ref-1: SHALL have a contained resource if a local reference is provided |
![]() ![]() ![]() |
SΣ | 0..1 | dateTime | The time when specimen was received for processing. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
C | 0..1 | BackboneElement | Collection details ele-1: All FHIR elements must have a @value or children ukcore-spec-001: Only one of Specimen.collection.collector or Specimen.collection.extension:collectorR5 can be populated at a time. |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
N | 0..* | CodeableConcept | This SHOULD be included if there is a high contamination risk reason for a sample / biopsy. URL: http://hl7.org/fhir/StructureDefinition/specimen-specialHandling ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() ![]() |
N | 0..1 | Reference(Patient | RelatedPerson) | Person who collected the specimen. URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.collection.collector ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
SΣC | 0..1 | Reference(PractitionerRole) | Who collected the specimen ele-1: All FHIR elements must have a @value or children ref-1: SHALL have a contained resource if a local reference is provided |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | dateTime | Collection time ele-1: All FHIR elements must have a @value or children |
![]() |
Path | Conformance | ValueSet | URI |
Specimen.status | required | SpecimenStatushttp://hl7.org/fhir/ValueSet/specimen-status|4.0.1 from the FHIR Standard | |
Specimen.type | preferred | UKCoreSpecimenTypehttps://fhir.hl7.org.uk/ValueSet/UKCore-SpecimenType |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | UKCoreSpecimen | 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 | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() |
N | 0..1 | CodeableConcept | An extension to record the category of a sample. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-SampleCategory Binding: UK Core Sample Category (extensible): A set of codes to record the category of the sample | ||||
![]() ![]() ![]() |
?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() |
SΣ | 1..* | CorrelationIdentifier | External Identifier | ||||
![]() ![]() ![]() |
SΣ | 0..1 | AccessionNumber | Identifier assigned by the lab | ||||
![]() ![]() ![]() |
?!SΣ | 0..1 | code | The availability of the specimen sample. Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. | ||||
![]() ![]() ![]() |
SΣ | 0..1 | CodeableConcept | The kind of material that forms the specimen. Binding: UK Core Specimen Type (preferred): A code from the SNOMED CT UK Clinical Terminology coding system | ||||
![]() ![]() ![]() |
SΣC | 1..1 | Reference(Patient) | Where the specimen came from. ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() |
SΣ | 0..1 | dateTime | The time when specimen was received for processing. | ||||
![]() ![]() ![]() |
C | 0..* | Reference(Specimen) | Specimen from which this specimen originated ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() |
C | 0..* | Reference(ServiceRequest) | Why the specimen was collected ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() |
C | 0..1 | BackboneElement | Collection details ukcore-spec-001: Only one of Specimen.collection.collector or Specimen.collection.extension:collectorR5 can be populated at a time. | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() ![]() |
N | 0..* | CodeableConcept | This SHOULD be included if there is a high contamination risk reason for a sample / biopsy. URL: http://hl7.org/fhir/StructureDefinition/specimen-specialHandling | ||||
![]() ![]() ![]() ![]() ![]() |
N | 0..1 | Reference(Patient | RelatedPerson) | Person who collected the specimen. URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.collection.collector | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
SΣC | 0..1 | Reference(PractitionerRole) | Who collected the specimen ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | dateTime | Collection time | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | Duration | How long it took to collect specimen qty-3: If a code for the unit is present, the system SHALL also be present drt-1: There SHALL be a code if there is a value and it SHALL be an expression of time. If system is present, it SHALL be UCUM. | ||||
![]() ![]() ![]() ![]() |
C | 0..1 | SimpleQuantity | The quantity of specimen collected qty-3: If a code for the unit is present, the system SHALL also be present sqty-1: The comparator is not used on a SimpleQuantity | ||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Technique used to perform collection Binding: FHIRSpecimenCollectionMethod (example): The technique that is used to perform the procedure. | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Anatomical collection site Binding: UK Core Specimen Body Site (preferred): Codes describing anatomical locations. May include laterality. | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
N | 0..1 | (Complex) | An extension to allow referencing to a BodyStructure. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BodySiteReference | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BodySiteReference" | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
N | 1..1 | Reference(BodyStructure) | A reference to a BodyStructure | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() ![]() |
Σ | 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 | |||||
![]() ![]() ![]() ![]() |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() |
?!Σ | 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. | |||||
![]() ![]() ![]() ![]() |
C | 0..* | Reference(Substance) | Material used in the processing step ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() ![]() |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() ![]() |
N | 0..1 | Reference(UK Core Device) | Device resource for the container. URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.container.device | ||||
![]() ![]() ![]() ![]() ![]() |
N | 0..1 | Reference(UK Core Location) | Where the container is. URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Specimen.container.location | ||||
![]() ![]() ![]() ![]() |
?!Σ | 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 (preferred): Type of specimen container. | |||||
![]() ![]() ![]() ![]() |
C | 0..1 | SimpleQuantity | Container volume or size qty-3: If a code for the unit is present, the system SHALL also be present sqty-1: The comparator is not used on a SimpleQuantity | ||||
![]() ![]() ![]() ![]() |
C | 0..1 | SimpleQuantity | Quantity of specimen within container qty-3: If a code for the unit is present, the system SHALL also be present sqty-1: The comparator is not used on a SimpleQuantity | ||||
![]() ![]() ![]() ![]() |
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: UK Core Sample State (extensible): Codes describing the state of the specimen. | ||||
![]() ![]() ![]() |
0..* | Annotation | Comments | |||||
![]() |
Path | Conformance | ValueSet | URI | |||
Specimen.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
Specimen.status | required | SpecimenStatushttp://hl7.org/fhir/ValueSet/specimen-status|4.0.1 from the FHIR Standard | ||||
Specimen.type | preferred | UKCoreSpecimenTypehttps://fhir.hl7.org.uk/ValueSet/UKCore-SpecimenType | ||||
Specimen.collection.method | example | FHIRSpecimenCollectionMethodhttp://hl7.org/fhir/ValueSet/specimen-collection-method from the FHIR Standard | ||||
Specimen.collection.bodySite | preferred | UKCoreSpecimenBodySitehttps://fhir.hl7.org.uk/ValueSet/UKCore-SpecimenBodySite | ||||
Specimen.collection.fastingStatus[x] | extensible | Hl7VSRelevantClincialInformationhttp://terminology.hl7.org/ValueSet/v2-0916 | ||||
Specimen.processing.procedure | example | SpecimenProcessingProcedurehttp://hl7.org/fhir/ValueSet/specimen-processing-procedure from the FHIR Standard | ||||
Specimen.container.type | preferred | SpecimenContainerTypehttp://hl7.org/fhir/ValueSet/specimen-container-type from the FHIR Standard | ||||
Specimen.container.additive[x] | example | Hl7VSAdditivePreservativehttp://terminology.hl7.org/ValueSet/v2-0371 | ||||
Specimen.condition | extensible | UKCoreSampleStatehttps://fhir.hl7.org.uk/ValueSet/UKCore-SampleState |
This structure is derived from UKCoreSpecimen
Summary
Mandatory: 2 elements
Must-Support: 4 elements
Structures
This structure refers to these other structures:
Other representations of profile: CSV, Excel, Schematron