NCPI FHIR Implementation Guide v2
0.2.0 - ci-build
NCPI FHIR Implementation Guide v2 - Local Development build (v0.2.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/SharedDataModelFileMetadata | Version: 0.2.0 | |||
| Draft as of 2025-12-03 | Computable Name: CdmFileMetadata | |||
The Shared Data Model for File Metadata
File metadata serves to provide further information about a given file related to certain participants or specimen. This IG supports FASTQ, MAF, BAM/CRAM, Proteomics, and VCF file types as branches from a common parent of NCPI File Metadata
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Base | Shared data model for File Metadata | |
![]() ![]() |
1..1 | Reference() | The file which this metadata refers to | |
![]() ![]() |
0..1 | CodeableConcept | Assay strategy employed for this file | |
![]() ![]() |
0..1 | CodeableConcept | The platform instrument employed for this file | |
![]() ![]() |
0..* | Reference() | Any samples (biospecimen) related to the file | |
![]() ![]() |
0..1 | CodeableConcept | The library preparation employed for this file | |
![]() ![]() |
0..1 | CodeableConcept | The library selection employed for this file | |
![]() ![]() |
0..1 | CodeableConcept | The strandedness of the file | |
![]() ![]() |
0..1 | CodeableConcept | The target region employed for this file | |
![]() ![]() |
0..1 | CodeableConcept | The reference genome employed for this file | |
![]() ![]() |
0..1 | boolean | Does this file represent paired end data? | |
![]() ![]() |
0..1 | CodeableConcept | The workflow type employed for this file | |
![]() ![]() |
0..1 | CodeableConcept | The workflow tool employed for this file | |
![]() ![]() |
0..1 | boolean | Does this file indicate that an adaptor is trimmed? | |
Documentation for this format | ||||
This structure is derived from Base
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Base | Shared data model for File Metadata | |
![]() ![]() |
1..1 | Reference() | The file which this metadata refers to | |
![]() ![]() |
0..1 | CodeableConcept | Assay strategy employed for this file | |
![]() ![]() |
0..1 | CodeableConcept | The platform instrument employed for this file | |
![]() ![]() |
0..* | Reference() | Any samples (biospecimen) related to the file | |
![]() ![]() |
0..1 | CodeableConcept | The library preparation employed for this file | |
![]() ![]() |
0..1 | CodeableConcept | The library selection employed for this file | |
![]() ![]() |
0..1 | CodeableConcept | The strandedness of the file | |
![]() ![]() |
0..1 | CodeableConcept | The target region employed for this file | |
![]() ![]() |
0..1 | CodeableConcept | The reference genome employed for this file | |
![]() ![]() |
0..1 | boolean | Does this file represent paired end data? | |
![]() ![]() |
0..1 | CodeableConcept | The workflow type employed for this file | |
![]() ![]() |
0..1 | CodeableConcept | The workflow tool employed for this file | |
![]() ![]() |
0..1 | boolean | Does this file indicate that an adaptor is trimmed? | |
Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Base | Shared data model for File Metadata | |
![]() ![]() |
1..1 | Reference() | The file which this metadata refers to | |
![]() ![]() |
0..1 | CodeableConcept | Assay strategy employed for this file | |
![]() ![]() |
0..1 | CodeableConcept | The platform instrument employed for this file | |
![]() ![]() |
0..* | Reference() | Any samples (biospecimen) related to the file | |
![]() ![]() |
0..1 | CodeableConcept | The library preparation employed for this file | |
![]() ![]() |
0..1 | CodeableConcept | The library selection employed for this file | |
![]() ![]() |
0..1 | CodeableConcept | The strandedness of the file | |
![]() ![]() |
0..1 | CodeableConcept | The target region employed for this file | |
![]() ![]() |
0..1 | CodeableConcept | The reference genome employed for this file | |
![]() ![]() |
0..1 | boolean | Does this file represent paired end data? | |
![]() ![]() |
0..1 | CodeableConcept | The workflow type employed for this file | |
![]() ![]() |
0..1 | CodeableConcept | The workflow tool employed for this file | |
![]() ![]() |
0..1 | boolean | Does this file indicate that an adaptor is trimmed? | |
Documentation for this format | ||||
This structure is derived from Base
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Base | Shared data model for File Metadata | |
![]() ![]() |
1..1 | Reference() | The file which this metadata refers to | |
![]() ![]() |
0..1 | CodeableConcept | Assay strategy employed for this file | |
![]() ![]() |
0..1 | CodeableConcept | The platform instrument employed for this file | |
![]() ![]() |
0..* | Reference() | Any samples (biospecimen) related to the file | |
![]() ![]() |
0..1 | CodeableConcept | The library preparation employed for this file | |
![]() ![]() |
0..1 | CodeableConcept | The library selection employed for this file | |
![]() ![]() |
0..1 | CodeableConcept | The strandedness of the file | |
![]() ![]() |
0..1 | CodeableConcept | The target region employed for this file | |
![]() ![]() |
0..1 | CodeableConcept | The reference genome employed for this file | |
![]() ![]() |
0..1 | boolean | Does this file represent paired end data? | |
![]() ![]() |
0..1 | CodeableConcept | The workflow type employed for this file | |
![]() ![]() |
0..1 | CodeableConcept | The workflow tool employed for this file | |
![]() ![]() |
0..1 | boolean | Does this file indicate that an adaptor is trimmed? | |
Documentation for this format | ||||
Differential View
This structure is derived from Base
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Base | Shared data model for File Metadata | |
![]() ![]() |
1..1 | Reference() | The file which this metadata refers to | |
![]() ![]() |
0..1 | CodeableConcept | Assay strategy employed for this file | |
![]() ![]() |
0..1 | CodeableConcept | The platform instrument employed for this file | |
![]() ![]() |
0..* | Reference() | Any samples (biospecimen) related to the file | |
![]() ![]() |
0..1 | CodeableConcept | The library preparation employed for this file | |
![]() ![]() |
0..1 | CodeableConcept | The library selection employed for this file | |
![]() ![]() |
0..1 | CodeableConcept | The strandedness of the file | |
![]() ![]() |
0..1 | CodeableConcept | The target region employed for this file | |
![]() ![]() |
0..1 | CodeableConcept | The reference genome employed for this file | |
![]() ![]() |
0..1 | boolean | Does this file represent paired end data? | |
![]() ![]() |
0..1 | CodeableConcept | The workflow type employed for this file | |
![]() ![]() |
0..1 | CodeableConcept | The workflow tool employed for this file | |
![]() ![]() |
0..1 | boolean | Does this file indicate that an adaptor is trimmed? | |
Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Base | Shared data model for File Metadata | |
![]() ![]() |
1..1 | Reference() | The file which this metadata refers to | |
![]() ![]() |
0..1 | CodeableConcept | Assay strategy employed for this file | |
![]() ![]() |
0..1 | CodeableConcept | The platform instrument employed for this file | |
![]() ![]() |
0..* | Reference() | Any samples (biospecimen) related to the file | |
![]() ![]() |
0..1 | CodeableConcept | The library preparation employed for this file | |
![]() ![]() |
0..1 | CodeableConcept | The library selection employed for this file | |
![]() ![]() |
0..1 | CodeableConcept | The strandedness of the file | |
![]() ![]() |
0..1 | CodeableConcept | The target region employed for this file | |
![]() ![]() |
0..1 | CodeableConcept | The reference genome employed for this file | |
![]() ![]() |
0..1 | boolean | Does this file represent paired end data? | |
![]() ![]() |
0..1 | CodeableConcept | The workflow type employed for this file | |
![]() ![]() |
0..1 | CodeableConcept | The workflow tool employed for this file | |
![]() ![]() |
0..1 | boolean | Does this file indicate that an adaptor is trimmed? | |
Documentation for this format | ||||
This structure is derived from Base