java.lang.Object
- org.hl7.fhir.dstu3.model.Base
- - org.hl7.fhir.dstu3.model.BaseResource
  - - org.hl7.fhir.dstu3.model.Resource
    - - org.hl7.fhir.dstu3.model.DomainResource
      - org.hl7.fhir.dstu3.model.MetadataResource
        
        org.hl7.fhir.dstu3.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 artifacts such as clinical decision support rules, order sets and protocols.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`PlanDefinition.ActionCardinalityBehavior`
`static class`	`PlanDefinition.ActionCardinalityBehaviorEnumFactory`
`static class`	`PlanDefinition.ActionConditionKind`
`static class`	`PlanDefinition.ActionConditionKindEnumFactory`
`static class`	`PlanDefinition.ActionGroupingBehavior`
`static class`	`PlanDefinition.ActionGroupingBehaviorEnumFactory`
`static class`	`PlanDefinition.ActionParticipantType`
`static class`	`PlanDefinition.ActionParticipantTypeEnumFactory`
`static class`	`PlanDefinition.ActionPrecheckBehavior`
`static class`	`PlanDefinition.ActionPrecheckBehaviorEnumFactory`
`static class`	`PlanDefinition.ActionRelationshipType`
`static class`	`PlanDefinition.ActionRelationshipTypeEnumFactory`
`static class`	`PlanDefinition.ActionRequiredBehavior`
`static class`	`PlanDefinition.ActionRequiredBehaviorEnumFactory`
`static class`	`PlanDefinition.ActionSelectionBehavior`
`static class`	`PlanDefinition.ActionSelectionBehaviorEnumFactory`
`static class`	`PlanDefinition.PlanDefinitionActionComponent`
`static class`	`PlanDefinition.PlanDefinitionActionConditionComponent`
`static class`	`PlanDefinition.PlanDefinitionActionDynamicValueComponent`
`static class`	`PlanDefinition.PlanDefinitionActionParticipantComponent`
`static class`	`PlanDefinition.PlanDefinitionActionRelatedActionComponent`
`static class`	`PlanDefinition.PlanDefinitionGoalComponent`
`static class`	`PlanDefinition.PlanDefinitionGoalTargetComponent`

Field Summary

Fields
Modifier and Type	Field	Description
`protected List<PlanDefinition.PlanDefinitionActionComponent>`	`action`	An action to be taken as part of the plan.
`protected DateType`	`approvalDate`	The date on which the resource content was approved by the publisher.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`COMPOSED_OF`	Fluent Client search parameter constant for composed-of
`protected List<Contributor>`	`contributor`	A contributor to the content of the asset, including authors, editors, reviewers, and endorsers.
`protected MarkdownType`	`copyright`	A copyright statement relating to the plan definition and/or its contents.
`static ca.uhn.fhir.rest.gclient.DateClientParam`	`DATE`	Fluent Client search parameter constant for date
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`DEPENDS_ON`	Fluent Client search parameter constant for depends-on
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`DERIVED_FROM`	Fluent Client search parameter constant for derived-from
`static ca.uhn.fhir.rest.gclient.StringClientParam`	`DESCRIPTION`	Fluent Client search parameter constant for description
`static ca.uhn.fhir.rest.gclient.DateClientParam`	`EFFECTIVE`	Fluent Client search parameter constant for effective
`protected Period`	`effectivePeriod`	The period during which the plan definition content was or is planned to be in active use.
`protected List<PlanDefinition.PlanDefinitionGoalComponent>`	`goal`	Goals that describe what the activities within the plan are intended to achieve.
`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.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`IDENTIFIER`	Fluent Client search parameter constant for identifier
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_COMPOSED_OF`	Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_DEPENDS_ON`	Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_DERIVED_FROM`	Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_PREDECESSOR`	Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_SUCCESSOR`	Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`JURISDICTION`	Fluent Client search parameter constant for jurisdiction
`protected DateType`	`lastReviewDate`	The date on which the resource content was last reviewed.
`protected List<Reference>`	`library`	A reference to a Library resource containing any formal logic used by the plan definition.
`protected List<Library>`	`libraryTarget`	The actual objects that are the target of the reference (A reference to a Library resource containing any formal logic used by the plan definition.)
`static ca.uhn.fhir.rest.gclient.StringClientParam`	`NAME`	Fluent Client search parameter constant for name
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`PREDECESSOR`	Fluent Client search parameter constant for predecessor
`static ca.uhn.fhir.rest.gclient.StringClientParam`	`PUBLISHER`	Fluent Client search parameter constant for publisher
`protected MarkdownType`	`purpose`	Explaination of why this plan definition is needed and why it has been designed as it has.
`protected List<RelatedArtifact>`	`relatedArtifact`	Related artifacts such as additional documentation, justification, or bibliographic references.
`static String`	`SP_COMPOSED_OF`	Search parameter: composed-of
`static String`	`SP_DATE`	Search parameter: date
`static String`	`SP_DEPENDS_ON`	Search parameter: depends-on
`static String`	`SP_DERIVED_FROM`	Search parameter: derived-from
`static String`	`SP_DESCRIPTION`	Search parameter: description
`static String`	`SP_EFFECTIVE`	Search parameter: effective
`static String`	`SP_IDENTIFIER`	Search parameter: identifier
`static String`	`SP_JURISDICTION`	Search parameter: jurisdiction
`static String`	`SP_NAME`	Search parameter: name
`static String`	`SP_PREDECESSOR`	Search parameter: predecessor
`static String`	`SP_PUBLISHER`	Search parameter: publisher
`static String`	`SP_STATUS`	Search parameter: status
`static String`	`SP_SUCCESSOR`	Search parameter: successor
`static String`	`SP_TITLE`	Search parameter: title
`static String`	`SP_TOPIC`	Search parameter: topic
`static String`	`SP_URL`	Search parameter: url
`static String`	`SP_VERSION`	Search parameter: version
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`STATUS`	Fluent Client search parameter constant for status
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`SUCCESSOR`	Fluent Client search parameter constant for successor
`static ca.uhn.fhir.rest.gclient.StringClientParam`	`TITLE`	Fluent Client search parameter constant for title
`protected List<CodeableConcept>`	`topic`	Descriptive topics related to the content of the plan definition.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`TOPIC`	Fluent Client search parameter constant for topic
`protected CodeableConcept`	`type`	The type of asset the plan definition represents, e.g.
`static ca.uhn.fhir.rest.gclient.UriClientParam`	`URL`	Fluent Client search parameter constant for url
`protected StringType`	`usage`	A detailed description of how the asset is used from a clinical perspective.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`VERSION`	Fluent Client search parameter constant for version

