Skip to main content

HS.FHIR.vSTU3.Model.Resource.ResearchSubject

deprecated class HS.FHIR.vSTU3.Model.Resource.ResearchSubject extends HS.FHIR.vSTU3.Model.Base.DomainResource

THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
A process where a researcher or organization plans and then executes a series of steps intended to increase the field of healthcare-related knowledge. This includes studies of safety, efficacy, comparative effectiveness and other information about medications, devices, therapies and other interventional and investigative techniques. A ResearchStudy involves the gathering of information about human or animal subjects.
If the element is present, it must have either a @value, an @id, or extensions

Property Inventory

Method Inventory

Parameters

parameter ELEMENTQUALIFIED = 1;
Inherited description: ELEMENTQUALIFIED controls the format of exported XML. The ELEMENTQUALIFIED specification should be based on the elementFormDefault attribute of the schema that defines the type. To maintain compatibility, ELEMENTQUALIFIED will default to 1 (true) for literal format export and will default to 0 (false) for encoded or encoded12 format export. These were the values always previously assumed for the elementFormDefault attribute. NOTE: Direct use of XMLExport method does not support the ELEMENTQUALIFIED. The export must be done using %XML.Writer or SOAP support.
parameter XMLNAME = ResearchSubject;
Inherited description: This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.
parameter XMLSEQUENCE = 1;
Inherited description: If the XMLSEQUENCE = 1, then the order of the XML elements must match the order of the class properties. This allows us to deal with XML where the same field appears multiple times and is distinguished by the order.

Properties

property actualArm as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "actualArm", XMLPROJECTION = "ELEMENT");
The name of the arm in the study the subject actually followed as part of this study.
Property methods: actualArmGet(), actualArmGetSwizzled(), actualArmIsValid(), actualArmNewObject(), actualArmSet()
property assignedArm as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "assignedArm", XMLPROJECTION = "ELEMENT");
The name of the arm in the study the subject is expected to follow as part of this study.
Property methods: assignedArmGet(), assignedArmGetSwizzled(), assignedArmIsValid(), assignedArmNewObject(), assignedArmSet()
A record of the patient's informed agreement to participate in the study.
Property methods: consentGet(), consentGetSwizzled(), consentIsValid(), consentNewObject(), consentSet()
property identifier as HS.FHIR.vSTU3.Model.Base.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");
Identifiers assigned to this research study by the sponsor or other systems.
Property methods: identifierGet(), identifierGetSwizzled(), identifierIsValid(), identifierNewObject(), identifierSet()
property individual as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "individual", XMLPROJECTION = "ELEMENT") [ Required ];
The record of the person or animal who is involved in the study.
Property methods: individualGet(), individualGetSwizzled(), individualIsValid(), individualNewObject(), individualSet()
property period as HS.FHIR.vSTU3.Model.Base.Period (XMLNAME = "period", XMLPROJECTION = "ELEMENT");
The dates the subject began and ended their participation in the study.
Property methods: periodGet(), periodGetSwizzled(), periodIsValid(), periodNewObject(), periodSet()
property status as HS.FHIR.vSTU3.Model.Base.ResearchSubjectStatus (XMLNAME = "status", XMLPROJECTION = "ELEMENT") [ Required ];
The current state of the subject.
Property methods: statusGet(), statusGetSwizzled(), statusIsValid(), statusNewObject(), statusSet()
property study as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "study", XMLPROJECTION = "ELEMENT") [ Required ];
Reference to the study the subject is participating in.
Property methods: studyGet(), studyGetSwizzled(), studyIsValid(), studyNewObject(), studySet()

Methods

deprecated method SetActualArm(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "actualArm" property.
deprecated method SetAssignedArm(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "assignedArm" property.
deprecated method SetConsent(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "consent" property.
deprecated method SetIdentifier(pValue As %String = "", pSystem As %String = "", pUse As %String = "", pTypeCode As %String = "", pTypeSystem As %String = "", pTypeDisplay As %String = "", pTypeText As %String = "", pId As %String = "", pStart As %String = "", pEnd As %String = "", pAssignerReference As %String = "", pAssignerDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "identifier" property.
deprecated method SetIndividual(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "individual" property.
deprecated method SetPeriod(pStart As %String = "", pEnd As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "period" property.
deprecated method SetStatus(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "status" property.
deprecated method SetStudy(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "study" property.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab