:py:mod:`spark_auto_mapper_fhir.value_sets.research_subject_status`
===================================================================

.. py:module:: spark_auto_mapper_fhir.value_sets.research_subject_status


Module Contents
---------------

Classes
~~~~~~~

.. autoapisummary::

   spark_auto_mapper_fhir.value_sets.research_subject_status.ResearchSubjectStatusCode
   spark_auto_mapper_fhir.value_sets.research_subject_status.ResearchSubjectStatusCodeValues




.. py:class:: ResearchSubjectStatusCode(value)

   Bases: :py:obj:`spark_auto_mapper_fhir.value_sets.generic_type.GenericTypeCode`

   ResearchSubjectStatus
   From: http://hl7.org/fhir/research-subject-status in valuesets.xml
       Indicates the progression of a study subject through a study.

   .. py:attribute:: codeset
      :annotation: :spark_auto_mapper_fhir.fhir_types.uri.FhirUri = http://hl7.org/fhir/research-subject-status

      


.. py:class:: ResearchSubjectStatusCodeValues

   An identified person that can be considered for inclusion in a study.
   From: http://hl7.org/fhir/research-subject-status in valuesets.xml

   .. py:attribute:: Candidate
      

      A person that has met the eligibility criteria for inclusion in a study.
      From: http://hl7.org/fhir/research-subject-status in valuesets.xml


   .. py:attribute:: Eligible
      

      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.
      From: http://hl7.org/fhir/research-subject-status in valuesets.xml


   .. py:attribute:: Follow_up
      

      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.
      From: http://hl7.org/fhir/research-subject-status in valuesets.xml


   .. py:attribute:: Ineligible
      

      A person for whom registration was not completed.
      From: http://hl7.org/fhir/research-subject-status in valuesets.xml


   .. py:attribute:: NotRegistered
      

      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.
      From: http://hl7.org/fhir/research-subject-status in valuesets.xml


   .. py:attribute:: Off_study
      

      A person that is enrolled or registered on a study.
      From: http://hl7.org/fhir/research-subject-status in valuesets.xml


   .. py:attribute:: On_study
      

      The person is receiving the treatment or participating in an activity (e.g.
      yoga, diet, etc.) that the study is evaluating.
      From: http://hl7.org/fhir/research-subject-status in valuesets.xml


   .. py:attribute:: On_study_intervention
      

      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".
      From: http://hl7.org/fhir/research-subject-status in valuesets.xml


   .. py:attribute:: On_study_observation
      

      A person is pre-registered for a study.
      From: http://hl7.org/fhir/research-subject-status in valuesets.xml


   .. py:attribute:: PendingOn_study
      

      A person that is potentially eligible for participation in the study.
      From: http://hl7.org/fhir/research-subject-status in valuesets.xml


   .. py:attribute:: PotentialCandidate
      

      A person who is being evaluated for eligibility for a study.
      From: http://hl7.org/fhir/research-subject-status in valuesets.xml


   .. py:attribute:: Screening
      

      The person has withdrawn their participation in the study before registration.
      From: http://hl7.org/fhir/research-subject-status in valuesets.xml


   .. py:attribute:: Withdrawn