
Class PlanDefinition
- All Implemented Interfaces:
ca.uhn.fhir.model.api.IElement
,Serializable
,org.hl7.fhir.instance.model.api.IAnyResource
,org.hl7.fhir.instance.model.api.IBase
,org.hl7.fhir.instance.model.api.IBaseHasExtensions
,org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions
,org.hl7.fhir.instance.model.api.IBaseResource
,org.hl7.fhir.instance.model.api.IDomainResource
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
static class
static class
static class
static class
static class
static class
static class
static class
static class
static class
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected List<PlanDefinition.PlanDefinitionActionComponent>
An action or group of actions to be taken as part of the plan.protected List<PlanDefinition.PlanDefinitionActorComponent>
Actors represent the individuals or groups involved in the execution of the defined set of activities.protected DateType
The date on which the resource content was approved by the publisher.protected List<ContactDetail>
An individiual or organization primarily involved in the creation and maintenance of the content.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for composed-ofprotected List<ContactDetail>
Contact details to assist a user in finding and communicating with the publisher.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for contextstatic final ca.uhn.fhir.rest.gclient.QuantityClientParam
Fluent Client search parameter constant for context-quantitystatic final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for context-typestatic final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,
ca.uhn.fhir.rest.gclient.QuantityClientParam> Fluent Client search parameter constant for context-type-quantitystatic final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,
ca.uhn.fhir.rest.gclient.TokenClientParam> Fluent Client search parameter constant for context-type-valueprotected MarkdownType
A copyright statement relating to the plan definition and/or its contents.protected DateTimeType
The date (and optionally time) when the plan definition was published.static final ca.uhn.fhir.rest.gclient.DateClientParam
Fluent Client search parameter constant for datestatic final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for definitionstatic final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for depends-onstatic final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for derived-fromprotected MarkdownType
A free text natural language description of the plan definition from a consumer's perspective.static final ca.uhn.fhir.rest.gclient.StringClientParam
Fluent Client search parameter constant for descriptionprotected List<ContactDetail>
An individual or organization primarily responsible for internal coherence of the content.static final ca.uhn.fhir.rest.gclient.DateClientParam
Fluent Client search parameter constant for effectiveprotected Period
The period during which the plan definition content was or is planned to be in active use.protected List<ContactDetail>
An individual or organization responsible for officially endorsing the content for use in some setting.protected BooleanType
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.protected List<PlanDefinition.PlanDefinitionGoalComponent>
A goal describes an expected outcome that activities within the plan are intended to achieve.protected List<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
Fluent Client search parameter constant for identifierstatic final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.protected List<CodeableConcept>
A legal or geographic region in which the plan definition is intended to be used.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for jurisdictionprotected DateType
The date on which the resource content was last reviewed.protected List<CanonicalType>
A reference to a Library resource containing any formal logic used by the plan definition.protected StringType
A natural language name identifying the plan definition.static final ca.uhn.fhir.rest.gclient.StringClientParam
Fluent Client search parameter constant for namestatic final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for predecessorprotected StringType
The name of the organization or individual that published the plan definition.static final ca.uhn.fhir.rest.gclient.StringClientParam
Fluent Client search parameter constant for publisherprotected MarkdownType
Explanation of why this plan definition is needed and why it has been designed as it has.protected List<RelatedArtifact>
Related artifacts such as additional documentation, justification, or bibliographic references.protected List<ContactDetail>
An individual or organization primarily responsible for review of some aspect of the content.static final String
Search parameter: composed-ofstatic final String
Search parameter: contextstatic final String
Search parameter: context-quantitystatic final String
Search parameter: context-typestatic final String
Search parameter: context-type-quantitystatic final String
Search parameter: context-type-valuestatic final String
Search parameter: datestatic final String
Search parameter: definitionstatic final String
Search parameter: depends-onstatic final String
Search parameter: derived-fromstatic final String
Search parameter: descriptionstatic final String
Search parameter: effectivestatic final String
Search parameter: identifierstatic final String
Search parameter: jurisdictionstatic final String
Search parameter: namestatic final String
Search parameter: predecessorstatic final String
Search parameter: publisherstatic final String
Search parameter: statusstatic final String
Search parameter: successorstatic final String
Search parameter: titlestatic final String
Search parameter: topicstatic final String
Search parameter: typestatic final String
Search parameter: urlstatic final String
Search parameter: versionprotected Enumeration<Enumerations.PublicationStatus>
The status of this plan definition.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for statusprotected DataType
A code, group definition, or canonical reference that describes or identifies the intended subject of the plan definition.protected StringType
An explanatory or alternate title for the plan definition giving additional information about its content.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for successorprotected StringType
A short, descriptive, user-friendly title for the plan definition.static final ca.uhn.fhir.rest.gclient.StringClientParam
Fluent Client search parameter constant for titleprotected List<CodeableConcept>
Descriptive topics related to the content of the plan definition.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for topicprotected CodeableConcept
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
Fluent Client search parameter constant for typeprotected UriType
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.static final ca.uhn.fhir.rest.gclient.UriClientParam
Fluent Client search parameter constant for urlprotected StringType
A detailed description of how the plan definition is used from a clinical perspective.protected List<UsageContext>
The content was developed with a focus and intent of supporting the contexts that are listed.protected StringType
The identifier that is used to identify this version of the plan definition when it is referenced in a specification, model, design or instance.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for versionFields inherited from class org.hl7.fhir.r5.model.DomainResource
contained, extension, modifierExtension, SP_TEXT, text, TEXT
Fields inherited from class org.hl7.fhir.r5.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
ConstructorsConstructorDescriptionConstructorConstructor -
Method Summary
Modifier and TypeMethodDescriptionaddActor()
addGoal()
addLibrary
(String value) addTopic()
copy()
void
copyValues
(PlanDefinition dst) boolean
equalsDeep
(Base other_) boolean
equalsShallow
(Base other_) fhirType()
getActor()
getDate()
boolean
getGoal()
getName()
getNamedProperty
(int _hash, String _name, boolean _checkValid) Base[]
getProperty
(int hash, String name, boolean checkValid) getTitle()
getTopic()
getType()
String[]
getTypesForProperty
(int hash, String name) getUrl()
getUsage()
boolean
boolean
hasActor()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasDate()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasGoal()
boolean
boolean
boolean
boolean
boolean
boolean
hasLibrary
(String value) boolean
hasName()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasTitle()
boolean
boolean
hasTopic()
boolean
hasType()
boolean
hasUrl()
boolean
boolean
hasUsage()
boolean
boolean
boolean
boolean
boolean
isEmpty()
protected void
listChildren
(List<Property> children) makeProperty
(int hash, String name) setApprovalDate
(Date value) setApprovalDateElement
(DateType value) setAuthor
(List<ContactDetail> theAuthor) setContact
(List<ContactDetail> theContact) setCopyright
(String value) setCopyrightElement
(MarkdownType value) setDateElement
(DateTimeType value) setDescription
(String value) setEditor
(List<ContactDetail> theEditor) setEffectivePeriod
(Period value) setEndorser
(List<ContactDetail> theEndorser) setExperimental
(boolean value) setIdentifier
(List<Identifier> theIdentifier) setJurisdiction
(List<CodeableConcept> theJurisdiction) setLastReviewDate
(Date value) setLastReviewDateElement
(DateType value) setLibrary
(List<CanonicalType> theLibrary) setNameElement
(StringType value) setProperty
(int hash, String name, Base value) setProperty
(String name, Base value) setPublisher
(String value) setPublisherElement
(StringType value) setPurpose
(String value) setPurposeElement
(MarkdownType value) setRelatedArtifact
(List<RelatedArtifact> theRelatedArtifact) setReviewer
(List<ContactDetail> theReviewer) setSubject
(DataType value) setSubtitle
(String value) setSubtitleElement
(StringType value) setTitleElement
(StringType value) setTopic
(List<CodeableConcept> theTopic) setType
(CodeableConcept value) setUrlElement
(UriType value) setUsageElement
(StringType value) setUseContext
(List<UsageContext> theUseContext) setVersion
(String value) setVersionElement
(StringType value) protected PlanDefinition
Methods inherited from class org.hl7.fhir.r5.model.MetadataResource
copyValues, getApprovalDateMax, getAuthorMax, getEditorMax, getEffectivePeriodMax, getEndorserMax, getLastReviewDateMax, getRelatedArtifactMax, getReviewerMax, getTopicMax
Methods inherited from class org.hl7.fhir.r5.model.CanonicalResource
copyValues, getContactMax, getCopyrightMax, getDateMax, getDescriptionMax, getExperimentalMax, getIdentifierMax, getJurisdictionMax, getNameMax, getPublisherMax, getPurposeMax, getStatusMax, getTitleMax, getUrlMax, getUseContextMax, getVersionedUrl, getVersionMax, getVUrl, present, supportsCopyright, supportsExperimental, toString
Methods inherited from class org.hl7.fhir.r5.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText
Methods inherited from class org.hl7.fhir.r5.model.Resource
copyValues, getId, getIdBase, getIdElement, 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.r5.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
Methods inherited from class org.hl7.fhir.r5.model.Base
children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyUserData, 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, setId
-
Field Details
-
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. -
identifier
A formal identifier that is used to identify this plan definition when it is represented in other formats, or referenced in a specification, model, design or an instance. -
version
The identifier that is used to identify this version of the plan definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the plan definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts. -
name
A natural language name identifying the plan definition. This name should be usable as an identifier for the module by machine processing applications such as code generation. -
title
A short, descriptive, user-friendly title for the plan definition. -
subtitle
An explanatory or alternate title for the plan definition giving additional information about its content. -
type
A high-level category for the plan definition that distinguishes the kinds of systems that would be interested in the plan definition. -
status
The status of this plan definition. Enables tracking the life-cycle of the content. -
experimental
A Boolean value to indicate that this plan definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. -
subject
A code, group definition, or canonical reference that describes or identifies the intended subject of the plan definition. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource. -
date
The date (and optionally time) when the plan definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the plan definition changes. -
publisher
The name of the organization or individual that published the plan definition. -
contact
Contact details to assist a user in finding and communicating with the publisher. -
description
A free text natural language description of the plan definition from a consumer's perspective. -
useContext
The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate plan definition instances. -
jurisdiction
A legal or geographic region in which the plan definition is intended to be used. -
purpose
Explanation of why this plan definition is needed and why it has been designed as it has. -
usage
A detailed description of how the plan definition is used from a clinical perspective. -
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
The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. -
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
The period during which the plan definition content was or is planned to be in active use. -
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
An individiual or organization primarily involved in the creation and maintenance of the content. -
editor
An individual or organization primarily responsible for internal coherence of the content. -
reviewer
An individual or organization primarily responsible for review of some aspect of the content. -
endorser
An individual or organization responsible for officially endorsing the content for use in some setting. -
library
A reference to a Library resource containing any formal logic used by the plan definition. -
goal
A goal describes an expected outcome that activities within the plan are intended to achieve. For example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, meeting the acceptance criteria for a test as specified by a quality specification, etc. -
actor
Actors represent the individuals or groups involved in the execution of the defined set of activities. -
action
An action or group of actions to be taken as part of the plan. For example, in clinical care, an action would be to prescribe a particular indicated medication, or perform a particular test as appropriate. In pharmaceutical quality, an action would be the test that needs to be performed on a drug product as defined in the quality specification. -
SP_COMPOSED_OF
Search parameter: composed-ofDescription: What resource is being referenced
Type: reference
Path: PlanDefinition.relatedArtifact.where(type='composed-of').resource
- See Also:
-
COMPOSED_OF
Fluent Client search parameter constant for composed-ofDescription: What resource is being referenced
Type: reference
Path: PlanDefinition.relatedArtifact.where(type='composed-of').resource
-
INCLUDE_COMPOSED_OF
Constant for fluent queries to be used to add include statements. Specifies the path value of "PlanDefinition:composed-of". -
SP_CONTEXT_QUANTITY
Search parameter: context-quantityDescription: A quantity- or range-valued use context assigned to the plan definition
Type: quantity
Path: (PlanDefinition.useContext.value as Quantity) | (PlanDefinition.useContext.value as Range)
- See Also:
-
CONTEXT_QUANTITY
Fluent Client search parameter constant for context-quantityDescription: A quantity- or range-valued use context assigned to the plan definition
Type: quantity
Path: (PlanDefinition.useContext.value as Quantity) | (PlanDefinition.useContext.value as Range)
-
SP_CONTEXT_TYPE_QUANTITY
Search parameter: context-type-quantityDescription: A use context type and quantity- or range-based value assigned to the plan definition
Type: composite
Path: PlanDefinition.useContext
- See Also:
-
CONTEXT_TYPE_QUANTITY
public static final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.QuantityClientParam> CONTEXT_TYPE_QUANTITYFluent Client search parameter constant for context-type-quantityDescription: A use context type and quantity- or range-based value assigned to the plan definition
Type: composite
Path: PlanDefinition.useContext
-
SP_CONTEXT_TYPE_VALUE
Search parameter: context-type-valueDescription: A use context type and value assigned to the plan definition
Type: composite
Path: PlanDefinition.useContext
- See Also:
-
CONTEXT_TYPE_VALUE
public static final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.TokenClientParam> CONTEXT_TYPE_VALUEFluent Client search parameter constant for context-type-valueDescription: A use context type and value assigned to the plan definition
Type: composite
Path: PlanDefinition.useContext
-
SP_CONTEXT_TYPE
Search parameter: context-typeDescription: A type of use context assigned to the plan definition
Type: token
Path: PlanDefinition.useContext.code
- See Also:
-
CONTEXT_TYPE
Fluent Client search parameter constant for context-typeDescription: A type of use context assigned to the plan definition
Type: token
Path: PlanDefinition.useContext.code
-
SP_CONTEXT
Search parameter: contextDescription: A use context assigned to the plan definition
Type: token
Path: (PlanDefinition.useContext.value as CodeableConcept)
- See Also:
-
CONTEXT
Fluent Client search parameter constant for contextDescription: A use context assigned to the plan definition
Type: token
Path: (PlanDefinition.useContext.value as CodeableConcept)
-
SP_DATE
Search parameter: dateDescription: The plan definition publication date
Type: date
Path: PlanDefinition.date
- See Also:
-
DATE
Fluent Client search parameter constant for dateDescription: The plan definition publication date
Type: date
Path: PlanDefinition.date
-
SP_DEFINITION
Search parameter: definitionDescription: Activity or plan definitions used by plan definition
Type: reference
Path: PlanDefinition.action.definition
- See Also:
-
DEFINITION
Fluent Client search parameter constant for definitionDescription: Activity or plan definitions used by plan definition
Type: reference
Path: PlanDefinition.action.definition
-
INCLUDE_DEFINITION
Constant for fluent queries to be used to add include statements. Specifies the path value of "PlanDefinition:definition". -
SP_DEPENDS_ON
Search parameter: depends-onDescription: What resource is being referenced
Type: reference
Path: PlanDefinition.relatedArtifact.where(type='depends-on').resource | PlanDefinition.library
- See Also:
-
DEPENDS_ON
Fluent Client search parameter constant for depends-onDescription: What resource is being referenced
Type: reference
Path: PlanDefinition.relatedArtifact.where(type='depends-on').resource | PlanDefinition.library
-
INCLUDE_DEPENDS_ON
Constant for fluent queries to be used to add include statements. Specifies the path value of "PlanDefinition:depends-on". -
SP_DERIVED_FROM
Search parameter: derived-fromDescription: What resource is being referenced
Type: reference
Path: PlanDefinition.relatedArtifact.where(type='derived-from').resource
- See Also:
-
DERIVED_FROM
Fluent Client search parameter constant for derived-fromDescription: What resource is being referenced
Type: reference
Path: PlanDefinition.relatedArtifact.where(type='derived-from').resource
-
INCLUDE_DERIVED_FROM
Constant for fluent queries to be used to add include statements. Specifies the path value of "PlanDefinition:derived-from". -
SP_DESCRIPTION
Search parameter: descriptionDescription: The description of the plan definition
Type: string
Path: PlanDefinition.description
- See Also:
-
DESCRIPTION
Fluent Client search parameter constant for descriptionDescription: The description of the plan definition
Type: string
Path: PlanDefinition.description
-
SP_EFFECTIVE
Search parameter: effectiveDescription: The time during which the plan definition is intended to be in use
Type: date
Path: PlanDefinition.effectivePeriod
- See Also:
-
EFFECTIVE
Fluent Client search parameter constant for effectiveDescription: The time during which the plan definition is intended to be in use
Type: date
Path: PlanDefinition.effectivePeriod
-
SP_IDENTIFIER
Search parameter: identifierDescription: External identifier for the plan definition
Type: token
Path: PlanDefinition.identifier
- See Also:
-
IDENTIFIER
Fluent Client search parameter constant for identifierDescription: External identifier for the plan definition
Type: token
Path: PlanDefinition.identifier
-
SP_JURISDICTION
Search parameter: jurisdictionDescription: Intended jurisdiction for the plan definition
Type: token
Path: PlanDefinition.jurisdiction
- See Also:
-
JURISDICTION
Fluent Client search parameter constant for jurisdictionDescription: Intended jurisdiction for the plan definition
Type: token
Path: PlanDefinition.jurisdiction
-
SP_NAME
Search parameter: nameDescription: Computationally friendly name of the plan definition
Type: string
Path: PlanDefinition.name
- See Also:
-
NAME
Fluent Client search parameter constant for nameDescription: Computationally friendly name of the plan definition
Type: string
Path: PlanDefinition.name
-
SP_PREDECESSOR
Search parameter: predecessorDescription: What resource is being referenced
Type: reference
Path: PlanDefinition.relatedArtifact.where(type='predecessor').resource
- See Also:
-
PREDECESSOR
Fluent Client search parameter constant for predecessorDescription: What resource is being referenced
Type: reference
Path: PlanDefinition.relatedArtifact.where(type='predecessor').resource
-
INCLUDE_PREDECESSOR
Constant for fluent queries to be used to add include statements. Specifies the path value of "PlanDefinition:predecessor". -
SP_PUBLISHER
Search parameter: publisherDescription: Name of the publisher of the plan definition
Type: string
Path: PlanDefinition.publisher
- See Also:
-
PUBLISHER
Fluent Client search parameter constant for publisherDescription: Name of the publisher of the plan definition
Type: string
Path: PlanDefinition.publisher
-
SP_STATUS
Search parameter: statusDescription: The current status of the plan definition
Type: token
Path: PlanDefinition.status
- See Also:
-
STATUS
Fluent Client search parameter constant for statusDescription: The current status of the plan definition
Type: token
Path: PlanDefinition.status
-
SP_SUCCESSOR
Search parameter: successorDescription: What resource is being referenced
Type: reference
Path: PlanDefinition.relatedArtifact.where(type='successor').resource
- See Also:
-
SUCCESSOR
Fluent Client search parameter constant for successorDescription: What resource is being referenced
Type: reference
Path: PlanDefinition.relatedArtifact.where(type='successor').resource
-
INCLUDE_SUCCESSOR
Constant for fluent queries to be used to add include statements. Specifies the path value of "PlanDefinition:successor". -
SP_TITLE
Search parameter: titleDescription: The human-friendly name of the plan definition
Type: string
Path: PlanDefinition.title
- See Also:
-
TITLE
Fluent Client search parameter constant for titleDescription: The human-friendly name of the plan definition
Type: string
Path: PlanDefinition.title
-
SP_TOPIC
Search parameter: topicDescription: Topics associated with the module
Type: token
Path: PlanDefinition.topic
- See Also:
-
TOPIC
Fluent Client search parameter constant for topicDescription: Topics associated with the module
Type: token
Path: PlanDefinition.topic
-
SP_TYPE
Search parameter: typeDescription: The type of artifact the plan (e.g. order-set, eca-rule, protocol)
Type: token
Path: PlanDefinition.type
- See Also:
-
TYPE
Fluent Client search parameter constant for typeDescription: The type of artifact the plan (e.g. order-set, eca-rule, protocol)
Type: token
Path: PlanDefinition.type
-
SP_URL
Search parameter: urlDescription: The uri that identifies the plan definition
Type: uri
Path: PlanDefinition.url
- See Also:
-
URL
Fluent Client search parameter constant for urlDescription: The uri that identifies the plan definition
Type: uri
Path: PlanDefinition.url
-
SP_VERSION
Search parameter: versionDescription: The business version of the plan definition
Type: token
Path: PlanDefinition.version
- See Also:
-
VERSION
Fluent Client search parameter constant for versionDescription: The business version of the plan definition
Type: token
Path: PlanDefinition.version
-
-
Constructor Details
-
PlanDefinition
public PlanDefinition()Constructor -
PlanDefinition
Constructor
-
-
Method Details
-
getUrlElement
- Specified by:
getUrlElement
in classCanonicalResource
- Returns:
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
- Specified by:
hasUrlElement
in classCanonicalResource
-
hasUrl
- Specified by:
hasUrl
in classCanonicalResource
-
setUrlElement
- Specified by:
setUrlElement
in classCanonicalResource
- Parameters:
value
-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
- Specified by:
getUrl
in classCanonicalResource
- 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
- Specified by:
setUrl
in classCanonicalResource
- 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
- Specified by:
getIdentifier
in classCanonicalResource
- 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
- Specified by:
setIdentifier
in classCanonicalResource
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasIdentifier
- Specified by:
hasIdentifier
in classCanonicalResource
-
addIdentifier
- Specified by:
addIdentifier
in classCanonicalResource
-
addIdentifier
- Specified by:
addIdentifier
in classCanonicalResource
-
getIdentifierFirstRep
- Specified by:
getIdentifierFirstRep
in classCanonicalResource
- Returns:
- The first repetition of repeating field
identifier
, creating it if it does not already exist {3}
-
getVersionElement
- Specified by:
getVersionElement
in classCanonicalResource
- Returns:
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
- Specified by:
hasVersionElement
in classCanonicalResource
-
hasVersion
- Specified by:
hasVersion
in classCanonicalResource
-
setVersionElement
- Specified by:
setVersionElement
in classCanonicalResource
- Parameters:
value
-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
- Specified by:
getVersion
in classCanonicalResource
- 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
- Specified by:
setVersion
in classCanonicalResource
- 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
- Specified by:
getNameElement
in classCanonicalResource
- Returns:
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
- Specified by:
hasNameElement
in classCanonicalResource
-
hasName
- Specified by:
hasName
in classCanonicalResource
-
setNameElement
- Specified by:
setNameElement
in classCanonicalResource
- Parameters:
value
-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
- Specified by:
getName
in classCanonicalResource
- 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
- Specified by:
setName
in classCanonicalResource
- 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
- Specified by:
getTitleElement
in classCanonicalResource
- Returns:
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
- Specified by:
hasTitleElement
in classCanonicalResource
-
hasTitle
- Specified by:
hasTitle
in classCanonicalResource
-
setTitleElement
- Specified by:
setTitleElement
in classCanonicalResource
- Parameters:
value
-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
- Specified by:
getTitle
in classCanonicalResource
- Returns:
- A short, descriptive, user-friendly title for the plan definition.
-
setTitle
- Specified by:
setTitle
in classCanonicalResource
- Parameters:
value
- A short, descriptive, user-friendly title for the plan definition.
-
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
-
hasSubtitle
-
setSubtitleElement
- 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
- Returns:
- An explanatory or alternate title for the plan definition giving additional information about its content.
-
setSubtitle
- Parameters:
value
- An explanatory or alternate title for the plan definition giving additional information about its content.
-
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
-
setType
- 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
- Specified by:
getStatusElement
in classCanonicalResource
- Returns:
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
- Specified by:
hasStatusElement
in classCanonicalResource
-
hasStatus
- Specified by:
hasStatus
in classCanonicalResource
-
setStatusElement
- Specified by:
setStatusElement
in classCanonicalResource
- Parameters:
value
-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
- Specified by:
getStatus
in classCanonicalResource
- Returns:
- The status of this plan definition. Enables tracking the life-cycle of the content.
-
setStatus
- Specified by:
setStatus
in classCanonicalResource
- Parameters:
value
- The status of this plan definition. Enables tracking the life-cycle of the content.
-
getExperimentalElement
- Specified by:
getExperimentalElement
in classCanonicalResource
- Returns:
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
- Specified by:
hasExperimentalElement
in classCanonicalResource
-
hasExperimental
- Specified by:
hasExperimental
in classCanonicalResource
-
setExperimentalElement
- Specified by:
setExperimentalElement
in classCanonicalResource
- Parameters:
value
-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
- Specified by:
getExperimental
in classCanonicalResource
- 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
- Specified by:
setExperimental
in classCanonicalResource
- 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
- Returns:
subject
(A code, group definition, or canonical reference that describes or identifies the intended subject of the plan definition. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource.)
-
getSubjectCodeableConcept
- Returns:
subject
(A code, group definition, or canonical reference that describes or identifies the intended subject of the plan definition. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasSubjectCodeableConcept
-
getSubjectReference
- Returns:
subject
(A code, group definition, or canonical reference that describes or identifies the intended subject of the plan definition. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasSubjectReference
-
getSubjectCanonicalType
- Returns:
subject
(A code, group definition, or canonical reference that describes or identifies the intended subject of the plan definition. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasSubjectCanonicalType
-
hasSubject
-
setSubject
- Parameters:
value
-subject
(A code, group definition, or canonical reference that describes or identifies the intended subject of the plan definition. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource.)
-
getDateElement
- Specified by:
getDateElement
in classCanonicalResource
- Returns:
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
- Specified by:
hasDateElement
in classCanonicalResource
-
hasDate
- Specified by:
hasDate
in classCanonicalResource
-
setDateElement
- Specified by:
setDateElement
in classCanonicalResource
- Parameters:
value
-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
- Specified by:
getDate
in classCanonicalResource
- 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
- Specified by:
setDate
in classCanonicalResource
- 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
- Specified by:
getPublisherElement
in classCanonicalResource
- Returns:
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
- Specified by:
hasPublisherElement
in classCanonicalResource
-
hasPublisher
- Specified by:
hasPublisher
in classCanonicalResource
-
setPublisherElement
- Specified by:
setPublisherElement
in classCanonicalResource
- Parameters:
value
-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
- Specified by:
getPublisher
in classCanonicalResource
- Returns:
- The name of the organization or individual that published the plan definition.
-
setPublisher
- Specified by:
setPublisher
in classCanonicalResource
- Parameters:
value
- The name of the organization or individual that published the plan definition.
-
getContact
- Specified by:
getContact
in classCanonicalResource
- Returns:
contact
(Contact details to assist a user in finding and communicating with the publisher.)
-
setContact
- Specified by:
setContact
in classCanonicalResource
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasContact
- Specified by:
hasContact
in classCanonicalResource
-
addContact
- Specified by:
addContact
in classCanonicalResource
-
addContact
- Specified by:
addContact
in classCanonicalResource
-
getContactFirstRep
- Specified by:
getContactFirstRep
in classCanonicalResource
- Returns:
- The first repetition of repeating field
contact
, creating it if it does not already exist {3}
-
getDescriptionElement
- Specified by:
getDescriptionElement
in classCanonicalResource
- Returns:
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
- Specified by:
hasDescriptionElement
in classCanonicalResource
-
hasDescription
- Specified by:
hasDescription
in classCanonicalResource
-
setDescriptionElement
- Specified by:
setDescriptionElement
in classCanonicalResource
- Parameters:
value
-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
- Specified by:
getDescription
in classCanonicalResource
- Returns:
- A free text natural language description of the plan definition from a consumer's perspective.
-
setDescription
- Specified by:
setDescription
in classCanonicalResource
- Parameters:
value
- A free text natural language description of the plan definition from a consumer's perspective.
-
getUseContext
- Specified by:
getUseContext
in classCanonicalResource
- Returns:
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
- Specified by:
setUseContext
in classCanonicalResource
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasUseContext
- Specified by:
hasUseContext
in classCanonicalResource
-
addUseContext
- Specified by:
addUseContext
in classCanonicalResource
-
addUseContext
- Specified by:
addUseContext
in classCanonicalResource
-
getUseContextFirstRep
- Specified by:
getUseContextFirstRep
in classCanonicalResource
- Returns:
- The first repetition of repeating field
useContext
, creating it if it does not already exist {3}
-
getJurisdiction
- Specified by:
getJurisdiction
in classCanonicalResource
- Returns:
jurisdiction
(A legal or geographic region in which the plan definition is intended to be used.)
-
setJurisdiction
- Specified by:
setJurisdiction
in classCanonicalResource
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasJurisdiction
- Specified by:
hasJurisdiction
in classCanonicalResource
-
addJurisdiction
- Specified by:
addJurisdiction
in classCanonicalResource
-
addJurisdiction
- Specified by:
addJurisdiction
in classCanonicalResource
-
getJurisdictionFirstRep
- Specified by:
getJurisdictionFirstRep
in classCanonicalResource
- Returns:
- The first repetition of repeating field
jurisdiction
, creating it if it does not already exist {3}
-
getPurposeElement
- Specified by:
getPurposeElement
in classCanonicalResource
- 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
- Specified by:
hasPurposeElement
in classCanonicalResource
-
hasPurpose
- Specified by:
hasPurpose
in classCanonicalResource
-
setPurposeElement
- Specified by:
setPurposeElement
in classCanonicalResource
- 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
- Specified by:
getPurpose
in classCanonicalResource
- Returns:
- Explanation of why this plan definition is needed and why it has been designed as it has.
-
setPurpose
- Specified by:
setPurpose
in classCanonicalResource
- Parameters:
value
- Explanation of why this plan definition is needed and why it has been designed as it has.
-
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
-
hasUsage
-
setUsageElement
- 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
- Returns:
- A detailed description of how the plan definition is used from a clinical perspective.
-
setUsage
- Parameters:
value
- A detailed description of how the plan definition is used from a clinical perspective.
-
getCopyrightElement
- Specified by:
getCopyrightElement
in classCanonicalResource
- 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
- Specified by:
hasCopyrightElement
in classCanonicalResource
-
hasCopyright
- Specified by:
hasCopyright
in classCanonicalResource
-
setCopyrightElement
- Specified by:
setCopyrightElement
in classCanonicalResource
- 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
- Specified by:
getCopyright
in classCanonicalResource
- 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
- Specified by:
setCopyright
in classCanonicalResource
- 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
- Specified by:
getApprovalDateElement
in classMetadataResource
- 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
- Specified by:
hasApprovalDateElement
in classMetadataResource
-
hasApprovalDate
- Specified by:
hasApprovalDate
in classMetadataResource
-
setApprovalDateElement
- Specified by:
setApprovalDateElement
in classMetadataResource
- 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
- Specified by:
getApprovalDate
in classMetadataResource
- 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
- Specified by:
setApprovalDate
in classMetadataResource
- 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
- Specified by:
getLastReviewDateElement
in classMetadataResource
- 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
- Specified by:
hasLastReviewDateElement
in classMetadataResource
-
hasLastReviewDate
- Specified by:
hasLastReviewDate
in classMetadataResource
-
setLastReviewDateElement
- Specified by:
setLastReviewDateElement
in classMetadataResource
- 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
- Specified by:
getLastReviewDate
in classMetadataResource
- 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
- Specified by:
setLastReviewDate
in classMetadataResource
- 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
- Specified by:
getEffectivePeriod
in classMetadataResource
- Returns:
effectivePeriod
(The period during which the plan definition content was or is planned to be in active use.)
-
hasEffectivePeriod
- Specified by:
hasEffectivePeriod
in classMetadataResource
-
setEffectivePeriod
- Specified by:
setEffectivePeriod
in classMetadataResource
- Parameters:
value
-effectivePeriod
(The period during which the plan definition content was or is planned to be in active use.)
-
getTopic
- Specified by:
getTopic
in classMetadataResource
- 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
- Specified by:
setTopic
in classMetadataResource
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasTopic
- Specified by:
hasTopic
in classMetadataResource
-
addTopic
- Specified by:
addTopic
in classMetadataResource
-
addTopic
- Specified by:
addTopic
in classMetadataResource
-
getTopicFirstRep
- Specified by:
getTopicFirstRep
in classMetadataResource
- Returns:
- The first repetition of repeating field
topic
, creating it if it does not already exist {3}
-
getAuthor
- Specified by:
getAuthor
in classMetadataResource
- Returns:
author
(An individiual or organization primarily involved in the creation and maintenance of the content.)
-
setAuthor
- Specified by:
setAuthor
in classMetadataResource
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasAuthor
- Specified by:
hasAuthor
in classMetadataResource
-
addAuthor
- Specified by:
addAuthor
in classMetadataResource
-
addAuthor
- Specified by:
addAuthor
in classMetadataResource
-
getAuthorFirstRep
- Specified by:
getAuthorFirstRep
in classMetadataResource
- Returns:
- The first repetition of repeating field
author
, creating it if it does not already exist {3}
-
getEditor
- Specified by:
getEditor
in classMetadataResource
- Returns:
editor
(An individual or organization primarily responsible for internal coherence of the content.)
-
setEditor
- Specified by:
setEditor
in classMetadataResource
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasEditor
- Specified by:
hasEditor
in classMetadataResource
-
addEditor
- Specified by:
addEditor
in classMetadataResource
-
addEditor
- Specified by:
addEditor
in classMetadataResource
-
getEditorFirstRep
- Specified by:
getEditorFirstRep
in classMetadataResource
- Returns:
- The first repetition of repeating field
editor
, creating it if it does not already exist {3}
-
getReviewer
- Specified by:
getReviewer
in classMetadataResource
- Returns:
reviewer
(An individual or organization primarily responsible for review of some aspect of the content.)
-
setReviewer
- Specified by:
setReviewer
in classMetadataResource
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasReviewer
- Specified by:
hasReviewer
in classMetadataResource
-
addReviewer
- Specified by:
addReviewer
in classMetadataResource
-
addReviewer
- Specified by:
addReviewer
in classMetadataResource
-
getReviewerFirstRep
- Specified by:
getReviewerFirstRep
in classMetadataResource
- Returns:
- The first repetition of repeating field
reviewer
, creating it if it does not already exist {3}
-
getEndorser
- Specified by:
getEndorser
in classMetadataResource
- Returns:
endorser
(An individual or organization responsible for officially endorsing the content for use in some setting.)
-
setEndorser
- Specified by:
setEndorser
in classMetadataResource
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasEndorser
- Specified by:
hasEndorser
in classMetadataResource
-
addEndorser
- Specified by:
addEndorser
in classMetadataResource
-
addEndorser
- Specified by:
addEndorser
in classMetadataResource
-
getEndorserFirstRep
- Specified by:
getEndorserFirstRep
in classMetadataResource
- Returns:
- The first repetition of repeating field
endorser
, creating it if it does not already exist {3}
-
getRelatedArtifact
- Specified by:
getRelatedArtifact
in classMetadataResource
- Returns:
relatedArtifact
(Related artifacts such as additional documentation, justification, or bibliographic references.)
-
setRelatedArtifact
- Specified by:
setRelatedArtifact
in classMetadataResource
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasRelatedArtifact
- Specified by:
hasRelatedArtifact
in classMetadataResource
-
addRelatedArtifact
- Specified by:
addRelatedArtifact
in classMetadataResource
-
addRelatedArtifact
- Specified by:
addRelatedArtifact
in classMetadataResource
-
getRelatedArtifactFirstRep
- Specified by:
getRelatedArtifactFirstRep
in classMetadataResource
- Returns:
- The first repetition of repeating field
relatedArtifact
, creating it if it does not already exist {3}
-
getLibrary
- Returns:
library
(A reference to a Library resource containing any formal logic used by the plan definition.)
-
setLibrary
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasLibrary
-
addLibraryElement
- Returns:
library
(A reference to a Library resource containing any formal logic used by the plan definition.)
-
addLibrary
- Parameters:
value
-library
(A reference to a Library resource containing any formal logic used by the plan definition.)
-
hasLibrary
- Parameters:
value
-library
(A reference to a Library resource containing any formal logic used by the plan definition.)
-
getGoal
- Returns:
goal
(A goal describes an expected outcome that activities within the plan are intended to achieve. For example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, meeting the acceptance criteria for a test as specified by a quality specification, etc.)
-
setGoal
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasGoal
-
addGoal
-
addGoal
-
getGoalFirstRep
- Returns:
- The first repetition of repeating field
goal
, creating it if it does not already exist {3}
-
getActor
- Returns:
actor
(Actors represent the individuals or groups involved in the execution of the defined set of activities.)
-
setActor
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasActor
-
addActor
-
addActor
-
getActorFirstRep
- Returns:
- The first repetition of repeating field
actor
, creating it if it does not already exist {3}
-
getAction
- Returns:
action
(An action or group of actions to be taken as part of the plan. For example, in clinical care, an action would be to prescribe a particular indicated medication, or perform a particular test as appropriate. In pharmaceutical quality, an action would be the test that needs to be performed on a drug product as defined in the quality specification.)
-
setAction
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasAction
-
addAction
-
addAction
-
getActionFirstRep
- Returns:
- The first repetition of repeating field
action
, creating it if it does not already exist {3}
-
listChildren
- Overrides:
listChildren
in classMetadataResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getNamedProperty
in classMetadataResource
- 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 classMetadataResource
- 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 classMetadataResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
- Overrides:
setProperty
in classMetadataResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
- Overrides:
makeProperty
in classMetadataResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getTypesForProperty
in classMetadataResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
- Overrides:
addChild
in classMetadataResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
- Specified by:
fhirType
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
fhirType
in classMetadataResource
-
copy
- Specified by:
copy
in classMetadataResource
-
copyValues
-
typedCopy
-
equalsDeep
- Overrides:
equalsDeep
in classMetadataResource
-
equalsShallow
- Overrides:
equalsShallow
in classMetadataResource
-
isEmpty
- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
isEmpty
in classMetadataResource
-
getResourceType
- Specified by:
getResourceType
in classResource
-