Package org.hl7.fhir.r4.model

Class PlanDefinition

java.lang.Object

org.hl7.fhir.r4.model.Base

org.hl7.fhir.r4.model.BaseResource

org.hl7.fhir.r4.model.Resource

org.hl7.fhir.r4.model.DomainResource

org.hl7.fhir.r4.model.MetadataResource

org.hl7.fhir.r4.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 enum	PlanDefinition.ActionCardinalityBehavior
static class	PlanDefinition.ActionCardinalityBehaviorEnumFactory
static enum	PlanDefinition.ActionConditionKind
static class	PlanDefinition.ActionConditionKindEnumFactory
static enum	PlanDefinition.ActionGroupingBehavior
static class	PlanDefinition.ActionGroupingBehaviorEnumFactory
static enum	PlanDefinition.ActionParticipantType
static class	PlanDefinition.ActionParticipantTypeEnumFactory
static enum	PlanDefinition.ActionPrecheckBehavior
static class	PlanDefinition.ActionPrecheckBehaviorEnumFactory
static enum	PlanDefinition.ActionRelationshipType
static class	PlanDefinition.ActionRelationshipTypeEnumFactory
static enum	PlanDefinition.ActionRequiredBehavior
static class	PlanDefinition.ActionRequiredBehaviorEnumFactory
static enum	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
static enum	PlanDefinition.RequestPriority
static class	PlanDefinition.RequestPriorityEnumFactory

Field Summary

Fields

Modifier and Type	Field	Description
protected List<PlanDefinition.PlanDefinitionActionComponent>	action	An action or group of actions to be taken as part of the plan.
protected DateType	approvalDate	The date on which the resource content was approved by the publisher.
protected List<ContactDetail>	author	An individiual or organization primarily involved in the creation and maintenance of the content.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	COMPOSED_OF	Fluent Client search parameter constant for composed-of
static final ca.uhn.fhir.rest.gclient.TokenClientParam	CONTEXT	Fluent Client search parameter constant for context
static final ca.uhn.fhir.rest.gclient.QuantityClientParam	CONTEXT_QUANTITY	Fluent Client search parameter constant for context-quantity
static final ca.uhn.fhir.rest.gclient.TokenClientParam	CONTEXT_TYPE	Fluent Client search parameter constant for context-type
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
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
protected MarkdownType	copyright	A copyright statement relating to the plan definition and/or its contents.
static final ca.uhn.fhir.rest.gclient.DateClientParam	DATE	Fluent Client search parameter constant for date
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	DEFINITION	Fluent Client search parameter constant for definition
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	DEPENDS_ON	Fluent Client search parameter constant for depends-on
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	DERIVED_FROM	Fluent Client search parameter constant for derived-from
static final ca.uhn.fhir.rest.gclient.StringClientParam	DESCRIPTION	Fluent Client search parameter constant for description
protected List<ContactDetail>	editor	An individual or organization primarily responsible for internal coherence of the content.
static final 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<ContactDetail>	endorser	An individual or organization responsible for officially endorsing the content for use in some setting.
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 final ca.uhn.fhir.rest.gclient.TokenClientParam	IDENTIFIER	Fluent Client search parameter constant for identifier
static final ca.uhn.fhir.model.api.Include	INCLUDE_COMPOSED_OF	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_DEFINITION	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_DEPENDS_ON	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_DERIVED_FROM	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_PREDECESSOR	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_SUCCESSOR	Constant for fluent queries to be used to add include statements.
static final 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<CanonicalType>	library	A reference to a Library resource containing any formal logic used by the plan definition.
static final ca.uhn.fhir.rest.gclient.StringClientParam	NAME	Fluent Client search parameter constant for name
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	PREDECESSOR	Fluent Client search parameter constant for predecessor
static final ca.uhn.fhir.rest.gclient.StringClientParam	PUBLISHER	Fluent Client search parameter constant for publisher
protected MarkdownType	purpose	Explanation 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.
protected List<ContactDetail>	reviewer	An individual or organization primarily responsible for review of some aspect of the content.
static final String	SP_COMPOSED_OF	Search parameter: composed-of
static final String	SP_CONTEXT	Search parameter: context
static final String	SP_CONTEXT_QUANTITY	Search parameter: context-quantity
static final String	SP_CONTEXT_TYPE	Search parameter: context-type
static final String	SP_CONTEXT_TYPE_QUANTITY	Search parameter: context-type-quantity
static final String	SP_CONTEXT_TYPE_VALUE	Search parameter: context-type-value
static final String	SP_DATE	Search parameter: date
static final String	SP_DEFINITION	Search parameter: definition
static final String	SP_DEPENDS_ON	Search parameter: depends-on
static final String	SP_DERIVED_FROM	Search parameter: derived-from
static final String	SP_DESCRIPTION	Search parameter: description
static final String	SP_EFFECTIVE	Search parameter: effective
static final String	SP_IDENTIFIER	Search parameter: identifier
static final String	SP_JURISDICTION	Search parameter: jurisdiction
static final String	SP_NAME	Search parameter: name
static final String	SP_PREDECESSOR	Search parameter: predecessor
static final String	SP_PUBLISHER	Search parameter: publisher
static final String	SP_STATUS	Search parameter: status
static final String	SP_SUCCESSOR	Search parameter: successor
static final String	SP_TITLE	Search parameter: title
static final String	SP_TOPIC	Search parameter: topic
static final String	SP_TYPE	Search parameter: type
static final String	SP_URL	Search parameter: url
static final String	SP_VERSION	Search parameter: version
static final ca.uhn.fhir.rest.gclient.TokenClientParam	STATUS	Fluent Client search parameter constant for status
protected Type	subject	A code or group definition that describes the intended subject of the plan definition.
protected StringType	subtitle	An explanatory or alternate title for the plan definition giving additional information about its content.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	SUCCESSOR	Fluent Client search parameter constant for successor
static final 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 final ca.uhn.fhir.rest.gclient.TokenClientParam	TOPIC	Fluent Client search parameter constant for topic
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.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	TYPE	Fluent Client search parameter constant for type
static final ca.uhn.fhir.rest.gclient.UriClientParam	URL	Fluent Client search parameter constant for url
protected StringType	usage	A detailed description of how the plan definition is used from a clinical perspective.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	VERSION	Fluent Client search parameter constant for version

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

