The FHIR Specimen Resource is defined as a sample to be used for analysis. Scope and usage extends to any material sample which is taken from a biological entity, living or dead or taken from a physical object or the environment. Some specimens are biological and can contain one or more components including but not limited to cellular molecules, cells, tissues, organs, body fluids, embryos, and body excretory products (source: NCI Thesaurus , modified). The specimen resource covers substances used for diagnostic and environmental testing.
Name | Card. | Type | Description & Constraints |
---|---|---|---|
Specimen | Specimen | Sample for analysis | |
identifier | 0..1 | Identifier | External Identifier |
use | 0..1 | Code | usual | official | temp | secondary (If known) Binding: Identifies the purpose for this identifier, if known . (http://hl7.org/fhir/ValueSet/identifier-use) Binding Strength: Required Example Value: official |
type | 0..1 | CodeableConcept | Description of identifier Binding: A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. (http://hl7.org/fhir/ValueSet/identifier-type) Binding Strength: Extensible |
coding | 0..1 | Coding | Code defined by a terminology system |
system | 1..1 | Uri | Identity of the terminology system |
version | 0..1 | String | Version of the system - if relevant |
code | 1..1 | Code | Symbol in syntax defined by the system |
display | 1..1 | String | Representation defined by the system |
userSelected | 0..1 | Boolean | If this coding was chosen directly by the user |
text | 0..1 | String | Plain text representation of the concept |
system | 1..1 | Uri | The namespace for the identifier Example Value: http://mmp.nhs.uk/id/specimen-id |
value | 1..1 | String | The value that is unique Example Value: B603CEDE-8C3F-4909-9CB1-D47C0FDE9F8A |
period | 0..1 | Period | Time period when id is/was valid for use |
start | 1..1 | DateTime | Starting time with inclusive boundary |
end | 0..1 | DateTime | End time with inclusive boundary, if not ongoing |
assigner | 0..1 | Organization | Organization that issued id (may be just text) |
reference | 1..1 | String | Relative URL reference Example Value: Organisation/78D64BB3-B5B2-450B-AEB7-D9035EBC711D |
display | 0..1 | String | Text alternative for the resource Example Value: MGP Medical Centre |
status | 0..1 | Code | available | unavailable | unsatisfactory | entered-in-error Binding: Codes providing the status/availability of a specimen. (http://hl7.org/fhir/ValueSet/specimen-status) Binding Strength: Required |
type | 0..1 | CodeableConcept | Kind of material that forms the specimen Binding: The type of the specimen. (http://snomed.info/sct) Binding Strength: Example |
coding | 0..1 | Coding | Code defined by a terminology system |
system | 1..1 | Uri | Identity of the terminology system Fixed Value: http://snomed.info/sct |
version | 0..1 | String | Version of the system - if relevant Example Value: 20150731 |
code | 1..1 | Code | Symbol in syntax defined by the system Example Value: 119297000 |
display | 1..1 | String | Representation defined by the system Example Value: Blood specimen |
userSelected | 0..1 | Boolean | If this coding was chosen directly by the user |
text | 0..1 | String | Plain text representation of the concept |
parent | 0..* | Specimen | Specimen from which this specimen originated |
reference | 1..1 | String | Relative, internal or absolute URL reference |
display | 0..1 | String | Text alternative for the resource |
subject | 1..1 | dds-report-patient-1-0, Group, Device, Substance | Where the specimen came from. This may be from the patient(s) or from the environment or a device |
accessionIdentifier | 0..1 | Identifier | Identifier assigned by the lab |
use | 0..1 | Code | usual | official | temp | secondary (If known) Binding: Identifies the purpose for this identifier, if known . (http://hl7.org/fhir/ValueSet/identifier-use) Binding Strength: Required |
type | 0..1 | CodeableConcept | Description of identifier Binding: A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. (http://hl7.org/fhir/ValueSet/identifier-type) Binding Strength: Extensible |
coding | 0..1 | Coding | Code defined by a terminology system |
system | 1..1 | Uri | Identity of the terminology system |
version | 0..1 | String | Version of the system - if relevant |
code | 1..1 | Code | Symbol in syntax defined by the system |
display | 1..1 | String | Representation defined by the system |
userSelected | 0..1 | Boolean | If this coding was chosen directly by the user |
text | 0..1 | String | Plain text representation of the concept |
system | 1..1 | Uri | The namespace for the identifier Example Value: http://www.sampleth.nhs.uk/pathology/BloodSciences/labno |
value | 1..1 | String | The value that is unique Example Value: HAEM8667800001 |
period | 0..1 | Period | Time period when id is/was valid for use |
start | 1..1 | DateTime | Starting time with inclusive boundary |
end | 0..1 | DateTime | End time with inclusive boundary, if not ongoing |
assigner | 0..1 | Organization | Organization that issued id (may be just text) |
reference | 1..1 | String | Relative URL reference Example Value: Organization/223F5C66-66BF-4CEA-A5D7-25AB9348B448 |
display | 0..1 | String | Text alternative for the resource |
receivedTime | 0..1 | DateTime | The time when specimen was received for processing |
collection | 0..1 | BackboneElement | Collection details |
collector | 0..1 | Practitioner | Who collected the specimen |
reference | 1..1 | String | Relative URL reference Example Value: Practitioner/4BFCA0EF-85D0-4C5E-B662-D4910BB83D82 |
display | 0..1 | String | Text alternative for the resource Example Value: Dr. Jones |
comment | 0..* | String | Collector comments |
collected[x] | 0..1 | DateTime, Period | Collection time |
quantity | 0..1 | StructureDefinition/SimpleQuantity | The quantity of specimen collected |
value | 1..1 | Decimal | Numerical value (with implicit precision) Example Value: 6 |
comparator | 0..1 | Code | < | <= | >= | > - how to understand the value Binding: How the Quantity should be understood and represented. (http://hl7.org/fhir/ValueSet/quantity-comparator) Binding Strength: Required |
unit | 1..1 | String | Unit representation Example Value: millilitre |
system | 1..1 | Uri | System that defines coded unit form Example Value: http://unitsofmeasure.org |
code | 1..1 | Code | Coded form of the unit Example Value: mL |
method | 0..1 | CodeableConcept | Technique used to perform collection Binding: The technique that is used to perform the procedure (http://snomed.info/sct) Binding Strength: Example |
coding | 0..1 | Coding | Code defined by a terminology system |
system | 1..1 | Uri | Identity of the terminology system Fixed Value: http://snomed.info/sct |
version | 0..1 | String | Version of the system - if relevant |
code | 1..1 | Code | Symbol in syntax defined by the system Example Value: 32564009 |
display | 1..1 | String | Representation defined by the system Example Value: arterial specimen collection for laboratory test |
userSelected | 0..1 | Boolean | If this coding was chosen directly by the user |
text | 0..1 | String | Plain text representation of the concept |
bodySite | 0..1 | CodeableConcept | Anatomical collection site Binding: Codes describing anatomical locations. May include laterality. (http://hl7.org/fhir/ValueSet/body-site) Binding Strength: Example |
coding | 0..1 | Coding | Code defined by a terminology system |
system | 1..1 | Uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/ValueSet/body-site |
version | 0..1 | String | Version of the system - if relevant |
code | 1..1 | Code | Symbol in syntax defined by the system Example Value: 308046002 |
display | 1..1 | String | Representation defined by the system Example Value: Structure of superficial forearm vein |
userSelected | 0..1 | Boolean | If this coding was chosen directly by the user |
text | 0..1 | String | Plain text representation of the concept |
treatment | 0..* | BackboneElement | Treatment and processing step details |
description | 0..1 | String | Textual description of procedure Example Value: Treated with anticoagulants. |
procedure | 0..1 | CodeableConcept | Indicates the treatment or processing step applied to the specimen Binding: Type indicating the technique used to process the specimen (http://hl7.org/fhir/ValueSet/specimen-treatment-procedure) Binding Strength: Example |
coding | 0..1 | Coding | Code defined by a terminology system |
system | 1..1 | Uri | Identity of the terminology system |
version | 0..1 | String | Version of the system - if relevant |
code | 1..1 | Code | Symbol in syntax defined by the system |
display | 1..1 | String | Representation defined by the system |
userSelected | 0..1 | Boolean | If this coding was chosen directly by the user |
text | 0..1 | String | Plain text representation of the concept |
additive | 0..* | StructureDefinition/Substance | Material used in the processing step |
reference | 1..1 | String | Relative URL reference |
display | 0..1 | String | Text alternative for the resource |
container | 0..* | BackboneElement | Direct container of specimen (tube/slide, etc.) |
identifier | 0..1 | Identifier | Id for the container |
use | 0..1 | Code | usual | official | temp | secondary (If known) Binding: Identifies the purpose for this identifier, if known . (http://hl7.org/fhir/ValueSet/identifier-use) Binding Strength: Required |
type | 0..1 | CodeableConcept | Description of identifier Binding: A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. (http://hl7.org/fhir/ValueSet/identifier-type) Binding Strength: Extensible |
coding | 0..1 | Coding | Code defined by a terminology system |
system | 1..1 | Uri | Identity of the terminology system |
version | 0..1 | String | Version of the system - if relevant |
code | 1..1 | Code | Symbol in syntax defined by the system |
display | 1..1 | String | Representation defined by the system |
userSelected | 0..1 | Boolean | If this coding was chosen directly by the user |
text | 0..1 | String | Plain text representation of the concept |
system | 1..1 | Uri | The namespace for the identifier Example Value: http://mmp.nhs.uk/id/container-id |
value | 1..1 | String | The value that is unique Example Value: 08FC96C4-EB3A-46D3-93C5-4B23792DCC1C |
period | 0..1 | Period | Time period when id is/was valid for use |
start | 1..1 | DateTime | Starting time with inclusive boundary |
end | 0..1 | DateTime | End time with inclusive boundary, if not ongoing |
assigner | 0..1 | StructureDefinition/dds-report-organization-1-0 | Organization that issued id (may be just text) |
reference | 1..1 | String | Relative URL reference Example Value: Organization/78D64BB3-B5B2-450B-AEB7-D9035EBC711D |
display | 0..1 | String | Text alternative for the resource Example Value: MGP Medical Centre |
description | 0..1 | String | Textual description of the container |
type | 0..1 | CodeableConcept | Kind of container directly associated with specimen Binding: Type of specimen container (http://snomed.info/sct) Binding Strength: Example |
coding | 0..1 | Coding | Code defined by a terminology system |
system | 1..1 | Uri | Identity of the terminology system Fixed Value: http://snomed.info/sct |
version | 0..1 | String | Version of the system - if relevant Example Value: 20150731 |
code | 1..1 | Code | Symbol in syntax defined by the system Example Value: 434746001 |
display | 1..1 | String | Representation defined by the system Example Value: Specimen vial |
userSelected | 0..1 | Boolean | If this coding was chosen directly by the user |
text | 0..1 | String | Plain text representation of the concept |
capacity | 0..1 | StructureDefinition/SimpleQuantity | Container volume or size |
value | 1..1 | Decimal | Numerical value (with implicit precision) Example Value: 10 |
comparator | 0..1 | Code | < | <= | >= | > - how to understand the value Binding: How the Quantity should be understood and represented. (http://hl7.org/fhir/ValueSet/quantity-comparator) Binding Strength: Required |
unit | 1..1 | String | Unit representation Example Value: millilitre |
system | 1..1 | Uri | System that defines coded unit form Example Value: http://unitsofmeasure.org |
code | 1..1 | Code | Coded form of the unit Example Value: mL |
specimenQuantity | 0..1 | StructureDefinition/SimpleQuantity | Quantity of specimen within container |
value | 1..1 | Decimal | Numerical value (with implicit precision) Example Value: 6 |
comparator | 0..1 | Code | < | <= | >= | > - how to understand the value Binding: How the Quantity should be understood and represented. (http://hl7.org/fhir/ValueSet/quantity-comparator) Binding Strength: Required |
unit | 1..1 | String | Unit representation Example Value: millilitre |
system | 1..1 | Uri | System that defines coded unit form Example Value: http://unitsofmeasure.org |
code | 1..1 | Code | Coded form of the unit Example Value: mL |
additive[x] | 0..1 | Substance | Additive associated with container Binding: Substance added to specimen container (http://hl7.org/fhir/ValueSet/v2-0371) Binding Strength: Example |