pet.yaml

---
# PET common metadata fields
PETHardware:
  selectors:
    - datatype == "pet"
    - suffix == "pet"
  fields:
    Manufacturer:
      level: required
      description_addendum: |
        Corresponds to [DICOM Tag 0008, 0070](http://www.dicomlookup.com/dicomtags/(0008,0070))
        `Manufacturer`.
    ManufacturersModelName:
      level: required
      description_addendum: |
        Corresponds to [DICOM Tag 0008, 1090](http://www.dicomlookup.com/dicomtags/(0008,1090))
        `Manufacturers Model Name`.
    Units:
      level: required
      description_addendum: |
        SI unit for radioactivity (Becquerel) should be used (for example, "Bq/mL").
        Corresponds to [DICOM Tag 0054, 1001](http://www.dicomlookup.com/dicomtags/(0054,1001)) `Units`.

PETInstitutionInformation:
  selectors:
    - datatype == "pet"
    - suffix == "pet"
  fields:
    InstitutionName:
      level: recommended
      description_addendum: |
        Corresponds to [DICOM Tag 0008, 0080](http://www.dicomlookup.com/dicomtags/(0008,0080))
        `InstitutionName`.
    InstitutionAddress:
      level: recommended
      description_addendum: |
        Corresponds to [DICOM Tag 0008, 0081](http://www.dicomlookup.com/dicomtags/(0008,0081))
        `InstitutionAddress`.
    InstitutionalDepartmentName:
      level: recommended
      description_addendum: |
        Corresponds to [DICOM Tag 0008, 1040](http://www.dicomlookup.com/dicomtags/(0008,1040))
        `Institutional Department Name`.

PETSample:
  selectors:
    - modality == "pet"
    - suffix == "pet"
  fields:
    BodyPart: optional
    BodyPartDetails: optional
    BodyPartDetailsOntology: optional

PETRadioChemistry:
  selectors:
    - datatype == "pet"
    - suffix == "pet"
  fields:
    TracerName: required
    TracerRadionuclide: required
    InjectedRadioactivity: required
    InjectedRadioactivityUnits: required
    InjectedMass: required
    InjectedMassUnits: required
    SpecificRadioactivity: required
    SpecificRadioactivityUnits: required
    ModeOfAdministration: required
    TracerRadLex: recommended
    TracerSNOMED: recommended
    TracerMolecularWeight: recommended
    TracerMolecularWeightUnits: recommended
    InjectedMassPerWeight: recommended
    InjectedMassPerWeightUnits: recommended
    SpecificRadioactivityMeasTime: recommended
    MolarActivity: recommended
    MolarActivityUnits: recommended
    MolarActivityMeasTime: recommended
    InfusionRadioactivity:
      level: recommended
      level_addendum: required if ModeOfAdministration is `'bolus-infusion'`
    InfusionStart:
      level: recommended
      level_addendum: required if ModeOfAdministration is `'bolus-infusion'`
    InfusionSpeed:
      level: recommended
      level_addendum: required if ModeOfAdministration is `'bolus-infusion'`
    InfusionSpeedUnits:
      level: recommended
      level_addendum: required if ModeOfAdministration is `'bolus-infusion'`
    InjectedVolume:
      level: recommended
      level_addendum: required if ModeOfAdministration is `'bolus-infusion'`
    Purity: recommended

# PET Infusion conditionally required entities
EntitiesBolusMetadata:
  selectors:
    - datatype == "pet"
    - suffix == "pet"
    - sidecar.ModeOfAdministration == 'bolus-infusion'
  fields:
    InfusionRadioactivity: required
    InfusionStart: required
    InfusionSpeed: required
    InfusionSpeedUnits: required
    InjectedVolume: required

PETPharmaceuticals:
  selectors:
    - datatype == "pet"
    - suffix == "pet"
  fields:
    PharmaceuticalName: recommended
    PharmaceuticalDoseAmount: recommended
    PharmaceuticalDoseUnits: recommended
    PharmaceuticalDoseRegimen: recommended
    PharmaceuticalDoseTime: recommended
    Anaesthesia: optional

PETTime:
  selectors:
    - datatype == "pet"
    - suffix == "pet"
  fields:
    TimeZero: required
    ScanStart: required
    InjectionStart: required
    FrameTimesStart: required
    FrameDuration: required
    InjectionEnd: recommended
    ScanDate: deprecated

PETReconstruction:
  selectors:
    - datatype == "pet"
    - suffix == "pet"
  fields:
    AcquisitionMode: required
    ImageDecayCorrected: required
    ImageDecayCorrectionTime: required
    ReconMethodName: required
    ReconMethodParameterLabels: required
    ReconMethodParameterUnits:
      level: recommended
      level_addendum: required if `ReconMethodParameterLabels` does not contain `"none"`
    ReconMethodParameterValues:
      level: recommended
      level_addendum: required if `ReconMethodParameterLabels` does not contain `"none"`
    ReconFilterType: required
    ReconFilterSize:
      level: recommended
      level_addendum: required if `ReconFilterType` is not `"none"`
    AttenuationCorrection: required
    ReconMethodImplementationVersion: recommended
    AttenuationCorrectionMethodReference: recommended
    ScaleFactor: recommended
    ScatterFraction: recommended
    DecayCorrectionFactor: recommended
    DoseCalibrationFactor: recommended
    PromptRate: recommended
    SinglesRate: recommended
    RandomRate: recommended

# set required reconstruction fields to optional when "none" is provided as a parameter label
EntitiesReconMethodMetadata:
  selectors:
    - datatype == "pet"
    - suffix == "pet"
    - '!intersects(sidecar.ReconMethodParameterLabels, ["none"])'
  fields:
    ReconMethodParameterValues: required
    ReconMethodParameterUnits: required

# set required recon filter fields to optional when FilterType is "None"
EntitiesReconFilterMetadata:
  selectors:
    - datatype == "pet"
    - suffix == "pet"
    - '!intersects(sidecar.ReconFilterType, ["none"])'
  fields:
    ReconFilterSize: required

BloodRecording:
  selectors:
    - datatype == "pet"
    - suffix == "blood"
  fields:
    PlasmaAvail: required
    MetaboliteAvail: required
    WholeBloodAvail: required
    DispersionCorrected: required
    WithdrawalRate: recommended
    TubingType: recommended
    TubingLength: recommended
    DispersionConstant: recommended
    Haematocrit: recommended
    BloodDensity: recommended

BloodPlasmaFreeFraction:
  selectors:
    - datatype == "pet"
    - suffix == "blood"
    - sidecar.PlasmaAvail == true
  fields:
    PlasmaFreeFraction:
      level: recommended
      level_addendum: if `PlasmaAvail` is `true`
    PlasmaFreeFractionMethod:
      level: recommended
      level_addendum: if `PlasmaAvail` is `true`

BloodMetaboliteMethod:
  selectors:
    - datatype == "pet"
    - suffix == "blood"
    - sidecar.MetaboliteAvail == true
  fields:
    MetaboliteMethod:
      level: required
      level_addendum: if `MetaboliteAvail` is `true`
    MetaboliteRecoveryCorrectionApplied:
      level: required
      level_addendum: if `MetaboliteAvail` is `true`

# PET task information
PETTask:
  selectors:
    - datatype == "pet"
    - '"task" in entities'
  fields:
    TaskName:
      level: recommended
      description_addendum: |
        If used to denote resting scans, a RECOMMENDED convention is to use labels
        beginning with `rest`.
    Instructions:
      level: recommended
      description_addendum: |
        This is especially important in context of resting state recordings
        and distinguishing between eyes open and eyes closed paradigms.
    TaskDescription: recommended
    CogAtlasID: recommended
    CogPOID: recommended