Skip to main content

HS.FHIRModel.R4.ResearchSubject

class HS.FHIRModel.R4.ResearchSubject extends HS.FHIRModel.FHIRClassSuper

*****************************************
** ResearchSubject generated class schema
*****************************************
A physical entity which is the primary unit of operational and/or administrative interest in a study.

Property Inventory

Method Inventory

Parameters

parameter XMLTYPE = R4_RESEARCHSUBJECT;
Inherited description: This parameter provides the default XMLTYPE for the class. If it is empty then the class name will be used to construct a default XML type.

The default XMLTYPE is used when naming and referencing this type in a schema and the schema context did not provide an XML type name.

Properties

property _actualArm as HS.FHIRModel.R4.Element;
Extensions for actualArm
Property methods: _actualArmGet(), _actualArmGetSwizzled(), _actualArmIsValid(), _actualArmNewObject(), _actualArmSet()
property _assignedArm as HS.FHIRModel.R4.Element;
Extensions for assignedArm
Property methods: _assignedArmGet(), _assignedArmGetSwizzled(), _assignedArmIsValid(), _assignedArmNewObject(), _assignedArmSet()
property _implicitRules as HS.FHIRModel.R4.Element;
Extensions for implicitRules
Property methods: _implicitRulesGet(), _implicitRulesGetSwizzled(), _implicitRulesIsValid(), _implicitRulesNewObject(), _implicitRulesSet()
property _language as HS.FHIRModel.R4.Element;
Extensions for language
Property methods: _languageGet(), _languageGetSwizzled(), _languageIsValid(), _languageNewObject(), _languageSet()
property _status as HS.FHIRModel.R4.Element;
Extensions for status
Property methods: _statusGet(), _statusGetSwizzled(), _statusIsValid(), _statusNewObject(), _statusSet()
property actualArm as %String;
The name of the arm in the study the subject actually followed as part of this study.
Property methods: actualArmDisplayToLogical(), actualArmGet(), actualArmIsValid(), actualArmLogicalToDisplay(), actualArmLogicalToOdbc(), actualArmNormalize(), actualArmSet()
property assignedArm as %String;
The name of the arm in the study the subject is expected to follow as part of this study.
Property methods: assignedArmDisplayToLogical(), assignedArmGet(), assignedArmIsValid(), assignedArmLogicalToDisplay(), assignedArmLogicalToOdbc(), assignedArmNormalize(), assignedArmSet()
A record of the patient's informed agreement to participate in the study.
Property methods: consentGet(), consentGetSwizzled(), consentIsValid(), consentNewObject(), consentSet()
property contained as HS.FHIRModel.R4.SeqOfResourceList;
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Property methods: containedGet(), containedGetSwizzled(), containedIsValid(), containedNewObject(), containedSet()
property extension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Property methods: extensionGet(), extensionGetSwizzled(), extensionIsValid(), extensionNewObject(), extensionSet()
property fhirID as %String;
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Property methods: fhirIDDisplayToLogical(), fhirIDGet(), fhirIDIsValid(), fhirIDLogicalToDisplay(), fhirIDLogicalToOdbc(), fhirIDNormalize(), fhirIDSet()
property identifier as HS.FHIRModel.R4.SeqOfIdentifier;
Identifiers assigned to this research subject for a study.
Property methods: identifierGet(), identifierGetSwizzled(), identifierIsValid(), identifierNewObject(), identifierSet()
property implicitRules as %String;
A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Property methods: implicitRulesDisplayToLogical(), implicitRulesGet(), implicitRulesIsValid(), implicitRulesLogicalToDisplay(), implicitRulesLogicalToOdbc(), implicitRulesNormalize(), implicitRulesSet()
property individual as HS.FHIRModel.R4.Reference [ Required ];
The record of the person or animal who is involved in the study.
Property methods: individualGet(), individualGetSwizzled(), individualIsValid(), individualNewObject(), individualSet()
property language as %String;
The base language in which the resource is written.
Property methods: languageDisplayToLogical(), languageGet(), languageIsValid(), languageLogicalToDisplay(), languageLogicalToOdbc(), languageNormalize(), languageSet()
property meta as HS.FHIRModel.R4.Meta;
The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Property methods: metaGet(), metaGetSwizzled(), metaIsValid(), metaNewObject(), metaSet()
property modifierExtension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Property methods: modifierExtensionGet(), modifierExtensionGetSwizzled(), modifierExtensionIsValid(), modifierExtensionNewObject(), modifierExtensionSet()
property period as HS.FHIRModel.R4.Period;
The dates the subject began and ended their participation in the study.
Property methods: periodGet(), periodGetSwizzled(), periodIsValid(), periodNewObject(), periodSet()
property resourceType as %String [ InitialExpression = "ResearchSubject" , Required ];
This is a ResearchSubject resource
Property methods: resourceTypeDisplayToLogical(), resourceTypeGet(), resourceTypeIsValid(), resourceTypeLogicalToDisplay(), resourceTypeLogicalToOdbc(), resourceTypeNormalize(), resourceTypeSet()
property status as %String (VALUELIST = ",candidate,eligible,follow-up,ineligible,not-registered,off-study,on-study,on-study-intervention,on-study-observation,pending-on-study,potential-candidate,screening,withdrawn");
The current state of the subject.
Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
property study as HS.FHIRModel.R4.Reference [ Required ];
Reference to the study the subject is participating in.
Property methods: studyGet(), studyGetSwizzled(), studyIsValid(), studyNewObject(), studySet()
property text as HS.FHIRModel.R4.Narrative;
A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Property methods: textGet(), textGetSwizzled(), textIsValid(), textNewObject(), textSet()

Methods

method IncludeConsent()
method IncludeContained()
method IncludeExtension()
method IncludeIdentifier()
method IncludeIndividual()
method IncludeMeta()
method IncludeModifierExtension()
method IncludePeriod()
method IncludeStudy()
method IncludeText()
method _getProperties() as %DynamicArray
Inherited description: Return an array of the defined properties of this class in the definition order that they were discovered in the the HL7FHIR JSchema document
method toDao() as %DynamicAbstractObject
Inherited description: >

The toDao() method casts the set to a DAO.

Inherited Members

Inherited Methods

FeedbackOpens in a new tab