Package org.hl7.fhir.r5.model

Class PlanDefinition

java.lang.Object
org.hl7.fhir.r5.model.Base
org.hl7.fhir.r5.model.BaseResource
org.hl7.fhir.r5.model.Resource
org.hl7.fhir.r5.model.DomainResource
org.hl7.fhir.r5.model.CanonicalResource
org.hl7.fhir.r5.model.MetadataResource
org.hl7.fhir.r5.model.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 and non-clinical artifacts such as clinical decision support rules, order sets, protocols, and drug quality specifications.
See Also:

  • Field Details

    • url

      protected UriType url
      An absolute URI that is used to identify this plan 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 an authoritative instance of this plan definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the plan definition is stored on different servers.

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

    • version

      protected StringType version
      The identifier that is used to identify this version of the plan definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the plan 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 plan 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 plan definition.

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

    • status

      protected Enumeration<Enumerations.PublicationStatus> status
      The status of this plan definition. Enables tracking the life-cycle of the content.

    • experimental

      protected BooleanType experimental
      A Boolean value to indicate that this plan definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.

    • subject

      protected DataType subject
      A code, group definition, or canonical reference that describes or identifies the intended subject of the plan definition. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource.

    • date

      protected DateTimeType date
      The date (and optionally time) when the plan 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 plan definition changes.

    • publisher

      protected StringType publisher
      The name of the organization or individual responsible for the release and ongoing maintenance of the plan 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 plan definition from a consumer's perspective.

    • 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 plan definition instances.

    • jurisdiction

      protected List<CodeableConcept> jurisdiction
      A legal or geographic region in which the plan definition is intended to be used.

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

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

    • 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 any formal logic used by the plan definition.

    • goal

      protected List<PlanDefinition.PlanDefinitionGoalComponent> goal
      A goal describes an expected outcome that 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, meeting the acceptance criteria for a test as specified by a quality specification, etc.

    • actor

      protected List<PlanDefinition.PlanDefinitionActorComponent> actor
      Actors represent the individuals or groups involved in the execution of the defined set of activities.

    • action

      protected List<PlanDefinition.PlanDefinitionActionComponent> action
      An action or group of actions to be taken as part of the plan. For example, in clinical care, an action would be to prescribe a particular indicated medication, or perform a particular test as appropriate. In pharmaceutical quality, an action would be the test that needs to be performed on a drug product as defined in the quality specification.

    • asNeeded

      protected DataType asNeeded
      If a CodeableConcept is present, it indicates the pre-condition for performing the service. For example "pain", "on flare-up", etc.

    • 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.where(type='composed-of').resource

      See Also:

    • 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.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 "PlanDefinition:composed-of".

    • 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.value as Quantity) | (PlanDefinition.useContext.value as Range)

      See Also:

    • 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.value as Quantity) | (PlanDefinition.useContext.value as Range)

    • 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: PlanDefinition.useContext

      See Also:

    • 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: PlanDefinition.useContext

    • 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 plan definition
      Type: composite
      Path: PlanDefinition.useContext

      See Also:

    • 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: PlanDefinition.useContext

    • 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:

    • 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_CONTEXT

      public static final String SP_CONTEXT
      Search parameter: context

      Description: A use context assigned to the plan definition
      Type: token
      Path: (PlanDefinition.useContext.value as CodeableConcept)

      See Also:

    • 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.value as CodeableConcept)

    • SP_DATE

      public static final String SP_DATE
      Search parameter: date

      Description: The plan definition publication date
      Type: date
      Path: PlanDefinition.date

      See Also:

    • 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_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

      See Also:

    • 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

    • 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_DEPENDS_ON

      public static final String SP_DEPENDS_ON
      Search parameter: depends-on

      Description: What resource is being referenced
      Type: reference
      Path: PlanDefinition.relatedArtifact.where(type='depends-on').resource | PlanDefinition.library

      See Also:

    • 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.where(type='depends-on').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_DERIVED_FROM

      public static final String SP_DERIVED_FROM
      Search parameter: derived-from

      Description: What resource is being referenced
      Type: reference
      Path: PlanDefinition.relatedArtifact.where(type='derived-from').resource

      See Also:

    • 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.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 "PlanDefinition:derived-from".

    • 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:

    • 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_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:

    • 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_IDENTIFIER

      public static final String SP_IDENTIFIER
      Search parameter: identifier

      Description: External identifier for the plan definition
      Type: token
      Path: PlanDefinition.identifier

      See Also:

    • 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_JURISDICTION

      public static final String SP_JURISDICTION
      Search parameter: jurisdiction

      Description: Intended jurisdiction for the plan definition
      Type: token
      Path: PlanDefinition.jurisdiction

      See Also:

    • 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_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:

    • 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_PREDECESSOR

      public static final String SP_PREDECESSOR
      Search parameter: predecessor

      Description: What resource is being referenced
      Type: reference
      Path: PlanDefinition.relatedArtifact.where(type='predecessor').resource

      See Also:

    • 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.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 "PlanDefinition:predecessor".

    • 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:

    • 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_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:

    • 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

    • SP_SUCCESSOR

      public static final String SP_SUCCESSOR
      Search parameter: successor

      Description: What resource is being referenced
      Type: reference
      Path: PlanDefinition.relatedArtifact.where(type='successor').resource

      See Also:

    • 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.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 "PlanDefinition:successor".

    • 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:

    • 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_TOPIC

      public static final String SP_TOPIC
      Search parameter: topic

      Description: Topics associated with the module
      Type: token
      Path: PlanDefinition.topic

      See Also:

    • 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_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:

    • 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_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:

    • 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_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:

    • 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

  • Constructor Details

  • Method Details