Fields inherited from class org.hl7.fhir.dstu3.model.MetadataResource
contact, date, description, experimental, jurisdiction, name, publisher, status, title, url, useContext, version

Fields inherited from class org.hl7.fhir.dstu3.model.DomainResource
contained, extension, modifierExtension, text

Fields inherited from class org.hl7.fhir.dstu3.model.Resource
id, implicitRules, language, meta

Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
RES_ID, SP_RES_ID, SP_RES_LANGUAGE

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors
Constructor Description

PlanDefinition()
Constructor

PlanDefinition(Enumeration<Enumerations.PublicationStatus> status)
Constructor

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`PlanDefinition.PlanDefinitionActionComponent`	`addAction()`
`PlanDefinition`	`addAction(PlanDefinition.PlanDefinitionActionComponent t)`
`Base`	`addChild(String name)`
`ContactDetail`	`addContact()`
`PlanDefinition`	`addContact(ContactDetail t)`
`Contributor`	`addContributor()`
`PlanDefinition`	`addContributor(Contributor t)`
`PlanDefinition.PlanDefinitionGoalComponent`	`addGoal()`
`PlanDefinition`	`addGoal(PlanDefinition.PlanDefinitionGoalComponent t)`
`Identifier`	`addIdentifier()`
`PlanDefinition`	`addIdentifier(Identifier t)`
`CodeableConcept`	`addJurisdiction()`
`PlanDefinition`	`addJurisdiction(CodeableConcept t)`
`Reference`	`addLibrary()`
`PlanDefinition`	`addLibrary(Reference t)`
`Library`	`addLibraryTarget()`	Deprecated. Use Reference#setResource(IBaseResource) instead
`RelatedArtifact`	`addRelatedArtifact()`
`PlanDefinition`	`addRelatedArtifact(RelatedArtifact t)`
`CodeableConcept`	`addTopic()`
`PlanDefinition`	`addTopic(CodeableConcept t)`
`UsageContext`	`addUseContext()`
`PlanDefinition`	`addUseContext(UsageContext t)`
`PlanDefinition`	`copy()`
`boolean`	`equalsDeep(Base other_)`
`boolean`	`equalsShallow(Base other_)`
`String`	`fhirType()`
`List<PlanDefinition.PlanDefinitionActionComponent>`	`getAction()`
`PlanDefinition.PlanDefinitionActionComponent`	`getActionFirstRep()`
`Date`	`getApprovalDate()`
`DateType`	`getApprovalDateElement()`
`List<ContactDetail>`	`getContact()`
`ContactDetail`	`getContactFirstRep()`
`List<Contributor>`	`getContributor()`
`Contributor`	`getContributorFirstRep()`
`String`	`getCopyright()`
`MarkdownType`	`getCopyrightElement()`
`Date`	`getDate()`
`DateTimeType`	`getDateElement()`
`String`	`getDescription()`
`MarkdownType`	`getDescriptionElement()`
`Period`	`getEffectivePeriod()`
`boolean`	`getExperimental()`
`BooleanType`	`getExperimentalElement()`
`List<PlanDefinition.PlanDefinitionGoalComponent>`	`getGoal()`
`PlanDefinition.PlanDefinitionGoalComponent`	`getGoalFirstRep()`
`List<Identifier>`	`getIdentifier()`
`Identifier`	`getIdentifierFirstRep()`
`List<CodeableConcept>`	`getJurisdiction()`
`CodeableConcept`	`getJurisdictionFirstRep()`
`Date`	`getLastReviewDate()`
`DateType`	`getLastReviewDateElement()`
`List<Reference>`	`getLibrary()`
`Reference`	`getLibraryFirstRep()`
`List<Library>`	`getLibraryTarget()`	Deprecated. Use Reference#setResource(IBaseResource) instead
`String`	`getName()`
`Property`	`getNamedProperty(int _hash, String _name, boolean _checkValid)`
`StringType`	`getNameElement()`
`Base[]`	`getProperty(int hash, String name, boolean checkValid)`
`String`	`getPublisher()`
`StringType`	`getPublisherElement()`
`String`	`getPurpose()`
`MarkdownType`	`getPurposeElement()`
`List<RelatedArtifact>`	`getRelatedArtifact()`
`RelatedArtifact`	`getRelatedArtifactFirstRep()`
`ResourceType`	`getResourceType()`
`Enumerations.PublicationStatus`	`getStatus()`
`Enumeration<Enumerations.PublicationStatus>`	`getStatusElement()`
`String`	`getTitle()`
`StringType`	`getTitleElement()`
`List<CodeableConcept>`	`getTopic()`
`CodeableConcept`	`getTopicFirstRep()`
`CodeableConcept`	`getType()`
`String[]`	`getTypesForProperty(int hash, String name)`
`String`	`getUrl()`
`UriType`	`getUrlElement()`
`String`	`getUsage()`
`StringType`	`getUsageElement()`
`List<UsageContext>`	`getUseContext()`
`UsageContext`	`getUseContextFirstRep()`
`String`	`getVersion()`
`StringType`	`getVersionElement()`
`boolean`	`hasAction()`
`boolean`	`hasApprovalDate()`
`boolean`	`hasApprovalDateElement()`
`boolean`	`hasContact()`
`boolean`	`hasContributor()`
`boolean`	`hasCopyright()`
`boolean`	`hasCopyrightElement()`
`boolean`	`hasDate()`
`boolean`	`hasDateElement()`
`boolean`	`hasDescription()`
`boolean`	`hasDescriptionElement()`
`boolean`	`hasEffectivePeriod()`
`boolean`	`hasExperimental()`
`boolean`	`hasExperimentalElement()`
`boolean`	`hasGoal()`
`boolean`	`hasIdentifier()`
`boolean`	`hasJurisdiction()`
`boolean`	`hasLastReviewDate()`
`boolean`	`hasLastReviewDateElement()`
`boolean`	`hasLibrary()`
`boolean`	`hasName()`
`boolean`	`hasNameElement()`
`boolean`	`hasPublisher()`
`boolean`	`hasPublisherElement()`
`boolean`	`hasPurpose()`
`boolean`	`hasPurposeElement()`
`boolean`	`hasRelatedArtifact()`
`boolean`	`hasStatus()`
`boolean`	`hasStatusElement()`
`boolean`	`hasTitle()`
`boolean`	`hasTitleElement()`
`boolean`	`hasTopic()`
`boolean`	`hasType()`
`boolean`	`hasUrl()`
`boolean`	`hasUrlElement()`
`boolean`	`hasUsage()`
`boolean`	`hasUsageElement()`
`boolean`	`hasUseContext()`
`boolean`	`hasVersion()`
`boolean`	`hasVersionElement()`
`boolean`	`isEmpty()`
`protected void`	`listChildren(List<Property> children)`
`Base`	`makeProperty(int hash, String name)`
`PlanDefinition`	`setAction(List<PlanDefinition.PlanDefinitionActionComponent> theAction)`
`PlanDefinition`	`setApprovalDate(Date value)`
`PlanDefinition`	`setApprovalDateElement(DateType value)`
`PlanDefinition`	`setContact(List<ContactDetail> theContact)`
`PlanDefinition`	`setContributor(List<Contributor> theContributor)`
`PlanDefinition`	`setCopyright(String value)`
`PlanDefinition`	`setCopyrightElement(MarkdownType value)`
`PlanDefinition`	`setDate(Date value)`
`PlanDefinition`	`setDateElement(DateTimeType value)`
`PlanDefinition`	`setDescription(String value)`
`PlanDefinition`	`setDescriptionElement(MarkdownType value)`
`PlanDefinition`	`setEffectivePeriod(Period value)`
`PlanDefinition`	`setExperimental(boolean value)`
`PlanDefinition`	`setExperimentalElement(BooleanType value)`
`PlanDefinition`	`setGoal(List<PlanDefinition.PlanDefinitionGoalComponent> theGoal)`
`PlanDefinition`	`setIdentifier(List<Identifier> theIdentifier)`
`PlanDefinition`	`setJurisdiction(List<CodeableConcept> theJurisdiction)`
`PlanDefinition`	`setLastReviewDate(Date value)`
`PlanDefinition`	`setLastReviewDateElement(DateType value)`
`PlanDefinition`	`setLibrary(List<Reference> theLibrary)`
`PlanDefinition`	`setName(String value)`
`PlanDefinition`	`setNameElement(StringType value)`
`Base`	`setProperty(int hash, String name, Base value)`
`Base`	`setProperty(String name, Base value)`
`PlanDefinition`	`setPublisher(String value)`
`PlanDefinition`	`setPublisherElement(StringType value)`
`PlanDefinition`	`setPurpose(String value)`
`PlanDefinition`	`setPurposeElement(MarkdownType value)`
`PlanDefinition`	`setRelatedArtifact(List<RelatedArtifact> theRelatedArtifact)`
`PlanDefinition`	`setStatus(Enumerations.PublicationStatus value)`
`PlanDefinition`	`setStatusElement(Enumeration<Enumerations.PublicationStatus> value)`
`PlanDefinition`	`setTitle(String value)`
`PlanDefinition`	`setTitleElement(StringType value)`
`PlanDefinition`	`setTopic(List<CodeableConcept> theTopic)`
`PlanDefinition`	`setType(CodeableConcept value)`
`PlanDefinition`	`setUrl(String value)`
`PlanDefinition`	`setUrlElement(UriType value)`
`PlanDefinition`	`setUsage(String value)`
`PlanDefinition`	`setUsageElement(StringType value)`
`PlanDefinition`	`setUseContext(List<UsageContext> theUseContext)`
`PlanDefinition`	`setVersion(String value)`
`PlanDefinition`	`setVersionElement(StringType value)`
`protected PlanDefinition`	`typedCopy()`