contact, date, description, experimental, jurisdiction, name, publisher, status, title, url, useContext, version

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

contained, extension, modifierExtension, text

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

id, implicitRules, language, meta

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

RES_ID, SP_RES_ID

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

Modifier and Type	Method	Description
PlanDefinition.PlanDefinitionActionComponent	addAction()
PlanDefinition	addAction(PlanDefinition.PlanDefinitionActionComponent t)
ContactDetail	addAuthor()
PlanDefinition	addAuthor(ContactDetail t)
Base	addChild(String name)
ContactDetail	addContact()
PlanDefinition	addContact(ContactDetail t)
ContactDetail	addEditor()
PlanDefinition	addEditor(ContactDetail t)
ContactDetail	addEndorser()
PlanDefinition	addEndorser(ContactDetail t)
PlanDefinition.PlanDefinitionGoalComponent	addGoal()
PlanDefinition	addGoal(PlanDefinition.PlanDefinitionGoalComponent t)
Identifier	addIdentifier()
PlanDefinition	addIdentifier(Identifier t)
CodeableConcept	addJurisdiction()
PlanDefinition	addJurisdiction(CodeableConcept t)
PlanDefinition	addLibrary(String value)
CanonicalType	addLibraryElement()
RelatedArtifact	addRelatedArtifact()
PlanDefinition	addRelatedArtifact(RelatedArtifact t)
ContactDetail	addReviewer()
PlanDefinition	addReviewer(ContactDetail t)
CodeableConcept	addTopic()
PlanDefinition	addTopic(CodeableConcept t)
UsageContext	addUseContext()
PlanDefinition	addUseContext(UsageContext t)
PlanDefinition	copy()
void	copyValues(PlanDefinition dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
List<PlanDefinition.PlanDefinitionActionComponent>	getAction()
PlanDefinition.PlanDefinitionActionComponent	getActionFirstRep()
Date	getApprovalDate()
DateType	getApprovalDateElement()
List<ContactDetail>	getAuthor()
ContactDetail	getAuthorFirstRep()
List<ContactDetail>	getContact()
ContactDetail	getContactFirstRep()
String	getCopyright()
MarkdownType	getCopyrightElement()
Date	getDate()
DateTimeType	getDateElement()
String	getDescription()
MarkdownType	getDescriptionElement()
List<ContactDetail>	getEditor()
ContactDetail	getEditorFirstRep()
Period	getEffectivePeriod()
List<ContactDetail>	getEndorser()
ContactDetail	getEndorserFirstRep()
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<CanonicalType>	getLibrary()
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()
List<ContactDetail>	getReviewer()
ContactDetail	getReviewerFirstRep()
Enumerations.PublicationStatus	getStatus()
Enumeration<Enumerations.PublicationStatus>	getStatusElement()
Type	getSubject()
CodeableConcept	getSubjectCodeableConcept()
Reference	getSubjectReference()
String	getSubtitle()
StringType	getSubtitleElement()
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	hasAuthor()
boolean	hasContact()
boolean	hasCopyright()
boolean	hasCopyrightElement()
boolean	hasDate()
boolean	hasDateElement()
boolean	hasDescription()
boolean	hasDescriptionElement()
boolean	hasEditor()
boolean	hasEffectivePeriod()
boolean	hasEndorser()
boolean	hasExperimental()
boolean	hasExperimentalElement()
boolean	hasGoal()
boolean	hasIdentifier()
boolean	hasJurisdiction()
boolean	hasLastReviewDate()
boolean	hasLastReviewDateElement()
boolean	hasLibrary()
boolean	hasLibrary(String value)
boolean	hasName()
boolean	hasNameElement()
boolean	hasPublisher()
boolean	hasPublisherElement()
boolean	hasPurpose()
boolean	hasPurposeElement()
boolean	hasRelatedArtifact()
boolean	hasReviewer()
boolean	hasStatus()
boolean	hasStatusElement()
boolean	hasSubject()
boolean	hasSubjectCodeableConcept()
boolean	hasSubjectReference()
boolean	hasSubtitle()
boolean	hasSubtitleElement()
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	setAuthor(List<ContactDetail> theAuthor)
PlanDefinition	setContact(List<ContactDetail> theContact)
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	setEditor(List<ContactDetail> theEditor)
PlanDefinition	setEffectivePeriod(Period value)
PlanDefinition	setEndorser(List<ContactDetail> theEndorser)
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<CanonicalType> 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	setReviewer(List<ContactDetail> theReviewer)
PlanDefinition	setStatus(Enumerations.PublicationStatus value)
PlanDefinition	setStatusElement(Enumeration<Enumerations.PublicationStatus> value)
PlanDefinition	setSubject(Type value)
PlanDefinition	setSubtitle(String value)
PlanDefinition	setSubtitleElement(StringType 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.r4.model.MetadataResource

copyValues, present, toString

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

addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText

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

copyValues, getId, getIdBase, getIdElement, getIdPart, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta

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

getStructureFhirVersionEnum, isResource, setId

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

castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExpression, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPopulation, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getXhtml, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, 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, isDeleted, setId

Field Details

identifier

protected List<Identifier> identifier

A formal identifier that is used to identify this plan definition when it is represented in other formats, or referenced in a specification, model, design or an instance.

subtitle

protected StringType subtitle

An explanatory or alternate title for the plan definition giving additional information about its content.

type

protected CodeableConcept type

A high-level category for the plan definition that distinguishes the kinds of systems that would be interested in the plan definition.

subject

protected Type subject

A code or group definition that describes the intended subject of the plan definition.

purpose

protected MarkdownType purpose

Explanation of why this plan definition is needed and why it has been designed as it has.

usage

protected StringType usage

A detailed description of how the plan definition is used from a clinical perspective.

copyright

protected MarkdownType copyright

A copyright statement relating to the plan definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the plan definition.

approvalDate

protected DateType approvalDate

The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.

lastReviewDate

protected DateType lastReviewDate

The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.

effectivePeriod

protected Period effectivePeriod

The period during which the plan definition content was or is planned to be in active use.

topic

protected List<CodeableConcept> topic

Descriptive topics related to the content of the plan definition. Topics provide a high-level categorization of the definition that can be useful for filtering and searching.

author

protected List<ContactDetail> author

An individiual or organization primarily involved in the creation and maintenance of the content.

editor

protected List<ContactDetail> editor

An individual or organization primarily responsible for internal coherence of the content.

reviewer

protected List<ContactDetail> reviewer

An individual or organization primarily responsible for review of some aspect of the content.

endorser

protected List<ContactDetail> endorser

An individual or organization responsible for officially endorsing the content for use in some setting.

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

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 or group of actions 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_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:

See Also:

• Constant Field Values

CONTEXT_TYPE_VALUE

public static final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.TokenClientParam> CONTEXT_TYPE_VALUE

Fluent Client search parameter constant for context-type-value

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

SP_JURISDICTION

public static final String SP_JURISDICTION

Search parameter: jurisdiction

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

See Also:

• Constant Field Values

JURISDICTION

public static final ca.uhn.fhir.rest.gclient.TokenClientParam JURISDICTION

Fluent Client search parameter constant for jurisdiction

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

SP_DESCRIPTION

public static final String SP_DESCRIPTION

Search parameter: description

Description: The description of the plan definition
Type: string
Path: PlanDefinition.description

See Also:

• Constant Field Values

DESCRIPTION

public static final ca.uhn.fhir.rest.gclient.StringClientParam DESCRIPTION

Fluent Client search parameter constant for description

Description: The description of the plan definition
Type: string
Path: PlanDefinition.description

SP_DERIVED_FROM

public static final String SP_DERIVED_FROM

Search parameter: derived-from

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

See Also:

• Constant Field Values

DERIVED_FROM

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam DERIVED_FROM

Fluent Client search parameter constant for derived-from

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

INCLUDE_DERIVED_FROM

public static final ca.uhn.fhir.model.api.Include INCLUDE_DERIVED_FROM

Constant for fluent queries to be used to add include statements. Specifies the path value of "PlanDefinition:derived-from".

SP_CONTEXT_TYPE

public static final String SP_CONTEXT_TYPE

Search parameter: context-type

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

See Also:

• Constant Field Values

CONTEXT_TYPE

public static final ca.uhn.fhir.rest.gclient.TokenClientParam CONTEXT_TYPE

Fluent Client search parameter constant for context-type

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

SP_PREDECESSOR

public static final String SP_PREDECESSOR

Search parameter: predecessor

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

See Also:

• Constant Field Values

PREDECESSOR

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PREDECESSOR

Fluent Client search parameter constant for predecessor

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

INCLUDE_PREDECESSOR

public static final ca.uhn.fhir.model.api.Include INCLUDE_PREDECESSOR

Constant for fluent queries to be used to add include statements. Specifies the path value of "PlanDefinition:predecessor".

SP_TITLE

public static final String SP_TITLE

Search parameter: title

Description: The human-friendly name of the plan definition
Type: string
Path: PlanDefinition.title

See Also:

• Constant Field Values

TITLE

public static final ca.uhn.fhir.rest.gclient.StringClientParam TITLE

Fluent Client search parameter constant for title

Description: The human-friendly name of the plan definition
Type: string
Path: PlanDefinition.title

SP_COMPOSED_OF

public static final String SP_COMPOSED_OF

Search parameter: composed-of

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

See Also:

• Constant Field Values

COMPOSED_OF

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam COMPOSED_OF

Fluent Client search parameter constant for composed-of

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

INCLUDE_COMPOSED_OF

public static final ca.uhn.fhir.model.api.Include INCLUDE_COMPOSED_OF

Constant for fluent queries to be used to add include statements. Specifies the path value of "PlanDefinition:composed-of".

SP_TYPE

public static final String SP_TYPE

Search parameter: type

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

See Also:

• Constant Field Values

TYPE

public static final ca.uhn.fhir.rest.gclient.TokenClientParam TYPE

Fluent Client search parameter constant for type

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

SP_VERSION

public static final String SP_VERSION

Search parameter: version

Description: The business version of the plan definition
Type: token
Path: PlanDefinition.version

See Also:

• Constant Field Values

VERSION

public static final ca.uhn.fhir.rest.gclient.TokenClientParam VERSION

Fluent Client search parameter constant for version

Description: The business version of the plan definition
Type: token
Path: PlanDefinition.version

SP_URL

public static final String SP_URL

Search parameter: url

Description: The uri that identifies the plan definition
Type: uri
Path: PlanDefinition.url

See Also:

• Constant Field Values

URL

public static final ca.uhn.fhir.rest.gclient.UriClientParam URL

Fluent Client search parameter constant for url

Description: The uri that identifies the plan definition
Type: uri
Path: PlanDefinition.url

SP_CONTEXT_QUANTITY

public static final String SP_CONTEXT_QUANTITY

Search parameter: context-quantity

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

See Also:

• Constant Field Values

CONTEXT_QUANTITY

public static final ca.uhn.fhir.rest.gclient.QuantityClientParam CONTEXT_QUANTITY

Fluent Client search parameter constant for context-quantity

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

SP_EFFECTIVE

public static final String SP_EFFECTIVE

Search parameter: effective

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

See Also:

• Constant Field Values

EFFECTIVE

public static final ca.uhn.fhir.rest.gclient.DateClientParam EFFECTIVE

Fluent Client search parameter constant for effective

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

SP_DEPENDS_ON

public static final String SP_DEPENDS_ON

Search parameter: depends-on

Description: What resource is being referenced
Type: reference
Path: PlanDefinition.relatedArtifact.resource, PlanDefinition.library

See Also:

• Constant Field Values

DEPENDS_ON

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam DEPENDS_ON

Fluent Client search parameter constant for depends-on

Description: What resource is being referenced
Type: reference
Path: PlanDefinition.relatedArtifact.resource, PlanDefinition.library

INCLUDE_DEPENDS_ON

public static final ca.uhn.fhir.model.api.Include INCLUDE_DEPENDS_ON

Constant for fluent queries to be used to add include statements. Specifies the path value of "PlanDefinition:depends-on".

SP_NAME

public static final String SP_NAME

Search parameter: name

Description: Computationally friendly name of the plan definition
Type: string
Path: PlanDefinition.name

See Also:

• Constant Field Values

NAME

public static final ca.uhn.fhir.rest.gclient.StringClientParam NAME

Fluent Client search parameter constant for name

Description: Computationally friendly name of the plan definition
Type: string
Path: PlanDefinition.name

SP_CONTEXT

public static final String SP_CONTEXT

Search parameter: context

Description: A use context assigned to the plan definition
Type: token
Path: PlanDefinition.useContext.valueCodeableConcept

See Also:

• Constant Field Values

CONTEXT

public static final ca.uhn.fhir.rest.gclient.TokenClientParam CONTEXT

Fluent Client search parameter constant for context

Description: A use context assigned to the plan definition
Type: token
Path: PlanDefinition.useContext.valueCodeableConcept

SP_PUBLISHER

public static final String SP_PUBLISHER

Search parameter: publisher

Description: Name of the publisher of the plan definition
Type: string
Path: PlanDefinition.publisher

See Also:

• Constant Field Values

PUBLISHER

public static final ca.uhn.fhir.rest.gclient.StringClientParam PUBLISHER

Fluent Client search parameter constant for publisher

Description: Name of the publisher of the plan definition
Type: string
Path: PlanDefinition.publisher

SP_TOPIC

public static final String SP_TOPIC

Search parameter: topic

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

See Also:

• Constant Field Values

TOPIC

public static final ca.uhn.fhir.rest.gclient.TokenClientParam TOPIC

Fluent Client search parameter constant for topic

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

SP_DEFINITION

public static final String SP_DEFINITION

Search parameter: definition

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

See Also:

• Constant Field Values

DEFINITION

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam DEFINITION

Fluent Client search parameter constant for definition

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

INCLUDE_DEFINITION

public static final ca.uhn.fhir.model.api.Include INCLUDE_DEFINITION

Constant for fluent queries to be used to add include statements. Specifies the path value of "PlanDefinition:definition".

SP_CONTEXT_TYPE_QUANTITY

public static final String SP_CONTEXT_TYPE_QUANTITY

Search parameter: context-type-quantity

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

See Also:

• Constant Field Values

CONTEXT_TYPE_QUANTITY

public static final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.QuantityClientParam> CONTEXT_TYPE_QUANTITY

Fluent Client search parameter constant for context-type-quantity

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

SP_STATUS

public static final String SP_STATUS

Search parameter: status

Description: The current status of the plan definition
Type: token
Path: PlanDefinition.status

See Also:

• Constant Field Values

STATUS

public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS

Fluent Client search parameter constant for status

Description: The current status of the plan definition
Type: token
Path: PlanDefinition.status

Constructor Details

PlanDefinition

public PlanDefinition()

Constructor

PlanDefinition

public PlanDefinition(Enumeration<Enumerations.PublicationStatus> status)

Constructor

Method Details

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; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this 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.). 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; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this 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.). 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; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this 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.

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; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this 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.

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.

