Class PlanDefinition

  • 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 PlanDefinition
    extends MetadataResource
    This resource allows for the definition of various types of plans as a sharable, consumable, and executable artifact. The resource is general enough to support the description of a broad range of clinical artifacts such as clinical decision support rules, order sets and protocols.
    See Also:
    Serialized Form
    • Field Detail

      • identifier

        protected List<Identifier> identifier
        A formal identifier that is used to identify this plan definition when it is represented in other formats, or referenced in a specification, model, design or an instance.
      • subtitle

        protected StringType subtitle
        An explanatory or alternate title for the plan definition giving additional information about its content.
      • type

        protected CodeableConcept type
        A high-level category for the plan definition that distinguishes the kinds of systems that would be interested in the plan definition.
      • subject

        protected Type subject
        A code or group definition that describes the intended subject of the plan definition.
      • purpose

        protected MarkdownType purpose
        Explanation of why this plan definition is needed and why it has been designed as it has.
      • usage

        protected StringType usage
        A detailed description of how the plan definition is used from a clinical perspective.
      • copyright

        protected MarkdownType copyright
        A copyright statement relating to the plan definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the plan 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 plan definition content was or is planned to be in active use.
      • topic

        protected List<CodeableConcept> topic
        Descriptive topics related to the content of the plan definition. Topics provide a high-level categorization of the definition 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 any formal logic used by the plan definition.
      • goal

        protected List<PlanDefinition.PlanDefinitionGoalComponent> goal
        Goals that describe what the activities within the plan are intended to achieve. For example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, etc.
      • SP_DATE

        public static final String SP_DATE
        Search parameter: date

        Description: The plan definition publication date
        Type: date
        Path: PlanDefinition.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 plan definition publication date
        Type: date
        Path: PlanDefinition.date

      • SP_IDENTIFIER

        public static final String SP_IDENTIFIER
        Search parameter: identifier

        Description: External identifier for the plan definition
        Type: token
        Path: PlanDefinition.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 plan definition
        Type: token
        Path: PlanDefinition.identifier

      • SP_SUCCESSOR

        public static final String SP_SUCCESSOR
        Search parameter: successor

        Description: What resource is being referenced
        Type: reference
        Path: PlanDefinition.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: PlanDefinition.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 "PlanDefinition:successor".
      • 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 plan definition
        Type: composite
        Path:

      • SP_JURISDICTION

        public static final String SP_JURISDICTION
        Search parameter: jurisdiction

        Description: Intended jurisdiction for the plan definition
        Type: token
        Path: PlanDefinition.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 plan definition
        Type: token
        Path: PlanDefinition.jurisdiction

      • SP_DESCRIPTION

        public static final String SP_DESCRIPTION
        Search parameter: description

        Description: The description of the plan definition
        Type: string
        Path: PlanDefinition.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 plan definition
        Type: string
        Path: PlanDefinition.description

      • SP_DERIVED_FROM

        public static final String SP_DERIVED_FROM
        Search parameter: derived-from

        Description: What resource is being referenced
        Type: reference
        Path: PlanDefinition.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: PlanDefinition.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 "PlanDefinition: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 plan definition
        Type: token
        Path: PlanDefinition.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 plan definition
        Type: token
        Path: PlanDefinition.useContext.code

      • SP_PREDECESSOR

        public static final String SP_PREDECESSOR
        Search parameter: predecessor

        Description: What resource is being referenced
        Type: reference
        Path: PlanDefinition.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: PlanDefinition.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 "PlanDefinition:predecessor".
      • SP_TITLE

        public static final String SP_TITLE
        Search parameter: title

        Description: The human-friendly name of the plan definition
        Type: string
        Path: PlanDefinition.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 plan definition
        Type: string
        Path: PlanDefinition.title

      • SP_COMPOSED_OF

        public static final String SP_COMPOSED_OF
        Search parameter: composed-of

        Description: What resource is being referenced
        Type: reference
        Path: PlanDefinition.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: PlanDefinition.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 "PlanDefinition:composed-of".
      • SP_TYPE

        public static final String SP_TYPE
        Search parameter: type

        Description: The type of artifact the plan (e.g. order-set, eca-rule, protocol)
        Type: token
        Path: PlanDefinition.type

        See Also:
        Constant Field Values
      • TYPE

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

        Description: The type of artifact the plan (e.g. order-set, eca-rule, protocol)
        Type: token
        Path: PlanDefinition.type

      • SP_VERSION

        public static final String SP_VERSION
        Search parameter: version

        Description: The business version of the plan definition
        Type: token
        Path: PlanDefinition.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 plan definition
        Type: token
        Path: PlanDefinition.version

      • SP_URL

        public static final String SP_URL
        Search parameter: url

        Description: The uri that identifies the plan definition
        Type: uri
        Path: PlanDefinition.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 plan definition
        Type: uri
        Path: PlanDefinition.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 plan definition
        Type: quantity
        Path: PlanDefinition.useContext.valueQuantity, PlanDefinition.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 plan definition
        Type: quantity
        Path: PlanDefinition.useContext.valueQuantity, PlanDefinition.useContext.valueRange

      • SP_EFFECTIVE

        public static final String SP_EFFECTIVE
        Search parameter: effective

        Description: The time during which the plan definition is intended to be in use
        Type: date
        Path: PlanDefinition.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 plan definition is intended to be in use
        Type: date
        Path: PlanDefinition.effectivePeriod

      • SP_DEPENDS_ON

        public static final String SP_DEPENDS_ON
        Search parameter: depends-on

        Description: What resource is being referenced
        Type: reference
        Path: PlanDefinition.relatedArtifact.resource, PlanDefinition.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: PlanDefinition.relatedArtifact.resource, PlanDefinition.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 "PlanDefinition:depends-on".
      • SP_NAME

        public static final String SP_NAME
        Search parameter: name

        Description: Computationally friendly name of the plan definition
        Type: string
        Path: PlanDefinition.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 plan definition
        Type: string
        Path: PlanDefinition.name

      • SP_CONTEXT

        public static final String SP_CONTEXT
        Search parameter: context

        Description: A use context assigned to the plan definition
        Type: token
        Path: PlanDefinition.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 plan definition
        Type: token
        Path: PlanDefinition.useContext.valueCodeableConcept

      • SP_PUBLISHER

        public static final String SP_PUBLISHER
        Search parameter: publisher

        Description: Name of the publisher of the plan definition
        Type: string
        Path: PlanDefinition.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 plan definition
        Type: string
        Path: PlanDefinition.publisher

      • SP_TOPIC

        public static final String SP_TOPIC
        Search parameter: topic

        Description: Topics associated with the module
        Type: token
        Path: PlanDefinition.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 module
        Type: token
        Path: PlanDefinition.topic

      • SP_DEFINITION

        public static final String SP_DEFINITION
        Search parameter: definition

        Description: Activity or plan definitions used by plan definition
        Type: reference
        Path: PlanDefinition.action.definition[x]

        See Also:
        Constant Field Values
      • DEFINITION

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

        Description: Activity or plan definitions used by plan definition
        Type: reference
        Path: PlanDefinition.action.definition[x]

      • INCLUDE_DEFINITION

        public static final ca.uhn.fhir.model.api.Include INCLUDE_DEFINITION
        Constant for fluent queries to be used to add include statements. Specifies the path value of "PlanDefinition:definition".
      • 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 plan 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 plan definition
        Type: composite
        Path:

      • SP_STATUS

        public static final String SP_STATUS
        Search parameter: status

        Description: The current status of the plan definition
        Type: token
        Path: PlanDefinition.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 plan definition
        Type: token
        Path: PlanDefinition.status