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

Logical Model: Shared data model for File Metadata

Official URL: https://nih-ncpi.github.io/ncpi-fhir-ig-2/StructureDefinition/SharedDataModelFileMetadata Version: 0.1.0
Draft as of 2024-11-25 Computable Name: CdmFileMetadata

The Shared Data Model for File Metadata

NCPI File Metadata

Introduction

​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

Usage:

  • This Logical Model Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraintsdoco
.. SharedDataModelFileMetadata 0..* Base Shared data model for File Metadata
Instances of this logical model are not marked to be the target of a Reference
... parentFile 1..1 Reference() The file which this metadata refers to
... assayStrategy 0..1 CodeableConcept Assay strategy employed for this file
... platformInstrument 0..1 CodeableConcept The platform instrument employed for this file
... libraryPrep 0..1 CodeableConcept The library preparation employed for this file
... librarySelection 0..1 CodeableConcept The library selection employed for this file
... strandedness 0..1 CodeableConcept The strandedness of the file
... targetRegion 0..1 CodeableConcept The target region employed for this file
... referenceGenome 0..1 CodeableConcept The reference genome employed for this file
... isPairedEnd 0..1 boolean Does this file represent paired end data?
... workflowType 0..1 CodeableConcept The workflow type employed for this file
... workflowTool 0..1 CodeableConcept The workflow tool employed for this file
... adaptorTrimmed 0..1 boolean Does this file indicate that an adaptor is trimmed?

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. SharedDataModelFileMetadata 0..* Base Shared data model for File Metadata
Instances of this logical model are not marked to be the target of a Reference
... parentFile 1..1 Reference() The file which this metadata refers to
... assayStrategy 0..1 CodeableConcept Assay strategy employed for this file
... platformInstrument 0..1 CodeableConcept The platform instrument employed for this file
... libraryPrep 0..1 CodeableConcept The library preparation employed for this file
... librarySelection 0..1 CodeableConcept The library selection employed for this file
... strandedness 0..1 CodeableConcept The strandedness of the file
... targetRegion 0..1 CodeableConcept The target region employed for this file
... referenceGenome 0..1 CodeableConcept The reference genome employed for this file
... isPairedEnd 0..1 boolean Does this file represent paired end data?
... workflowType 0..1 CodeableConcept The workflow type employed for this file
... workflowTool 0..1 CodeableConcept The workflow tool employed for this file
... adaptorTrimmed 0..1 boolean Does this file indicate that an adaptor is trimmed?

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. SharedDataModelFileMetadata 0..* Base Shared data model for File Metadata
Instances of this logical model are not marked to be the target of a Reference
... parentFile 1..1 Reference() The file which this metadata refers to
... assayStrategy 0..1 CodeableConcept Assay strategy employed for this file
... platformInstrument 0..1 CodeableConcept The platform instrument employed for this file
... libraryPrep 0..1 CodeableConcept The library preparation employed for this file
... librarySelection 0..1 CodeableConcept The library selection employed for this file
... strandedness 0..1 CodeableConcept The strandedness of the file
... targetRegion 0..1 CodeableConcept The target region employed for this file
... referenceGenome 0..1 CodeableConcept The reference genome employed for this file
... isPairedEnd 0..1 boolean Does this file represent paired end data?
... workflowType 0..1 CodeableConcept The workflow type employed for this file
... workflowTool 0..1 CodeableConcept The workflow tool employed for this file
... adaptorTrimmed 0..1 boolean Does this file indicate that an adaptor is trimmed?

doco Documentation for this format

This structure is derived from Base

Summary

Mandatory: 0 element(1 nested mandatory element)

Differential View

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraintsdoco
.. SharedDataModelFileMetadata 0..* Base Shared data model for File Metadata
Instances of this logical model are not marked to be the target of a Reference
... parentFile 1..1 Reference() The file which this metadata refers to
... assayStrategy 0..1 CodeableConcept Assay strategy employed for this file
... platformInstrument 0..1 CodeableConcept The platform instrument employed for this file
... libraryPrep 0..1 CodeableConcept The library preparation employed for this file
... librarySelection 0..1 CodeableConcept The library selection employed for this file
... strandedness 0..1 CodeableConcept The strandedness of the file
... targetRegion 0..1 CodeableConcept The target region employed for this file
... referenceGenome 0..1 CodeableConcept The reference genome employed for this file
... isPairedEnd 0..1 boolean Does this file represent paired end data?
... workflowType 0..1 CodeableConcept The workflow type employed for this file
... workflowTool 0..1 CodeableConcept The workflow tool employed for this file
... adaptorTrimmed 0..1 boolean Does this file indicate that an adaptor is trimmed?

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. SharedDataModelFileMetadata 0..* Base Shared data model for File Metadata
Instances of this logical model are not marked to be the target of a Reference
... parentFile 1..1 Reference() The file which this metadata refers to
... assayStrategy 0..1 CodeableConcept Assay strategy employed for this file
... platformInstrument 0..1 CodeableConcept The platform instrument employed for this file
... libraryPrep 0..1 CodeableConcept The library preparation employed for this file
... librarySelection 0..1 CodeableConcept The library selection employed for this file
... strandedness 0..1 CodeableConcept The strandedness of the file
... targetRegion 0..1 CodeableConcept The target region employed for this file
... referenceGenome 0..1 CodeableConcept The reference genome employed for this file
... isPairedEnd 0..1 boolean Does this file represent paired end data?
... workflowType 0..1 CodeableConcept The workflow type employed for this file
... workflowTool 0..1 CodeableConcept The workflow tool employed for this file
... adaptorTrimmed 0..1 boolean Does this file indicate that an adaptor is trimmed?

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. SharedDataModelFileMetadata 0..* Base Shared data model for File Metadata
Instances of this logical model are not marked to be the target of a Reference
... parentFile 1..1 Reference() The file which this metadata refers to
... assayStrategy 0..1 CodeableConcept Assay strategy employed for this file
... platformInstrument 0..1 CodeableConcept The platform instrument employed for this file
... libraryPrep 0..1 CodeableConcept The library preparation employed for this file
... librarySelection 0..1 CodeableConcept The library selection employed for this file
... strandedness 0..1 CodeableConcept The strandedness of the file
... targetRegion 0..1 CodeableConcept The target region employed for this file
... referenceGenome 0..1 CodeableConcept The reference genome employed for this file
... isPairedEnd 0..1 boolean Does this file represent paired end data?
... workflowType 0..1 CodeableConcept The workflow type employed for this file
... workflowTool 0..1 CodeableConcept The workflow tool employed for this file
... adaptorTrimmed 0..1 boolean Does this file indicate that an adaptor is trimmed?

doco Documentation for this format

This structure is derived from Base

Summary

Mandatory: 0 element(1 nested mandatory element)

 

Other representations of profile: CSV, Excel