getSubtitleElement

public StringType getSubtitleElement()

Returns:

subtitle (An explanatory or alternate title for the plan definition giving additional information about its content.). This is the underlying object with id, value and extensions. The accessor "getSubtitle" gives direct access to the value

hasSubtitleElement

public boolean hasSubtitleElement()

hasSubtitle

public boolean hasSubtitle()

setSubtitleElement

public PlanDefinition setSubtitleElement(StringType value)

Parameters:

value - subtitle (An explanatory or alternate title for the plan definition giving additional information about its content.). This is the underlying object with id, value and extensions. The accessor "getSubtitle" gives direct access to the value

getSubtitle

public String getSubtitle()

Returns:

An explanatory or alternate title for the plan definition giving additional information about its content.

setSubtitle

public PlanDefinition setSubtitle(String value)

Parameters:

value - An explanatory or alternate title for the plan definition giving additional information about its content.

getType

public CodeableConcept getType()

Returns:

type (A high-level category for the plan definition that distinguishes the kinds of systems that would be interested in the plan definition.)

hasType

public boolean hasType()

setType

public PlanDefinition setType(CodeableConcept value)

Parameters:

value - type (A high-level category for the plan definition that distinguishes the kinds of systems that would be interested in the plan definition.)

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.

getSubject

public Type getSubject()

