org.phenopackets.schema.v1.core.PhenotypicFeatureOrBuilder Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of phenopacket-schema Show documentation
A Protobuf schema for capturing clinical phenotypes
There is a newer version: 2.0.2
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: base.proto

package org.phenopackets.schema.v1.core;

public interface PhenotypicFeatureOrBuilder extends
    // @@protoc_insertion_point(interface_extends:org.phenopackets.schema.v1.core.PhenotypicFeature)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * Free-text description of the phenotype. Note this is not a acceptable place to document/describe the phenotype -
   * the type and onset etc... fields should be used for this purpose.
   * 
   *
   * string description = 1;
   */
  java.lang.String getDescription();
  /**
   *    * Free-text description of the phenotype. Note this is not a acceptable place to document/describe the phenotype -
   * the type and onset etc... fields should be used for this purpose.
   * 
   *
   * string description = 1;
   */
  com.google.protobuf.ByteString
      getDescriptionBytes();

  /**
   *    * The primary ontology class which describes the phenotype. For example "HP:0001363"  "Craniosynostosis"
   * FHIR mapping: Condition.identifier
   * 
   *
   * .org.phenopackets.schema.v1.core.OntologyClass type = 2;
   */
  boolean hasType();
  /**
   *    * The primary ontology class which describes the phenotype. For example "HP:0001363"  "Craniosynostosis"
   * FHIR mapping: Condition.identifier
   * 
   *
   * .org.phenopackets.schema.v1.core.OntologyClass type = 2;
   */
  org.phenopackets.schema.v1.core.OntologyClass getType();
  /**
   *    * The primary ontology class which describes the phenotype. For example "HP:0001363"  "Craniosynostosis"
   * FHIR mapping: Condition.identifier
   * 
   *
   * .org.phenopackets.schema.v1.core.OntologyClass type = 2;
   */
  org.phenopackets.schema.v1.core.OntologyClassOrBuilder getTypeOrBuilder();

  /**
   *    * Flag to indicate whether the phenotype was observed or not. Default is 'false', in other words the phenotype was
   * observed. Therefore it is only required in cases to indicate that the phenotype was looked for, but found to be
   * absent.
   * More formally, this modifier indicates the logical negation of the OntologyClass used in the 'type' field.
   * *CAUTION* It is imperative to check this field for correct interpretation of the phenotype!
   * 
   *
   * bool negated = 3;
   */
  boolean getNegated();

  /**
   *    * Severity of the condition e.g. subclasses of HP:0012824-Severity or SNOMED:272141005-Severities
   * FHIR mapping: Condition.severity
   * 
   *
   * .org.phenopackets.schema.v1.core.OntologyClass severity = 4;
   */
  boolean hasSeverity();
  /**
   *    * Severity of the condition e.g. subclasses of HP:0012824-Severity or SNOMED:272141005-Severities
   * FHIR mapping: Condition.severity
   * 
   *
   * .org.phenopackets.schema.v1.core.OntologyClass severity = 4;
   */
  org.phenopackets.schema.v1.core.OntologyClass getSeverity();
  /**
   *    * Severity of the condition e.g. subclasses of HP:0012824-Severity or SNOMED:272141005-Severities
   * FHIR mapping: Condition.severity
   * 
   *
   * .org.phenopackets.schema.v1.core.OntologyClass severity = 4;
   */
  org.phenopackets.schema.v1.core.OntologyClassOrBuilder getSeverityOrBuilder();

  /**
   *    * subclasses of HP:0012823 ! Clinical modifier apart from Severity HP:0012824 - Severity
   * 
   *
   * repeated .org.phenopackets.schema.v1.core.OntologyClass modifiers = 5;
   */
  java.util.List 
      getModifiersList();
  /**
   *    * subclasses of HP:0012823 ! Clinical modifier apart from Severity HP:0012824 - Severity
   * 
   *
   * repeated .org.phenopackets.schema.v1.core.OntologyClass modifiers = 5;
   */
  org.phenopackets.schema.v1.core.OntologyClass getModifiers(int index);
  /**
   *    * subclasses of HP:0012823 ! Clinical modifier apart from Severity HP:0012824 - Severity
   * 
   *
   * repeated .org.phenopackets.schema.v1.core.OntologyClass modifiers = 5;
   */
  int getModifiersCount();
  /**
   *    * subclasses of HP:0012823 ! Clinical modifier apart from Severity HP:0012824 - Severity
   * 
   *
   * repeated .org.phenopackets.schema.v1.core.OntologyClass modifiers = 5;
   */
  java.util.List 
      getModifiersOrBuilderList();
  /**
   *    * subclasses of HP:0012823 ! Clinical modifier apart from Severity HP:0012824 - Severity
   * 
   *
   * repeated .org.phenopackets.schema.v1.core.OntologyClass modifiers = 5;
   */
  org.phenopackets.schema.v1.core.OntologyClassOrBuilder getModifiersOrBuilder(
      int index);

  /**
   * .org.phenopackets.schema.v1.core.Age age_of_onset = 6;
   */
  boolean hasAgeOfOnset();
  /**
   * .org.phenopackets.schema.v1.core.Age age_of_onset = 6;
   */
  org.phenopackets.schema.v1.core.Age getAgeOfOnset();
  /**
   * .org.phenopackets.schema.v1.core.Age age_of_onset = 6;
   */
  org.phenopackets.schema.v1.core.AgeOrBuilder getAgeOfOnsetOrBuilder();

  /**
   * .org.phenopackets.schema.v1.core.AgeRange age_range_of_onset = 7;
   */
  boolean hasAgeRangeOfOnset();
  /**
   * .org.phenopackets.schema.v1.core.AgeRange age_range_of_onset = 7;
   */
  org.phenopackets.schema.v1.core.AgeRange getAgeRangeOfOnset();
  /**
   * .org.phenopackets.schema.v1.core.AgeRange age_range_of_onset = 7;
   */
  org.phenopackets.schema.v1.core.AgeRangeOrBuilder getAgeRangeOfOnsetOrBuilder();

  /**
   * .org.phenopackets.schema.v1.core.OntologyClass class_of_onset = 9;
   */
  boolean hasClassOfOnset();
  /**
   * .org.phenopackets.schema.v1.core.OntologyClass class_of_onset = 9;
   */
  org.phenopackets.schema.v1.core.OntologyClass getClassOfOnset();
  /**
   * .org.phenopackets.schema.v1.core.OntologyClass class_of_onset = 9;
   */
  org.phenopackets.schema.v1.core.OntologyClassOrBuilder getClassOfOnsetOrBuilder();

  /**
   *    * Evidences for how the phenotype was determined.
   * 
   *
   * repeated .org.phenopackets.schema.v1.core.Evidence evidence = 10;
   */
  java.util.List 
      getEvidenceList();
  /**
   *    * Evidences for how the phenotype was determined.
   * 
   *
   * repeated .org.phenopackets.schema.v1.core.Evidence evidence = 10;
   */
  org.phenopackets.schema.v1.core.Evidence getEvidence(int index);
  /**
   *    * Evidences for how the phenotype was determined.
   * 
   *
   * repeated .org.phenopackets.schema.v1.core.Evidence evidence = 10;
   */
  int getEvidenceCount();
  /**
   *    * Evidences for how the phenotype was determined.
   * 
   *
   * repeated .org.phenopackets.schema.v1.core.Evidence evidence = 10;
   */
  java.util.List 
      getEvidenceOrBuilderList();
  /**
   *    * Evidences for how the phenotype was determined.
   * 
   *
   * repeated .org.phenopackets.schema.v1.core.Evidence evidence = 10;
   */
  org.phenopackets.schema.v1.core.EvidenceOrBuilder getEvidenceOrBuilder(
      int index);

  public org.phenopackets.schema.v1.core.PhenotypicFeature.OnsetCase getOnsetCase();
}