Skip to main content


class HS.FHIR.DTL.vR4.Model.Resource.ResearchSubject extends HS.FHIR.DTL.vR4.Model.Base.DomainResource

Physical entity which is the primary unit of interest in the study.

Property Inventory


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.
parameter XMLTYPE = 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.


property actualArm as %String (MAXLEN = 1000000, XMLNAME = "actualArm", XMLPROJECTION = "ATTRIBUTE");

What path was followed.

Property methods: actualArmDisplayToLogical(), actualArmGet(), actualArmIsValid(), actualArmLogicalToDisplay(), actualArmLogicalToOdbc(), actualArmNormalize(), actualArmSet()
property assignedArm as %String (MAXLEN = 1000000, XMLNAME = "assignedArm", XMLPROJECTION = "ATTRIBUTE");

What path should be followed.

Property methods: assignedArmDisplayToLogical(), assignedArmGet(), assignedArmIsValid(), assignedArmLogicalToDisplay(), assignedArmLogicalToOdbc(), assignedArmNormalize(), assignedArmSet()

Agreement to participate in study.


Property methods: consentGet(), consentGetSwizzled(), consentIsValid(), consentNewObject(), consentSet()
property identifier as list of HS.FHIR.DTL.vR4.Model.Datatype.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");

Business Identifier for research subject in a study.

Property methods: identifierBuildValueArray(), identifierCollectionToDisplay(), identifierCollectionToOdbc(), identifierDisplayToCollection(), identifierGet(), identifierGetObject(), identifierGetObjectId(), identifierGetSwizzled(), identifierIsValid(), identifierOdbcToCollection(), identifierSet(), identifierSetObject(), identifierSetObjectId()
property individual as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "individual", XMLPROJECTION = "ELEMENT") [ Required ];

Who is part of study.


Property methods: individualGet(), individualGetSwizzled(), individualIsValid(), individualNewObject(), individualSet()
property period as HS.FHIR.DTL.vR4.Model.Datatype.Period (XMLNAME = "period", XMLPROJECTION = "ELEMENT");

Start and end of participation.

Property methods: periodGet(), periodGetSwizzled(), periodIsValid(), periodNewObject(), periodSet()
property status as %String (MAXLEN = 1000000, XMLNAME = "status", XMLPROJECTION = "ATTRIBUTE") [ Required ];

candidate | eligible | follow-up | ineligible | not-registered | off-study | on-study | on-study-intervention | on-study-observation | pending-on-study | potential-candidate | screening | withdrawn

research-subject-status|4.0.1 is the REQUIRED FHIR4 ValueSet for codes; you may NOT extend research-subject-status|4.0.1 and you may NOT use codes from other ValueSets.

Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
property study as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "study", XMLPROJECTION = "ELEMENT") [ Required ];

Study subject is part of.


Property methods: studyGet(), studyGetSwizzled(), studyIsValid(), studyNewObject(), studySet()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab