Class 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 MetadataResource
    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 Detail

      • 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.
      • 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.
      • subject

        protected Type 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.
      • comment

        protected List<StringType> comment
        A human-readable string to clarify or explain concepts about the resource.
      • 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.
      • 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.
      • populationTarget

        protected ResearchElementDefinition populationTarget
        The actual object that is the target of the reference (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.
      • exposureTarget

        protected ResearchElementDefinition exposureTarget
        The actual object that is the target of the reference (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.
      • exposureAlternativeTarget

        protected ResearchElementDefinition exposureAlternativeTarget
        The actual object that is the target of the reference (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.
      • outcomeTarget

        protected ResearchElementDefinition outcomeTarget
        The actual object that is the target of the reference (A reference to a ResearchElementDefinition resomece that defines the outcome for the research.)
      • SP_DATE

        public static final String SP_DATE
        Search parameter: date

        Description: 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 date

        Description: The research definition publication date
        Type: date
        Path: ResearchDefinition.date

      • SP_IDENTIFIER

        public static final String SP_IDENTIFIER
        Search parameter: identifier

        Description: 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 identifier

        Description: External identifier for the research definition
        Type: token
        Path: ResearchDefinition.identifier

      • SP_SUCCESSOR

        public static final String SP_SUCCESSOR
        Search parameter: successor

        Description: What resource is being referenced
        Type: reference
        Path: ResearchDefinition.relatedArtifact.resource

        See Also:
        Constant Field Values
      • SUCCESSOR

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SUCCESSOR
        Fluent Client search parameter constant for successor

        Description: What resource is being referenced
        Type: reference
        Path: ResearchDefinition.relatedArtifact.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_CONTEXT_TYPE_VALUE

        public static final String SP_CONTEXT_TYPE_VALUE
        Search parameter: context-type-value

        Description: A use context type and value assigned to the research definition
        Type: composite
        Path:

        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-value

        Description: A use context type and value assigned to the research definition
        Type: composite
        Path:

      • SP_JURISDICTION

        public static final String SP_JURISDICTION
        Search parameter: jurisdiction

        Description: 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 jurisdiction

        Description: Intended jurisdiction for the research definition
        Type: token
        Path: ResearchDefinition.jurisdiction

      • SP_DESCRIPTION

        public static final String SP_DESCRIPTION
        Search parameter: description

        Description: 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 description

        Description: The description of the research definition
        Type: string
        Path: ResearchDefinition.description

      • SP_DERIVED_FROM

        public static final String SP_DERIVED_FROM
        Search parameter: derived-from

        Description: What resource is being referenced
        Type: reference
        Path: ResearchDefinition.relatedArtifact.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-from

        Description: What resource is being referenced
        Type: reference
        Path: ResearchDefinition.relatedArtifact.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_CONTEXT_TYPE

        public static final String SP_CONTEXT_TYPE
        Search parameter: context-type

        Description: 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-type

        Description: A type of use context assigned to the research definition
        Type: token
        Path: ResearchDefinition.useContext.code

      • SP_PREDECESSOR

        public static final String SP_PREDECESSOR
        Search parameter: predecessor

        Description: What resource is being referenced
        Type: reference
        Path: ResearchDefinition.relatedArtifact.resource

        See Also:
        Constant Field Values
      • PREDECESSOR

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PREDECESSOR
        Fluent Client search parameter constant for predecessor

        Description: What resource is being referenced
        Type: reference
        Path: ResearchDefinition.relatedArtifact.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_TITLE

        public static final String SP_TITLE
        Search parameter: title

        Description: 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 title

        Description: The human-friendly name of the research definition
        Type: string
        Path: ResearchDefinition.title

      • SP_COMPOSED_OF

        public static final String SP_COMPOSED_OF
        Search parameter: composed-of

        Description: What resource is being referenced
        Type: reference
        Path: ResearchDefinition.relatedArtifact.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-of

        Description: What resource is being referenced
        Type: reference
        Path: ResearchDefinition.relatedArtifact.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_VERSION

        public static final String SP_VERSION
        Search parameter: version

        Description: 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 version

        Description: The business version of the research definition
        Type: token
        Path: ResearchDefinition.version

      • SP_URL

        public static final String SP_URL
        Search parameter: url

        Description: 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 url

        Description: The uri that identifies the research definition
        Type: uri
        Path: ResearchDefinition.url

      • SP_CONTEXT_QUANTITY

        public static final String SP_CONTEXT_QUANTITY
        Search parameter: context-quantity

        Description: A quantity- or range-valued use context assigned to the research definition
        Type: quantity
        Path: ResearchDefinition.useContext.valueQuantity, ResearchDefinition.useContext.valueRange

        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-quantity

        Description: A quantity- or range-valued use context assigned to the research definition
        Type: quantity
        Path: ResearchDefinition.useContext.valueQuantity, ResearchDefinition.useContext.valueRange

      • SP_EFFECTIVE

        public static final String SP_EFFECTIVE
        Search parameter: effective

        Description: 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 effective

        Description: The time during which the research definition is intended to be in use
        Type: date
        Path: ResearchDefinition.effectivePeriod

      • SP_DEPENDS_ON

        public static final String SP_DEPENDS_ON
        Search parameter: depends-on

        Description: What resource is being referenced
        Type: reference
        Path: ResearchDefinition.relatedArtifact.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-on

        Description: What resource is being referenced
        Type: reference
        Path: ResearchDefinition.relatedArtifact.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_NAME

        public static final String SP_NAME
        Search parameter: name

        Description: 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 name

        Description: Computationally friendly name of the research definition
        Type: string
        Path: ResearchDefinition.name

      • SP_CONTEXT

        public static final String SP_CONTEXT
        Search parameter: context

        Description: A use context assigned to the research definition
        Type: token
        Path: ResearchDefinition.useContext.valueCodeableConcept

        See Also:
        Constant Field Values
      • CONTEXT

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam CONTEXT
        Fluent Client search parameter constant for context

        Description: A use context assigned to the research definition
        Type: token
        Path: ResearchDefinition.useContext.valueCodeableConcept

      • SP_PUBLISHER

        public static final String SP_PUBLISHER
        Search parameter: publisher

        Description: 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 publisher

        Description: Name of the publisher of the research definition
        Type: string
        Path: ResearchDefinition.publisher

      • SP_TOPIC

        public static final String SP_TOPIC
        Search parameter: topic

        Description: 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 topic

        Description: Topics associated with the ResearchDefinition
        Type: token
        Path: ResearchDefinition.topic

      • SP_CONTEXT_TYPE_QUANTITY

        public static final String SP_CONTEXT_TYPE_QUANTITY
        Search parameter: context-type-quantity

        Description: A use context type and quantity- or range-based value assigned to the research definition
        Type: composite
        Path:

        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-quantity

        Description: A use context type and quantity- or range-based value assigned to the research definition
        Type: composite
        Path:

      • SP_STATUS

        public static final String SP_STATUS
        Search parameter: status

        Description: 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 status

        Description: The current status of the research definition
        Type: token
        Path: ResearchDefinition.status