
Class PlanDefinition
- All Implemented Interfaces:
ca.uhn.fhir.model.api.IElement
,Serializable
,org.hl7.fhir.instance.model.api.IAnyResource
,org.hl7.fhir.instance.model.api.IBase
,org.hl7.fhir.instance.model.api.IBaseHasExtensions
,org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions
,org.hl7.fhir.instance.model.api.IBaseResource
,org.hl7.fhir.instance.model.api.IDomainResource
public class PlanDefinition extends MetadataResource
- See Also:
- Serialized Form
-
Nested Class Summary
-
Field Summary
Fields Modifier and Type Field Description protected List<PlanDefinition.PlanDefinitionActionComponent>
action
An action to be taken as part of the plan.protected DateType
approvalDate
The date on which the resource content was approved by the publisher.static ca.uhn.fhir.rest.gclient.ReferenceClientParam
COMPOSED_OF
Fluent Client search parameter constant for composed-ofprotected List<Contributor>
contributor
A contributor to the content of the asset, including authors, editors, reviewers, and endorsers.protected MarkdownType
copyright
A copyright statement relating to the plan definition and/or its contents.static ca.uhn.fhir.rest.gclient.DateClientParam
DATE
Fluent Client search parameter constant for datestatic ca.uhn.fhir.rest.gclient.ReferenceClientParam
DEPENDS_ON
Fluent Client search parameter constant for depends-onstatic ca.uhn.fhir.rest.gclient.ReferenceClientParam
DERIVED_FROM
Fluent Client search parameter constant for derived-fromstatic ca.uhn.fhir.rest.gclient.StringClientParam
DESCRIPTION
Fluent Client search parameter constant for descriptionstatic ca.uhn.fhir.rest.gclient.DateClientParam
EFFECTIVE
Fluent Client search parameter constant for effectiveprotected Period
effectivePeriod
The period during which the plan definition content was or is planned to be in active use.protected List<PlanDefinition.PlanDefinitionGoalComponent>
goal
Goals that describe what the activities within the plan are intended to achieve.protected List<Identifier>
identifier
A formal identifier that is used to identify this plan definition when it is represented in other formats, or referenced in a specification, model, design or an instance.static ca.uhn.fhir.rest.gclient.TokenClientParam
IDENTIFIER
Fluent Client search parameter constant for identifierstatic ca.uhn.fhir.model.api.Include
INCLUDE_COMPOSED_OF
Constant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.Include
INCLUDE_DEPENDS_ON
Constant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.Include
INCLUDE_DERIVED_FROM
Constant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.Include
INCLUDE_PREDECESSOR
Constant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.Include
INCLUDE_SUCCESSOR
Constant for fluent queries to be used to add include statements.static ca.uhn.fhir.rest.gclient.TokenClientParam
JURISDICTION
Fluent Client search parameter constant for jurisdictionprotected DateType
lastReviewDate
The date on which the resource content was last reviewed.protected List<Reference>
library
A reference to a Library resource containing any formal logic used by the plan definition.protected List<Library>
libraryTarget
The actual objects that are the target of the reference (A reference to a Library resource containing any formal logic used by the plan definition.)static ca.uhn.fhir.rest.gclient.StringClientParam
NAME
Fluent Client search parameter constant for namestatic ca.uhn.fhir.rest.gclient.ReferenceClientParam
PREDECESSOR
Fluent Client search parameter constant for predecessorstatic ca.uhn.fhir.rest.gclient.StringClientParam
PUBLISHER
Fluent Client search parameter constant for publisherprotected MarkdownType
purpose
Explaination of why this plan definition is needed and why it has been designed as it has.protected List<RelatedArtifact>
relatedArtifact
Related artifacts such as additional documentation, justification, or bibliographic references.static String
SP_COMPOSED_OF
Search parameter: composed-ofstatic String
SP_DATE
Search parameter: datestatic String
SP_DEPENDS_ON
Search parameter: depends-onstatic String
SP_DERIVED_FROM
Search parameter: derived-fromstatic String
SP_DESCRIPTION
Search parameter: descriptionstatic String
SP_EFFECTIVE
Search parameter: effectivestatic String
SP_IDENTIFIER
Search parameter: identifierstatic String
SP_JURISDICTION
Search parameter: jurisdictionstatic String
SP_NAME
Search parameter: namestatic String
SP_PREDECESSOR
Search parameter: predecessorstatic String
SP_PUBLISHER
Search parameter: publisherstatic String
SP_STATUS
Search parameter: statusstatic String
SP_SUCCESSOR
Search parameter: successorstatic String
SP_TITLE
Search parameter: titlestatic String
SP_TOPIC
Search parameter: topicstatic String
SP_URL
Search parameter: urlstatic String
SP_VERSION
Search parameter: versionstatic ca.uhn.fhir.rest.gclient.TokenClientParam
STATUS
Fluent Client search parameter constant for statusstatic ca.uhn.fhir.rest.gclient.ReferenceClientParam
SUCCESSOR
Fluent Client search parameter constant for successorstatic ca.uhn.fhir.rest.gclient.StringClientParam
TITLE
Fluent Client search parameter constant for titleprotected List<CodeableConcept>
topic
Descriptive topics related to the content of the plan definition.static ca.uhn.fhir.rest.gclient.TokenClientParam
TOPIC
Fluent Client search parameter constant for topicprotected CodeableConcept
type
The type of asset the plan definition represents, e.g.static ca.uhn.fhir.rest.gclient.UriClientParam
URL
Fluent Client search parameter constant for urlprotected StringType
usage
A detailed description of how the asset is used from a clinical perspective.static ca.uhn.fhir.rest.gclient.TokenClientParam
VERSION
Fluent Client search parameter constant for versionFields inherited from class org.hl7.fhir.dstu3.model.MetadataResource
contact, date, description, experimental, jurisdiction, name, publisher, status, title, url, useContext, version
Fields inherited from class org.hl7.fhir.dstu3.model.DomainResource
contained, extension, modifierExtension, text
Fields inherited from class org.hl7.fhir.dstu3.model.Resource
id, implicitRules, language, meta
Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
RES_ID, SP_RES_ID, SP_RES_LANGUAGE
Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET
-
Constructor Summary
Constructors Constructor Description PlanDefinition()
ConstructorPlanDefinition(Enumeration<Enumerations.PublicationStatus> status)
Constructor -
Method Summary
Methods inherited from class org.hl7.fhir.dstu3.model.MetadataResource
checkCanUseUrl, copyValues, toString
Methods inherited from class org.hl7.fhir.dstu3.model.DomainResource
addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText
Methods inherited from class org.hl7.fhir.dstu3.model.Resource
copyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta
Methods inherited from class org.hl7.fhir.dstu3.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
Methods inherited from class org.hl7.fhir.dstu3.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
getId, getIdElement, getLanguageElement, getUserData, setId, setUserData
Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, hasFormatComment
Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
getMeta, getStructureFhirVersionEnum, setId
-
Field Details
-
identifier
A formal identifier that is used to identify this plan definition when it is represented in other formats, or referenced in a specification, model, design or an instance. -
type
The type of asset the plan definition represents, e.g. an order set, protocol, or event-condition-action rule. -
purpose
Explaination of why this plan definition is needed and why it has been designed as it has. -
usage
A detailed description of how the asset is used from a clinical perspective. -
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 doesn't 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. -
contributor
A contributor to the content of the asset, including authors, editors, reviewers, and endorsers. -
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. -
library
A reference to a Library resource containing any formal logic used by the plan definition. -
libraryTarget
The actual objects that are the target of the reference (A reference to a Library resource containing any formal logic used by the plan definition.) -
goal
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
An action to be taken as part of the plan. -
SP_DATE
Search parameter: dateDescription: The plan definition publication date
Type: date
Path: PlanDefinition.date
- See Also:
- Constant Field Values
-
DATE
Fluent Client search parameter constant for dateDescription: The plan definition publication date
Type: date
Path: PlanDefinition.date
-
SP_IDENTIFIER
Search parameter: identifierDescription: External identifier for the plan definition
Type: token
Path: PlanDefinition.identifier
- See Also:
- Constant Field Values
-
IDENTIFIER
Fluent Client search parameter constant for identifierDescription: External identifier for the plan definition
Type: token
Path: PlanDefinition.identifier
-
SP_SUCCESSOR
Search parameter: successorDescription: What resource is being referenced
Type: reference
Path: PlanDefinition.relatedArtifact.resource
- See Also:
- Constant Field Values
-
SUCCESSOR
Fluent Client search parameter constant for successorDescription: What resource is being referenced
Type: reference
Path: PlanDefinition.relatedArtifact.resource
-
INCLUDE_SUCCESSOR
Constant for fluent queries to be used to add include statements. Specifies the path value of "PlanDefinition:successor". -
SP_JURISDICTION
Search parameter: jurisdictionDescription: Intended jurisdiction for the plan definition
Type: token
Path: PlanDefinition.jurisdiction
- See Also:
- Constant Field Values
-
JURISDICTION
Fluent Client search parameter constant for jurisdictionDescription: Intended jurisdiction for the plan definition
Type: token
Path: PlanDefinition.jurisdiction
-
SP_DESCRIPTION
Search parameter: descriptionDescription: The description of the plan definition
Type: string
Path: PlanDefinition.description
- See Also:
- Constant Field Values
-
DESCRIPTION
Fluent Client search parameter constant for descriptionDescription: The description of the plan definition
Type: string
Path: PlanDefinition.description
-
SP_DERIVED_FROM
Search parameter: derived-fromDescription: What resource is being referenced
Type: reference
Path: PlanDefinition.relatedArtifact.resource
- See Also:
- Constant Field Values
-
DERIVED_FROM
Fluent Client search parameter constant for derived-fromDescription: What resource is being referenced
Type: reference
Path: PlanDefinition.relatedArtifact.resource
-
INCLUDE_DERIVED_FROM
Constant for fluent queries to be used to add include statements. Specifies the path value of "PlanDefinition:derived-from". -
SP_PREDECESSOR
Search parameter: predecessorDescription: What resource is being referenced
Type: reference
Path: PlanDefinition.relatedArtifact.resource
- See Also:
- Constant Field Values
-
PREDECESSOR
Fluent Client search parameter constant for predecessorDescription: What resource is being referenced
Type: reference
Path: PlanDefinition.relatedArtifact.resource
-
INCLUDE_PREDECESSOR
Constant for fluent queries to be used to add include statements. Specifies the path value of "PlanDefinition:predecessor". -
SP_TITLE
Search parameter: titleDescription: The human-friendly name of the plan definition
Type: string
Path: PlanDefinition.title
- See Also:
- Constant Field Values
-
TITLE
Fluent Client search parameter constant for titleDescription: The human-friendly name of the plan definition
Type: string
Path: PlanDefinition.title
-
SP_COMPOSED_OF
Search parameter: composed-ofDescription: What resource is being referenced
Type: reference
Path: PlanDefinition.relatedArtifact.resource
- See Also:
- Constant Field Values
-
COMPOSED_OF
Fluent Client search parameter constant for composed-ofDescription: What resource is being referenced
Type: reference
Path: PlanDefinition.relatedArtifact.resource
-
INCLUDE_COMPOSED_OF
Constant for fluent queries to be used to add include statements. Specifies the path value of "PlanDefinition:composed-of". -
SP_VERSION
Search parameter: versionDescription: The business version of the plan definition
Type: token
Path: PlanDefinition.version
- See Also:
- Constant Field Values
-
VERSION
Fluent Client search parameter constant for versionDescription: The business version of the plan definition
Type: token
Path: PlanDefinition.version
-
SP_URL
Search parameter: urlDescription: The uri that identifies the plan definition
Type: uri
Path: PlanDefinition.url
- See Also:
- Constant Field Values
-
URL
Fluent Client search parameter constant for urlDescription: The uri that identifies the plan definition
Type: uri
Path: PlanDefinition.url
-
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:
- Constant Field Values
-
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_DEPENDS_ON
Search parameter: depends-onDescription: What resource is being referenced
Type: reference
Path: PlanDefinition.relatedArtifact.resource, PlanDefinition.library
- See Also:
- Constant Field Values
-
DEPENDS_ON
Fluent Client search parameter constant for depends-onDescription: What resource is being referenced
Type: reference
Path: PlanDefinition.relatedArtifact.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_NAME
Search parameter: nameDescription: Computationally friendly name of the plan definition
Type: string
Path: PlanDefinition.name
- See Also:
- Constant Field Values
-
NAME
Fluent Client search parameter constant for nameDescription: Computationally friendly name of the plan definition
Type: string
Path: PlanDefinition.name
-
SP_PUBLISHER
Search parameter: publisherDescription: Name of the publisher of the plan definition
Type: string
Path: PlanDefinition.publisher
- See Also:
- Constant Field Values
-
PUBLISHER
Fluent Client search parameter constant for publisherDescription: Name of the publisher of the plan definition
Type: string
Path: PlanDefinition.publisher
-
SP_TOPIC
Search parameter: topicDescription: Topics associated with the module
Type: token
Path: PlanDefinition.topic
- See Also:
- Constant Field Values
-
TOPIC
Fluent Client search parameter constant for topicDescription: Topics associated with the module
Type: token
Path: PlanDefinition.topic
-
SP_STATUS
Search parameter: statusDescription: The current status of the plan definition
Type: token
Path: PlanDefinition.status
- See Also:
- Constant Field Values
-
STATUS
Fluent Client search parameter constant for statusDescription: The current status of the plan definition
Type: token
Path: PlanDefinition.status
-
-
Constructor Details
-
PlanDefinition
public PlanDefinition()Constructor -
PlanDefinition
Constructor
-
-
Method Details
-
getUrlElement
- Overrides:
getUrlElement
in classMetadataResource
- Returns:
MetadataResource.url
(An absolute URI that is used to identify this plan definition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this plan definition is (or will be) published. The URL SHOULD include the major version of the plan definition. For more information see [Technical and Business Versions](resource.html#versions).). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value
-
hasUrlElement
- Overrides:
hasUrlElement
in classMetadataResource
-
hasUrl
- Overrides:
hasUrl
in classMetadataResource
-
setUrlElement
- Overrides:
setUrlElement
in classMetadataResource
- Parameters:
value
-MetadataResource.url
(An absolute URI that is used to identify this plan definition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this plan definition is (or will be) published. The URL SHOULD include the major version of the plan definition. For more information see [Technical and Business Versions](resource.html#versions).). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value
-
getUrl
- Overrides:
getUrl
in classMetadataResource
- Returns:
- An absolute URI that is used to identify this plan definition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this plan definition is (or will be) published. The URL SHOULD include the major version of the plan definition. For more information see [Technical and Business Versions](resource.html#versions).
-
setUrl
- Overrides:
setUrl
in classMetadataResource
- Parameters:
value
- An absolute URI that is used to identify this plan definition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this plan definition is (or will be) published. The URL SHOULD include the major version of the plan definition. For more information see [Technical and Business Versions](resource.html#versions).
-
getIdentifier
- 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
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasIdentifier
-
addIdentifier
-
addIdentifier
-
getIdentifierFirstRep
- Returns:
- The first repetition of repeating field
identifier
, creating it if it does not already exist
-
getVersionElement
- Overrides:
getVersionElement
in classMetadataResource
- 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
- Overrides:
hasVersionElement
in classMetadataResource
-
hasVersion
- Overrides:
hasVersion
in classMetadataResource
-
setVersionElement
- Overrides:
setVersionElement
in classMetadataResource
- 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
- Overrides:
getVersion
in classMetadataResource
- 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
- Overrides:
setVersion
in classMetadataResource
- 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
- Overrides:
getNameElement
in classMetadataResource
- 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
- Overrides:
hasNameElement
in classMetadataResource
-
hasName
- Overrides:
hasName
in classMetadataResource
-
setNameElement
- Overrides:
setNameElement
in classMetadataResource
- 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
- Overrides:
getName
in classMetadataResource
- 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
- Overrides:
setName
in classMetadataResource
- 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
- Overrides:
getTitleElement
in classMetadataResource
- 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
- Overrides:
hasTitleElement
in classMetadataResource
-
hasTitle
- Overrides:
hasTitle
in classMetadataResource
-
setTitleElement
- Overrides:
setTitleElement
in classMetadataResource
- 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
- Overrides:
getTitle
in classMetadataResource
- Returns:
- A short, descriptive, user-friendly title for the plan definition.
-
setTitle
- Overrides:
setTitle
in classMetadataResource
- Parameters:
value
- A short, descriptive, user-friendly title for the plan definition.
-
getType
- Returns:
type
(The type of asset the plan definition represents, e.g. an order set, protocol, or event-condition-action rule.)
-
hasType
-
setType
- Parameters:
value
-type
(The type of asset the plan definition represents, e.g. an order set, protocol, or event-condition-action rule.)
-
getStatusElement
- Overrides:
getStatusElement
in classMetadataResource
- 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
- Overrides:
hasStatusElement
in classMetadataResource
-
hasStatus
- Overrides:
hasStatus
in classMetadataResource
-
setStatusElement
- Overrides:
setStatusElement
in classMetadataResource
- 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
- Overrides:
getStatus
in classMetadataResource
- Returns:
- The status of this plan definition. Enables tracking the life-cycle of the content.
-
setStatus
- Overrides:
setStatus
in classMetadataResource
- Parameters:
value
- The status of this plan definition. Enables tracking the life-cycle of the content.
-
getExperimentalElement
- Overrides:
getExperimentalElement
in classMetadataResource
- 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
- Overrides:
hasExperimentalElement
in classMetadataResource
-
hasExperimental
- Overrides:
hasExperimental
in classMetadataResource
-
setExperimentalElement
- Overrides:
setExperimentalElement
in classMetadataResource
- 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
- Overrides:
getExperimental
in classMetadataResource
- 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
- Overrides:
setExperimental
in classMetadataResource
- Parameters:
value
- A boolean value to indicate that this plan definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
-
getDateElement
- Overrides:
getDateElement
in classMetadataResource
- Returns:
MetadataResource.date
(The date (and optionally time) when the plan definition was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the plan definition changes.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value
-
hasDateElement
- Overrides:
hasDateElement
in classMetadataResource
-
hasDate
- Overrides:
hasDate
in classMetadataResource
-
setDateElement
- Overrides:
setDateElement
in classMetadataResource
- Parameters:
value
-MetadataResource.date
(The date (and optionally time) when the plan definition was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the plan definition changes.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value
-
getDate
- Overrides:
getDate
in classMetadataResource
- Returns:
- The date (and optionally time) when the plan definition was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the plan definition changes.
-
setDate
- Overrides:
setDate
in classMetadataResource
- Parameters:
value
- The date (and optionally time) when the plan definition was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the plan definition changes.
-
getPublisherElement
- Overrides:
getPublisherElement
in classMetadataResource
- Returns:
MetadataResource.publisher
(The name of the individual or organization that published the plan definition.). This is the underlying object with id, value and extensions. The accessor "getPublisher" gives direct access to the value
-
hasPublisherElement
- Overrides:
hasPublisherElement
in classMetadataResource
-
hasPublisher
- Overrides:
hasPublisher
in classMetadataResource
-
setPublisherElement
- Overrides:
setPublisherElement
in classMetadataResource
- Parameters:
value
-MetadataResource.publisher
(The name of the individual or organization that published the plan definition.). This is the underlying object with id, value and extensions. The accessor "getPublisher" gives direct access to the value
-
getPublisher
- Overrides:
getPublisher
in classMetadataResource
- Returns:
- The name of the individual or organization that published the plan definition.
-
setPublisher
- Overrides:
setPublisher
in classMetadataResource
- Parameters:
value
- The name of the individual or organization that published the plan definition.
-
getDescriptionElement
- Overrides:
getDescriptionElement
in classMetadataResource
- 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
- Overrides:
hasDescriptionElement
in classMetadataResource
-
hasDescription
- Overrides:
hasDescription
in classMetadataResource
-
setDescriptionElement
- Overrides:
setDescriptionElement
in classMetadataResource
- 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
- Overrides:
getDescription
in classMetadataResource
- Returns:
- A free text natural language description of the plan definition from a consumer's perspective.
-
setDescription
- Overrides:
setDescription
in classMetadataResource
- Parameters:
value
- A free text natural language description of the plan definition from a consumer's perspective.
-
getPurposeElement
- Returns:
purpose
(Explaination of why this plan definition is needed and why it has been designed as it has.). This is the underlying object with id, value and extensions. The accessor "getPurpose" gives direct access to the value
-
hasPurposeElement
-
hasPurpose
-
setPurposeElement
- Parameters:
value
-purpose
(Explaination of why this plan definition is needed and why it has been designed as it has.). This is the underlying object with id, value and extensions. The accessor "getPurpose" gives direct access to the value
-
getPurpose
- Returns:
- Explaination of why this plan definition is needed and why it has been designed as it has.
-
setPurpose
- Parameters:
value
- Explaination 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 asset is used from a clinical perspective.). This is the underlying object with id, value and extensions. The accessor "getUsage" gives direct access to the value
-
hasUsageElement
-
hasUsage
-
setUsageElement
- Parameters:
value
-usage
(A detailed description of how the asset is used from a clinical perspective.). This is the underlying object with id, value and extensions. The accessor "getUsage" gives direct access to the value
-
getUsage
- Returns:
- A detailed description of how the asset is used from a clinical perspective.
-
setUsage
- Parameters:
value
- A detailed description of how the asset is used from a clinical perspective.
-
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
-
hasApprovalDate
-
setApprovalDateElement
- 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
- 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
- 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
- Returns:
lastReviewDate
(The date on which the resource content was last reviewed. Review happens periodically after approval, but doesn't change the original approval date.). This is the underlying object with id, value and extensions. The accessor "getLastReviewDate" gives direct access to the value
-
hasLastReviewDateElement
-
hasLastReviewDate
-
setLastReviewDateElement
- Parameters:
value
-lastReviewDate
(The date on which the resource content was last reviewed. Review happens periodically after approval, but doesn't change the original approval date.). This is the underlying object with id, value and extensions. The accessor "getLastReviewDate" gives direct access to the value
-
getLastReviewDate
- Returns:
- The date on which the resource content was last reviewed. Review happens periodically after approval, but doesn't change the original approval date.
-
setLastReviewDate
- Parameters:
value
- The date on which the resource content was last reviewed. Review happens periodically after approval, but doesn't change the original approval date.
-
getEffectivePeriod
- Returns:
effectivePeriod
(The period during which the plan definition content was or is planned to be in active use.)
-
hasEffectivePeriod
-
setEffectivePeriod
- Parameters:
value
-effectivePeriod
(The period during which the plan definition content was or is planned to be in active use.)
-
getUseContext
- Overrides:
getUseContext
in classMetadataResource
- Returns:
MetadataResource.useContext
(The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate plan definition instances.)
-
setUseContext
- Overrides:
setUseContext
in classMetadataResource
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasUseContext
- Overrides:
hasUseContext
in classMetadataResource
-
addUseContext
- Overrides:
addUseContext
in classMetadataResource
-
addUseContext
- Overrides:
addUseContext
in classMetadataResource
-
getUseContextFirstRep
- Overrides:
getUseContextFirstRep
in classMetadataResource
- Returns:
- The first repetition of repeating field
MetadataResource.useContext
, creating it if it does not already exist
-
getJurisdiction
- Overrides:
getJurisdiction
in classMetadataResource
- Returns:
MetadataResource.jurisdiction
(A legal or geographic region in which the plan definition is intended to be used.)
-
setJurisdiction
- Overrides:
setJurisdiction
in classMetadataResource
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasJurisdiction
- Overrides:
hasJurisdiction
in classMetadataResource
-
addJurisdiction
- Overrides:
addJurisdiction
in classMetadataResource
-
addJurisdiction
- Overrides:
addJurisdiction
in classMetadataResource
-
getJurisdictionFirstRep
- Overrides:
getJurisdictionFirstRep
in classMetadataResource
- Returns:
- The first repetition of repeating field
MetadataResource.jurisdiction
, creating it if it does not already exist
-
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
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasTopic
-
addTopic
-
addTopic
-
getTopicFirstRep
- Returns:
- The first repetition of repeating field
topic
, creating it if it does not already exist
-
getContributor
- Returns:
contributor
(A contributor to the content of the asset, including authors, editors, reviewers, and endorsers.)
-
setContributor
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasContributor
-
addContributor
-
addContributor
-
getContributorFirstRep
- Returns:
- The first repetition of repeating field
contributor
, creating it if it does not already exist
-
getContact
- Overrides:
getContact
in classMetadataResource
- Returns:
MetadataResource.contact
(Contact details to assist a user in finding and communicating with the publisher.)
-
setContact
- Overrides:
setContact
in classMetadataResource
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasContact
- Overrides:
hasContact
in classMetadataResource
-
addContact
- Overrides:
addContact
in classMetadataResource
-
addContact
- Overrides:
addContact
in classMetadataResource
-
getContactFirstRep
- Overrides:
getContactFirstRep
in classMetadataResource
- Returns:
- The first repetition of repeating field
MetadataResource.contact
, creating it if it does not already exist
-
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
-
hasCopyright
-
setCopyrightElement
- 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
- 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
- Parameters:
value
- A copyright statement relating to the plan definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the plan definition.
-
getRelatedArtifact
- Returns:
relatedArtifact
(Related artifacts such as additional documentation, justification, or bibliographic references.)
-
setRelatedArtifact
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasRelatedArtifact
-
addRelatedArtifact
-
addRelatedArtifact
-
getRelatedArtifactFirstRep
- Returns:
- The first repetition of repeating field
relatedArtifact
, creating it if it does not already exist
-
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
-
addLibrary
-
addLibrary
-
getLibraryFirstRep
- Returns:
- The first repetition of repeating field
library
, creating it if it does not already exist
-
getLibraryTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
addLibraryTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
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
- 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
-
getAction
- Returns:
action
(An action to be taken as part of the plan.)
-
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
-
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
-
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
-