CIMAC-CIDC/cidc-schemas

View on GitHub
docs/docs/assays.ihc.html

Summary

Maintainability
Test Coverage

<!DOCTYPE html>
<html>
  <head>
    <title>CIDC Schemas</title>
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/css/bootstrap.min.css" integrity="sha384-ggOyR0iXCbMQv3Xipma34MD+dH/1fQ784/j6cY/iJTQUOhcWr7x9JvoRxT2MZw1T" crossorigin="anonymous">
    <style>
      .bd-placeholder-img {
        font-size: 1.125rem;
        text-anchor: middle;
        -webkit-user-select: none;
        -moz-user-select: none;
        -ms-user-select: none;
        user-select: none;
      }

      @media (min-width: 768px) {
        .bd-placeholder-img-lg {
          font-size: 3.5rem;
        }
      }
    </style>
  </head>
  <body>
    <main role="main">
      

    
    <div class="container">
        <p>
            <a href="index.html">CIDC Documentation</a>
        </p>
        <h1>
            IHC Assay
            
        </h1>
        <p>
            <b>Description:</b>  Immunohistochemical analysis.
        </p>
    </div>

    <div class="container">
        <div class="accordion" id="assay_accordion">
            
                <div class="card">
                    <div class="card-header" id="assay_metadata">
                        <h2 class="mb-0">
                            <button class="btn btn-link" type="button" data-toggle="collapse" data-target="#assay_metadata_card" aria-expanded="false" aria-controls="assay_metadata_card">
                                Assay Metadata
                            </button>
                        </h2>
                    </div>
                    <div id="assay_metadata_card" class="collapse" aria-labelledby="assay_metadata" data-parent="#assay_accordion">
                        <div class="card-body">
                            
    

    

    
        
    

    <table class="table table-striped">
        <thead>
        <tr>
            <th>Property</th>
            <th>Description</th>
            <th>Data Type</th>
        </tr>
        </thead>
        
            
            
            
        
            
            
            
                
            
        
            
            
            
                
                    <tr>
    <td>
        
            <span id="autostainer_model">
                autostainer_model
            </span>
            
                <br><sup><mark>required</mark></sup>
            
        
    </td>
    <td width=55%>
        
            Model version of the autostainer instrument.
        
    </td>
    <td>
        
            &lt; 
                
        string
    

    
            &gt;
            
                <ul>
                    
                        <li>"Bond RX"</li>
                    
                        <li>"Bond MAX"</li>
                    
                        <li>"Other"</li>
                    
                        <li>"N/A"</li>
                    
                </ul>
            
            
            
        
    </td>
</tr>
                
            
        
            
            
            
                
                    <tr>
    <td>
        
            <span id="protocol_identifier">
                protocol_identifier
            </span>
            
                <br><sup><mark>required</mark></sup>
            
        
    </td>
    <td width=55%>
        
            Trial identifier used by lead organization, ie. Center for Experimental Therapeutics Program (CTEP) ID or Industry Sponsored ID.  This is usually a short identifier. Example: E4412.
        
    </td>
    <td>
        
            &lt; 
                
        string
    

    
            &gt;
            
            
            
        
    </td>
</tr>
                
            
        
            
            
            
                
                    <tr>
    <td>
        
            <span id="slide_scanner_model">
                slide_scanner_model
            </span>
            
                <br><sup><mark>required</mark></sup>
            
        
    </td>
    <td width=55%>
        
            Model version of the slide scanner instrument.
        
    </td>
    <td>
        
            &lt; 
                
        string
    

    
            &gt;
            
                <ul>
                    
                        <li>"Vectra 2.0"</li>
                    
                        <li>"Hamamatsu"</li>
                    
                        <li>"AT2 Turbo"</li>
                    
                </ul>
            
            
            
        
    </td>
