NCPI FHIR Implementation Guide v2
0.1.0 - ci-build
NCPI FHIR Implementation Guide v2 - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Official URL: https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/SharedDataModelAliquot | Version: 0.1.0 | |||
Draft as of 2024-11-25 | Computable Name: CmdAliquot |
Shared Data Model for Aliquot
These entities are intended to present to users the history of samples used in a research study. They may also indicate potential availability of samples for request by other researchers. This model is specifically intended to express sample origins (Collection), sample flow and processing (Sample), and even specific stored tubes/slides (Aliquot). Conceptually, these represent the procedure at which the Biospecimen was collected (Collection), “biologically equivalent” samples in the path of processing (Sample), and specific tubes which may have a role in some circumstances (Aliquot).
A high level requirement from our common use cases is to understand “what sample was collected” and “what sample went into the assay”. This is important in genomics given “whole blood” vs “saliva” DNA analysis.
Some studies may provide detailed information about biospecimen-in-tubes. They may be available for analysis by others, for example. These can represent exact tubes or total amounts available of a Sample.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Base
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
SharedDataModelAliquot | 0..* | Base | Shared Data Model for Aliquot Instances of this logical model are not marked to be the target of a Reference | |
aliquotId | 1..1 | string | Unique ID for this aliquot | |
sample | 1..1 | VSReference(5.1.0) | The sample of which this tube is a part. | |
availabilityStatus | 0..1 | code | Can this Sample be requested for further analysis? | |
volume | 0..1 | Quantity | What is the volume of the Aliquot? | |
concentration | 0..1 | Quantity | What is the concentration of the analyte in the Aliquot? | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
SharedDataModelAliquot | 0..* | Base | Shared Data Model for Aliquot Instances of this logical model are not marked to be the target of a Reference | |
aliquotId | 1..1 | string | Unique ID for this aliquot | |
sample | 1..1 | VSReference(5.1.0) | The sample of which this tube is a part. | |
availabilityStatus | 0..1 | code | Can this Sample be requested for further analysis? | |
volume | 0..1 | Quantity | What is the volume of the Aliquot? | |
concentration | 0..1 | Quantity | What is the concentration of the analyte in the Aliquot? | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
SharedDataModelAliquot | 0..* | Base | Shared Data Model for Aliquot Instances of this logical model are not marked to be the target of a Reference | |
aliquotId | 1..1 | string | Unique ID for this aliquot | |
sample | 1..1 | VSReference(5.1.0) | The sample of which this tube is a part. | |
availabilityStatus | 0..1 | code | Can this Sample be requested for further analysis? | |
volume | 0..1 | Quantity | What is the volume of the Aliquot? | |
concentration | 0..1 | Quantity | What is the concentration of the analyte in the Aliquot? | |
Documentation for this format |
This structure is derived from Base
Differential View
This structure is derived from Base
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
SharedDataModelAliquot | 0..* | Base | Shared Data Model for Aliquot Instances of this logical model are not marked to be the target of a Reference | |
aliquotId | 1..1 | string | Unique ID for this aliquot | |
sample | 1..1 | VSReference(5.1.0) | The sample of which this tube is a part. | |
availabilityStatus | 0..1 | code | Can this Sample be requested for further analysis? | |
volume | 0..1 | Quantity | What is the volume of the Aliquot? | |
concentration | 0..1 | Quantity | What is the concentration of the analyte in the Aliquot? | |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
SharedDataModelAliquot | 0..* | Base | Shared Data Model for Aliquot Instances of this logical model are not marked to be the target of a Reference | |
aliquotId | 1..1 | string | Unique ID for this aliquot | |
sample | 1..1 | VSReference(5.1.0) | The sample of which this tube is a part. | |
availabilityStatus | 0..1 | code | Can this Sample be requested for further analysis? | |
volume | 0..1 | Quantity | What is the volume of the Aliquot? | |
concentration | 0..1 | Quantity | What is the concentration of the analyte in the Aliquot? | |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
SharedDataModelAliquot | 0..* | Base | Shared Data Model for Aliquot Instances of this logical model are not marked to be the target of a Reference | |
aliquotId | 1..1 | string | Unique ID for this aliquot | |
sample | 1..1 | VSReference(5.1.0) | The sample of which this tube is a part. | |
availabilityStatus | 0..1 | code | Can this Sample be requested for further analysis? | |
volume | 0..1 | Quantity | What is the volume of the Aliquot? | |
concentration | 0..1 | Quantity | What is the concentration of the analyte in the Aliquot? | |
Documentation for this format |
This structure is derived from Base