Private OptionalurlResearchStudy.url Element
Private OptionalidentifierResearchStudy.identifier Element
FHIR Specification
IdentifierPrivate OptionalversionResearchStudy.version Element
Private OptionalnameResearchStudy.name Element
Private OptionaltitleResearchStudy.title Element
Private OptionallabelResearchStudy.label Element
Private OptionalprotocolResearchStudy.protocol Element
FHIR Specification
Reference
Private OptionalpartResearchStudy.partOf Element
FHIR Specification
Reference
Private OptionalrelatedResearchStudy.relatedArtifact Element
FHIR Specification
RelatedArtifactPrivate OptionaldateResearchStudy.date Element
FHIR Specification
dateTimePrivate ReadonlypublicationFHIR CodeSystem: PublicationStatus
PrivatestatusResearchStudy.status Element
FHIR Specification
codeCodeSystem Enumeration: PublicationStatusEnum
Private OptionalprimaryResearchStudy.primaryPurposeType Element
FHIR Specification
CodeableConceptPrivate OptionalphaseResearchStudy.phase Element
FHIR Specification
CodeableConceptPrivate OptionalstudyResearchStudy.studyDesign Element
FHIR Specification
CodeableConceptPrivate OptionalfocusResearchStudy.focus Element
FHIR Specification
CodeableReference
Private OptionalconditionResearchStudy.condition Element
FHIR Specification
CodeableConceptPrivate OptionalkeywordResearchStudy.keyword Element
Private OptionalregionResearchStudy.region Element
Private OptionaldescriptionResearchStudy.descriptionSummary Element
Private OptionaldescriptionResearchStudy.description Element
Private OptionalperiodResearchStudy.period Element
Private OptionalsiteResearchStudy.site Element
Private OptionalnoteResearchStudy.note Element
Private OptionalclassifierResearchStudy.classifier Element
FHIR Specification
CodeableConceptPrivate OptionalassociatedResearchStudy.associatedParty Element
FHIR Specification
BackboneElementPrivate OptionalprogressResearchStudy.progressStatus Element
Private OptionalwhyResearchStudy.whyStopped Element
FHIR Specification
CodeableConceptPrivate OptionalrecruitmentResearchStudy.recruitment Element
Private OptionalcomparisonResearchStudy.comparisonGroup Element
FHIR Specification
BackboneElementPrivate OptionalobjectiveResearchStudy.objective Element
Private OptionaloutcomeResearchStudy.outcomeMeasure Element
FHIR Specification
BackboneElementPrivate OptionalresultResearchStudy.result Element
FHIR Specification
Reference
StaticparseParse the provided ResearchStudy JSON to instantiate the ResearchStudy data model.
JSON representing FHIR ResearchStudy
OptionaloptSourceField: stringOptional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to ResearchStudy
ResearchStudy data model or undefined for ResearchStudy
JsonError if the provided JSON is not a valid JSON object
the url property value as a UriType object if defined; else an empty UriType object
Assigns the provided PrimitiveType value to the url property.
the url value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the url property exists and has a value; false otherwise
the url property value as a fhirUri if defined; else undefined
Assigns the provided primitive value to the url property.
the url value
this
PrimitiveTypeError for invalid primitive types
true if the url property exists and has a value; false otherwise
the identifier property value as a Identifier array
Assigns the provided Identifier array value to the identifier property.
the identifier array value
this
InvalidTypeError for invalid data types
Add the provided Identifier value to the identifier array property.
the identifier value
this
InvalidTypeError for invalid data types
true if the identifier property exists and has a value; false otherwise
the version property value as a StringType object if defined; else an empty StringType object
Assigns the provided PrimitiveType value to the version property.
the version value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the version property exists and has a value; false otherwise
the version property value as a fhirString if defined; else undefined
Assigns the provided primitive value to the version property.
the version value
this
PrimitiveTypeError for invalid primitive types
true if the version property exists and has a value; false otherwise
the name property value as a StringType object if defined; else an empty StringType object
Assigns the provided PrimitiveType value to the name property.
the name value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the name property exists and has a value; false otherwise
the name property value as a fhirString if defined; else undefined
Assigns the provided primitive value to the name property.
the name value
this
PrimitiveTypeError for invalid primitive types
true if the name property exists and has a value; false otherwise
the title property value as a StringType object if defined; else an empty StringType object
Assigns the provided PrimitiveType value to the title property.
the title value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the title property exists and has a value; false otherwise
the title property value as a fhirString if defined; else undefined
Assigns the provided primitive value to the title property.
the title value
this
PrimitiveTypeError for invalid primitive types
true if the title property exists and has a value; false otherwise
the label property value as a ResearchStudyLabelComponent array
Assigns the provided ResearchStudyLabelComponent array value to the label property.
the label array value
this
InvalidTypeError for invalid data types
Add the provided ResearchStudyLabelComponent value to the label array property.
the label value
this
InvalidTypeError for invalid data types
true if the label property exists and has a value; false otherwise
the protocol property value as a Reference array
Assigns the provided Reference array value to the protocol property.
the protocol array value
this
InvalidTypeError for invalid data type or reference value
Add the provided Reference value to the protocol array property.
the protocol value
this
InvalidTypeError for invalid data type or reference value
true if the protocol property exists and has a value; false otherwise
the partOf property value as a Reference array
Assigns the provided Reference array value to the partOf property.
the partOf array value
this
InvalidTypeError for invalid data type or reference value
Add the provided Reference value to the partOf array property.
the partOf value
this
InvalidTypeError for invalid data type or reference value
true if the partOf property exists and has a value; false otherwise
the relatedArtifact property value as a RelatedArtifact array
Assigns the provided RelatedArtifact array value to the relatedArtifact property.
the relatedArtifact array value
this
InvalidTypeError for invalid data types
Add the provided RelatedArtifact value to the relatedArtifact array property.
the relatedArtifact value
this
InvalidTypeError for invalid data types
true if the relatedArtifact property exists and has a value; false otherwise
the date property value as a DateTimeType object if defined; else an empty DateTimeType object
Assigns the provided PrimitiveType value to the date property.
the date value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the date property exists and has a value; false otherwise
the date property value as a fhirDateTime if defined; else undefined
Assigns the provided primitive value to the date property.
the date value
this
PrimitiveTypeError for invalid primitive types
true if the date property exists and has a value; false otherwise
the status property value as a EnumCodeType if defined; else null
CodeSystem Enumeration: PublicationStatusEnum
Assigns the provided EnumCodeType value to the status property.
the status value
this
InvalidCodeError for invalid code value
InvalidTypeError for invalid data types
CodeSystem Enumeration: PublicationStatusEnum
true if the status property exists and has a value; false otherwise
the status property value as a CodeType if defined; else null
CodeSystem Enumeration: PublicationStatusEnum
Assigns the provided PrimitiveType value to the status property.
the status value
this
InvalidCodeError for invalid code value
InvalidTypeError for invalid data types
CodeSystem Enumeration: PublicationStatusEnum
true if the status property exists and has a value; false otherwise
the status property value as a fhirCode if defined; else null
CodeSystem Enumeration: PublicationStatusEnum
Assigns the provided primitive value to the status property.
the status value
this
InvalidCodeError for invalid code value
PrimitiveTypeError for invalid primitive types
CodeSystem Enumeration: PublicationStatusEnum
true if the status property exists and has a value; false otherwise
the primaryPurposeType property value as a CodeableConcept object if defined; else an empty CodeableConcept object
Assigns the provided PrimaryPurposeType object value to the primaryPurposeType property.
the primaryPurposeType object value
this
InvalidTypeError for invalid data types
true if the primaryPurposeType property exists and has a value; false otherwise
the phase property value as a CodeableConcept object if defined; else an empty CodeableConcept object
Assigns the provided Phase object value to the phase property.
the phase object value
this
InvalidTypeError for invalid data types
true if the phase property exists and has a value; false otherwise
the studyDesign property value as a CodeableConcept array
Assigns the provided CodeableConcept array value to the studyDesign property.
the studyDesign array value
this
InvalidTypeError for invalid data types
Add the provided CodeableConcept value to the studyDesign array property.
the studyDesign value
this
InvalidTypeError for invalid data types
true if the studyDesign property exists and has a value; false otherwise
the focus property value as a CodeableReference array
Assigns the provided CodeableReference array value to the focus property.
the focus array value
this
InvalidTypeError for invalid data types
Add the provided CodeableReference value to the focus array property.
the focus value
this
InvalidTypeError for invalid data types
true if the focus property exists and has a value; false otherwise
the condition property value as a CodeableConcept array
Assigns the provided CodeableConcept array value to the condition property.
the condition array value
this
InvalidTypeError for invalid data types
Add the provided CodeableConcept value to the condition array property.
the condition value
this
InvalidTypeError for invalid data types
true if the condition property exists and has a value; false otherwise
the keyword property value as a CodeableConcept array
Assigns the provided CodeableConcept array value to the keyword property.
the keyword array value
this
InvalidTypeError for invalid data types
Add the provided CodeableConcept value to the keyword array property.
the keyword value
this
InvalidTypeError for invalid data types
true if the keyword property exists and has a value; false otherwise
the region property value as a CodeableConcept array
Assigns the provided CodeableConcept array value to the region property.
the region array value
this
InvalidTypeError for invalid data types
Add the provided CodeableConcept value to the region array property.
the region value
this
InvalidTypeError for invalid data types
true if the region property exists and has a value; false otherwise
the descriptionSummary property value as a MarkdownType object if defined; else an empty MarkdownType object
Assigns the provided PrimitiveType value to the descriptionSummary property.
the descriptionSummary value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the descriptionSummary property exists and has a value; false otherwise
the descriptionSummary property value as a fhirMarkdown if defined; else undefined
Assigns the provided primitive value to the descriptionSummary property.
the descriptionSummary value
this
PrimitiveTypeError for invalid primitive types
true if the descriptionSummary property exists and has a value; false otherwise
the description property value as a MarkdownType object if defined; else an empty MarkdownType object
Assigns the provided PrimitiveType value to the description property.
the description value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the description property exists and has a value; false otherwise
the description property value as a fhirMarkdown if defined; else undefined
Assigns the provided primitive value to the description property.
the description value
this
PrimitiveTypeError for invalid primitive types
true if the description property exists and has a value; false otherwise
the period property value as a Period object if defined; else an empty Period object
Assigns the provided Period object value to the period property.
the period object value
this
InvalidTypeError for invalid data types
true if the period property exists and has a value; false otherwise
the site property value as a Reference array
Assigns the provided Reference array value to the site property.
the site array value
this
InvalidTypeError for invalid data type or reference value
Add the provided Reference value to the site array property.
the site value
this
InvalidTypeError for invalid data type or reference value
true if the site property exists and has a value; false otherwise
the note property value as a Annotation array
Assigns the provided Annotation array value to the note property.
the note array value
this
InvalidTypeError for invalid data types
Add the provided Annotation value to the note array property.
the note value
this
InvalidTypeError for invalid data types
true if the note property exists and has a value; false otherwise
the classifier property value as a CodeableConcept array
Assigns the provided CodeableConcept array value to the classifier property.
the classifier array value
this
InvalidTypeError for invalid data types
Add the provided CodeableConcept value to the classifier array property.
the classifier value
this
InvalidTypeError for invalid data types
true if the classifier property exists and has a value; false otherwise
the associatedParty property value as a ResearchStudyAssociatedPartyComponent array
Assigns the provided ResearchStudyAssociatedPartyComponent array value to the associatedParty property.
the associatedParty array value
this
InvalidTypeError for invalid data types
Add the provided ResearchStudyAssociatedPartyComponent value to the associatedParty array property.
the associatedParty value
this
InvalidTypeError for invalid data types
true if the associatedParty property exists and has a value; false otherwise
the progressStatus property value as a ResearchStudyProgressStatusComponent array
Assigns the provided ResearchStudyProgressStatusComponent array value to the progressStatus property.
the progressStatus array value
this
InvalidTypeError for invalid data types
Add the provided ResearchStudyProgressStatusComponent value to the progressStatus array property.
the progressStatus value
this
InvalidTypeError for invalid data types
true if the progressStatus property exists and has a value; false otherwise
the whyStopped property value as a CodeableConcept object if defined; else an empty CodeableConcept object
Assigns the provided WhyStopped object value to the whyStopped property.
the whyStopped object value
this
InvalidTypeError for invalid data types
true if the whyStopped property exists and has a value; false otherwise
the recruitment property value as a ResearchStudyRecruitmentComponent object if defined; else an empty ResearchStudyRecruitmentComponent object
Assigns the provided Recruitment object value to the recruitment property.
the recruitment object value
this
InvalidTypeError for invalid data types
true if the recruitment property exists and has a value; false otherwise
the comparisonGroup property value as a ResearchStudyComparisonGroupComponent array
Assigns the provided ResearchStudyComparisonGroupComponent array value to the comparisonGroup property.
the comparisonGroup array value
this
InvalidTypeError for invalid data types
Add the provided ResearchStudyComparisonGroupComponent value to the comparisonGroup array property.
the comparisonGroup value
this
InvalidTypeError for invalid data types
true if the comparisonGroup property exists and has a value; false otherwise
the objective property value as a ResearchStudyObjectiveComponent array
Assigns the provided ResearchStudyObjectiveComponent array value to the objective property.
the objective array value
this
InvalidTypeError for invalid data types
Add the provided ResearchStudyObjectiveComponent value to the objective array property.
the objective value
this
InvalidTypeError for invalid data types
true if the objective property exists and has a value; false otherwise
the outcomeMeasure property value as a ResearchStudyOutcomeMeasureComponent array
Assigns the provided ResearchStudyOutcomeMeasureComponent array value to the outcomeMeasure property.
the outcomeMeasure array value
this
InvalidTypeError for invalid data types
Add the provided ResearchStudyOutcomeMeasureComponent value to the outcomeMeasure array property.
the outcomeMeasure value
this
InvalidTypeError for invalid data types
true if the outcomeMeasure property exists and has a value; false otherwise
the result property value as a Reference array
Assigns the provided Reference array value to the result property.
the result array value
this
@ReferenceTargets('ResearchStudy.result', ['EvidenceReport','Citation','DiagnosticReport',])
InvalidTypeError for invalid data type or reference value
Add the provided Reference value to the result array property.
the result value
this
@ReferenceTargets('ResearchStudy.result', ['EvidenceReport','Citation','DiagnosticReport',])
InvalidTypeError for invalid data type or reference value
true if the result property exists and has a value; false otherwise
the FHIR type defined in the FHIR standard
true if the instance is empty; false otherwise
true if and only if the data model has required fields (min cardinality > 0)
and at least one of those required fields in the instance is empty; false otherwise
Creates a copy of the current instance.
the a new instance copied from the current instance
the JSON value or undefined if the instance is empty
the text property value as a Narrative
Assigns the provided value to the text property.
the text value
this
true if the text property exists and has a value; false otherwise
the contained property value as a Resource array
Assigns the provided Resource array value to the contained property.
the contained array value
this
Add the provided Resource value to the contained array property.
the contained value
this
true if the contained property exists and has a value; false otherwise
the array of extension values
Assigns the provided array of Extension values to the extension property.
array of Extensions
this
Determines if the extension property exists.
Optionalurl: stringthe url that identifies a specific Extension
true if an Extension has the provided url; false otherwise
If the url is provided, determines if an Extension having
the provided url exists. If the url is not provided, determines
if the extension property exists and has any values.
AssertionError for invalid url
Returns the Extension having the provided url.
the url that identifies a specific Extension
the Extension having the provided url
AssertionError for invalid url
Adds the provided Extension to the extension property array.
the Extension value to add to the extension property array
this
Removes the Extension having the provided url from the extension property array.
the url that identifies a specific Extension to remove
AssertionError for invalid url
the array of modifierExtension values
Assigns the provided array of Extension values to the modifierExtension property.
array of Extensions
this
Determines if the modifierExtension property exists.
Optionalurl: stringthe url that identifies a specific Extension
true if an Extension has the provided url
If the url is provided, determines if an Extension having
the provided url exists. If the url is not provided, determines
if the modifierExtension property exists and has any values.
AssertionError for invalid url
Returns the Extension having the provided url.
the url that identifies a specific Extension
the Extension having the provided url
AssertionError for invalid url
Adds the provided Extension to the modifierExtension property array.
the Extension value to add to the modifierExtension property array
this
Removes the Extension having the provided url from the modifierExtension property array.
the url that identifies a specific Extension to remove
AssertionError for invalid url
the FHIR resource type as defined by the FHIR specification
the id property value as a PrimitiveType
Assigns the provided PrimitiveType value to the id property.
the id value
this
true if the id property exists and has a value; false otherwise
the id property value as a primitive value
Assigns the provided primitive value to the id property.
the id value
this
PrimitiveTypeError for invalid primitive types
true if the id property exists and has a value; false otherwise
the meta property value as a Meta
Assigns the provided value to the meta property.
the meta value
this
true if the meta property exists and has a value; false otherwise
the implicitRules property value as a PrimitiveType
Assigns the provided PrimitiveType value to the implicitRules property.
the implicitRules value
this
true if the implicitRules property exists and has a value; false otherwise
the implicitRules property value as a primitive value
Assigns the provided primitive value to the implicitRules property.
the implicitRules value
this
PrimitiveTypeError for invalid primitive types
true if the system property exists and has a value; false otherwise
the language property value as a PrimitiveType
Assigns the provided PrimitiveType value to the language property.
the language value
this
true if the language property exists and has a value; false otherwise
the language property value as a primitive value
Assigns the provided primitive value to the language property.
the language value
this
PrimitiveTypeError for invalid primitive types
true if the language property exists and has a value; false otherwise
true if the instance is a FHIR resource; false otherwise
true if the instance is a FHIR complex or primitive datatype; false otherwise
true if the instance is a FHIR complex datatype; false otherwise
true if the instance is a FHIR primitive datatype; false otherwise
true if the instance is a FHIR primitive boolean datatype; false otherwise
true if the instance is a FHIR primitive string-based datatype; false otherwise
true if the instance is a FHIR primitive number-based datatype; false otherwise
true if the instance is a FHIR primitive bigint-based datatype; false otherwise
true if the instance is a FHIR primitive datetime-based datatype; false otherwise
ProtectedcopyProtectedCopies the current instance's elements into the provided object.
the copied instance
PrivateinitInitialize the identifier property
PrivateinitInitialize the label property
PrivateinitInitialize the protocol property
PrivateinitInitialize the partOf property
PrivateinitInitialize the relatedArtifact property
PrivateinitInitialize the studyDesign property
PrivateinitInitialize the focus property
PrivateinitInitialize the condition property
PrivateinitInitialize the keyword property
PrivateinitInitialize the region property
PrivateinitInitialize the site property
PrivateinitInitialize the note property
PrivateinitInitialize the classifier property
PrivateinitInitialize the associatedParty property
PrivateinitInitialize the progressStatus property
PrivateinitInitialize the comparisonGroup property
PrivateinitInitialize the objective property
PrivateinitInitialize the outcomeMeasure property
PrivateinitInitialize the result property
ResearchStudy Class
Remarks
A scientific study of nature that sometimes includes processes involved in health and disease. For example, clinical trials are research studies that involve people. These studies may be related to new ways to screen, prevent, diagnose, and treat disease. They may also study certain outcomes and certain groups of people by looking at data collected in the past or future.
FHIR Specification
See
FHIR ResearchStudy