</tr>
                
            
        
            
            
            
                
                    <tr>
    <td>
        
            <span id="staining_platform">
                staining_platform
            </span>
            
                <br><sup><mark>required</mark></sup>
            
        
    </td>
    <td width=55%>
        
            Staining platform used for tissue sample labeling.
        
    </td>
    <td>
        
            &lt; 
                
        string
    

    
            &gt;
            
                <ul>
                    
                        <li>"auto"</li>
                    
                        <li>"manual"</li>
                    
                </ul>
            
            
            
        
    </td>
</tr>
                
            
        
        
            
        
            
                
                    <tr>
    <td>
        
            <span id="assay_creator">
                assay_creator
            </span>
            
        
    </td>
    <td width=55%>
        
            Indicates what site is filling out the assay.
        
    </td>
    <td>
        
            &lt; 
                
        string
    

    
            &gt;
            
                <ul>
                    
                        <li>"DFCI"</li>
                    
                        <li>"Mount Sinai"</li>
                    
                        <li>"Stanford"</li>
                    
                        <li>"MD Anderson"</li>
                    
                        <li>"Adaptive"</li>
                    
                        <li>"Broad"</li>
                    
                </ul>
            
            
            
        
    </td>
</tr>
                
            
        
            
                
            
        
            
                
            
        
            
                
            
        
            
                
            
        
        
            
                <tr>
    <td colspan=3 class="container">
        <div class="accordion" id="antibody_accordion">
            <div class="card">
                <div class="card-header" id="antibody">
                    <button class="btn btn-link" type="button" data-toggle="collapse" data-target="#antibody_card" aria-expanded="false" aria-controls="antibody_card">
                        antibody
                    </button>
                    
                        <sup><mark>required</mark></sup>
                    
                        <div style="float: right;">
                            &lt; 
                                
                                    object
                                
                            &gt;
                        </div>
                </div>
                <div id="antibody_card" class="collapse" aria-labelledby="antibody">
                    <div class="card-body">
                        
                            
                        
                        <br>
                        
    

    

    
        
    

    <table class="table table-striped">
        <thead>
        <tr>
            <th>Property</th>
            <th>Description</th>
            <th>Data Type</th>
        </tr>
        </thead>
        
            
            
            
                
                    <tr>
    <td>
        
            <span id="antibody">
                antibody
            </span>
            
                <br><sup><mark>required</mark></sup>
            
        
    </td>
    <td width=55%>
        
            Antibody type collected for this study.
        
    </td>
    <td>
        
            &lt; 
                
        string
    

    
            &gt;
            
            
            
        
    </td>
</tr>
                
            
        
            
            
            
        
            
            
            
                
            
        
            
            
            
                
            
        
            
            
            
                
            
        
            
            
            
                
                    <tr>
    <td>
        
            <span id="dilution">
                dilution
            </span>
            
                <br><sup><mark>required</mark></sup>
            
        
    </td>
    <td width=55%>
        
            Concentration ratio for antibody dilution.
        
    </td>
    <td>
        
            &lt; 
                
        string
    

    
            &gt;
            
            
            
        
    </td>
</tr>
                
            
        
            
            
            
                
                    <tr>
    <td>
        
            <span id="incubation_temp">
                incubation_temp
            </span>
            
                <br><sup><mark>required</mark></sup>
            
        
    </td>
    <td width=55%>
        
            Temperature used for antibody incubation.
        
    </td>
    <td>
        
            &lt; 
                
        string
    

    
            &gt;
            
            
            
        
    </td>
</tr>
                
            
        
            
            
            
                
                    <tr>
    <td>
        
            <span id="incubation_time">
                incubation_time
            </span>
            
                <br><sup><mark>required</mark></sup>
            
        
    </td>
    <td width=55%>
        
            Time duration of antibody incubation.
        
    </td>
    <td>
        
            &lt; 
                
        string
    

     :  time
            &gt;
            
            
            
        
    </td>
</tr>
                
            
        
            
            
            
                
            
        
        
            
                
            
        
            
        
            
                
                    <tr>
    <td>
        
            <span id="cat_num">
                cat_num
            </span>
            
        
    </td>
    <td width=55%>
        
            Antibody registry catalog number assigned to antibody sample.
        
    </td>
    <td>
        
            &lt; 
                
        string
    

    
            &gt;
            
            
            
        
    </td>
