Sorry, your browser does not support JavaScript or JavaScript is disabled. Please enable JavaScript or use another browser to have a better experience.

HS.FHIR.DTL.vSTU3.Model.Resource.ResearchStudy

class HS.FHIR.DTL.vSTU3.Model.Resource.ResearchStudy extends HS.FHIR.DTL.vSTU3.Model.Base.DomainResource

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.

Property Inventory

arm
category
contact
description
enrollment
focus
identifier
jurisdiction
keyword
note
partOf
period
principalInvestigator
protocol
reasonStopped
relatedArtifact
site
sponsor
status
title

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 = ResearchStudy;

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 XMLPROJECTION = ELEMENT;

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 = ResearchStudy;

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 arm as list of HS.FHIR.DTL.vSTU3.Model.Element.ResearchStudy.arm (XMLNAME = "arm", XMLPROJECTION = "ELEMENT");

BackboneElement

Defined path through the study for a subject.

Property methods: armBuildValueArray(), armCollectionToDisplay(), armCollectionToOdbc(), armDisplayToCollection(), armGet(), armGetObject(), armGetObjectId(), armGetSwizzled(), armIsValid(), armOdbcToCollection(), armSet(), armSetObject(), armSetObjectId()

property category as list of HS.FHIR.DTL.vSTU3.Model.Datatype.CodeableConcept (XMLNAME = "category", XMLPROJECTION = "ELEMENT");

CodeableConcept

Classifications for the study.

any FHIR3 code from any ValueSet may be used.

Property methods: categoryBuildValueArray(), categoryCollectionToDisplay(), categoryCollectionToOdbc(), categoryDisplayToCollection(), categoryGet(), categoryGetObject(), categoryGetObjectId(), categoryGetSwizzled(), categoryIsValid(), categoryOdbcToCollection(), categorySet(), categorySetObject(), categorySetObjectId()

property contact as list of HS.FHIR.DTL.vSTU3.Model.Datatype.ContactDetail (XMLNAME = "contact", XMLPROJECTION = "ELEMENT");

ContactDetail

Contact details for the study.

Property methods: contactBuildValueArray(), contactCollectionToDisplay(), contactCollectionToOdbc(), contactDisplayToCollection(), contactGet(), contactGetObject(), contactGetObjectId(), contactGetSwizzled(), contactIsValid(), contactOdbcToCollection(), contactSet(), contactSetObject(), contactSetObjectId()

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

markdown

What this is study doing.

Property methods: descriptionDisplayToLogical(), descriptionGet(), descriptionIsValid(), descriptionLogicalToDisplay(), descriptionLogicalToOdbc(), descriptionNormalize(), descriptionSet()

property enrollment as list of HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "enrollment", XMLPROJECTION = "ELEMENT");

Reference

Inclusion & exclusion criteria.

Group

Property methods: enrollmentBuildValueArray(), enrollmentCollectionToDisplay(), enrollmentCollectionToOdbc(), enrollmentDisplayToCollection(), enrollmentGet(), enrollmentGetObject(), enrollmentGetObjectId(), enrollmentGetSwizzled(), enrollmentIsValid(), enrollmentOdbcToCollection(), enrollmentSet(), enrollmentSetObject(), enrollmentSetObjectId()

property focus as list of HS.FHIR.DTL.vSTU3.Model.Datatype.CodeableConcept (XMLNAME = "focus", XMLPROJECTION = "ELEMENT");

CodeableConcept

Drugs, devices, conditions, etc. under study.

any FHIR3 code from any ValueSet may be used.

Property methods: focusBuildValueArray(), focusCollectionToDisplay(), focusCollectionToOdbc(), focusDisplayToCollection(), focusGet(), focusGetObject(), focusGetObjectId(), focusGetSwizzled(), focusIsValid(), focusOdbcToCollection(), focusSet(), focusSetObject(), focusSetObjectId()

property identifier as list of HS.FHIR.DTL.vSTU3.Model.Datatype.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");

Identifier

Business Identifier for study.

Property methods: identifierBuildValueArray(), identifierCollectionToDisplay(), identifierCollectionToOdbc(), identifierDisplayToCollection(), identifierGet(), identifierGetObject(), identifierGetObjectId(), identifierGetSwizzled(), identifierIsValid(), identifierOdbcToCollection(), identifierSet(), identifierSetObject(), identifierSetObjectId()

property jurisdiction as list of HS.FHIR.DTL.vSTU3.Model.Datatype.CodeableConcept (XMLNAME = "jurisdiction", XMLPROJECTION = "ELEMENT");

CodeableConcept

Geographic region(s) for study.

jurisdiction is the REQUIRED FHIR3 ValueSet for codes, but if you need to express meanings not found in jurisdiction, you may formally EXTEND jurisdiction to add codes to it.

Property methods: jurisdictionBuildValueArray(), jurisdictionCollectionToDisplay(), jurisdictionCollectionToOdbc(), jurisdictionDisplayToCollection(), jurisdictionGet(), jurisdictionGetObject(), jurisdictionGetObjectId(), jurisdictionGetSwizzled(), jurisdictionIsValid(), jurisdictionOdbcToCollection(), jurisdictionSet(), jurisdictionSetObject(), jurisdictionSetObjectId()

