Standard CSV Order Parser Documentation

Prima has the ability to pull a limited amount of order data via a CSV or Excel file. While the REST API is the preferred and much more powerful approach, a simple CSV file may be a quick and easy alternative that does enough to meet certain needs.

Available CSV Columns

  • Name
    Sample Alternate Identifier
    Column Name(s)
    • alternate id
    • alternate identifier
    • alt id
    • sample alternate identifier
    • sample alt id
    • sample alternate id
    • alt sample id
    Expected Value(s)
    String
    Description
    String that provides an alternate identifier for the sample. Commonly used to provide the identifier in another system (e.g.LIS).
  • Name
    Specimen Part
    Column Name(s)
    • specimen part
    Expected Value(s)
    String
    Description
    The part of the surgical identifier for the jar (e.g. A in S22-0001:A)
  • Name
    Cassette Part
    Column Name(s)
    • cassette part
    Expected Value(s)
    String
    Description
    The part of the surgical identifier for the block (e.g. 3 in S22-0001:A-3)
  • Name
    Slide Part
    Column Name(s)
    • slide part
    Expected Value(s)
    String
    Description
    The part of the surgical identifier for the slide (e.g. 6 in S22-0001:A-3-6)
  • Name
    Specimen Submission State
    Column Name(s)
    • specimen submission state
    Expected Value(s)
    • Pre-Print (No tissue)
      Specimen is being submitted without any tissue. This is typically used to provide a barcode from an outside facility.
    • Live
      Specimen is an animal being submitted in a living state.
    • Fresh Tissue
      Specimen is being submitted with tissue/fluid that has not yet been fixed.
    • Frozen Tissue
      Specimen is being submitted with tissue that has been frozen in order to cut slides directly from it.
    • Fixed Tissue
      Specimen is being submitted with tissue/fluid that has already been placed in a fixative.
    • Completed
      All work has been completed on the specimen and is being submitted for distribution/review.
    • For Storage
      All work has been completed on the specimen and is being submitted for archival.
    • For Disposal
      All work has been completed on the specimen and is being submitted for disposal.
    Description
    The state of the specimen being submitted to the lab for work
  • Name
    Cassette Submission State
    Column Name(s)
    • cassette submission state
    Expected Value(s)
    • N/A
      Cassette was ordered, so a submission state does not apply.
    • Pre-Print (No tissue)
      An empty cassette is typically used to provide a barcode from an outside facility (pre-print).
    • Fresh Tissue
      Cassette contains fresh tissue that has not yet been fixed or embedded.
    • Frozen Tissue
      Cassette contains tissue that has been frozen instead of fixed.
    • Fixed Tissue
      Cassette contains tissue that has been fixed, but not yet processed.
    • Processed Tissue
      Cassette contains tissue that has been fixed and processed, but not yet embedded.
    • Embedded Tissue
      Block has been embedded and may or may not be attached to a cassette.
    • Completed
      All work has been completed on the block and is being submitted for distribution/review.
    • For Storage
      All work has been completed on the block and is being submitted for archival.
    • For Disposal
      All work has been completed on the block and is being submitted for disposal.
    Description
    The state of the cassette/block being submitted to the lab for work
  • Name
    Slide Submission State
    Column Name(s)
    • slide submission state
    Expected Value(s)
    • N/A
      Slide was ordered, so a submission state does not apply.
    • Pre-Print (No tissue)
      Slide is being submitted without any tissue. This is typically used to provide a barcode from an outside facility.
    • Unstained
      Slide has tissue, but has not yet been stained.
    • Stained
      The slide has been stained, but may be re-stained, imaged, reviewed or archived.
    • Completed
      All work has been completed on the slide and is being submitted for distribution/review.
    • For Storage
      All work has been completed on the specimen and is being submitted for archival.
    • For Disposal
      All work has been completed on the specimen and is being submitted for disposal.
    Description
    The state of the slide being submitted to the lab for work
  • Name
    Sample Barcode
    Column Name(s)
    • barcode
    • sample barcode
    • barcode contents
    Expected Value(s)
    String
    Description
    String that specifies the barcode contents of an existing label on the sample.
  • Name
    Animal Alternate Identifier
    Column Name(s)
    • animal alternate id
    • animal alternate identifier
    • animal alt id
    • alt animal id
    Expected Value(s)
    String
    Description
    String that provides an alternate identifier for the animal. Commonly used to provide the identifier in another system (e.g.LIS).
  • Name
    Case Alternate Identifier
    Column Name(s)
    • case alternate id
    • case alternate identifier
    • case alt id
    • alt case id
    Expected Value(s)
    String
    Description
    String that provides an alternate identifier for the case. Commonly used to provide the identifier in another system (e.g.LIS).
  • Name
    Collection Date
    Column Name(s)
    • collection date
    • date collected
    Description
    Date (and time) at which the sample was collected.
  • Name
    Study Id
    Column Name(s)
    • study number
    • study
    Expected Value(s)
    String
    Description
    String title or identifier for the corresponding study.
  • Name
    Species
    Column Name(s)
    • species
    Expected Value(s)
    String
    Description
    The species of animal from which the sample originated.
  • Name
    Case Serial Number
    Column Name(s)
    • case serial
    • case serial number
    • case number
    Description
    Serial number for the case. If the entry is proceeded by a '#', then these rows will use the same Prima generated case serial (e.g. #2 may group several items into case 0035). A number alone will tell Prima to not generate a serial (e.g. 35 will produce case 0035).
  • Name
    Case Year
    Column Name(s)
    • case year
    • case created year
    • year
    Description
    Created year for the case.
  • Name
    Breed
    Column Name(s)
    • breed
    Expected Value(s)
    String
    Description
    String title for the animal breed.
  • Name
    Strain
    Column Name(s)
    • strain
    Expected Value(s)
    String
    Description
    The strain of animal from which the sample originated.
  • Name
    Manner Of Death
    Column Name(s)
    • mannerofdeath
    • manner of death
    Expected Value(s)
    String
    Description
    The actual (planned or unplanned) manner in which the case subject died.
  • Name
    Genotype
    Column Name(s)
    • genotype
    Expected Value(s)
    String
    Description
    The genotype of animal from which the sample originated.
  • Name
    Gender
    Column Name(s)
    • gender
    • sex
    Expected Value(s)
    • Unknown
    • Male
    • Female
    • Transgender
    • Hermaphrodite
    Description
    Gender of case subject.
  • Name
    Priority Level
    Column Name(s)
    • priority
    • priority level
    Expected Value(s)
    String
    Description
    String title for the priority level of the order.
  • Name
    Date Of Birth
    Column Name(s)
    • date of birth
    • birth date
    • DOB
    Description
    Birth Date (and time) of case subject.
  • Name
    Date Of Death
    Column Name(s)
    • date of death
    • death date
    • DOD
    Description
    Death Date (and time) of case subject.
  • Name
    Subject Id
    Column Name(s)
    • research patient id
    • research patient identifier
    • research patient
    • animal id
    • animal identifier
    • animal
    Expected Value(s)
    String
    Description
    String identifier for the case subject.
  • Name
    Cohort
    Column Name(s)
    • cohort
    • arm
    Expected Value(s)
    String
    Description
    String title or identifier for the study cohort.
  • Name
    Tissue Collection
    Column Name(s)
    • tissue collection
    • tissue
    Expected Value(s)
    String
    Description
    The tissues or tissue(s) contained in the sample.
  • Name
    Anatomic Site
    Column Name(s)
    • anatomic site
    Expected Value(s)
    String
    Description
    The anatomic site of tissue contained in the sample.
  • Name
    Study Phase
    Column Name(s)
    • study phase
    • time point
    • time point/sample type
    Expected Value(s)
    String
    Description
    The study phase.
  • Name
    Tracking Number
    Column Name(s)
    • tracking number
    • shipment tracking number
    Expected Value(s)
    String
    Description
    The tracking number for the shipment in which the sample was received.
  • Name
    Differential Diagnosis
    Column Name(s)
    • differential diagnosis
    Expected Value(s)
    String
    Description
    The differential diagnosis for the case to which the sample belongs.
  • Name
    Order Origin
    Column Name(s)
    • order origin
    • sample origin
    Expected Value(s)
    String
    Description
    Specifies the name of the origin of the order.
  • Name
    Surgery Location
    Column Name(s)
    • surgery location
    • case location
    • case origin
    Expected Value(s)
    String
    Description
    Specifies the location of the origin of the surgery/case.
  • Name
    Surgery Age
    Column Name(s)
    • age
    • subject age
    • case subject age
    Expected Value(s)
    String
    Description
    Age of the subject at the time of the surgery/case. e.g. '12 months, 2 days' or 'Adult'. This will override any value calculated from the date of birth and surgery date.
  • Name
    Surgical Wheel
    Column Name(s)
    • wheel
    • surgical wheel
    Expected Value(s)
    String
    Description
    The surgical wheel for the case (e.g. the 'S' in S19-0012).
  • Name
    Protocol
    Column Name(s)
    • protocol
    Expected Value(s)
    String
    Description
    Specifies the protocol. Must exist as a protocol in Prima.
  • Name
    Request Submitted Date
    Column Name(s)
    • request submitted date
    Description
    The date/time the the original work order request was made/placed.
  • Name
    Order Number
    Column Name(s)
    • order number
    • order
    • case number
    • work request #
    Expected Value(s)
    String
    Description
    The identifier for the order/work request.
  • Name
    Order Notes
    Column Name(s)
    • order notes
    • work request notes
    Expected Value(s)
    String
    Description
    Notes or description to add on the order/work request.
  • Name
    Requested By First Name
    Column Name(s)
    • requested by first name
    • requesting first name
    Expected Value(s)
    String
    Description
    The given name of the doctor or P.I. who has requested the work.
  • Name
    Requested By Middle Name
    Column Name(s)
    • requested by mi
    • requested by middle name
    • requesting mi
    • requesting middle name
    Expected Value(s)
    String
    Description
    The middle name of the doctor or P.I. who has requested the work.
  • Name
    Requested By Last Name
    Column Name(s)
    • requested by last name
    • requesting last name
    Expected Value(s)
    String
    Description
    The surname of the doctor or P.I. who has requested the work.
  • Name
    Results Recipient First Name
    Column Name(s)
    • results person first name
    Expected Value(s)
    String
    Description
    The given name of the person to whom the results of the case or study should be sent.
  • Name
    Results Recipient Middle Name
    Column Name(s)
    • results person mi
    • results person middle name
    Expected Value(s)
    String
    Description
    The middle name of the person to whom the results of the case or study should be sent.
  • Name
    Results Recipient Last Name
    Column Name(s)
    • results person last name
    Expected Value(s)
    String
    Description
    The surname of the person to whom the results of the case or study should be sent.
  • Name
    Researcher First Name
    Column Name(s)
    • researcher first name
    Expected Value(s)
    String
    Description
    The given name of the researcher associated with the case or study.
  • Name
    Researcher Middle Name
    Column Name(s)
    • researcher middle name
    • researcher mi
    Expected Value(s)
    String
    Description
    The middle name of the researcher associated with the case or study.
  • Name
    Researcher Last Name
    Column Name(s)
    • researcher last name
    Expected Value(s)
    String
    Description
    The surname of the researcher associated with the case or study.
  • Name
    Patient First Name
    Column Name(s)
    • patient first name
    Expected Value(s)
    String
    Description
    The given name of the Patient.
  • Name
    Patient Middle Name
    Column Name(s)
    • patient middle name
    • patient mi
    Expected Value(s)
    String
    Description
    The middle name of the Patient.
  • Name
    Patient Last Name
    Column Name(s)
    • patient last name
    Expected Value(s)
    String
    Description
    The surname of the Patient.
  • Name
    Emr Number
    Column Name(s)
    • emr number
    • emr
    Expected Value(s)
    String
    Description
    The electronic medical records number of the Patient.
  • Name
    Ssn Number
    Column Name(s)
    • social security number
    • ssn
    Expected Value(s)
    String
    Description
    The social security number of the Patient.
  • Name
    Pathologist First Name
    Column Name(s)
    • pathologist first name
    Expected Value(s)
    String
    Description
    The given name of the reviewing Pathologist.
  • Name
    Pathologist Middle Name
    Column Name(s)
    • pathologist middle name
    • pathologist mi
    Expected Value(s)
    String
    Description
    The middle name of the reviewing Pathologist.
  • Name
    Pathologist Last Name
    Column Name(s)
    • pathologist last name
    Expected Value(s)
    String
    Description
    The surname of the reviewing Pathologist.
  • Name
    Sample Type
    Column Name(s)
    • sample type
    • sample
    Expected Value(s)
    • Unknown
    • Cytology Specimen
    • Frozen Specimen
    • Hematology Specimen
    • Surgical Specimen
    • Cassette
    • Cassette Pellet
    • Cytology Slide
    • Frozen Slide
    • Hematology Slide
    • Surgical Slide
    Description
    Specifies what item the lab should expect to receive and the workflow to be applied.
  • Name
    Fixative
    Column Name(s)
    • fixative
    Expected Value(s)
    String
    Description
    The name of the fixative in which the sample arrived or should be placed.
  • Name
    Pathologist Review
    Column Name(s)
    • professional review
    • review
    Expected Value(s)
    • false
    • f
    • no
    • n
    • 0
    • true
    • t
    • yes
    • y
    • 1
    Description
    Specifies that a Pathologist should review the case as part of this order.
  • Name
    Is Embed Only
    Column Name(s)
    • is embed only
    • embed only
    Expected Value(s)
    • false
    • f
    • no
    • n
    • 0
    • true
    • t
    • yes
    • y
    • 1
    Description
    Specifies that no slides are to be generated as part of the order.
  • Name
    Send Out Specimens
    Column Name(s)
    • return specimens
    • send out specimens
    Expected Value(s)
    • false
    • f
    • no
    • n
    • 0
    • true
    • t
    • yes
    • y
    • 1
    Description
    Specifies whether or not specimens should be returned to results recipient after lab work is completed.
  • Name
    Send Out Blocks
    Column Name(s)
    • return blocks
    • send out blocks
    • return cassettes
    • send out cassettes
    Expected Value(s)
    • false
    • f
    • no
    • n
    • 0
    • true
    • t
    • yes
    • y
    • 1
    Description
    Specifies whether or not blocks should be returned to results recipient after lab work is completed.
  • Name
    Send Out Slides
    Column Name(s)
    • return slides
    • send out slides
    Expected Value(s)
    • false
    • f
    • no
    • n
    • 0
    • true
    • t
    • yes
    • y
    • 1
    Description
    Specifies whether or not slides should be returned to results recipient after lab work is completed.
  • Name
    Request Digital Images
    Column Name(s)
    • request digital images
    • request digital image
    • request imaging
    • request images
    • digital images
    • digital imaging
    • slide images
    • slide imaging
    Expected Value(s)
    • false
    • f
    • no
    • n
    • 0
    • true
    • t
    • yes
    • y
    • 1
    Description
    Specifies that digital images are to be generated for all slides in the order.
  • Name
    Requisition Forms
    Column Name(s)
    • requisition forms
    Description
    A semi-colon separated list of file paths that should be attached to the case as requisition forms.
  • Name
    Case Documents
    Column Name(s)
    • case documents
    Description
    A semi-colon separated list of file paths that should be attached to the case as extraneous documents.
  • Name
    Stain
    Column Name(s)
    • stain
    • stain test
    • existing stain
    • requested stain
    Expected Value(s)
    String
    Description
    The stain that is being ordered or has already been applied to the slide.
  • Name
    Stain Requests
    Column Name(s)
    • requested stains
    • requested stain tests
    • stains
    • stain tests
    • request slides
    Description
    JSON array of slide data which will request that the provided slides and their stains will be created.
  • Name
    Stain Test Panels
    Column Name(s)
    • stain test panels
    • stain panels
    • optimizations
    • stain optimizations
    • stain test panel
    • stain panel
    • optimization
    • stain optimization
    Description
    List of comma separated stain test panels (names of panels that exist in Prima). All slides from the panels will be added to the order.