</tr>
                
            
        
            
                
                    <tr>
    <td>
        
            <span id="clone">
                clone
            </span>
            
        
    </td>
    <td width=55%>
        
            Resulting type of antibody clone from primary antibody sample.
        
    </td>
    <td>
        
            &lt; 
                
        string
    

    
            &gt;
            
            
            
        
    </td>
</tr>
                
            
        
            
                
                    <tr>
    <td>
        
            <span id="company">
                company
            </span>
            
        
    </td>
    <td width=55%>
        
            Company from which antibody sample was derived.
        
    </td>
    <td>
        
            &lt; 
                
        string
    

    
            &gt;
            
            
            
        
    </td>
</tr>
                
            
        
            
                
            
        
            
                
            
        
            
                
            
        
            
                
                    <tr>
    <td>
        
            <span id="lot_num">
                lot_num
            </span>
            
        
    </td>
    <td width=55%>
        
            Identification number assigned to the particular quantity or lot of material from manufacturer.
        
    </td>
    <td>
        
            &lt; 
                
        string
    

    
            &gt;
            
            
            
        
    </td>
</tr>
                
            
        
        
            
        
            
        
            
        
            
        
            
        
            
        
            
        
            
        
            
        
    </table>
                    </div>
                </div>
            </div>
        </div>
    </td>
</tr>
            
        
            
        
            
        
            
        
            
        
            
        
    </table>
                        </div>
                    </div>
                </div>
            
            
                <div class="card">
                    <div class="card-header" id="assay_data">
                        <h2 class="mb-0">
                            <button class="btn btn-link" type="button" data-toggle="collapse" data-target="#assay_data_card" aria-expanded="false" aria-controls="assay_data_card">
                                Assay Data
                            </button>
                        </h2>
                    </div>
                    <div id="assay_data_card" class="collapse" aria-labelledby="assay_data" data-parent="#assay_accordion">
                        <div class="card-body">
                            
    

    

    
        
    

    <table class="table table-striped">
        <thead>
        <tr>
            <th>Property</th>
            <th>Description</th>
            <th>Data Type</th>
        </tr>
        </thead>
        
            
            
            
        
        
            
        
        
            
                <tr>
    <td colspan=3 class="container">
        <div class="accordion" id="records_accordion">
            <div class="card">
                <div class="card-header" id="records">
                    <button class="btn btn-link" type="button" data-toggle="collapse" data-target="#records_card" aria-expanded="false" aria-controls="records_card">
                        records
                    </button>
                    
                        <sup><mark>required</mark></sup>
                    
                        <div style="float: right;">
                            &lt; 
                                
                                    array
                                
                            &gt;
                        </div>
                </div>
                <div id="records_card" class="collapse" aria-labelledby="records">
                    <div class="card-body">
                        
                            A single data record from IHC assay.
                        
                        <br>
                        
    

    

    
        
    

    <table class="table table-striped">
        <thead>
        <tr>
            <th>Property</th>
            <th>Description</th>
            <th>Data Type</th>
        </tr>
        </thead>
        
            
            
            
                
                    <tr>
    <td>
        
            <span id="cimac_id">
                cimac_id
            </span>
            
                <br><sup><mark>required</mark></sup>
            
        
    </td>
    <td width=55%>
        
            Specimen identifier assigned by the CIMAC-CIDC Network. Formatted as CTTTPPPSS.AA for trial code TTT, participant PPP, sample SS, and aliquot AA.
        
    </td>
    <td>
        
            &lt; 
                
        string
    

    
            &gt;
            
            
            
                as regex <br> <code>^C[A-Z0-9]{3}[A-Z0-9]{3}[A-Z0-9]{2}.[0-9]{2}$</code>
            
        
    </td>