property keyword as list of HS.FHIR.DTL.vSTU3.Model.Datatype.CodeableConcept (XMLNAME = "keyword", XMLPROJECTION = "ELEMENT");

CodeableConcept

Used to search for the study.

any FHIR3 code from any ValueSet may be used.

Property methods: keywordBuildValueArray(), keywordCollectionToDisplay(), keywordCollectionToOdbc(), keywordDisplayToCollection(), keywordGet(), keywordGetObject(), keywordGetObjectId(), keywordGetSwizzled(), keywordIsValid(), keywordOdbcToCollection(), keywordSet(), keywordSetObject(), keywordSetObjectId()

property note as list of HS.FHIR.DTL.vSTU3.Model.Datatype.Annotation (XMLNAME = "note", XMLPROJECTION = "ELEMENT");

Annotation

Comments made about the event.

Property methods: noteBuildValueArray(), noteCollectionToDisplay(), noteCollectionToOdbc(), noteDisplayToCollection(), noteGet(), noteGetObject(), noteGetObjectId(), noteGetSwizzled(), noteIsValid(), noteOdbcToCollection(), noteSet(), noteSetObject(), noteSetObjectId()

property partOf as list of HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "partOf", XMLPROJECTION = "ELEMENT");

Reference

Part of larger study.

ResearchStudy

Property methods: partOfBuildValueArray(), partOfCollectionToDisplay(), partOfCollectionToOdbc(), partOfDisplayToCollection(), partOfGet(), partOfGetObject(), partOfGetObjectId(), partOfGetSwizzled(), partOfIsValid(), partOfOdbcToCollection(), partOfSet(), partOfSetObject(), partOfSetObjectId()

property period as HS.FHIR.DTL.vSTU3.Model.Datatype.Period (XMLNAME = "period", XMLPROJECTION = "ELEMENT");

Period

When the study began and ended.

Property methods: periodGet(), periodGetSwizzled(), periodIsValid(), periodNewObject(), periodSet()

property principalInvestigator as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "principalInvestigator", XMLPROJECTION = "ELEMENT");

Reference

The individual responsible for the study.

Practitioner

Property methods: principalInvestigatorGet(), principalInvestigatorGetSwizzled(), principalInvestigatorIsValid(), principalInvestigatorNewObject(), principalInvestigatorSet()

property protocol as list of HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "protocol", XMLPROJECTION = "ELEMENT");

Reference

Steps followed in executing study.

PlanDefinition

Property methods: protocolBuildValueArray(), protocolCollectionToDisplay(), protocolCollectionToOdbc(), protocolDisplayToCollection(), protocolGet(), protocolGetObject(), protocolGetObjectId(), protocolGetSwizzled(), protocolIsValid(), protocolOdbcToCollection(), protocolSet(), protocolSetObject(), protocolSetObjectId()

property reasonStopped as HS.FHIR.DTL.vSTU3.Model.Datatype.CodeableConcept (XMLNAME = "reasonStopped", XMLPROJECTION = "ELEMENT");

CodeableConcept

Reason for terminating study early.

any FHIR3 code from any ValueSet may be used.

Property methods: reasonStoppedGet(), reasonStoppedGetSwizzled(), reasonStoppedIsValid(), reasonStoppedNewObject(), reasonStoppedSet()

property relatedArtifact as list of HS.FHIR.DTL.vSTU3.Model.Datatype.RelatedArtifact (XMLNAME = "relatedArtifact", XMLPROJECTION = "ELEMENT");

RelatedArtifact

References and dependencies.

Property methods: relatedArtifactBuildValueArray(), relatedArtifactCollectionToDisplay(), relatedArtifactCollectionToOdbc(), relatedArtifactDisplayToCollection(), relatedArtifactGet(), relatedArtifactGetObject(), relatedArtifactGetObjectId(), relatedArtifactGetSwizzled(), relatedArtifactIsValid(), relatedArtifactOdbcToCollection(), relatedArtifactSet(), relatedArtifactSetObject(), relatedArtifactSetObjectId()

property site as list of HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "site", XMLPROJECTION = "ELEMENT");

Reference

Location involved in study execution.

Location

Property methods: siteBuildValueArray(), siteCollectionToDisplay(), siteCollectionToOdbc(), siteDisplayToCollection(), siteGet(), siteGetObject(), siteGetObjectId(), siteGetSwizzled(), siteIsValid(), siteOdbcToCollection(), siteSet(), siteSetObject(), siteSetObjectId()

Reference

Organization responsible for the study.

Organization

Property methods: sponsorGet(), sponsorGetSwizzled(), sponsorIsValid(), sponsorNewObject(), sponsorSet()

property status as %String (MAXLEN = 1000000, XMLNAME = "status", XMLPROJECTION = "ATTRIBUTE") [ Required ];

code

research-study-status is the REQUIRED FHIR3 ValueSet for codes; you may NOT extend research-study-status and you may NOT use codes from other ValueSets.

Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()

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

string

Name for this study.

Property methods: titleDisplayToLogical(), titleGet(), titleIsValid(), titleLogicalToDisplay(), titleLogicalToOdbc(), titleNormalize(), titleSet()

Inherited Members

Inherited Properties

Inherited Methods

Feedback