Returns:

subject (A code or group definition that describes the intended subject of the plan definition.)

getSubjectCodeableConcept

public CodeableConcept getSubjectCodeableConcept()
                                          throws org.hl7.fhir.exceptions.FHIRException

Returns:

subject (A code or group definition that describes the intended subject of the plan definition.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasSubjectCodeableConcept

public boolean hasSubjectCodeableConcept()

getSubjectReference

public Reference getSubjectReference()
                              throws org.hl7.fhir.exceptions.FHIRException

Returns:

subject (A code or group definition that describes the intended subject of the plan definition.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasSubjectReference

public boolean hasSubjectReference()

hasSubject

public boolean hasSubject()

setSubject

public PlanDefinition setSubject(Type value)

Parameters:

value - subject (A code or group definition that describes the intended subject of the plan definition.)

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 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 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 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 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 organization or individual 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 organization or individual 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 organization or individual that published the plan definition.

setPublisher

public PlanDefinition setPublisher(String value)

Overrides:

setPublisher in class MetadataResource

Parameters:

value - The name of the organization or individual that published the plan definition.

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

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.

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

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

getPurposeElement

public MarkdownType getPurposeElement()

Returns:

purpose (Explanation 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 (Explanation 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:

Explanation of why this plan definition is needed and why it has been designed as it has.

setPurpose

public PlanDefinition setPurpose(String value)

Parameters:

value - Explanation 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 plan definition 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 plan definition 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 plan definition is used from a clinical perspective.

setUsage

public PlanDefinition setUsage(String value)

Parameters:

value - A detailed description of how the plan definition is used from a clinical perspective.

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.

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 does not change the original approval date.). This is the underlying object with id, value and extensions. The accessor "getLastReviewDate" gives direct access to the value

hasLastReviewDateElement

public boolean hasLastReviewDateElement()

hasLastReviewDate

public boolean hasLastReviewDate()

setLastReviewDateElement

public PlanDefinition setLastReviewDateElement(DateType value)

Parameters:

value - lastReviewDate (The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.). This is the underlying object with id, value and extensions. The accessor "getLastReviewDate" gives direct access to the value

getLastReviewDate

public Date getLastReviewDate()

Returns:

The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.

setLastReviewDate

public PlanDefinition setLastReviewDate(Date value)

Parameters:

value - The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.

getEffectivePeriod

public Period getEffectivePeriod()

Returns:

effectivePeriod (The period during which the 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.)

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

getAuthor

public List<ContactDetail> getAuthor()

Returns:

author (An individiual or organization primarily involved in the creation and maintenance of the content.)

setAuthor

public PlanDefinition setAuthor(List<ContactDetail> theAuthor)

Returns:

Returns a reference to this for easy method chaining

hasAuthor

public boolean hasAuthor()

addAuthor

public ContactDetail addAuthor()

addAuthor

public PlanDefinition addAuthor(ContactDetail t)

getAuthorFirstRep

public ContactDetail getAuthorFirstRep()

Returns:

The first repetition of repeating field author, creating it if it does not already exist

getEditor

public List<ContactDetail> getEditor()

Returns:

editor (An individual or organization primarily responsible for internal coherence of the content.)

setEditor

public PlanDefinition setEditor(List<ContactDetail> theEditor)

Returns:

Returns a reference to this for easy method chaining

hasEditor

public boolean hasEditor()

addEditor

public ContactDetail addEditor()

addEditor

public PlanDefinition addEditor(ContactDetail t)

getEditorFirstRep

public ContactDetail getEditorFirstRep()

Returns:

The first repetition of repeating field editor, creating it if it does not already exist

getReviewer

public List<ContactDetail> getReviewer()

Returns:

reviewer (An individual or organization primarily responsible for review of some aspect of the content.)

setReviewer

public PlanDefinition setReviewer(List<ContactDetail> theReviewer)

Returns:

Returns a reference to this for easy method chaining

hasReviewer

public boolean hasReviewer()

addReviewer

public ContactDetail addReviewer()

addReviewer

public PlanDefinition addReviewer(ContactDetail t)

getReviewerFirstRep

public ContactDetail getReviewerFirstRep()

Returns:

The first repetition of repeating field reviewer, creating it if it does not already exist

getEndorser

public List<ContactDetail> getEndorser()

Returns:

endorser (An individual or organization responsible for officially endorsing the content for use in some setting.)

setEndorser

public PlanDefinition setEndorser(List<ContactDetail> theEndorser)

Returns:

Returns a reference to this for easy method chaining

hasEndorser

public boolean hasEndorser()

addEndorser

public ContactDetail addEndorser()

addEndorser

public PlanDefinition addEndorser(ContactDetail t)

getEndorserFirstRep

public ContactDetail getEndorserFirstRep()

Returns:

The first repetition of repeating field endorser, creating it if it does not already exist

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<CanonicalType> getLibrary()

Returns:

library (A reference to a Library resource containing any formal logic used by the plan definition.)

setLibrary

public PlanDefinition setLibrary(List<CanonicalType> theLibrary)

Returns:

Returns a reference to this for easy method chaining

hasLibrary

public boolean hasLibrary()

addLibraryElement

public CanonicalType addLibraryElement()

Returns:

library (A reference to a Library resource containing any formal logic used by the plan definition.)

addLibrary

public PlanDefinition addLibrary(String value)

Parameters:

value - library (A reference to a Library resource containing any formal logic used by the plan definition.)

hasLibrary

public boolean hasLibrary(String value)

Parameters:

value - library (A reference to a Library resource containing any formal logic used by the plan definition.)

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 or group of actions 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 DomainResource

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

copyValues

public void copyValues(PlanDefinition dst)

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