</tr>
                
            
        
            
            
            
        
            
            
            
        
            
            
            
                
            
        
            
            
            
                
            
        
            
            
            
                
            
        
            
            
            
        
            
            
            
                
            
        
            
            
            
                
            
        
            
            
            
                
                    <tr>
    <td>
        
            <span id="marker_positive">
                marker_positive
            </span>
            
                <br><sup><mark>required</mark></sup>
            
        
    </td>
    <td width=55%>
        
            Indicates whether the marker is considered positive by clinical trial guidelines (if applicable).
        
    </td>
    <td>
        
            &lt; 
                
        string
    

    
            &gt;
            
                <ul>
                    
                        <li>"positive"</li>
                    
                        <li>"negative"</li>
                    
                        <li>"no_call"</li>
                    
                </ul>
            
            
            
        
    </td>
</tr>
                
            
        
            
            
            
                
            
        
            
            
            
                
            
        
            
            
            
                
            
        
        
            
                
            
        
            
        
            
        
            
                
                    <tr>
    <td>
        
            <span id="combined_positive_score">
                combined_positive_score
            </span>
            
        
    </td>
    <td width=55%>
        
            Combined Positive Score (CPS) is the percentage of marker staining cells (tumor cells and cells that are non-tumor) relative to all viable tumor cells. (0-1)
        
    </td>
    <td>
        
            &lt; 
                
        
            number
            , 
        
            string
            
        
    

    
            &gt;
            
            
            
        
    </td>
</tr>
                
            
        
            
                
                    <tr>
    <td>
        
            <span id="comment">
                comment
            </span>
            
        
    </td>
    <td width=55%>
        
            A text comment regarding this slide.
        
    </td>
    <td>
        
            &lt; 
                
        string
    

    
            &gt;
            
            
            
        
    </td>
</tr>
                
            
        
            
                
                    <tr>
    <td>
        
            <span id="h_score">
                h_score
            </span>
            
        
    </td>
    <td width=55%>
        
            A summation of the percentage of area stained at each intensity level multiplied by the weighted intensity. (0-300)
        
    </td>
    <td>
        
            &lt; 
                
        
            integer
            , 
        
            string
            
        
    

    
            &gt;
            
            
            
        
    </td>
</tr>
                
            
        
            
        
            
                
                    <tr>
    <td>
        
            <span id="inflammatory_cells">
                inflammatory_cells
            </span>
            
        
    </td>
    <td width=55%>
        
            Percentage of inflammatory cells (non-tumor cells) showing marker staining relative to all inflammatory cells. (0-1)
        
    </td>
    <td>
        
            &lt; 
                
        
            number
            , 
        
            string
            
        
    

    
            &gt;
            
            
            
        
    </td>
</tr>
                
            
        
            
                
                    <tr>
    <td>
        
            <span id="intensity">
                intensity
            </span>
            
        
    </td>
    <td width=55%>
        
            A measure of the intensity or brightness of the protein. (0-3)
        
    </td>
    <td>
        
            &lt; 
                
        
            number
            , 
        
            string
            
        
    

    
            &gt;
            
            
            
        
    </td>
</tr>
                
            
        
            
                
            
        
            
                
                    <tr>
    <td>
        
            <span id="percentage_expression">
                percentage_expression
            </span>
            
        
    </td>
    <td width=55%>
        
            A percentage of the relevant cells considered positive. (0-100)
        
    </td>
    <td>
        
            &lt; 
                
        
            number
            , 
        
            string
            
        
    

    
            &gt;
            
            
            
        
    </td>
</tr>
                
            
        
            
                
                    <tr>
    <td>
        
            <span id="positive_inflammatory_cell_area">
                positive_inflammatory_cell_area
            </span>
            
        
    </td>
    <td width=55%>
        
            Area of PD-L1+ Inflammatory Cells over the area of TSI + IT as a percentage. (0-1)
        
    </td>
    <td>
        
            &lt; 
                
        
            number
            , 
        
            string
            
        
    

    
            &gt;
            
            
            
        
    </td>
