Class ResearchDefinition
- java.lang.Object
-
- org.hl7.fhir.r4b.model.Base
-
- org.hl7.fhir.r4b.model.BaseResource
-
- org.hl7.fhir.r4b.model.Resource
-
- org.hl7.fhir.r4b.model.DomainResource
-
- org.hl7.fhir.r4b.model.ResearchDefinition
-
- All Implemented Interfaces:
ca.uhn.fhir.model.api.IElement,Serializable,org.hl7.fhir.instance.model.api.IAnyResource,org.hl7.fhir.instance.model.api.IBase,org.hl7.fhir.instance.model.api.IBaseHasExtensions,org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions,org.hl7.fhir.instance.model.api.IBaseResource,org.hl7.fhir.instance.model.api.IDomainResource
public class ResearchDefinition extends DomainResource
The ResearchDefinition resource describes the conditional state (population and any exposures being compared within the population) and outcome (if specified) that the knowledge (evidence, assertion, recommendation) is about.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected DateTypeapprovalDateThe date on which the resource content was approved by the publisher.protected List<ContactDetail>authorAn individiual or organization primarily involved in the creation and maintenance of the content.protected List<StringType>commentA human-readable string to clarify or explain concepts about the resource.static ca.uhn.fhir.rest.gclient.ReferenceClientParamCOMPOSED_OFFluent Client search parameter constant for composed-ofprotected List<ContactDetail>contactContact details to assist a user in finding and communicating with the publisher.static ca.uhn.fhir.rest.gclient.TokenClientParamCONTEXTFluent Client search parameter constant for contextstatic ca.uhn.fhir.rest.gclient.QuantityClientParamCONTEXT_QUANTITYFluent Client search parameter constant for context-quantitystatic ca.uhn.fhir.rest.gclient.TokenClientParamCONTEXT_TYPEFluent Client search parameter constant for context-typestatic ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.QuantityClientParam>CONTEXT_TYPE_QUANTITYFluent Client search parameter constant for context-type-quantitystatic ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.TokenClientParam>CONTEXT_TYPE_VALUEFluent Client search parameter constant for context-type-valueprotected MarkdownTypecopyrightA copyright statement relating to the research definition and/or its contents.protected DateTimeTypedateThe date (and optionally time) when the research definition was published.static ca.uhn.fhir.rest.gclient.DateClientParamDATEFluent Client search parameter constant for datestatic ca.uhn.fhir.rest.gclient.ReferenceClientParamDEPENDS_ONFluent Client search parameter constant for depends-onstatic ca.uhn.fhir.rest.gclient.ReferenceClientParamDERIVED_FROMFluent Client search parameter constant for derived-fromprotected MarkdownTypedescriptionA free text natural language description of the research definition from a consumer's perspective.static ca.uhn.fhir.rest.gclient.StringClientParamDESCRIPTIONFluent Client search parameter constant for descriptionprotected List<ContactDetail>editorAn individual or organization primarily responsible for internal coherence of the content.static ca.uhn.fhir.rest.gclient.DateClientParamEFFECTIVEFluent Client search parameter constant for effectiveprotected PeriodeffectivePeriodThe period during which the research definition content was or is planned to be in active use.protected List<ContactDetail>endorserAn individual or organization responsible for officially endorsing the content for use in some setting.protected BooleanTypeexperimentalA Boolean value to indicate that this research definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.protected ReferenceexposureA reference to a ResearchElementDefinition resource that defines the exposure for the research.protected ReferenceexposureAlternativeA reference to a ResearchElementDefinition resource that defines the exposureAlternative for the research.protected List<Identifier>identifierA formal identifier that is used to identify this research definition when it is represented in other formats, or referenced in a specification, model, design or an instance.static ca.uhn.fhir.rest.gclient.TokenClientParamIDENTIFIERFluent Client search parameter constant for identifierstatic ca.uhn.fhir.model.api.IncludeINCLUDE_COMPOSED_OFConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_DEPENDS_ONConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_DERIVED_FROMConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_PREDECESSORConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_SUCCESSORConstant for fluent queries to be used to add include statements.protected List<CodeableConcept>jurisdictionA legal or geographic region in which the research definition is intended to be used.static ca.uhn.fhir.rest.gclient.TokenClientParamJURISDICTIONFluent Client search parameter constant for jurisdictionprotected DateTypelastReviewDateThe date on which the resource content was last reviewed.protected List<CanonicalType>libraryA reference to a Library resource containing the formal logic used by the ResearchDefinition.protected StringTypenameA natural language name identifying the research definition.static ca.uhn.fhir.rest.gclient.StringClientParamNAMEFluent Client search parameter constant for nameprotected ReferenceoutcomeA reference to a ResearchElementDefinition resomece that defines the outcome for the research.protected ReferencepopulationA reference to a ResearchElementDefinition resource that defines the population for the research.static ca.uhn.fhir.rest.gclient.ReferenceClientParamPREDECESSORFluent Client search parameter constant for predecessorprotected StringTypepublisherThe name of the organization or individual that published the research definition.static ca.uhn.fhir.rest.gclient.StringClientParamPUBLISHERFluent Client search parameter constant for publisherprotected MarkdownTypepurposeExplanation of why this research definition is needed and why it has been designed as it has.protected List<RelatedArtifact>relatedArtifactRelated artifacts such as additional documentation, justification, or bibliographic references.protected List<ContactDetail>reviewerAn individual or organization primarily responsible for review of some aspect of the content.protected StringTypeshortTitleThe short title provides an alternate title for use in informal descriptive contexts where the full, formal title is not necessary.static StringSP_COMPOSED_OFSearch parameter: composed-ofstatic StringSP_CONTEXTSearch parameter: contextstatic StringSP_CONTEXT_QUANTITYSearch parameter: context-quantitystatic StringSP_CONTEXT_TYPESearch parameter: context-typestatic StringSP_CONTEXT_TYPE_QUANTITYSearch parameter: context-type-quantitystatic StringSP_CONTEXT_TYPE_VALUESearch parameter: context-type-valuestatic StringSP_DATESearch parameter: datestatic StringSP_DEPENDS_ONSearch parameter: depends-onstatic StringSP_DERIVED_FROMSearch parameter: derived-fromstatic StringSP_DESCRIPTIONSearch parameter: descriptionstatic StringSP_EFFECTIVESearch parameter: effectivestatic StringSP_IDENTIFIERSearch parameter: identifierstatic StringSP_JURISDICTIONSearch parameter: jurisdictionstatic StringSP_NAMESearch parameter: namestatic StringSP_PREDECESSORSearch parameter: predecessorstatic StringSP_PUBLISHERSearch parameter: publisherstatic StringSP_STATUSSearch parameter: statusstatic StringSP_SUCCESSORSearch parameter: successorstatic StringSP_TITLESearch parameter: titlestatic StringSP_TOPICSearch parameter: topicstatic StringSP_URLSearch parameter: urlstatic StringSP_VERSIONSearch parameter: versionprotected Enumeration<Enumerations.PublicationStatus>statusThe status of this research definition.static ca.uhn.fhir.rest.gclient.TokenClientParamSTATUSFluent Client search parameter constant for statusprotected DataTypesubjectThe intended subjects for the ResearchDefinition.protected StringTypesubtitleAn explanatory or alternate title for the ResearchDefinition giving additional information about its content.static ca.uhn.fhir.rest.gclient.ReferenceClientParamSUCCESSORFluent Client search parameter constant for successorprotected StringTypetitleA short, descriptive, user-friendly title for the research definition.static ca.uhn.fhir.rest.gclient.StringClientParamTITLEFluent Client search parameter constant for titleprotected List<CodeableConcept>topicDescriptive topics related to the content of the ResearchDefinition.static ca.uhn.fhir.rest.gclient.TokenClientParamTOPICFluent Client search parameter constant for topicprotected UriTypeurlAn absolute URI that is used to identify this research definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier.static ca.uhn.fhir.rest.gclient.UriClientParamURLFluent Client search parameter constant for urlprotected StringTypeusageA detailed description, from a clinical perspective, of how the ResearchDefinition is used.protected List<UsageContext>useContextThe content was developed with a focus and intent of supporting the contexts that are listed.protected StringTypeversionThe identifier that is used to identify this version of the research definition when it is referenced in a specification, model, design or instance.static ca.uhn.fhir.rest.gclient.TokenClientParamVERSIONFluent Client search parameter constant for version-
Fields inherited from class org.hl7.fhir.r4b.model.DomainResource
contained, extension, modifierExtension, SP_TEXT, text, TEXT
-
Fields inherited from class org.hl7.fhir.r4b.model.Resource
id, implicitRules, language, meta
-
-
Constructor Summary
Constructors Constructor Description ResearchDefinition()ConstructorResearchDefinition(Enumerations.PublicationStatus status, Reference population)Constructor
-
Method Summary
-
Methods inherited from class org.hl7.fhir.r4b.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText
-
Methods inherited from class org.hl7.fhir.r4b.model.Resource
copyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta
-
Methods inherited from class org.hl7.fhir.r4b.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
-
Methods inherited from class org.hl7.fhir.r4b.model.Base
children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyUserData, copyValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getXhtml, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
getId, getIdElement, getLanguageElement, getUserData, setId, setUserData
-
-
-
-
Field Detail
-
url
protected UriType url
An absolute URI that is used to identify this research definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this research definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the research definition is stored on different servers.
-
identifier
protected List<Identifier> identifier
A formal identifier that is used to identify this research definition when it is represented in other formats, or referenced in a specification, model, design or an instance.
-
version
protected StringType version
The identifier that is used to identify this version of the research definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the research definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts.
-
name
protected StringType name
A natural language name identifying the research definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
-
title
protected StringType title
A short, descriptive, user-friendly title for the research definition.
-
shortTitle
protected StringType shortTitle
The short title provides an alternate title for use in informal descriptive contexts where the full, formal title is not necessary.
-
subtitle
protected StringType subtitle
An explanatory or alternate title for the ResearchDefinition giving additional information about its content.
-
status
protected Enumeration<Enumerations.PublicationStatus> status
The status of this research definition. Enables tracking the life-cycle of the content.
-
experimental
protected BooleanType experimental
A Boolean value to indicate that this research definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
-
subject
protected DataType subject
The intended subjects for the ResearchDefinition. If this element is not provided, a Patient subject is assumed, but the subject of the ResearchDefinition can be anything.
-
date
protected DateTimeType date
The date (and optionally time) when the research definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the research definition changes.
-
publisher
protected StringType publisher
The name of the organization or individual that published the research definition.
-
contact
protected List<ContactDetail> contact
Contact details to assist a user in finding and communicating with the publisher.
-
description
protected MarkdownType description
A free text natural language description of the research definition from a consumer's perspective.
-
comment
protected List<StringType> comment
A human-readable string to clarify or explain concepts about the resource.
-
useContext
protected List<UsageContext> useContext
The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate research definition instances.
-
jurisdiction
protected List<CodeableConcept> jurisdiction
A legal or geographic region in which the research definition is intended to be used.
-
purpose
protected MarkdownType purpose
Explanation of why this research definition is needed and why it has been designed as it has.
-
usage
protected StringType usage
A detailed description, from a clinical perspective, of how the ResearchDefinition is used.
-
copyright
protected MarkdownType copyright
A copyright statement relating to the research definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the research definition.
-
approvalDate
protected DateType approvalDate
The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
-
lastReviewDate
protected DateType lastReviewDate
The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
-
effectivePeriod
protected Period effectivePeriod
The period during which the research definition content was or is planned to be in active use.
-
topic
protected List<CodeableConcept> topic
Descriptive topics related to the content of the ResearchDefinition. Topics provide a high-level categorization grouping types of ResearchDefinitions that can be useful for filtering and searching.
-
author
protected List<ContactDetail> author
An individiual or organization primarily involved in the creation and maintenance of the content.
-
editor
protected List<ContactDetail> editor
An individual or organization primarily responsible for internal coherence of the content.
-
reviewer
protected List<ContactDetail> reviewer
An individual or organization primarily responsible for review of some aspect of the content.
-
endorser
protected List<ContactDetail> endorser
An individual or organization responsible for officially endorsing the content for use in some setting.
-
relatedArtifact
protected List<RelatedArtifact> relatedArtifact
Related artifacts such as additional documentation, justification, or bibliographic references.
-
library
protected List<CanonicalType> library
A reference to a Library resource containing the formal logic used by the ResearchDefinition.
-
population
protected Reference population
A reference to a ResearchElementDefinition resource that defines the population for the research.
-
exposure
protected Reference exposure
A reference to a ResearchElementDefinition resource that defines the exposure for the research.
-
exposureAlternative
protected Reference exposureAlternative
A reference to a ResearchElementDefinition resource that defines the exposureAlternative for the research.
-
outcome
protected Reference outcome
A reference to a ResearchElementDefinition resomece that defines the outcome for the research.
-
SP_COMPOSED_OF
public static final String SP_COMPOSED_OF
Search parameter: composed-ofDescription: What resource is being referenced
Type: reference
Path: ResearchDefinition.relatedArtifact.where(type='composed-of').resource
- See Also:
- Constant Field Values
-
COMPOSED_OF
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam COMPOSED_OF
Fluent Client search parameter constant for composed-ofDescription: What resource is being referenced
Type: reference
Path: ResearchDefinition.relatedArtifact.where(type='composed-of').resource
-
INCLUDE_COMPOSED_OF
public static final ca.uhn.fhir.model.api.Include INCLUDE_COMPOSED_OF
Constant for fluent queries to be used to add include statements. Specifies the path value of "ResearchDefinition:composed-of".
-
SP_CONTEXT_QUANTITY
public static final String SP_CONTEXT_QUANTITY
Search parameter: context-quantityDescription: A quantity- or range-valued use context assigned to the research definition
Type: quantity
Path: (ResearchDefinition.useContext.value as Quantity) | (ResearchDefinition.useContext.value as Range)
- See Also:
- Constant Field Values
-
CONTEXT_QUANTITY
public static final ca.uhn.fhir.rest.gclient.QuantityClientParam CONTEXT_QUANTITY
Fluent Client search parameter constant for context-quantityDescription: A quantity- or range-valued use context assigned to the research definition
Type: quantity
Path: (ResearchDefinition.useContext.value as Quantity) | (ResearchDefinition.useContext.value as Range)
-
SP_CONTEXT_TYPE_QUANTITY
public static final String SP_CONTEXT_TYPE_QUANTITY
Search parameter: context-type-quantityDescription: A use context type and quantity- or range-based value assigned to the research definition
Type: composite
Path: ResearchDefinition.useContext
- See Also:
- Constant Field Values
-
CONTEXT_TYPE_QUANTITY
public static final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.QuantityClientParam> CONTEXT_TYPE_QUANTITY
Fluent Client search parameter constant for context-type-quantityDescription: A use context type and quantity- or range-based value assigned to the research definition
Type: composite
Path: ResearchDefinition.useContext
-
SP_CONTEXT_TYPE_VALUE
public static final String SP_CONTEXT_TYPE_VALUE
Search parameter: context-type-valueDescription: A use context type and value assigned to the research definition
Type: composite
Path: ResearchDefinition.useContext
- See Also:
- Constant Field Values
-
CONTEXT_TYPE_VALUE
public static final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.TokenClientParam> CONTEXT_TYPE_VALUE
Fluent Client search parameter constant for context-type-valueDescription: A use context type and value assigned to the research definition
Type: composite
Path: ResearchDefinition.useContext
-
SP_CONTEXT_TYPE
public static final String SP_CONTEXT_TYPE
Search parameter: context-typeDescription: A type of use context assigned to the research definition
Type: token
Path: ResearchDefinition.useContext.code
- See Also:
- Constant Field Values
-
CONTEXT_TYPE
public static final ca.uhn.fhir.rest.gclient.TokenClientParam CONTEXT_TYPE
Fluent Client search parameter constant for context-typeDescription: A type of use context assigned to the research definition
Type: token
Path: ResearchDefinition.useContext.code
-
SP_CONTEXT
public static final String SP_CONTEXT
Search parameter: contextDescription: A use context assigned to the research definition
Type: token
Path: (ResearchDefinition.useContext.value as CodeableConcept)
- See Also:
- Constant Field Values
-
CONTEXT
public static final ca.uhn.fhir.rest.gclient.TokenClientParam CONTEXT
Fluent Client search parameter constant for contextDescription: A use context assigned to the research definition
Type: token
Path: (ResearchDefinition.useContext.value as CodeableConcept)
-
SP_DATE
public static final String SP_DATE
Search parameter: dateDescription: The research definition publication date
Type: date
Path: ResearchDefinition.date
- See Also:
- Constant Field Values
-
DATE
public static final ca.uhn.fhir.rest.gclient.DateClientParam DATE
Fluent Client search parameter constant for dateDescription: The research definition publication date
Type: date
Path: ResearchDefinition.date
-
SP_DEPENDS_ON
public static final String SP_DEPENDS_ON
Search parameter: depends-onDescription: What resource is being referenced
Type: reference
Path: ResearchDefinition.relatedArtifact.where(type='depends-on').resource | ResearchDefinition.library
- See Also:
- Constant Field Values
-
DEPENDS_ON
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam DEPENDS_ON
Fluent Client search parameter constant for depends-onDescription: What resource is being referenced
Type: reference
Path: ResearchDefinition.relatedArtifact.where(type='depends-on').resource | ResearchDefinition.library
-
INCLUDE_DEPENDS_ON
public static final ca.uhn.fhir.model.api.Include INCLUDE_DEPENDS_ON
Constant for fluent queries to be used to add include statements. Specifies the path value of "ResearchDefinition:depends-on".
-
SP_DERIVED_FROM
public static final String SP_DERIVED_FROM
Search parameter: derived-fromDescription: What resource is being referenced
Type: reference
Path: ResearchDefinition.relatedArtifact.where(type='derived-from').resource
- See Also:
- Constant Field Values
-
DERIVED_FROM
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam DERIVED_FROM
Fluent Client search parameter constant for derived-fromDescription: What resource is being referenced
Type: reference
Path: ResearchDefinition.relatedArtifact.where(type='derived-from').resource
-
INCLUDE_DERIVED_FROM
public static final ca.uhn.fhir.model.api.Include INCLUDE_DERIVED_FROM
Constant for fluent queries to be used to add include statements. Specifies the path value of "ResearchDefinition:derived-from".
-
SP_DESCRIPTION
public static final String SP_DESCRIPTION
Search parameter: descriptionDescription: The description of the research definition
Type: string
Path: ResearchDefinition.description
- See Also:
- Constant Field Values
-
DESCRIPTION
public static final ca.uhn.fhir.rest.gclient.StringClientParam DESCRIPTION
Fluent Client search parameter constant for descriptionDescription: The description of the research definition
Type: string
Path: ResearchDefinition.description
-
SP_EFFECTIVE
public static final String SP_EFFECTIVE
Search parameter: effectiveDescription: The time during which the research definition is intended to be in use
Type: date
Path: ResearchDefinition.effectivePeriod
- See Also:
- Constant Field Values
-
EFFECTIVE
public static final ca.uhn.fhir.rest.gclient.DateClientParam EFFECTIVE
Fluent Client search parameter constant for effectiveDescription: The time during which the research definition is intended to be in use
Type: date
Path: ResearchDefinition.effectivePeriod
-
SP_IDENTIFIER
public static final String SP_IDENTIFIER
Search parameter: identifierDescription: External identifier for the research definition
Type: token
Path: ResearchDefinition.identifier
- See Also:
- Constant Field Values
-
IDENTIFIER
public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
Fluent Client search parameter constant for identifierDescription: External identifier for the research definition
Type: token
Path: ResearchDefinition.identifier
-
SP_JURISDICTION
public static final String SP_JURISDICTION
Search parameter: jurisdictionDescription: Intended jurisdiction for the research definition
Type: token
Path: ResearchDefinition.jurisdiction
- See Also:
- Constant Field Values
-
JURISDICTION
public static final ca.uhn.fhir.rest.gclient.TokenClientParam JURISDICTION
Fluent Client search parameter constant for jurisdictionDescription: Intended jurisdiction for the research definition
Type: token
Path: ResearchDefinition.jurisdiction
-
SP_NAME
public static final String SP_NAME
Search parameter: nameDescription: Computationally friendly name of the research definition
Type: string
Path: ResearchDefinition.name
- See Also:
- Constant Field Values
-
NAME
public static final ca.uhn.fhir.rest.gclient.StringClientParam NAME
Fluent Client search parameter constant for nameDescription: Computationally friendly name of the research definition
Type: string
Path: ResearchDefinition.name
-
SP_PREDECESSOR
public static final String SP_PREDECESSOR
Search parameter: predecessorDescription: What resource is being referenced
Type: reference
Path: ResearchDefinition.relatedArtifact.where(type='predecessor').resource
- See Also:
- Constant Field Values
-
PREDECESSOR
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PREDECESSOR
Fluent Client search parameter constant for predecessorDescription: What resource is being referenced
Type: reference
Path: ResearchDefinition.relatedArtifact.where(type='predecessor').resource
-
INCLUDE_PREDECESSOR
public static final ca.uhn.fhir.model.api.Include INCLUDE_PREDECESSOR
Constant for fluent queries to be used to add include statements. Specifies the path value of "ResearchDefinition:predecessor".
-
SP_PUBLISHER
public static final String SP_PUBLISHER
Search parameter: publisherDescription: Name of the publisher of the research definition
Type: string
Path: ResearchDefinition.publisher
- See Also:
- Constant Field Values
-
PUBLISHER
public static final ca.uhn.fhir.rest.gclient.StringClientParam PUBLISHER
Fluent Client search parameter constant for publisherDescription: Name of the publisher of the research definition
Type: string
Path: ResearchDefinition.publisher
-
SP_STATUS
public static final String SP_STATUS
Search parameter: statusDescription: The current status of the research definition
Type: token
Path: ResearchDefinition.status
- See Also:
- Constant Field Values
-
STATUS
public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
Fluent Client search parameter constant for statusDescription: The current status of the research definition
Type: token
Path: ResearchDefinition.status
-
SP_SUCCESSOR
public static final String SP_SUCCESSOR
Search parameter: successorDescription: What resource is being referenced
Type: reference
Path: ResearchDefinition.relatedArtifact.where(type='successor').resource
- See Also:
- Constant Field Values
-
SUCCESSOR
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SUCCESSOR
Fluent Client search parameter constant for successorDescription: What resource is being referenced
Type: reference
Path: ResearchDefinition.relatedArtifact.where(type='successor').resource
-
INCLUDE_SUCCESSOR
public static final ca.uhn.fhir.model.api.Include INCLUDE_SUCCESSOR
Constant for fluent queries to be used to add include statements. Specifies the path value of "ResearchDefinition:successor".
-
SP_TITLE
public static final String SP_TITLE
Search parameter: titleDescription: The human-friendly name of the research definition
Type: string
Path: ResearchDefinition.title
- See Also:
- Constant Field Values
-
TITLE
public static final ca.uhn.fhir.rest.gclient.StringClientParam TITLE
Fluent Client search parameter constant for titleDescription: The human-friendly name of the research definition
Type: string
Path: ResearchDefinition.title
-
SP_TOPIC
public static final String SP_TOPIC
Search parameter: topicDescription: Topics associated with the ResearchDefinition
Type: token
Path: ResearchDefinition.topic
- See Also:
- Constant Field Values
-
TOPIC
public static final ca.uhn.fhir.rest.gclient.TokenClientParam TOPIC
Fluent Client search parameter constant for topicDescription: Topics associated with the ResearchDefinition
Type: token
Path: ResearchDefinition.topic
-
SP_URL
public static final String SP_URL
Search parameter: urlDescription: The uri that identifies the research definition
Type: uri
Path: ResearchDefinition.url
- See Also:
- Constant Field Values
-
URL
public static final ca.uhn.fhir.rest.gclient.UriClientParam URL
Fluent Client search parameter constant for urlDescription: The uri that identifies the research definition
Type: uri
Path: ResearchDefinition.url
-
SP_VERSION
public static final String SP_VERSION
Search parameter: versionDescription: The business version of the research definition
Type: token
Path: ResearchDefinition.version
- See Also:
- Constant Field Values
-
VERSION
public static final ca.uhn.fhir.rest.gclient.TokenClientParam VERSION
Fluent Client search parameter constant for versionDescription: The business version of the research definition
Type: token
Path: ResearchDefinition.version
-
-
Constructor Detail
-
ResearchDefinition
public ResearchDefinition()
Constructor
-
ResearchDefinition
public ResearchDefinition(Enumerations.PublicationStatus status, Reference population)
Constructor
-
-
Method Detail
-
getUrlElement
public UriType getUrlElement()
- Returns:
url(An absolute URI that is used to identify this research definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this research definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the research definition is stored on different servers.). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value
-
hasUrlElement
public boolean hasUrlElement()
-
hasUrl
public boolean hasUrl()
-
setUrlElement
public ResearchDefinition setUrlElement(UriType value)
- Parameters:
value-url(An absolute URI that is used to identify this research definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this research definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the research definition is stored on different servers.). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value
-
getUrl
public String getUrl()
- Returns:
- An absolute URI that is used to identify this research definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this research definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the research definition is stored on different servers.
-
setUrl
public ResearchDefinition setUrl(String value)
- Parameters:
value- An absolute URI that is used to identify this research definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this research definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the research definition is stored on different servers.
-
getIdentifier
public List<Identifier> getIdentifier()
- Returns:
identifier(A formal identifier that is used to identify this research definition when it is represented in other formats, or referenced in a specification, model, design or an instance.)
-
setIdentifier
public ResearchDefinition setIdentifier(List<Identifier> theIdentifier)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasIdentifier
public boolean hasIdentifier()
-
addIdentifier
public Identifier addIdentifier()
-
addIdentifier
public ResearchDefinition addIdentifier(Identifier t)
-
getIdentifierFirstRep
public Identifier getIdentifierFirstRep()
- Returns:
- The first repetition of repeating field
identifier, creating it if it does not already exist {3}
-
getVersionElement
public StringType getVersionElement()
- Returns:
version(The identifier that is used to identify this version of the research definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the research definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value
-
hasVersionElement
public boolean hasVersionElement()
-
hasVersion
public boolean hasVersion()
-
setVersionElement
public ResearchDefinition setVersionElement(StringType value)
- Parameters:
value-version(The identifier that is used to identify this version of the research definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the research definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value
-
getVersion
public String getVersion()
- Returns:
- The identifier that is used to identify this version of the research definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the research definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts.
-
setVersion
public ResearchDefinition setVersion(String value)
- Parameters:
value- The identifier that is used to identify this version of the research definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the research definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts.
-
getNameElement
public StringType getNameElement()
- Returns:
name(A natural language name identifying the research definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value
-
hasNameElement
public boolean hasNameElement()
-
hasName
public boolean hasName()
-
setNameElement
public ResearchDefinition setNameElement(StringType value)
- Parameters:
value-name(A natural language name identifying the research definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value
-
getName
public String getName()
- Returns:
- A natural language name identifying the research definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
-
setName
public ResearchDefinition setName(String value)
- Parameters:
value- A natural language name identifying the research definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
-
getTitleElement
public StringType getTitleElement()
- Returns:
title(A short, descriptive, user-friendly title for the research definition.). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value
-
hasTitleElement
public boolean hasTitleElement()
-
hasTitle
public boolean hasTitle()
-
setTitleElement
public ResearchDefinition setTitleElement(StringType value)
- Parameters:
value-title(A short, descriptive, user-friendly title for the research definition.). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value
-
getTitle
public String getTitle()
- Returns:
- A short, descriptive, user-friendly title for the research definition.
-
setTitle
public ResearchDefinition setTitle(String value)
- Parameters:
value- A short, descriptive, user-friendly title for the research definition.
-
getShortTitleElement
public StringType getShortTitleElement()
- Returns:
shortTitle(The short title provides an alternate title for use in informal descriptive contexts where the full, formal title is not necessary.). This is the underlying object with id, value and extensions. The accessor "getShortTitle" gives direct access to the value
-
hasShortTitleElement
public boolean hasShortTitleElement()
-
hasShortTitle
public boolean hasShortTitle()
-
setShortTitleElement
public ResearchDefinition setShortTitleElement(StringType value)
- Parameters:
value-shortTitle(The short title provides an alternate title for use in informal descriptive contexts where the full, formal title is not necessary.). This is the underlying object with id, value and extensions. The accessor "getShortTitle" gives direct access to the value
-
getShortTitle
public String getShortTitle()
- Returns:
- The short title provides an alternate title for use in informal descriptive contexts where the full, formal title is not necessary.
-
setShortTitle
public ResearchDefinition setShortTitle(String value)
- Parameters:
value- The short title provides an alternate title for use in informal descriptive contexts where the full, formal title is not necessary.
-
getSubtitleElement
public StringType getSubtitleElement()
- Returns:
subtitle(An explanatory or alternate title for the ResearchDefinition giving additional information about its content.). This is the underlying object with id, value and extensions. The accessor "getSubtitle" gives direct access to the value
-
hasSubtitleElement
public boolean hasSubtitleElement()
-
hasSubtitle
public boolean hasSubtitle()
-
setSubtitleElement
public ResearchDefinition setSubtitleElement(StringType value)
- Parameters:
value-subtitle(An explanatory or alternate title for the ResearchDefinition giving additional information about its content.). This is the underlying object with id, value and extensions. The accessor "getSubtitle" gives direct access to the value
-
getSubtitle
public String getSubtitle()
- Returns:
- An explanatory or alternate title for the ResearchDefinition giving additional information about its content.
-
setSubtitle
public ResearchDefinition setSubtitle(String value)
- Parameters:
value- An explanatory or alternate title for the ResearchDefinition giving additional information about its content.
-
getStatusElement
public Enumeration<Enumerations.PublicationStatus> getStatusElement()
- Returns:
status(The status of this research definition. Enables tracking the life-cycle of the content.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
-
hasStatusElement
public boolean hasStatusElement()
-
hasStatus
public boolean hasStatus()
-
setStatusElement
public ResearchDefinition setStatusElement(Enumeration<Enumerations.PublicationStatus> value)
- Parameters:
value-status(The status of this research definition. Enables tracking the life-cycle of the content.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
-
getStatus
public Enumerations.PublicationStatus getStatus()
- Returns:
- The status of this research definition. Enables tracking the life-cycle of the content.
-
setStatus
public ResearchDefinition setStatus(Enumerations.PublicationStatus value)
- Parameters:
value- The status of this research definition. Enables tracking the life-cycle of the content.
-
getExperimentalElement
public BooleanType getExperimentalElement()
- Returns:
experimental(A Boolean value to indicate that this research definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.). This is the underlying object with id, value and extensions. The accessor "getExperimental" gives direct access to the value
-
hasExperimentalElement
public boolean hasExperimentalElement()
-
hasExperimental
public boolean hasExperimental()
-
setExperimentalElement
public ResearchDefinition setExperimentalElement(BooleanType value)
- Parameters:
value-experimental(A Boolean value to indicate that this research definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.). This is the underlying object with id, value and extensions. The accessor "getExperimental" gives direct access to the value
-
getExperimental
public boolean getExperimental()
- Returns:
- A Boolean value to indicate that this research definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
-
setExperimental
public ResearchDefinition setExperimental(boolean value)
- Parameters:
value- A Boolean value to indicate that this research definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
-
getSubject
public DataType getSubject()
- Returns:
subject(The intended subjects for the ResearchDefinition. If this element is not provided, a Patient subject is assumed, but the subject of the ResearchDefinition can be anything.)
-
getSubjectCodeableConcept
public CodeableConcept getSubjectCodeableConcept() throws org.hl7.fhir.exceptions.FHIRException
- Returns:
subject(The intended subjects for the ResearchDefinition. If this element is not provided, a Patient subject is assumed, but the subject of the ResearchDefinition can be anything.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasSubjectCodeableConcept
public boolean hasSubjectCodeableConcept()
-
getSubjectReference
public Reference getSubjectReference() throws org.hl7.fhir.exceptions.FHIRException
- Returns:
subject(The intended subjects for the ResearchDefinition. If this element is not provided, a Patient subject is assumed, but the subject of the ResearchDefinition can be anything.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasSubjectReference
public boolean hasSubjectReference()
-
hasSubject
public boolean hasSubject()
-
setSubject
public ResearchDefinition setSubject(DataType value)
- Parameters:
value-subject(The intended subjects for the ResearchDefinition. If this element is not provided, a Patient subject is assumed, but the subject of the ResearchDefinition can be anything.)
-
getDateElement
public DateTimeType getDateElement()
- Returns:
date(The date (and optionally time) when the research definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the research definition changes.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value
-
hasDateElement
public boolean hasDateElement()
-
hasDate
public boolean hasDate()
-
setDateElement
public ResearchDefinition setDateElement(DateTimeType value)
- Parameters:
value-date(The date (and optionally time) when the research definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the research definition changes.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value
-
getDate
public Date getDate()
- Returns:
- The date (and optionally time) when the research definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the research definition changes.
-
setDate
public ResearchDefinition setDate(Date value)
- Parameters:
value- The date (and optionally time) when the research definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the research definition changes.
-
getPublisherElement
public StringType getPublisherElement()
- Returns:
publisher(The name of the organization or individual that published the research definition.). This is the underlying object with id, value and extensions. The accessor "getPublisher" gives direct access to the value
-
hasPublisherElement
public boolean hasPublisherElement()
-
hasPublisher
public boolean hasPublisher()
-
setPublisherElement
public ResearchDefinition setPublisherElement(StringType value)
- Parameters:
value-publisher(The name of the organization or individual that published the research definition.). This is the underlying object with id, value and extensions. The accessor "getPublisher" gives direct access to the value
-
getPublisher
public String getPublisher()
- Returns:
- The name of the organization or individual that published the research definition.
-
setPublisher
public ResearchDefinition setPublisher(String value)
- Parameters:
value- The name of the organization or individual that published the research definition.
-
getContact
public List<ContactDetail> getContact()
- Returns:
contact(Contact details to assist a user in finding and communicating with the publisher.)
-
setContact
public ResearchDefinition setContact(List<ContactDetail> theContact)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasContact
public boolean hasContact()
-
addContact
public ContactDetail addContact()
-
addContact
public ResearchDefinition addContact(ContactDetail t)
-
getContactFirstRep
public ContactDetail getContactFirstRep()
- Returns:
- The first repetition of repeating field
contact, creating it if it does not already exist {3}
-
getDescriptionElement
public MarkdownType getDescriptionElement()
- Returns:
description(A free text natural language description of the research definition from a consumer's perspective.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
-
hasDescriptionElement
public boolean hasDescriptionElement()
-
hasDescription
public boolean hasDescription()
-
setDescriptionElement
public ResearchDefinition setDescriptionElement(MarkdownType value)
- Parameters:
value-description(A free text natural language description of the research definition from a consumer's perspective.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
-
getDescription
public String getDescription()
- Returns:
- A free text natural language description of the research definition from a consumer's perspective.
-
setDescription
public ResearchDefinition setDescription(String value)
- Parameters:
value- A free text natural language description of the research definition from a consumer's perspective.
-
getComment
public List<StringType> getComment()
- Returns:
comment(A human-readable string to clarify or explain concepts about the resource.)
-
setComment
public ResearchDefinition setComment(List<StringType> theComment)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasComment
public boolean hasComment()
-
addCommentElement
public StringType addCommentElement()
- Returns:
comment(A human-readable string to clarify or explain concepts about the resource.)
-
addComment
public ResearchDefinition addComment(String value)
- Parameters:
value-comment(A human-readable string to clarify or explain concepts about the resource.)
-
hasComment
public boolean hasComment(String value)
- Parameters:
value-comment(A human-readable string to clarify or explain concepts about the resource.)
-
getUseContext
public List<UsageContext> getUseContext()
- Returns:
useContext(The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate research definition instances.)
-
setUseContext
public ResearchDefinition setUseContext(List<UsageContext> theUseContext)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasUseContext
public boolean hasUseContext()
-
addUseContext
public UsageContext addUseContext()
-
addUseContext
public ResearchDefinition addUseContext(UsageContext t)
-
getUseContextFirstRep
public UsageContext getUseContextFirstRep()
- Returns:
- The first repetition of repeating field
useContext, creating it if it does not already exist {3}
-
getJurisdiction
public List<CodeableConcept> getJurisdiction()
- Returns:
jurisdiction(A legal or geographic region in which the research definition is intended to be used.)
-
setJurisdiction
public ResearchDefinition setJurisdiction(List<CodeableConcept> theJurisdiction)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasJurisdiction
public boolean hasJurisdiction()
-
addJurisdiction
public CodeableConcept addJurisdiction()
-
addJurisdiction
public ResearchDefinition addJurisdiction(CodeableConcept t)
-
getJurisdictionFirstRep
public CodeableConcept getJurisdictionFirstRep()
- Returns:
- The first repetition of repeating field
jurisdiction, creating it if it does not already exist {3}
-
getPurposeElement
public MarkdownType getPurposeElement()
- Returns:
purpose(Explanation of why this research definition is needed and why it has been designed as it has.). This is the underlying object with id, value and extensions. The accessor "getPurpose" gives direct access to the value
-
hasPurposeElement
public boolean hasPurposeElement()
-
hasPurpose
public boolean hasPurpose()
-
setPurposeElement
public ResearchDefinition setPurposeElement(MarkdownType value)
- Parameters:
value-purpose(Explanation of why this research definition is needed and why it has been designed as it has.). This is the underlying object with id, value and extensions. The accessor "getPurpose" gives direct access to the value
-
getPurpose
public String getPurpose()
- Returns:
- Explanation of why this research definition is needed and why it has been designed as it has.
-
setPurpose
public ResearchDefinition setPurpose(String value)
- Parameters:
value- Explanation of why this research definition is needed and why it has been designed as it has.
-
getUsageElement
public StringType getUsageElement()
- Returns:
usage(A detailed description, from a clinical perspective, of how the ResearchDefinition is used.). This is the underlying object with id, value and extensions. The accessor "getUsage" gives direct access to the value
-
hasUsageElement
public boolean hasUsageElement()
-
hasUsage
public boolean hasUsage()
-
setUsageElement
public ResearchDefinition setUsageElement(StringType value)
- Parameters:
value-usage(A detailed description, from a clinical perspective, of how the ResearchDefinition is used.). This is the underlying object with id, value and extensions. The accessor "getUsage" gives direct access to the value
-
getUsage
public String getUsage()
- Returns:
- A detailed description, from a clinical perspective, of how the ResearchDefinition is used.
-
setUsage
public ResearchDefinition setUsage(String value)
- Parameters:
value- A detailed description, from a clinical perspective, of how the ResearchDefinition is used.
-
getCopyrightElement
public MarkdownType getCopyrightElement()
- Returns:
copyright(A copyright statement relating to the research definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the research definition.). This is the underlying object with id, value and extensions. The accessor "getCopyright" gives direct access to the value
-
hasCopyrightElement
public boolean hasCopyrightElement()
-
hasCopyright
public boolean hasCopyright()
-
setCopyrightElement
public ResearchDefinition setCopyrightElement(MarkdownType value)
- Parameters:
value-copyright(A copyright statement relating to the research definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the research definition.). This is the underlying object with id, value and extensions. The accessor "getCopyright" gives direct access to the value
-
getCopyright
public String getCopyright()
- Returns:
- A copyright statement relating to the research definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the research definition.
-
setCopyright
public ResearchDefinition setCopyright(String value)
- Parameters:
value- A copyright statement relating to the research definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the research definition.
-
getApprovalDateElement
public DateType getApprovalDateElement()
- Returns:
approvalDate(The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.). This is the underlying object with id, value and extensions. The accessor "getApprovalDate" gives direct access to the value
-
hasApprovalDateElement
public boolean hasApprovalDateElement()
-
hasApprovalDate
public boolean hasApprovalDate()
-
setApprovalDateElement
public ResearchDefinition setApprovalDateElement(DateType value)
- Parameters:
value-approvalDate(The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.). This is the underlying object with id, value and extensions. The accessor "getApprovalDate" gives direct access to the value
-
getApprovalDate
public Date getApprovalDate()
- Returns:
- The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
-
setApprovalDate
public ResearchDefinition setApprovalDate(Date value)
- Parameters:
value- The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
-
getLastReviewDateElement
public DateType getLastReviewDateElement()
- Returns:
lastReviewDate(The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.). This is the underlying object with id, value and extensions. The accessor "getLastReviewDate" gives direct access to the value
-
hasLastReviewDateElement
public boolean hasLastReviewDateElement()
-
hasLastReviewDate
public boolean hasLastReviewDate()
-
setLastReviewDateElement
public ResearchDefinition setLastReviewDateElement(DateType value)
- Parameters:
value-lastReviewDate(The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.). This is the underlying object with id, value and extensions. The accessor "getLastReviewDate" gives direct access to the value
-
getLastReviewDate
public Date getLastReviewDate()
- Returns:
- The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
-
setLastReviewDate
public ResearchDefinition setLastReviewDate(Date value)
- Parameters:
value- The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
-
getEffectivePeriod
public Period getEffectivePeriod()
- Returns:
effectivePeriod(The period during which the research definition content was or is planned to be in active use.)
-
hasEffectivePeriod
public boolean hasEffectivePeriod()
-
setEffectivePeriod
public ResearchDefinition setEffectivePeriod(Period value)
- Parameters:
value-effectivePeriod(The period during which the research definition content was or is planned to be in active use.)
-
getTopic
public List<CodeableConcept> getTopic()
- Returns:
topic(Descriptive topics related to the content of the ResearchDefinition. Topics provide a high-level categorization grouping types of ResearchDefinitions that can be useful for filtering and searching.)
-
setTopic
public ResearchDefinition setTopic(List<CodeableConcept> theTopic)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasTopic
public boolean hasTopic()
-
addTopic
public CodeableConcept addTopic()
-
addTopic
public ResearchDefinition addTopic(CodeableConcept t)
-
getTopicFirstRep
public CodeableConcept getTopicFirstRep()
- Returns:
- The first repetition of repeating field
topic, creating it if it does not already exist {3}
-
getAuthor
public List<ContactDetail> getAuthor()
- Returns:
author(An individiual or organization primarily involved in the creation and maintenance of the content.)
-
setAuthor
public ResearchDefinition setAuthor(List<ContactDetail> theAuthor)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasAuthor
public boolean hasAuthor()
-
addAuthor
public ContactDetail addAuthor()
-
addAuthor
public ResearchDefinition addAuthor(ContactDetail t)
-
getAuthorFirstRep
public ContactDetail getAuthorFirstRep()
- Returns:
- The first repetition of repeating field
author, creating it if it does not already exist {3}
-
getEditor
public List<ContactDetail> getEditor()
- Returns:
editor(An individual or organization primarily responsible for internal coherence of the content.)
-
setEditor
public ResearchDefinition setEditor(List<ContactDetail> theEditor)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasEditor
public boolean hasEditor()
-
addEditor
public ContactDetail addEditor()
-
addEditor
public ResearchDefinition addEditor(ContactDetail t)
-
getEditorFirstRep
public ContactDetail getEditorFirstRep()
- Returns:
- The first repetition of repeating field
editor, creating it if it does not already exist {3}
-
getReviewer
public List<ContactDetail> getReviewer()
- Returns:
reviewer(An individual or organization primarily responsible for review of some aspect of the content.)
-
setReviewer
public ResearchDefinition setReviewer(List<ContactDetail> theReviewer)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasReviewer
public boolean hasReviewer()
-
addReviewer
public ContactDetail addReviewer()
-
addReviewer
public ResearchDefinition addReviewer(ContactDetail t)
-
getReviewerFirstRep
public ContactDetail getReviewerFirstRep()
- Returns:
- The first repetition of repeating field
reviewer, creating it if it does not already exist {3}
-
getEndorser
public List<ContactDetail> getEndorser()
- Returns:
endorser(An individual or organization responsible for officially endorsing the content for use in some setting.)
-
setEndorser
public ResearchDefinition setEndorser(List<ContactDetail> theEndorser)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasEndorser
public boolean hasEndorser()
-
addEndorser
public ContactDetail addEndorser()
-
addEndorser
public ResearchDefinition addEndorser(ContactDetail t)
-
getEndorserFirstRep
public ContactDetail getEndorserFirstRep()
- Returns:
- The first repetition of repeating field
endorser, creating it if it does not already exist {3}
-
getRelatedArtifact
public List<RelatedArtifact> getRelatedArtifact()
- Returns:
relatedArtifact(Related artifacts such as additional documentation, justification, or bibliographic references.)
-
setRelatedArtifact
public ResearchDefinition setRelatedArtifact(List<RelatedArtifact> theRelatedArtifact)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasRelatedArtifact
public boolean hasRelatedArtifact()
-
addRelatedArtifact
public RelatedArtifact addRelatedArtifact()
-
addRelatedArtifact
public ResearchDefinition addRelatedArtifact(RelatedArtifact t)
-
getRelatedArtifactFirstRep
public RelatedArtifact getRelatedArtifactFirstRep()
- Returns:
- The first repetition of repeating field
relatedArtifact, creating it if it does not already exist {3}
-
getLibrary
public List<CanonicalType> getLibrary()
- Returns:
library(A reference to a Library resource containing the formal logic used by the ResearchDefinition.)
-
setLibrary
public ResearchDefinition setLibrary(List<CanonicalType> theLibrary)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasLibrary
public boolean hasLibrary()
-
addLibraryElement
public CanonicalType addLibraryElement()
- Returns:
library(A reference to a Library resource containing the formal logic used by the ResearchDefinition.)
-
addLibrary
public ResearchDefinition addLibrary(String value)
- Parameters:
value-library(A reference to a Library resource containing the formal logic used by the ResearchDefinition.)
-
hasLibrary
public boolean hasLibrary(String value)
- Parameters:
value-library(A reference to a Library resource containing the formal logic used by the ResearchDefinition.)
-
getPopulation
public Reference getPopulation()
- Returns:
population(A reference to a ResearchElementDefinition resource that defines the population for the research.)
-
hasPopulation
public boolean hasPopulation()
-
setPopulation
public ResearchDefinition setPopulation(Reference value)
- Parameters:
value-population(A reference to a ResearchElementDefinition resource that defines the population for the research.)
-
getExposure
public Reference getExposure()
- Returns:
exposure(A reference to a ResearchElementDefinition resource that defines the exposure for the research.)
-
hasExposure
public boolean hasExposure()
-
setExposure
public ResearchDefinition setExposure(Reference value)
- Parameters:
value-exposure(A reference to a ResearchElementDefinition resource that defines the exposure for the research.)
-
getExposureAlternative
public Reference getExposureAlternative()
- Returns:
exposureAlternative(A reference to a ResearchElementDefinition resource that defines the exposureAlternative for the research.)
-
hasExposureAlternative
public boolean hasExposureAlternative()
-
setExposureAlternative
public ResearchDefinition setExposureAlternative(Reference value)
- Parameters:
value-exposureAlternative(A reference to a ResearchElementDefinition resource that defines the exposureAlternative for the research.)
-
getOutcome
public Reference getOutcome()
- Returns:
outcome(A reference to a ResearchElementDefinition resomece that defines the outcome for the research.)
-
hasOutcome
public boolean hasOutcome()
-
setOutcome
public ResearchDefinition setOutcome(Reference value)
- Parameters:
value-outcome(A reference to a ResearchElementDefinition resomece that defines the outcome for the research.)
-
listChildren
protected void listChildren(List<Property> children)
- Overrides:
listChildrenin classDomainResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getNamedPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
makePropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getTypesForPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
addChildin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
public String fhirType()
- Specified by:
fhirTypein interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
fhirTypein classDomainResource
-
copy
public ResearchDefinition copy()
- Specified by:
copyin classDomainResource
-
copyValues
public void copyValues(ResearchDefinition dst)
-
typedCopy
protected ResearchDefinition typedCopy()
-
equalsDeep
public boolean equalsDeep(Base other_)
- Overrides:
equalsDeepin classDomainResource
-
equalsShallow
public boolean equalsShallow(Base other_)
- Overrides:
equalsShallowin classDomainResource
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmptyin interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
isEmptyin classDomainResource
-
getResourceType
public ResourceType getResourceType()
- Specified by:
getResourceTypein classResource
-
-