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

Thanks for your feedback!
Need to tell us more? Click here or use the Feedback button.

Is this page helpful?

Class Details

Parameters (5)
Properties (35)
Inherited Members

Show private members

HS.FHIR.DTL.vR4.Model.Resource.ResearchDefinition

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

A research context or question.

Property 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 = ResearchDefinition;

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

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 approvalDate as %String (MAXLEN = 1000000, XMLNAME = "approvalDate", XMLPROJECTION = "ATTRIBUTE");

date

When the research definition was approved by publisher.

Property methods: approvalDateDisplayToLogical(), approvalDateGet(), approvalDateIsValid(), approvalDateLogicalToDisplay(), approvalDateLogicalToOdbc(), approvalDateNormalize(), approvalDateSet()

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

ContactDetail

Who authored the content.

Property methods: authorBuildValueArray(), authorCollectionToDisplay(), authorCollectionToOdbc(), authorDisplayToCollection(), authorGet(), authorGetObject(), authorGetObjectId(), authorGetSwizzled(), authorIsValid(), authorOdbcToCollection(), authorSet(), authorSetObject(), authorSetObjectId()

property comment as list of %String (MAXLEN = 1000000, XMLNAME = "comment", XMLPROJECTION = "ELEMENT");

string

Used for footnotes or explanatory notes.

Property methods: commentBuildValueArray(), commentCollectionToDisplay(), commentCollectionToOdbc(), commentDisplayToCollection(), commentDisplayToLogical(), commentGet(), commentGetObject(), commentGetObjectId(), commentGetSwizzled(), commentIsValid(), commentLogicalToDisplay(), commentLogicalToOdbc(), commentNormalize(), commentOdbcToCollection(), commentSet(), commentSetObject(), commentSetObjectId()

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

ContactDetail

Contact details for the publisher.

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

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

markdown

Use and/or publishing restrictions.

Property methods: copyrightDisplayToLogical(), copyrightGet(), copyrightIsValid(), copyrightLogicalToDisplay(), copyrightLogicalToOdbc(), copyrightNormalize(), copyrightSet()

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

dateTime

Date last changed.

Property methods: dateDisplayToLogical(), dateGet(), dateIsValid(), dateLogicalToDisplay(), dateLogicalToOdbc(), dateNormalize(), dateSet()

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

markdown

Natural language description of the research definition.

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

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

ContactDetail

Who edited the content.

Property methods: editorBuildValueArray(), editorCollectionToDisplay(), editorCollectionToOdbc(), editorDisplayToCollection(), editorGet(), editorGetObject(), editorGetObjectId(), editorGetSwizzled(), editorIsValid(), editorOdbcToCollection(), editorSet(), editorSetObject(), editorSetObjectId()

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

Period

When the research definition is expected to be used.

Property methods: effectivePeriodGet(), effectivePeriodGetSwizzled(), effectivePeriodIsValid(), effectivePeriodNewObject(), effectivePeriodSet()

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

ContactDetail

Who endorsed the content.

Property methods: endorserBuildValueArray(), endorserCollectionToDisplay(), endorserCollectionToOdbc(), endorserDisplayToCollection(), endorserGet(), endorserGetObject(), endorserGetObjectId(), endorserGetSwizzled(), endorserIsValid(), endorserOdbcToCollection(), endorserSet(), endorserSetObject(), endorserSetObjectId()

property experimental as %Boolean (XMLNAME = "experimental", XMLPROJECTION = "ATTRIBUTE");

boolean

For testing purposes, not real usage.

Property methods: experimentalDisplayToLogical(), experimentalGet(), experimentalIsValid(), experimentalLogicalToDisplay(), experimentalLogicalToXSD(), experimentalNormalize(), experimentalSet(), experimentalXSDToLogical()

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

Reference

What exposure?

ResearchElementDefinition

Property methods: exposureGet(), exposureGetSwizzled(), exposureIsValid(), exposureNewObject(), exposureSet()

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

Reference

What alternative exposure state?

ResearchElementDefinition

Property methods: exposureAlternativeGet(), exposureAlternativeGetSwizzled(), exposureAlternativeIsValid(), exposureAlternativeNewObject(), exposureAlternativeSet()

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

Identifier

Additional identifier for the research definition.

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

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

CodeableConcept

Intended jurisdiction for research definition (if applicable)

jurisdiction is the REQUIRED FHIR4 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 lastReviewDate as %String (MAXLEN = 1000000, XMLNAME = "lastReviewDate", XMLPROJECTION = "ATTRIBUTE");

date

When the research definition was last reviewed.

Property methods: lastReviewDateDisplayToLogical(), lastReviewDateGet(), lastReviewDateIsValid(), lastReviewDateLogicalToDisplay(), lastReviewDateLogicalToOdbc(), lastReviewDateNormalize(), lastReviewDateSet()

property library as list of %String (MAXLEN = 1000000, XMLNAME = "library", XMLPROJECTION = "ELEMENT");

canonical

Logic used by the ResearchDefinition.

TO DO: Unrecognized value type for the FHIR4 model

