Package org.hl7.fhir.r4.model.codesystems

Enum ResearchSubjectStatus

java.lang.Object
java.lang.Enum<ResearchSubjectStatus>
org.hl7.fhir.r4.model.codesystems.ResearchSubjectStatus
All Implemented Interfaces:
Serializable, Comparable<ResearchSubjectStatus>
public enum ResearchSubjectStatus extends Enum<ResearchSubjectStatus>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    CANDIDATE
    An identified person that can be considered for inclusion in a study.
    ELIGIBLE
    A person that has met the eligibility criteria for inclusion in a study.
    FOLLOWUP
    A person is no longer receiving study intervention and/or being evaluated with tests and procedures according to the protocol, but they are being monitored on a protocol-prescribed schedule.
    INELIGIBLE
    A person who did not meet one or more criteria required for participation in a study is considered to have failed screening or is ineligible for the study.
    NOTREGISTERED
    A person for whom registration was not completed.
    NULL
    added to help the parsers
    OFFSTUDY
    A person that has ended their participation on a study either because their treatment/observation is complete or through not responding, withdrawal, non-compliance and/or adverse event.
    ONSTUDY
    A person that is enrolled or registered on a study.
    ONSTUDYINTERVENTION
    The person is receiving the treatment or participating in an activity (e.g.
    ONSTUDYOBSERVATION
    The subject is being evaluated via tests and assessments according to the study calendar, but is not receiving any intervention.
    PENDINGONSTUDY
    A person is pre-registered for a study.
    POTENTIALCANDIDATE
    A person that is potentially eligible for participation in the study.
    SCREENING
    A person who is being evaluated for eligibility for a study.
    WITHDRAWN
    The person has withdrawn their participation in the study before registration.

  • Method Summary

    Modifier and Type
    Method
    Description
    static ResearchSubjectStatus
    fromCode(String codeString)
     
    String
    getDefinition()
     
    String
    getDisplay()
     
    String
    getSystem()
     
    String
    toCode()
     
    static ResearchSubjectStatus
    valueOf(String name)
    Returns the enum constant of this type with the specified name.
    static ResearchSubjectStatus[]
    values()
    Returns an array containing the constants of this enum type, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • CANDIDATE

      public static final ResearchSubjectStatus CANDIDATE
      An identified person that can be considered for inclusion in a study.

    • ELIGIBLE

      public static final ResearchSubjectStatus ELIGIBLE
      A person that has met the eligibility criteria for inclusion in a study.

    • FOLLOWUP

      public static final ResearchSubjectStatus FOLLOWUP
      A person is no longer receiving study intervention and/or being evaluated with tests and procedures according to the protocol, but they are being monitored on a protocol-prescribed schedule.

    • INELIGIBLE

      public static final ResearchSubjectStatus INELIGIBLE
      A person who did not meet one or more criteria required for participation in a study is considered to have failed screening or is ineligible for the study.

    • NOTREGISTERED

      public static final ResearchSubjectStatus NOTREGISTERED
      A person for whom registration was not completed.

    • OFFSTUDY

      public static final ResearchSubjectStatus OFFSTUDY
      A person that has ended their participation on a study either because their treatment/observation is complete or through not responding, withdrawal, non-compliance and/or adverse event.

    • ONSTUDY

      public static final ResearchSubjectStatus ONSTUDY
      A person that is enrolled or registered on a study.

    • ONSTUDYINTERVENTION

      public static final ResearchSubjectStatus ONSTUDYINTERVENTION
      The person is receiving the treatment or participating in an activity (e.g. yoga, diet, etc.) that the study is evaluating.

    • ONSTUDYOBSERVATION

      public static final ResearchSubjectStatus ONSTUDYOBSERVATION
      The subject is being evaluated via tests and assessments according to the study calendar, but is not receiving any intervention. Note that this state is study-dependent and might not exist in all studies. A synonym for this is "short-term follow-up".

    • PENDINGONSTUDY

      public static final ResearchSubjectStatus PENDINGONSTUDY
      A person is pre-registered for a study.

    • POTENTIALCANDIDATE

      public static final ResearchSubjectStatus POTENTIALCANDIDATE
      A person that is potentially eligible for participation in the study.

    • SCREENING

      public static final ResearchSubjectStatus SCREENING
      A person who is being evaluated for eligibility for a study.

    • WITHDRAWN

      public static final ResearchSubjectStatus WITHDRAWN
      The person has withdrawn their participation in the study before registration.

    • NULL

      public static final ResearchSubjectStatus NULL
      added to help the parsers

  • Method Details

    • values

      public static ResearchSubjectStatus[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static ResearchSubjectStatus valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null

    • fromCode

      public static ResearchSubjectStatus fromCode(String codeString) throws org.hl7.fhir.exceptions.FHIRException
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • toCode

      public String toCode()

    • getSystem

      public String getSystem()

    • getDefinition

      public String getDefinition()

    • getDisplay

      public String getDisplay()