Class ResearchSubject

  • All Implemented Interfaces:
    ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IAnyResource, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.IBaseResource, org.hl7.fhir.instance.model.api.IDomainResource

    public class ResearchSubject
    extends DomainResource
    A physical entity which is the primary unit of operational and/or administrative interest in a study.
    See Also:
    Serialized Form
    • Field Detail

      • period

        protected Period period
        The dates the subject began and ended their participation in the study.
      • study

        protected Reference study
        Reference to the study the subject is participating in.
      • studyTarget

        protected ResearchStudy studyTarget
        The actual object that is the target of the reference (Reference to the study the subject is participating in.)
      • individual

        protected Reference individual
        The record of the person or animal who is involved in the study.
      • individualTarget

        protected Patient individualTarget
        The actual object that is the target of the reference (The record of the person or animal who is involved in the study.)
      • assignedArm

        protected StringType assignedArm
        The name of the arm in the study the subject is expected to follow as part of this study.
      • actualArm

        protected StringType actualArm
        The name of the arm in the study the subject actually followed as part of this study.
      • consent

        protected Reference consent
        A record of the patient's informed agreement to participate in the study.
      • consentTarget

        protected Consent consentTarget
        The actual object that is the target of the reference (A record of the patient's informed agreement to participate in the study.)
      • SP_DATE

        public static final String SP_DATE
        Search parameter: date

        Description: Start and end of participation
        Type: date
        Path: ResearchSubject.period

        See Also:
        Constant Field Values
      • DATE

        public static final ca.uhn.fhir.rest.gclient.DateClientParam DATE
        Fluent Client search parameter constant for date

        Description: Start and end of participation
        Type: date
        Path: ResearchSubject.period

      • SP_IDENTIFIER

        public static final String SP_IDENTIFIER
        Search parameter: identifier

        Description: Business Identifier for research subject in a study
        Type: token
        Path: ResearchSubject.identifier

        See Also:
        Constant Field Values
      • IDENTIFIER

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
        Fluent Client search parameter constant for identifier

        Description: Business Identifier for research subject in a study
        Type: token
        Path: ResearchSubject.identifier

      • SP_STUDY

        public static final String SP_STUDY
        Search parameter: study

        Description: Study subject is part of
        Type: reference
        Path: ResearchSubject.study

        See Also:
        Constant Field Values
      • STUDY

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam STUDY
        Fluent Client search parameter constant for study

        Description: Study subject is part of
        Type: reference
        Path: ResearchSubject.study

      • INCLUDE_STUDY

        public static final ca.uhn.fhir.model.api.Include INCLUDE_STUDY
        Constant for fluent queries to be used to add include statements. Specifies the path value of "ResearchSubject:study".
      • SP_INDIVIDUAL

        public static final String SP_INDIVIDUAL
        Search parameter: individual

        Description: Who is part of study
        Type: reference
        Path: ResearchSubject.individual

        See Also:
        Constant Field Values
      • INDIVIDUAL

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam INDIVIDUAL
        Fluent Client search parameter constant for individual

        Description: Who is part of study
        Type: reference
        Path: ResearchSubject.individual

      • INCLUDE_INDIVIDUAL

        public static final ca.uhn.fhir.model.api.Include INCLUDE_INDIVIDUAL
        Constant for fluent queries to be used to add include statements. Specifies the path value of "ResearchSubject:individual".
      • SP_PATIENT

        public static final String SP_PATIENT
        Search parameter: patient

        Description: Who is part of study
        Type: reference
        Path: ResearchSubject.individual

        See Also:
        Constant Field Values
      • PATIENT

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PATIENT
        Fluent Client search parameter constant for patient

        Description: Who is part of study
        Type: reference
        Path: ResearchSubject.individual

      • INCLUDE_PATIENT

        public static final ca.uhn.fhir.model.api.Include INCLUDE_PATIENT
        Constant for fluent queries to be used to add include statements. Specifies the path value of "ResearchSubject:patient".
      • SP_STATUS

        public static final String SP_STATUS
        Search parameter: status

        Description: candidate | eligible | follow-up | ineligible | not-registered | off-study | on-study | on-study-intervention | on-study-observation | pending-on-study | potential-candidate | screening | withdrawn
        Type: token
        Path: ResearchSubject.status

        See Also:
        Constant Field Values
      • STATUS

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
        Fluent Client search parameter constant for status

        Description: candidate | eligible | follow-up | ineligible | not-registered | off-study | on-study | on-study-intervention | on-study-observation | pending-on-study | potential-candidate | screening | withdrawn
        Type: token
        Path: ResearchSubject.status