Property methods: libraryBuildValueArray(), libraryCollectionToDisplay(), libraryCollectionToOdbc(), libraryDisplayToCollection(), libraryDisplayToLogical(), libraryGet(), libraryGetObject(), libraryGetObjectId(), libraryGetSwizzled(), libraryIsValid(), libraryLogicalToDisplay(), libraryLogicalToOdbc(), libraryNormalize(), libraryOdbcToCollection(), librarySet(), librarySetObject(), librarySetObjectId()

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

string

Name for this research definition (computer friendly)

Property methods: nameDisplayToLogical(), nameGet(), nameIsValid(), nameLogicalToDisplay(), nameLogicalToOdbc(), nameNormalize(), nameSet()

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

Reference

What outcome?

ResearchElementDefinition

Property methods: outcomeGet(), outcomeGetSwizzled(), outcomeIsValid(), outcomeNewObject(), outcomeSet()

property population as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "population", XMLPROJECTION = "ELEMENT") [ Required ];

Reference

What population?

ResearchElementDefinition

Property methods: populationGet(), populationGetSwizzled(), populationIsValid(), populationNewObject(), populationSet()

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

string

Name of the publisher (organization or individual)

Property methods: publisherDisplayToLogical(), publisherGet(), publisherIsValid(), publisherLogicalToDisplay(), publisherLogicalToOdbc(), publisherNormalize(), publisherSet()

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

markdown

Why this research definition is defined.

Property methods: purposeDisplayToLogical(), purposeGet(), purposeIsValid(), purposeLogicalToDisplay(), purposeLogicalToOdbc(), purposeNormalize(), purposeSet()

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

RelatedArtifact

Additional documentation, citations, etc.

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

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

ContactDetail

Who reviewed the content.

Property methods: reviewerBuildValueArray(), reviewerCollectionToDisplay(), reviewerCollectionToOdbc(), reviewerDisplayToCollection(), reviewerGet(), reviewerGetObject(), reviewerGetObjectId(), reviewerGetSwizzled(), reviewerIsValid(), reviewerOdbcToCollection(), reviewerSet(), reviewerSetObject(), reviewerSetObjectId()

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

string

Title for use in informal contexts.

Property methods: shortTitleDisplayToLogical(), shortTitleGet(), shortTitleIsValid(), shortTitleLogicalToDisplay(), shortTitleLogicalToOdbc(), shortTitleNormalize(), shortTitleSet()

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

code

draft | active | retired | unknown

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

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

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

CodeableConcept

E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device.

subject-type is the REQUIRED FHIR4 ValueSet for codes, but if you need to express meanings not found in subject-type, you may formally EXTEND subject-type to add codes to it.

Property methods: subjectCodeableConceptGet(), subjectCodeableConceptGetSwizzled(), subjectCodeableConceptIsValid(), subjectCodeableConceptNewObject(), subjectCodeableConceptSet()

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

Reference

E.g. Patient, Practitioner, RelatedPerson, Organization, Location, Device.

Group.

Property methods: subjectReferenceGet(), subjectReferenceGetSwizzled(), subjectReferenceIsValid(), subjectReferenceNewObject(), subjectReferenceSet()

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

string

Subordinate title of the ResearchDefinition.

Property methods: subtitleDisplayToLogical(), subtitleGet(), subtitleIsValid(), subtitleLogicalToDisplay(), subtitleLogicalToOdbc(), subtitleNormalize(), subtitleSet()

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

string

Name for this research definition (human friendly)

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

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

CodeableConcept

The category of the ResearchDefinition, such as Education, Treatment, Assessment, etc.

any FHIR4 code may be used; definition-topic shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: topicBuildValueArray(), topicCollectionToDisplay(), topicCollectionToOdbc(), topicDisplayToCollection(), topicGet(), topicGetObject(), topicGetObjectId(), topicGetSwizzled(), topicIsValid(), topicOdbcToCollection(), topicSet(), topicSetObject(), topicSetObjectId()

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

uri

Canonical identifier for this research definition, represented as a URI (globally unique)

Property methods: urlDisplayToLogical(), urlGet(), urlIsValid(), urlLogicalToDisplay(), urlLogicalToOdbc(), urlNormalize(), urlSet()

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

string

Describes the clinical usage of the ResearchDefinition.

Property methods: usageDisplayToLogical(), usageGet(), usageIsValid(), usageLogicalToDisplay(), usageLogicalToOdbc(), usageNormalize(), usageSet()

property useContext as list of HS.FHIR.DTL.vR4.Model.Datatype.UsageContext (XMLNAME = "useContext", XMLPROJECTION = "ELEMENT");

UsageContext

The context that the content is intended to support.

Property methods: useContextBuildValueArray(), useContextCollectionToDisplay(), useContextCollectionToOdbc(), useContextDisplayToCollection(), useContextGet(), useContextGetObject(), useContextGetObjectId(), useContextGetSwizzled(), useContextIsValid(), useContextOdbcToCollection(), useContextSet(), useContextSetObject(), useContextSetObjectId()

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

string

Business version of the research definition.

Property methods: versionDisplayToLogical(), versionGet(), versionIsValid(), versionLogicalToDisplay(), versionLogicalToOdbc(), versionNormalize(), versionSet()

Inherited Members

Inherited Properties

Inherited Methods

Feedback