</tr>
                
            
        
            
                
                    <tr>
    <td>
        
            <span id="tumor_proportion_score">
                tumor_proportion_score
            </span>
            
        
    </td>
    <td width=55%>
        
            Tumor Proportion Score (TPS) is the percentage of viable tumor cells showing marker staining relative to all viable tumor cells. (0-1)
        
    </td>
    <td>
        
            &lt; 
                
        
            number
            , 
        
            string
            
        
    

    
            &gt;
            
            
            
        
    </td>
</tr>
                
            
        
        
            
        
            
        
            
        
            
        
            
        
            
        
            
                <tr>
    <td colspan=3 class="container">
        <div class="accordion" id="files_accordion">
            <div class="card">
                <div class="card-header" id="files">
                    <button class="btn btn-link" type="button" data-toggle="collapse" data-target="#files_card" aria-expanded="false" aria-controls="files_card">
                        files
                    </button>
                    
                        <sup><mark>required</mark></sup>
                    
                        <div style="float: right;">
                            &lt; 
                                
                                    object
                                
                            &gt;
                        </div>
                </div>
                <div id="files_card" class="collapse" aria-labelledby="files">
                    <div class="card-body">
                        
                        <br>
                        
    

    

    
        
    

    <table class="table table-striped">
        <thead>
        <tr>
            <th>Property</th>
            <th>Description</th>
            <th>Data Type</th>
        </tr>
        </thead>
        
            
            
            
                
                    <tr>
    <td>
        
            <span id="ihc_image">
                ihc_image
            </span>
            
                <br><sup><mark>required</mark></sup>
            
        
    </td>
    <td width=55%>
        
            Information about an image file.
        
    </td>
    <td>
        
            <a href="files.image.html">
                image
            </a>
        
    </td>
</tr>
                
            
        
        
            
                
            
        
        
            
        
    </table>
                    </div>
                </div>
            </div>
        </div>
    </td>
</tr>
            
        
            
        
            
        
            
        
            
        
            
        
            
        
    </table>
                    </div>
                </div>
            </div>
        </div>
    </td>
</tr>
            
        
    </table>
                        </div>
                    </div>
                </div>
            
            
            

            
                <div class="card">
                    <div class="card-header" id="assay_uploads">
                        <h2 class="mb-0">
                            <button class="btn btn-link" type="button" data-toggle="collapse" data-target="#assay_uploads_card" aria-expanded="false" aria-controls="assay_uploads_card">
                                Assay Uploads
                            </button>
                        </h2>
                    </div>
                    <div id="assay_uploads_card" class="collapse" aria-labelledby="assay_uploads" data-parent="#assay_accordion">
                        <div class="card-body">
                            <table class="table table-striped">
        <thead>
        <tr>
            <th>Entity</th>
            <th>Description</th>
        </tr>
        </thead>
        
            <tr>
                <td width=25%>
                    <a href='assays.ihc.ihc_template.html'>
                        IHC assay template
                    </a>
                </td>
                <td>
                    ImmunoHistoChemistry (IHC) submission.
                </td>
            </tr>
        
    </table>
                        </div>
                    </div>
                </div>
            
            
        </div>
    </div>


    </main>
    <script src="https://code.jquery.com/jquery-3.3.1.slim.min.js" integrity="sha384-q8i/X+965DzO0rT7abK41JStQIAqVgRVzpbzo5smXKp4YfRvH+8abtTE1Pi6jizo" crossorigin="anonymous"></script>
    <script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.14.7/umd/popper.min.js" integrity="sha384-UO2eT0CpHqdSJQ6hJty5KVphtPhzWj9WO1clHTMGa3JDZwrnQq4sF86dIHNDz0W1" crossorigin="anonymous"></script>
    <script src="https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/js/bootstrap.min.js" integrity="sha384-JjSmVgyd0p3pXB1rRibZUAYoIIy6OrQ6VrjIEaFf/nJGzIxFDsf4x0xIM+B07jRM" crossorigin="anonymous"></script>
  </body>
</html>