Class ResearchSubjectStatus

  • All Implemented Interfaces:
    Visitable

    @Generated("com.ibm.fhir.tools.CodeGenerator")
    public class ResearchSubjectStatus
    extends Code
    • Field Detail

      • CANDIDATE

        public static final ResearchSubjectStatus CANDIDATE
        Candidate

        An identified person that can be considered for inclusion in a study.

      • ELIGIBLE

        public static final ResearchSubjectStatus ELIGIBLE
        Eligible

        A person that has met the eligibility criteria for inclusion in a study.

      • FOLLOW_UP

        public static final ResearchSubjectStatus FOLLOW_UP
        Follow-up

        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
        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.

      • NOT_REGISTERED

        public static final ResearchSubjectStatus NOT_REGISTERED
        Not Registered

        A person for whom registration was not completed.

      • OFF_STUDY

        public static final ResearchSubjectStatus OFF_STUDY
        Off-study

        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.

      • ON_STUDY

        public static final ResearchSubjectStatus ON_STUDY
        On-study

        A person that is enrolled or registered on a study.

      • ON_STUDY_INTERVENTION

        public static final ResearchSubjectStatus ON_STUDY_INTERVENTION
        On-study-intervention

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

      • ON_STUDY_OBSERVATION

        public static final ResearchSubjectStatus ON_STUDY_OBSERVATION
        On-study-observation

        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".

      • PENDING_ON_STUDY

        public static final ResearchSubjectStatus PENDING_ON_STUDY
        Pending on-study

        A person is pre-registered for a study.

      • POTENTIAL_CANDIDATE

        public static final ResearchSubjectStatus POTENTIAL_CANDIDATE
        Potential Candidate

        A person that is potentially eligible for participation in the study.

      • SCREENING

        public static final ResearchSubjectStatus SCREENING
        Screening

        A person who is being evaluated for eligibility for a study.

      • WITHDRAWN

        public static final ResearchSubjectStatus WITHDRAWN
        Withdrawn

        The person has withdrawn their participation in the study before registration.

    • Method Detail

      • of

        public static ResearchSubjectStatus of​(String value)
        Factory method for creating ResearchSubjectStatus objects from a passed string value.
        Parameters:
        value - A string that matches one of the allowed code values
        Throws:
        IllegalArgumentException - If the passed string cannot be parsed into an allowed code value
      • string

        public static String string​(String value)
        Inherited factory method for creating ResearchSubjectStatus objects from a passed string value.
        Parameters:
        value - A string that matches one of the allowed code values
        Throws:
        IllegalArgumentException - If the passed string cannot be parsed into an allowed code value
      • code

        public static Code code​(String value)
        Inherited factory method for creating ResearchSubjectStatus objects from a passed string value.
        Parameters:
        value - A string that matches one of the allowed code values
        Throws:
        IllegalArgumentException - If the passed string cannot be parsed into an allowed code value
      • equals

        public boolean equals​(Object obj)
        Overrides:
        equals in class Code
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Code