Methods inherited from class org.hl7.fhir.dstu3.model.MetadataResource
checkCanUseUrl, copyValues, toString

Methods inherited from class org.hl7.fhir.dstu3.model.DomainResource
addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText

Methods inherited from class org.hl7.fhir.dstu3.model.Resource
copyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, 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.dstu3.model.BaseResource
getStructureFhirVersionEnum, isResource, setId

Methods inherited from class org.hl7.fhir.dstu3.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
getId, getIdElement, getLanguageElement, getUserData, setId, setUserData

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
getMeta, getStructureFhirVersionEnum, setId

- 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.
  - type
```
protected CodeableConcept type
```
    The type of asset the plan definition represents, e.g. an order set, protocol, or event-condition-action rule.
  - purpose
```
protected MarkdownType purpose
```
    Explaination 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 asset 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 doesn't 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.
  - contributor
```
protected List<Contributor> contributor
```
    A contributor to the content of the asset, including authors, editors, reviewers, and endorsers.
  - 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.
  - relatedArtifact
```
protected List<RelatedArtifact> relatedArtifact
```
    Related artifacts such as additional documentation, justification, or bibliographic references.
  - library
```
protected List<Reference> library
```
    A reference to a Library resource containing any formal logic used by the plan definition.
  - libraryTarget
```
protected List<Library> libraryTarget
```
    The actual objects that are the target of the reference (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.
  - action
```
protected List<PlanDefinition.PlanDefinitionActionComponent> action
```
    An action to be taken as part of the plan.
  - 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".
  - 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_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_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_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_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_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
- Constructor Detail
  - PlanDefinition
```
public PlanDefinition()
```
    Constructor
  - PlanDefinition
```
public PlanDefinition(Enumeration<Enumerations.PublicationStatus> status)
```
    Constructor
- Method Detail
  - getUrlElement
```
public UriType getUrlElement()
```
    Overrides:
    
    getUrlElement in class MetadataResource
    
    Returns:
    
    MetadataResource.url (An absolute URI that is used to identify this plan definition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this plan definition is (or will be) published. The URL SHOULD include the major version of the plan definition. For more information see [Technical and Business Versions](resource.html#versions).). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value
  - hasUrlElement
```
public boolean hasUrlElement()
```
    Overrides:
    
    hasUrlElement in class MetadataResource
  - hasUrl
```
public boolean hasUrl()
```
    Overrides:
    
    hasUrl in class MetadataResource
  - setUrlElement
```
public PlanDefinition setUrlElement(UriType value)
```
    Overrides:
    
    setUrlElement in class MetadataResource
    
    Parameters:
    
    value - MetadataResource.url (An absolute URI that is used to identify this plan definition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this plan definition is (or will be) published. The URL SHOULD include the major version of the plan definition. For more information see [Technical and Business Versions](resource.html#versions).). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value
  - getUrl
```
public String getUrl()
```
    Overrides:
    
    getUrl in class MetadataResource
    
    Returns:
    
    An absolute URI that is used to identify this plan definition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this plan definition is (or will be) published. The URL SHOULD include the major version of the plan definition. For more information see [Technical and Business Versions](resource.html#versions).
  - setUrl
```
public PlanDefinition setUrl(String value)
```
    Overrides:
    
    setUrl in class MetadataResource
    
    Parameters:
    
    value - An absolute URI that is used to identify this plan definition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this plan definition is (or will be) published. The URL SHOULD include the major version of the plan definition. For more information see [Technical and Business Versions](resource.html#versions).
  - getIdentifier
```
public List<Identifier> getIdentifier()
```
    Returns:
    
    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.)
  - setIdentifier
```
public PlanDefinition setIdentifier(List<Identifier> theIdentifier)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasIdentifier
```
public boolean hasIdentifier()
```
  - addIdentifier
```
public Identifier addIdentifier()
```
  - addIdentifier
```
public PlanDefinition addIdentifier(Identifier t)
```
  - getIdentifierFirstRep
```
public Identifier getIdentifierFirstRep()
```
    Returns:
    
    The first repetition of repeating field identifier, creating it if it does not already exist
  - getVersionElement
```
public StringType getVersionElement()
```
    Overrides:
    
    getVersionElement in class MetadataResource
    
    Returns:
    
    MetadataResource.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.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value
  - hasVersionElement
```
public boolean hasVersionElement()
```
    Overrides:
    
    hasVersionElement in class MetadataResource
  - hasVersion
```
public boolean hasVersion()
```
    Overrides:
    
    hasVersion in class MetadataResource
  - setVersionElement
```
public PlanDefinition setVersionElement(StringType value)
```
    Overrides:
    
    setVersionElement in class MetadataResource
    
    Parameters:
    
    value - MetadataResource.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.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value
  - getVersion
```
public String getVersion()
```
    Overrides:
    
    getVersion in class MetadataResource
    
    Returns:
    
    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.
  - setVersion
```
public PlanDefinition setVersion(String value)
```
    Overrides:
    
    setVersion in class MetadataResource
    
    Parameters:
    
    value - 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.
  - getNameElement
```
public StringType getNameElement()
```
    Overrides:
    
    getNameElement in class MetadataResource
    
    Returns:
    
    MetadataResource.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.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value
  - hasNameElement
```
public boolean hasNameElement()
```
    Overrides:
    
    hasNameElement in class MetadataResource
  - hasName
```
public boolean hasName()
```
    Overrides:
    
    hasName in class MetadataResource
  - setNameElement
```
public PlanDefinition setNameElement(StringType value)
```
    Overrides:
    
    setNameElement in class MetadataResource
    
    Parameters:
    
    value - MetadataResource.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.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value
  - getName
```
public String getName()
```
    Overrides:
    
    getName in class MetadataResource
    
    Returns:
    
    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.
  - setName
```
public PlanDefinition setName(String value)
```
    Overrides:
    
    setName in class MetadataResource
    
    Parameters:
    
    value - 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.
  - getTitleElement
```
public StringType getTitleElement()
```
    Overrides:
    
    getTitleElement in class MetadataResource
    
    Returns:
    
    MetadataResource.title (A short, descriptive, user-friendly title for the plan definition.). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value
  - hasTitleElement
```
public boolean hasTitleElement()
```
    Overrides:
    
    hasTitleElement in class MetadataResource
  - hasTitle
```
public boolean hasTitle()
```
    Overrides:
    
    hasTitle in class MetadataResource
  - setTitleElement
```
public PlanDefinition setTitleElement(StringType value)
```
    Overrides:
    
    setTitleElement in class MetadataResource
    
    Parameters:
    
    value - MetadataResource.title (A short, descriptive, user-friendly title for the plan definition.). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value
  - getTitle
```
public String getTitle()
```
    Overrides:
    
    getTitle in class MetadataResource
    
    Returns:
    
    A short, descriptive, user-friendly title for the plan definition.
  - setTitle
```
public PlanDefinition setTitle(String value)
```
    Overrides:
    
    setTitle in class MetadataResource
    
    Parameters:
    
    value - A short, descriptive, user-friendly title for the plan definition.
  - getType
```
public CodeableConcept getType()
```
    Returns:
    
    type (The type of asset the plan definition represents, e.g. an order set, protocol, or event-condition-action rule.)
  - hasType
```
public boolean hasType()
```
  - setType
```
public PlanDefinition setType(CodeableConcept value)
```
    Parameters:
    
    value - type (The type of asset the plan definition represents, e.g. an order set, protocol, or event-condition-action rule.)
  - getStatusElement
```
public Enumeration<Enumerations.PublicationStatus> getStatusElement()
```
    Overrides:
    
    getStatusElement in class MetadataResource
    
    Returns:
    
    MetadataResource.status (The status of this plan 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()
```
    Overrides:
    
    hasStatusElement in class MetadataResource
  - hasStatus
```
public boolean hasStatus()
```
    Overrides:
    
    hasStatus in class MetadataResource
  - setStatusElement
```
public PlanDefinition setStatusElement(Enumeration<Enumerations.PublicationStatus> value)
```
    Overrides:
    
    setStatusElement in class MetadataResource
    
    Parameters:
    
    value - MetadataResource.status (The status of this plan 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()
```
    Overrides:
    
    getStatus in class MetadataResource
    
    Returns:
    
    The status of this plan definition. Enables tracking the life-cycle of the content.
  - setStatus
```
public PlanDefinition setStatus(Enumerations.PublicationStatus value)
```
    Overrides:
    
    setStatus in class MetadataResource
    
    Parameters:
    
    value - The status of this plan definition. Enables tracking the life-cycle of the content.
  - getExperimentalElement
```
public BooleanType getExperimentalElement()
```
    Overrides:
    
    getExperimentalElement in class MetadataResource
    
    Returns:
    
    MetadataResource.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.). This is the underlying object with id, value and extensions. The accessor "getExperimental" gives direct access to the value
  - hasExperimentalElement
```
public boolean hasExperimentalElement()
```
    Overrides:
    
    hasExperimentalElement in class MetadataResource
  - hasExperimental
```
public boolean hasExperimental()
```
    Overrides:
    
    hasExperimental in class MetadataResource
  - setExperimentalElement
```
public PlanDefinition setExperimentalElement(BooleanType value)
```
    Overrides:
    
    setExperimentalElement in class MetadataResource
    
    Parameters:
    
    value - MetadataResource.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.). This is the underlying object with id, value and extensions. The accessor "getExperimental" gives direct access to the value
  - getExperimental
```
public boolean getExperimental()
```
    Overrides:
    
    getExperimental in class MetadataResource
    
    Returns:
    
    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.
  - setExperimental
```
public PlanDefinition setExperimental(boolean value)
```
    Overrides:
    
    setExperimental in class MetadataResource
    
    Parameters:
    
    value - 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.
  - getDateElement
```
public DateTimeType getDateElement()
```
    Overrides:
    
    getDateElement in class MetadataResource
    
    Returns:
    
    MetadataResource.date (The date (and optionally time) when the plan definition was published. The date must change if and 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.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value
  - hasDateElement
```
public boolean hasDateElement()
```
    Overrides:
    
    hasDateElement in class MetadataResource
  - hasDate
```
public boolean hasDate()
```
    Overrides:
    
    hasDate in class MetadataResource
  - setDateElement
```
public PlanDefinition setDateElement(DateTimeType value)
```
    Overrides:
    
    setDateElement in class MetadataResource
    
    Parameters:
    
    value - MetadataResource.date (The date (and optionally time) when the plan definition was published. The date must change if and 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.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value
  - getDate
```
public Date getDate()
```
    Overrides:
    
    getDate in class MetadataResource
    
    Returns:
    
    The date (and optionally time) when the plan definition was published. The date must change if and 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.
  - setDate
```
public PlanDefinition setDate(Date value)
```
    Overrides:
    
    setDate in class MetadataResource
    
    Parameters:
    
    value - The date (and optionally time) when the plan definition was published. The date must change if and 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.
  - getPublisherElement
```
public StringType getPublisherElement()
```
    Overrides:
    
    getPublisherElement in class MetadataResource
    
    Returns:
    
    MetadataResource.publisher (The name of the individual or organization that published the plan definition.). This is the underlying object with id, value and extensions. The accessor "getPublisher" gives direct access to the value
  - hasPublisherElement
```
public boolean hasPublisherElement()
```
    Overrides:
    
    hasPublisherElement in class MetadataResource
  - hasPublisher
```
public boolean hasPublisher()
```
    Overrides:
    
    hasPublisher in class MetadataResource
  - setPublisherElement
```
public PlanDefinition setPublisherElement(StringType value)
```
    Overrides:
    
    setPublisherElement in class MetadataResource
    
    Parameters:
    
    value - MetadataResource.publisher (The name of the individual or organization that published the plan definition.). This is the underlying object with id, value and extensions. The accessor "getPublisher" gives direct access to the value
  - getPublisher
```
public String getPublisher()
```
    Overrides:
    
    getPublisher in class MetadataResource
    
    Returns:
    
    The name of the individual or organization that published the plan definition.
  - setPublisher
```
public PlanDefinition setPublisher(String value)
```
    Overrides:
    
    setPublisher in class MetadataResource
    
    Parameters:
    
    value - The name of the individual or organization that published the plan definition.
  - getDescriptionElement
```
public MarkdownType getDescriptionElement()
```
    Overrides:
    
    getDescriptionElement in class MetadataResource
    
    Returns:
    
    MetadataResource.description (A free text natural language description of the plan 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()
```
    Overrides:
    
    hasDescriptionElement in class MetadataResource
  - hasDescription
```
public boolean hasDescription()
```
    Overrides:
    
    hasDescription in class MetadataResource
  - setDescriptionElement
```
public PlanDefinition setDescriptionElement(MarkdownType value)
```
    Overrides:
    
    setDescriptionElement in class MetadataResource
    
    Parameters:
    
    value - MetadataResource.description (A free text natural language description of the plan 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()
```
    Overrides:
    
    getDescription in class MetadataResource
    
    Returns:
    
    A free text natural language description of the plan definition from a consumer's perspective.
  - setDescription
```
public PlanDefinition setDescription(String value)
```
    Overrides:
    
    setDescription in class MetadataResource
    
    Parameters:
    
    value - A free text natural language description of the plan definition from a consumer's perspective.
  - getPurposeElement
```
public MarkdownType getPurposeElement()
```
    Returns:
    
    purpose (Explaination of why this plan 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 PlanDefinition setPurposeElement(MarkdownType value)
```
    Parameters:
    
    value - purpose (Explaination of why this plan 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:
    
    Explaination of why this plan definition is needed and why it has been designed as it has.
  - setPurpose
```
public PlanDefinition setPurpose(String value)
```
    Parameters:
    
    value - Explaination of why this plan definition is needed and why it has been designed as it has.
  - getUsageElement
```
public StringType getUsageElement()
```
    Returns:
    
    usage (A detailed description of how the asset is used from a clinical perspective.). 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 PlanDefinition setUsageElement(StringType value)
```
    Parameters:
    
    value - usage (A detailed description of how the asset is used from a clinical perspective.). 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 of how the asset is used from a clinical perspective.
  - setUsage
```
public PlanDefinition setUsage(String value)
```
    Parameters:
    
    value - A detailed description of how the asset is used from a clinical perspective.
  - 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 PlanDefinition 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 PlanDefinition 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 doesn't 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 PlanDefinition setLastReviewDateElement(DateType value)
```
    Parameters:
    
    value - lastReviewDate (The date on which the resource content was last reviewed. Review happens periodically after approval, but doesn't 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 doesn't change the original approval date.
  - setLastReviewDate
```
public PlanDefinition setLastReviewDate(Date value)
```
    Parameters:
    
    value - The date on which the resource content was last reviewed. Review happens periodically after approval, but doesn't change the original approval date.
  - getEffectivePeriod
```
public Period getEffectivePeriod()
```
    Returns:
    
    effectivePeriod (The period during which the plan definition content was or is planned to be in active use.)
  - hasEffectivePeriod
```
public boolean hasEffectivePeriod()
```
  - setEffectivePeriod
```
public PlanDefinition setEffectivePeriod(Period value)
```
    Parameters:
    
    value - effectivePeriod (The period during which the plan definition content was or is planned to be in active use.)
  - getUseContext
```
public List<UsageContext> getUseContext()
```
    Overrides:
    
    getUseContext in class MetadataResource
    
    Returns:
    
    MetadataResource.useContext (The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate plan definition instances.)
  - setUseContext
```
public PlanDefinition setUseContext(List<UsageContext> theUseContext)
```
    Overrides:
    
    setUseContext in class MetadataResource
    
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasUseContext
```
public boolean hasUseContext()
```
    Overrides:
    
    hasUseContext in class MetadataResource
  - addUseContext
```
public UsageContext addUseContext()
```
    Overrides:
    
    addUseContext in class MetadataResource
  - addUseContext
```
public PlanDefinition addUseContext(UsageContext t)
```
    Overrides:
    
    addUseContext in class MetadataResource
  - getUseContextFirstRep
```
public UsageContext getUseContextFirstRep()
```
    Overrides:
    
    getUseContextFirstRep in class MetadataResource
    
    Returns:
    
    The first repetition of repeating field MetadataResource.useContext, creating it if it does not already exist
  - getJurisdiction
```
public List<CodeableConcept> getJurisdiction()
```
    Overrides:
    
    getJurisdiction in class MetadataResource
    
    Returns:
    
    MetadataResource.jurisdiction (A legal or geographic region in which the plan definition is intended to be used.)
  - setJurisdiction
```
public PlanDefinition setJurisdiction(List<CodeableConcept> theJurisdiction)
```
    Overrides:
    
    setJurisdiction in class MetadataResource
    
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasJurisdiction
```
public boolean hasJurisdiction()
```
    Overrides:
    
    hasJurisdiction in class MetadataResource
  - addJurisdiction
```
public CodeableConcept addJurisdiction()
```
    Overrides:
    
    addJurisdiction in class MetadataResource
  - addJurisdiction
```
public PlanDefinition addJurisdiction(CodeableConcept t)
```
    Overrides:
    
    addJurisdiction in class MetadataResource
  - getJurisdictionFirstRep
```
public CodeableConcept getJurisdictionFirstRep()
```
    Overrides:
    
    getJurisdictionFirstRep in class MetadataResource
    
    Returns:
    
    The first repetition of repeating field MetadataResource.jurisdiction, creating it if it does not already exist
  - getTopic
```
public List<CodeableConcept> getTopic()
```
    Returns:
    
    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.)
  - setTopic
```
public PlanDefinition setTopic(List<CodeableConcept> theTopic)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasTopic
```
public boolean hasTopic()
```
  - addTopic
```
public CodeableConcept addTopic()
```
  - addTopic
```
public PlanDefinition addTopic(CodeableConcept t)
```
  - getTopicFirstRep
```
public CodeableConcept getTopicFirstRep()
```
    Returns:
    
    The first repetition of repeating field topic, creating it if it does not already exist
  - getContributor
```
public List<Contributor> getContributor()
```
    Returns:
    
    contributor (A contributor to the content of the asset, including authors, editors, reviewers, and endorsers.)
  - setContributor
```
public PlanDefinition setContributor(List<Contributor> theContributor)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasContributor
```
public boolean hasContributor()
```
  - addContributor
```
public Contributor addContributor()
```
  - addContributor
```
public PlanDefinition addContributor(Contributor t)
```
  - getContributorFirstRep
```
public Contributor getContributorFirstRep()
```
    Returns:
    
    The first repetition of repeating field contributor, creating it if it does not already exist
  - getContact
```
public List<ContactDetail> getContact()
```
    Overrides:
    
    getContact in class MetadataResource
    
    Returns:
    
    MetadataResource.contact (Contact details to assist a user in finding and communicating with the publisher.)
  - setContact
```
public PlanDefinition setContact(List<ContactDetail> theContact)
```
    Overrides:
    
    setContact in class MetadataResource
    
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasContact
```
public boolean hasContact()
```
    Overrides:
    
    hasContact in class MetadataResource
  - addContact
```
public ContactDetail addContact()
```
    Overrides:
    
    addContact in class MetadataResource
  - addContact
```
public PlanDefinition addContact(ContactDetail t)
```
    Overrides:
    
    addContact in class MetadataResource
  - getContactFirstRep
```
public ContactDetail getContactFirstRep()
```
    Overrides:
    
    getContactFirstRep in class MetadataResource
    
    Returns:
    
    The first repetition of repeating field MetadataResource.contact, creating it if it does not already exist
  - getCopyrightElement
```
public MarkdownType getCopyrightElement()
```
    Returns:
    
    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.). 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 PlanDefinition setCopyrightElement(MarkdownType value)
```
    Parameters:
    
    value - 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.). 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 plan definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the plan definition.
  - setCopyright
```
public PlanDefinition setCopyright(String value)
```
    Parameters:
    
    value - 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.
  - getRelatedArtifact
```
public List<RelatedArtifact> getRelatedArtifact()
```
    Returns:
    
    relatedArtifact (Related artifacts such as additional documentation, justification, or bibliographic references.)
  - setRelatedArtifact
```
public PlanDefinition setRelatedArtifact(List<RelatedArtifact> theRelatedArtifact)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasRelatedArtifact
```
public boolean hasRelatedArtifact()
```
  - addRelatedArtifact
```
public RelatedArtifact addRelatedArtifact()
```
  - addRelatedArtifact
```
public PlanDefinition addRelatedArtifact(RelatedArtifact t)
```
  - getRelatedArtifactFirstRep
```
public RelatedArtifact getRelatedArtifactFirstRep()
```
    Returns:
    
    The first repetition of repeating field relatedArtifact, creating it if it does not already exist
  - getLibrary
```
public List<Reference> getLibrary()
```
    Returns:
    
    library (A reference to a Library resource containing any formal logic used by the plan definition.)
  - setLibrary
```
public PlanDefinition setLibrary(List<Reference> theLibrary)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasLibrary
```
public boolean hasLibrary()
```
  - addLibrary
```
public Reference addLibrary()
```
  - addLibrary
```
public PlanDefinition addLibrary(Reference t)
```
  - getLibraryFirstRep
```
public Reference getLibraryFirstRep()
```
    Returns:
    
    The first repetition of repeating field library, creating it if it does not already exist
  - getLibraryTarget
```
@Deprecated
public List<Library> getLibraryTarget()
```
    Deprecated.
    Use Reference#setResource(IBaseResource) instead
  - addLibraryTarget
```
@Deprecated
public Library addLibraryTarget()
```
    Deprecated.
    Use Reference#setResource(IBaseResource) instead
  - getGoal
```
public List<PlanDefinition.PlanDefinitionGoalComponent> getGoal()
```
    Returns:
    
    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.)
  - setGoal
```
public PlanDefinition setGoal(List<PlanDefinition.PlanDefinitionGoalComponent> theGoal)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasGoal
```
public boolean hasGoal()
```
  - addGoal
```
public PlanDefinition.PlanDefinitionGoalComponent addGoal()
```
  - addGoal
```
public PlanDefinition addGoal(PlanDefinition.PlanDefinitionGoalComponent t)
```
  - getGoalFirstRep
```
public PlanDefinition.PlanDefinitionGoalComponent getGoalFirstRep()
```
    Returns:
    
    The first repetition of repeating field goal, creating it if it does not already exist
  - getAction
```
public List<PlanDefinition.PlanDefinitionActionComponent> getAction()
```
    Returns:
    
    action (An action to be taken as part of the plan.)
  - setAction
```
public PlanDefinition setAction(List<PlanDefinition.PlanDefinitionActionComponent> theAction)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasAction
```
public boolean hasAction()
```
  - addAction
```
public PlanDefinition.PlanDefinitionActionComponent addAction()
```
  - addAction
```
public PlanDefinition addAction(PlanDefinition.PlanDefinitionActionComponent t)
```
  - getActionFirstRep
```
public PlanDefinition.PlanDefinitionActionComponent getActionFirstRep()
```
    Returns:
    
    The first repetition of repeating field action, creating it if it does not already exist
  - listChildren
```
protected void listChildren(List<Property> children)
```
    Overrides:
    
    listChildren in class MetadataResource
  - getNamedProperty
```
public Property getNamedProperty(int _hash,
                                 String _name,
                                 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    getNamedProperty in class MetadataResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - getProperty
```
public Base[] getProperty(int hash,
                          String name,
                          boolean checkValid)
                   throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    getProperty in class MetadataResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - setProperty
```
public Base setProperty(int hash,
                        String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    setProperty in class MetadataResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - setProperty
```
public Base setProperty(String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    setProperty in class MetadataResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - makeProperty
```
public Base makeProperty(int hash,
                         String name)
                  throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    makeProperty in class MetadataResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - getTypesForProperty
```
public String[] getTypesForProperty(int hash,
                                    String name)
                             throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    getTypesForProperty in class MetadataResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - addChild
```
public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    addChild in class MetadataResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - fhirType
```
public String fhirType()
```
    Specified by:
    
    fhirType in interface org.hl7.fhir.instance.model.api.IBase
    
    Overrides:
    
    fhirType in class MetadataResource
  - copy
```
public PlanDefinition copy()
```
    Specified by:
    
    copy in class MetadataResource
  - typedCopy
```
protected PlanDefinition typedCopy()
```
  - equalsDeep
```
public boolean equalsDeep(Base other_)
```
    Overrides:
    
    equalsDeep in class MetadataResource
  - equalsShallow
```
public boolean equalsShallow(Base other_)
```
    Overrides:
    
    equalsShallow in class MetadataResource
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface org.hl7.fhir.instance.model.api.IBase
    
    Overrides:
    
    isEmpty in class MetadataResource
  - getResourceType
```
public ResourceType getResourceType()
```
    Specified by:
    
    getResourceType in class Resource

Constructor	Description
`PlanDefinition()`	Constructor
`PlanDefinition(Enumeration<Enumerations.PublicationStatus> status)`	Constructor

Class PlanDefinition

Nested Class Summary

Field Summary

Fields inherited from class org.hl7.fhir.dstu3.model.MetadataResource

Fields inherited from class org.hl7.fhir.dstu3.model.DomainResource

Fields inherited from class org.hl7.fhir.dstu3.model.Resource

Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

Constructor Summary

Method Summary

Methods inherited from class org.hl7.fhir.dstu3.model.MetadataResource

Methods inherited from class org.hl7.fhir.dstu3.model.DomainResource

Methods inherited from class org.hl7.fhir.dstu3.model.Resource

Methods inherited from class org.hl7.fhir.dstu3.model.BaseResource

Methods inherited from class org.hl7.fhir.dstu3.model.Base

Methods inherited from class java.lang.Object

Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

Field Detail

identifier

type

purpose

usage

approvalDate

lastReviewDate

effectivePeriod

topic

contributor

copyright

relatedArtifact

library

libraryTarget

goal

action

SP_DATE

DATE

SP_IDENTIFIER

IDENTIFIER

SP_SUCCESSOR

SUCCESSOR

INCLUDE_SUCCESSOR

SP_JURISDICTION

JURISDICTION

SP_DESCRIPTION

DESCRIPTION

SP_DERIVED_FROM

DERIVED_FROM

INCLUDE_DERIVED_FROM

SP_PREDECESSOR

PREDECESSOR

INCLUDE_PREDECESSOR

SP_TITLE

TITLE

SP_COMPOSED_OF

COMPOSED_OF

INCLUDE_COMPOSED_OF

SP_VERSION

VERSION

SP_URL

URL

SP_EFFECTIVE

EFFECTIVE

SP_DEPENDS_ON

DEPENDS_ON

INCLUDE_DEPENDS_ON

SP_NAME

NAME

SP_PUBLISHER

PUBLISHER

SP_TOPIC

TOPIC

SP_STATUS

STATUS

Constructor Detail

PlanDefinition

PlanDefinition

Method Detail

getUrlElement

hasUrlElement