public class PlanDefinition extends MetadataResource
| Modifier and Type | Field and Description |
|---|---|
protected List<PlanDefinition.PlanDefinitionActionComponent> |
action
An action or group of actions to be taken as part of the plan.
|
protected DateType |
approvalDate
The date on which the resource content was approved by the publisher.
|
protected List<ContactDetail> |
author
An individiual or organization primarily involved in the creation and maintenance of the content.
|
static ca.uhn.fhir.rest.gclient.ReferenceClientParam |
COMPOSED_OF
Fluent Client search parameter constant for composed-of
|
static ca.uhn.fhir.rest.gclient.TokenClientParam |
CONTEXT
Fluent Client search parameter constant for context
|
static ca.uhn.fhir.rest.gclient.QuantityClientParam |
CONTEXT_QUANTITY
Fluent Client search parameter constant for context-quantity
|
static ca.uhn.fhir.rest.gclient.TokenClientParam |
CONTEXT_TYPE
Fluent Client search parameter constant for context-type
|
static ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.QuantityClientParam> |
CONTEXT_TYPE_QUANTITY
Fluent Client search parameter constant for context-type-quantity
|
static ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.TokenClientParam> |
CONTEXT_TYPE_VALUE
Fluent Client search parameter constant for context-type-value
|
protected MarkdownType |
copyright
A copyright statement relating to the plan definition and/or its contents.
|
static ca.uhn.fhir.rest.gclient.DateClientParam |
DATE
Fluent Client search parameter constant for date
|
static ca.uhn.fhir.rest.gclient.ReferenceClientParam |
DEFINITION
Fluent Client search parameter constant for definition
|
static ca.uhn.fhir.rest.gclient.ReferenceClientParam |
DEPENDS_ON
Fluent Client search parameter constant for depends-on
|
static ca.uhn.fhir.rest.gclient.ReferenceClientParam |
DERIVED_FROM
Fluent Client search parameter constant for derived-from
|
static ca.uhn.fhir.rest.gclient.StringClientParam |
DESCRIPTION
Fluent Client search parameter constant for description
|
protected List<ContactDetail> |
editor
An individual or organization primarily responsible for internal coherence of the content.
|
static ca.uhn.fhir.rest.gclient.DateClientParam |
EFFECTIVE
Fluent Client search parameter constant for effective
|
protected Period |
effectivePeriod
The period during which the plan definition content was or is planned to be in active use.
|
protected List<ContactDetail> |
endorser
An individual or organization responsible for officially endorsing the content for use in some setting.
|
protected List<PlanDefinition.PlanDefinitionGoalComponent> |
goal
Goals that describe what the activities within the plan are intended to achieve.
|
protected List<Identifier> |
identifier
A formal identifier that is used to identify this plan definition when it is represented in other formats, or referenced in a specification, model, design or an instance.
|
static ca.uhn.fhir.rest.gclient.TokenClientParam |
IDENTIFIER
Fluent Client search parameter constant for identifier
|
static ca.uhn.fhir.model.api.Include |
INCLUDE_COMPOSED_OF
Constant for fluent queries to be used to add include statements.
|
static ca.uhn.fhir.model.api.Include |
INCLUDE_DEFINITION
Constant for fluent queries to be used to add include statements.
|
static ca.uhn.fhir.model.api.Include |
INCLUDE_DEPENDS_ON
Constant for fluent queries to be used to add include statements.
|
static ca.uhn.fhir.model.api.Include |
INCLUDE_DERIVED_FROM
Constant for fluent queries to be used to add include statements.
|
static ca.uhn.fhir.model.api.Include |
INCLUDE_PREDECESSOR
Constant for fluent queries to be used to add include statements.
|
static ca.uhn.fhir.model.api.Include |
INCLUDE_SUCCESSOR
Constant for fluent queries to be used to add include statements.
|
static ca.uhn.fhir.rest.gclient.TokenClientParam |
JURISDICTION
Fluent Client search parameter constant for jurisdiction
|
protected DateType |
lastReviewDate
The date on which the resource content was last reviewed.
|
protected List<CanonicalType> |
library
A reference to a Library resource containing any formal logic used by the plan definition.
|
static ca.uhn.fhir.rest.gclient.StringClientParam |
NAME
Fluent Client search parameter constant for name
|
static ca.uhn.fhir.rest.gclient.ReferenceClientParam |
PREDECESSOR
Fluent Client search parameter constant for predecessor
|
static ca.uhn.fhir.rest.gclient.StringClientParam |
PUBLISHER
Fluent Client search parameter constant for publisher
|
protected MarkdownType |
purpose
Explanation of why this plan definition is needed and why it has been designed as it has.
|
protected List<RelatedArtifact> |
relatedArtifact
Related artifacts such as additional documentation, justification, or bibliographic references.
|
protected List<ContactDetail> |
reviewer
An individual or organization primarily responsible for review of some aspect of the content.
|
static String |
SP_COMPOSED_OF
Search parameter: composed-of
|
static String |
SP_CONTEXT
Search parameter: context
|
static String |
SP_CONTEXT_QUANTITY
Search parameter: context-quantity
|
static String |
SP_CONTEXT_TYPE
Search parameter: context-type
|
static String |
SP_CONTEXT_TYPE_QUANTITY
Search parameter: context-type-quantity
|
static String |
SP_CONTEXT_TYPE_VALUE
Search parameter: context-type-value
|
static String |
SP_DATE
Search parameter: date
|
static String |
SP_DEFINITION
Search parameter: definition
|
static String |
SP_DEPENDS_ON
Search parameter: depends-on
|
static String |
SP_DERIVED_FROM
Search parameter: derived-from
|
static String |
SP_DESCRIPTION
Search parameter: description
|
static String |
SP_EFFECTIVE
Search parameter: effective
|
static String |
SP_IDENTIFIER
Search parameter: identifier
|
static String |
SP_JURISDICTION
Search parameter: jurisdiction
|
static String |
SP_NAME
Search parameter: name
|
static String |
SP_PREDECESSOR
Search parameter: predecessor
|
static String |
SP_PUBLISHER
Search parameter: publisher
|
static String |
SP_STATUS
Search parameter: status
|
static String |
SP_SUCCESSOR
Search parameter: successor
|
static String |
SP_TITLE
Search parameter: title
|
static String |
SP_TOPIC
Search parameter: topic
|
static String |
SP_TYPE
Search parameter: type
|
static String |
SP_URL
Search parameter: url
|
static String |
SP_VERSION
Search parameter: version
|
static ca.uhn.fhir.rest.gclient.TokenClientParam |
STATUS
Fluent Client search parameter constant for status
|
protected Type |
subject
A code or group definition that describes the intended subject of the plan definition.
|
protected StringType |
subtitle
An explanatory or alternate title for the plan definition giving additional information about its content.
|
static ca.uhn.fhir.rest.gclient.ReferenceClientParam |
SUCCESSOR
Fluent Client search parameter constant for successor
|
static ca.uhn.fhir.rest.gclient.StringClientParam |
TITLE
Fluent Client search parameter constant for title
|
protected List<CodeableConcept> |
topic
Descriptive topics related to the content of the plan definition.
|
static ca.uhn.fhir.rest.gclient.TokenClientParam |
TOPIC
Fluent Client search parameter constant for topic
|
protected CodeableConcept |
type
A high-level category for the plan definition that distinguishes the kinds of systems that would be interested in the plan definition.
|
static ca.uhn.fhir.rest.gclient.TokenClientParam |
TYPE
Fluent Client search parameter constant for type
|
static ca.uhn.fhir.rest.gclient.UriClientParam |
URL
Fluent Client search parameter constant for url
|
protected StringType |
usage
A detailed description of how the plan definition is used from a clinical perspective.
|
static ca.uhn.fhir.rest.gclient.TokenClientParam |
VERSION
Fluent Client search parameter constant for version
|
contact, date, description, experimental, jurisdiction, name, publisher, status, title, url, useContext, versioncontained, extension, modifierExtension, textid, implicitRules, language, meta| Constructor and Description |
|---|
PlanDefinition()
Constructor
|
PlanDefinition(Enumeration<Enumerations.PublicationStatus> status)
Constructor
|
copyValues, present, toStringaddContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setTextcopyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMetagetStructureFhirVersionEnum, isResource, setIdcastToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExpression, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPopulation, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINNclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitgetId, getIdElement, getLanguageElement, getUserData, setId, setUserDataprotected List<Identifier> identifier
protected StringType subtitle
protected CodeableConcept type
protected Type subject
protected MarkdownType purpose
protected StringType usage
protected MarkdownType copyright
protected DateType approvalDate
protected DateType lastReviewDate
protected Period effectivePeriod
protected List<CodeableConcept> topic
protected List<ContactDetail> author
protected List<ContactDetail> editor
protected List<ContactDetail> reviewer
protected List<ContactDetail> endorser
protected List<RelatedArtifact> relatedArtifact
protected List<CanonicalType> library
protected List<PlanDefinition.PlanDefinitionGoalComponent> goal
protected List<PlanDefinition.PlanDefinitionActionComponent> action
public static final String SP_DATE
Description: The plan definition publication date
Type: date
Path: PlanDefinition.date
public static final ca.uhn.fhir.rest.gclient.DateClientParam DATE
Description: The plan definition publication date
Type: date
Path: PlanDefinition.date
public static final String SP_IDENTIFIER
Description: External identifier for the plan definition
Type: token
Path: PlanDefinition.identifier
public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
Description: External identifier for the plan definition
Type: token
Path: PlanDefinition.identifier
public static final String SP_SUCCESSOR
Description: What resource is being referenced
Type: reference
Path: PlanDefinition.relatedArtifact.resource
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SUCCESSOR
Description: What resource is being referenced
Type: reference
Path: PlanDefinition.relatedArtifact.resource
public static final ca.uhn.fhir.model.api.Include INCLUDE_SUCCESSOR
public static final String SP_CONTEXT_TYPE_VALUE
Description: A use context type and value assigned to the plan definition
Type: composite
Path:
public static final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.TokenClientParam> CONTEXT_TYPE_VALUE
Description: A use context type and value assigned to the plan definition
Type: composite
Path:
public static final String SP_JURISDICTION
Description: Intended jurisdiction for the plan definition
Type: token
Path: PlanDefinition.jurisdiction
public static final ca.uhn.fhir.rest.gclient.TokenClientParam JURISDICTION
Description: Intended jurisdiction for the plan definition
Type: token
Path: PlanDefinition.jurisdiction
public static final String SP_DESCRIPTION
Description: The description of the plan definition
Type: string
Path: PlanDefinition.description
public static final ca.uhn.fhir.rest.gclient.StringClientParam DESCRIPTION
Description: The description of the plan definition
Type: string
Path: PlanDefinition.description
public static final String SP_DERIVED_FROM
Description: What resource is being referenced
Type: reference
Path: PlanDefinition.relatedArtifact.resource
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam DERIVED_FROM
Description: What resource is being referenced
Type: reference
Path: PlanDefinition.relatedArtifact.resource
public static final ca.uhn.fhir.model.api.Include INCLUDE_DERIVED_FROM
public static final String SP_CONTEXT_TYPE
Description: A type of use context assigned to the plan definition
Type: token
Path: PlanDefinition.useContext.code
public static final ca.uhn.fhir.rest.gclient.TokenClientParam CONTEXT_TYPE
Description: A type of use context assigned to the plan definition
Type: token
Path: PlanDefinition.useContext.code
public static final String SP_PREDECESSOR
Description: What resource is being referenced
Type: reference
Path: PlanDefinition.relatedArtifact.resource
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PREDECESSOR
Description: What resource is being referenced
Type: reference
Path: PlanDefinition.relatedArtifact.resource
public static final ca.uhn.fhir.model.api.Include INCLUDE_PREDECESSOR
public static final String SP_TITLE
Description: The human-friendly name of the plan definition
Type: string
Path: PlanDefinition.title
public static final ca.uhn.fhir.rest.gclient.StringClientParam TITLE
Description: The human-friendly name of the plan definition
Type: string
Path: PlanDefinition.title
public static final String SP_COMPOSED_OF
Description: What resource is being referenced
Type: reference
Path: PlanDefinition.relatedArtifact.resource
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam COMPOSED_OF
Description: What resource is being referenced
Type: reference
Path: PlanDefinition.relatedArtifact.resource
public static final ca.uhn.fhir.model.api.Include INCLUDE_COMPOSED_OF
public static final String SP_TYPE
Description: The type of artifact the plan (e.g. order-set, eca-rule, protocol)
Type: token
Path: PlanDefinition.type
public static final ca.uhn.fhir.rest.gclient.TokenClientParam TYPE
Description: The type of artifact the plan (e.g. order-set, eca-rule, protocol)
Type: token
Path: PlanDefinition.type
public static final String SP_VERSION
Description: The business version of the plan definition
Type: token
Path: PlanDefinition.version
public static final ca.uhn.fhir.rest.gclient.TokenClientParam VERSION
Description: The business version of the plan definition
Type: token
Path: PlanDefinition.version
public static final String SP_URL
Description: The uri that identifies the plan definition
Type: uri
Path: PlanDefinition.url
public static final ca.uhn.fhir.rest.gclient.UriClientParam URL
Description: The uri that identifies the plan definition
Type: uri
Path: PlanDefinition.url
public static final String SP_CONTEXT_QUANTITY
Description: A quantity- or range-valued use context assigned to the plan definition
Type: quantity
Path: PlanDefinition.useContext.valueQuantity, PlanDefinition.useContext.valueRange
public static final ca.uhn.fhir.rest.gclient.QuantityClientParam CONTEXT_QUANTITY
Description: A quantity- or range-valued use context assigned to the plan definition
Type: quantity
Path: PlanDefinition.useContext.valueQuantity, PlanDefinition.useContext.valueRange
public static final String SP_EFFECTIVE
Description: The time during which the plan definition is intended to be in use
Type: date
Path: PlanDefinition.effectivePeriod
public static final ca.uhn.fhir.rest.gclient.DateClientParam EFFECTIVE
Description: The time during which the plan definition is intended to be in use
Type: date
Path: PlanDefinition.effectivePeriod
public static final String SP_DEPENDS_ON
Description: What resource is being referenced
Type: reference
Path: PlanDefinition.relatedArtifact.resource, PlanDefinition.library
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam DEPENDS_ON
Description: What resource is being referenced
Type: reference
Path: PlanDefinition.relatedArtifact.resource, PlanDefinition.library
public static final ca.uhn.fhir.model.api.Include INCLUDE_DEPENDS_ON
public static final String SP_NAME
Description: Computationally friendly name of the plan definition
Type: string
Path: PlanDefinition.name
public static final ca.uhn.fhir.rest.gclient.StringClientParam NAME
Description: Computationally friendly name of the plan definition
Type: string
Path: PlanDefinition.name
public static final String SP_CONTEXT
Description: A use context assigned to the plan definition
Type: token
Path: PlanDefinition.useContext.valueCodeableConcept
public static final ca.uhn.fhir.rest.gclient.TokenClientParam CONTEXT
Description: A use context assigned to the plan definition
Type: token
Path: PlanDefinition.useContext.valueCodeableConcept
public static final String SP_PUBLISHER
Description: Name of the publisher of the plan definition
Type: string
Path: PlanDefinition.publisher
public static final ca.uhn.fhir.rest.gclient.StringClientParam PUBLISHER
Description: Name of the publisher of the plan definition
Type: string
Path: PlanDefinition.publisher
public static final String SP_TOPIC
Description: Topics associated with the module
Type: token
Path: PlanDefinition.topic
public static final ca.uhn.fhir.rest.gclient.TokenClientParam TOPIC
Description: Topics associated with the module
Type: token
Path: PlanDefinition.topic
public static final String SP_DEFINITION
Description: Activity or plan definitions used by plan definition
Type: reference
Path: PlanDefinition.action.definition[x]
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam DEFINITION
Description: Activity or plan definitions used by plan definition
Type: reference
Path: PlanDefinition.action.definition[x]
public static final ca.uhn.fhir.model.api.Include INCLUDE_DEFINITION
public static final String SP_CONTEXT_TYPE_QUANTITY
Description: A use context type and quantity- or range-based value assigned to the plan definition
Type: composite
Path:
public static final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.QuantityClientParam> CONTEXT_TYPE_QUANTITY
Description: A use context type and quantity- or range-based value assigned to the plan definition
Type: composite
Path:
public static final String SP_STATUS
Description: The current status of the plan definition
Type: token
Path: PlanDefinition.status
public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
Description: The current status of the plan definition
Type: token
Path: PlanDefinition.status
public PlanDefinition()
public PlanDefinition(Enumeration<Enumerations.PublicationStatus> status)
public UriType getUrlElement()
getUrlElement in class MetadataResourceMetadataResource.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 valuepublic boolean hasUrlElement()
hasUrlElement in class MetadataResourcepublic boolean hasUrl()
hasUrl in class MetadataResourcepublic PlanDefinition setUrlElement(UriType value)
setUrlElement in class MetadataResourcevalue - MetadataResource.url (An absolute URI that is used to identify this plan definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this plan definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the plan definition is stored on different servers.). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the valuepublic String getUrl()
getUrl in class MetadataResourcepublic PlanDefinition setUrl(String value)
setUrl in class MetadataResourcevalue - 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.public List<Identifier> getIdentifier()
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.)public PlanDefinition setIdentifier(List<Identifier> theIdentifier)
this for easy method chainingpublic boolean hasIdentifier()
public Identifier addIdentifier()
public PlanDefinition addIdentifier(Identifier t)
public Identifier getIdentifierFirstRep()
identifier, creating it if it does not already existpublic StringType getVersionElement()
getVersionElement in class MetadataResourceMetadataResource.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 valuepublic boolean hasVersionElement()
hasVersionElement in class MetadataResourcepublic boolean hasVersion()
hasVersion in class MetadataResourcepublic PlanDefinition setVersionElement(StringType value)
setVersionElement in class MetadataResourcevalue - 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 valuepublic String getVersion()
getVersion in class MetadataResourcepublic PlanDefinition setVersion(String value)
setVersion in class MetadataResourcevalue - 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.public StringType getNameElement()
getNameElement in class MetadataResourceMetadataResource.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 valuepublic boolean hasNameElement()
hasNameElement in class MetadataResourcepublic boolean hasName()
hasName in class MetadataResourcepublic PlanDefinition setNameElement(StringType value)
setNameElement in class MetadataResourcevalue - 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 valuepublic String getName()
getName in class MetadataResourcepublic PlanDefinition setName(String value)
setName in class MetadataResourcevalue - 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.public StringType getTitleElement()
getTitleElement in class MetadataResourceMetadataResource.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 valuepublic boolean hasTitleElement()
hasTitleElement in class MetadataResourcepublic boolean hasTitle()
hasTitle in class MetadataResourcepublic PlanDefinition setTitleElement(StringType value)
setTitleElement in class MetadataResourcevalue - 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 valuepublic String getTitle()
getTitle in class MetadataResourcepublic PlanDefinition setTitle(String value)
setTitle in class MetadataResourcevalue - A short, descriptive, user-friendly title for the plan definition.public StringType getSubtitleElement()
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 valuepublic boolean hasSubtitleElement()
public boolean hasSubtitle()
public PlanDefinition setSubtitleElement(StringType value)
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 valuepublic String getSubtitle()
public PlanDefinition setSubtitle(String value)
value - An explanatory or alternate title for the plan definition giving additional information about its content.public CodeableConcept getType()
type (A high-level category for the plan definition that distinguishes the kinds of systems that would be interested in the plan definition.)public boolean hasType()
public PlanDefinition setType(CodeableConcept value)
value - type (A high-level category for the plan definition that distinguishes the kinds of systems that would be interested in the plan definition.)public Enumeration<Enumerations.PublicationStatus> getStatusElement()
getStatusElement in class MetadataResourceMetadataResource.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 valuepublic boolean hasStatusElement()
hasStatusElement in class MetadataResourcepublic boolean hasStatus()
hasStatus in class MetadataResourcepublic PlanDefinition setStatusElement(Enumeration<Enumerations.PublicationStatus> value)
setStatusElement in class MetadataResourcevalue - 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 valuepublic Enumerations.PublicationStatus getStatus()
getStatus in class MetadataResourcepublic PlanDefinition setStatus(Enumerations.PublicationStatus value)
setStatus in class MetadataResourcevalue - The status of this plan definition. Enables tracking the life-cycle of the content.public BooleanType getExperimentalElement()
getExperimentalElement in class MetadataResourceMetadataResource.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 valuepublic boolean hasExperimentalElement()
hasExperimentalElement in class MetadataResourcepublic boolean hasExperimental()
hasExperimental in class MetadataResourcepublic PlanDefinition setExperimentalElement(BooleanType value)
setExperimentalElement in class MetadataResourcevalue - 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 valuepublic boolean getExperimental()
getExperimental in class MetadataResourcepublic PlanDefinition setExperimental(boolean value)
setExperimental in class MetadataResourcevalue - 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.public Type getSubject()
subject (A code or group definition that describes the intended subject of the plan definition.)public CodeableConcept getSubjectCodeableConcept() throws org.hl7.fhir.exceptions.FHIRException
subject (A code or group definition that describes the intended subject of the plan definition.)org.hl7.fhir.exceptions.FHIRExceptionpublic boolean hasSubjectCodeableConcept()
public Reference getSubjectReference() throws org.hl7.fhir.exceptions.FHIRException
subject (A code or group definition that describes the intended subject of the plan definition.)org.hl7.fhir.exceptions.FHIRExceptionpublic boolean hasSubjectReference()
public boolean hasSubject()
public PlanDefinition setSubject(Type value)
value - subject (A code or group definition that describes the intended subject of the plan definition.)public DateTimeType getDateElement()
getDateElement in class MetadataResourceMetadataResource.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 valuepublic boolean hasDateElement()
hasDateElement in class MetadataResourcepublic boolean hasDate()
hasDate in class MetadataResourcepublic PlanDefinition setDateElement(DateTimeType value)
setDateElement in class MetadataResourcevalue - MetadataResource.date (The date (and optionally time) when the plan definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the plan definition changes.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the valuepublic Date getDate()
getDate in class MetadataResourcepublic PlanDefinition setDate(Date value)
setDate in class MetadataResourcevalue - 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.public StringType getPublisherElement()
getPublisherElement in class MetadataResourceMetadataResource.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 valuepublic boolean hasPublisherElement()
hasPublisherElement in class MetadataResourcepublic boolean hasPublisher()
hasPublisher in class MetadataResourcepublic PlanDefinition setPublisherElement(StringType value)
setPublisherElement in class MetadataResourcevalue - MetadataResource.publisher (The name of the organization or individual that published the plan definition.). This is the underlying object with id, value and extensions. The accessor "getPublisher" gives direct access to the valuepublic String getPublisher()
getPublisher in class MetadataResourcepublic PlanDefinition setPublisher(String value)
setPublisher in class MetadataResourcevalue - The name of the organization or individual that published the plan definition.public List<ContactDetail> getContact()
getContact in class MetadataResourceMetadataResource.contact (Contact details to assist a user in finding and communicating with the publisher.)public PlanDefinition setContact(List<ContactDetail> theContact)
setContact in class MetadataResourcethis for easy method chainingpublic boolean hasContact()
hasContact in class MetadataResourcepublic ContactDetail addContact()
addContact in class MetadataResourcepublic PlanDefinition addContact(ContactDetail t)
addContact in class MetadataResourcepublic ContactDetail getContactFirstRep()
getContactFirstRep in class MetadataResourceMetadataResource.contact, creating it if it does not already existpublic MarkdownType getDescriptionElement()
getDescriptionElement in class MetadataResourceMetadataResource.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 valuepublic boolean hasDescriptionElement()
hasDescriptionElement in class MetadataResourcepublic boolean hasDescription()
hasDescription in class MetadataResourcepublic PlanDefinition setDescriptionElement(MarkdownType value)
setDescriptionElement in class MetadataResourcevalue - 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 valuepublic String getDescription()
getDescription in class MetadataResourcepublic PlanDefinition setDescription(String value)
setDescription in class MetadataResourcevalue - A free text natural language description of the plan definition from a consumer's perspective.public List<UsageContext> getUseContext()
getUseContext in class MetadataResourceMetadataResource.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.)public PlanDefinition setUseContext(List<UsageContext> theUseContext)
setUseContext in class MetadataResourcethis for easy method chainingpublic boolean hasUseContext()
hasUseContext in class MetadataResourcepublic UsageContext addUseContext()
addUseContext in class MetadataResourcepublic PlanDefinition addUseContext(UsageContext t)
addUseContext in class MetadataResourcepublic UsageContext getUseContextFirstRep()
getUseContextFirstRep in class MetadataResourceMetadataResource.useContext, creating it if it does not already existpublic List<CodeableConcept> getJurisdiction()
getJurisdiction in class MetadataResourceMetadataResource.jurisdiction (A legal or geographic region in which the plan definition is intended to be used.)public PlanDefinition setJurisdiction(List<CodeableConcept> theJurisdiction)
setJurisdiction in class MetadataResourcethis for easy method chainingpublic boolean hasJurisdiction()
hasJurisdiction in class MetadataResourcepublic CodeableConcept addJurisdiction()
addJurisdiction in class MetadataResourcepublic PlanDefinition addJurisdiction(CodeableConcept t)
addJurisdiction in class MetadataResourcepublic CodeableConcept getJurisdictionFirstRep()
getJurisdictionFirstRep in class MetadataResourceMetadataResource.jurisdiction, creating it if it does not already existpublic MarkdownType getPurposeElement()
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 valuepublic boolean hasPurposeElement()
public boolean hasPurpose()
public PlanDefinition setPurposeElement(MarkdownType value)
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 valuepublic String getPurpose()
public PlanDefinition setPurpose(String value)
value - Explanation of why this plan definition is needed and why it has been designed as it has.public StringType getUsageElement()
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 valuepublic boolean hasUsageElement()
public boolean hasUsage()
public PlanDefinition setUsageElement(StringType value)
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 valuepublic String getUsage()
public PlanDefinition setUsage(String value)
value - A detailed description of how the plan definition is used from a clinical perspective.public MarkdownType getCopyrightElement()
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 valuepublic boolean hasCopyrightElement()
public boolean hasCopyright()
public PlanDefinition setCopyrightElement(MarkdownType value)
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 valuepublic String getCopyright()
public PlanDefinition setCopyright(String value)
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.public DateType getApprovalDateElement()
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 valuepublic boolean hasApprovalDateElement()
public boolean hasApprovalDate()
public PlanDefinition setApprovalDateElement(DateType value)
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 valuepublic Date getApprovalDate()
public PlanDefinition setApprovalDate(Date value)
value - The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.public DateType getLastReviewDateElement()
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 valuepublic boolean hasLastReviewDateElement()
public boolean hasLastReviewDate()
public PlanDefinition setLastReviewDateElement(DateType value)
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 valuepublic Date getLastReviewDate()
public PlanDefinition setLastReviewDate(Date value)
value - The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.public Period getEffectivePeriod()
effectivePeriod (The period during which the plan definition content was or is planned to be in active use.)public boolean hasEffectivePeriod()
public PlanDefinition setEffectivePeriod(Period value)
value - effectivePeriod (The period during which the plan definition content was or is planned to be in active use.)public List<CodeableConcept> getTopic()
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.)public PlanDefinition setTopic(List<CodeableConcept> theTopic)
this for easy method chainingpublic boolean hasTopic()
public CodeableConcept addTopic()
public PlanDefinition addTopic(CodeableConcept t)
public CodeableConcept getTopicFirstRep()
topic, creating it if it does not already existpublic List<ContactDetail> getAuthor()
author (An individiual or organization primarily involved in the creation and maintenance of the content.)public PlanDefinition setAuthor(List<ContactDetail> theAuthor)
this for easy method chainingpublic boolean hasAuthor()
public ContactDetail addAuthor()
public PlanDefinition addAuthor(ContactDetail t)
public ContactDetail getAuthorFirstRep()
author, creating it if it does not already existpublic List<ContactDetail> getEditor()
editor (An individual or organization primarily responsible for internal coherence of the content.)public PlanDefinition setEditor(List<ContactDetail> theEditor)
this for easy method chainingpublic boolean hasEditor()
public ContactDetail addEditor()
public PlanDefinition addEditor(ContactDetail t)
public ContactDetail getEditorFirstRep()
editor, creating it if it does not already existpublic List<ContactDetail> getReviewer()
reviewer (An individual or organization primarily responsible for review of some aspect of the content.)public PlanDefinition setReviewer(List<ContactDetail> theReviewer)
this for easy method chainingpublic boolean hasReviewer()
public ContactDetail addReviewer()
public PlanDefinition addReviewer(ContactDetail t)
public ContactDetail getReviewerFirstRep()
reviewer, creating it if it does not already existpublic List<ContactDetail> getEndorser()
endorser (An individual or organization responsible for officially endorsing the content for use in some setting.)public PlanDefinition setEndorser(List<ContactDetail> theEndorser)
this for easy method chainingpublic boolean hasEndorser()
public ContactDetail addEndorser()
public PlanDefinition addEndorser(ContactDetail t)
public ContactDetail getEndorserFirstRep()
endorser, creating it if it does not already existpublic List<RelatedArtifact> getRelatedArtifact()
relatedArtifact (Related artifacts such as additional documentation, justification, or bibliographic references.)public PlanDefinition setRelatedArtifact(List<RelatedArtifact> theRelatedArtifact)
this for easy method chainingpublic boolean hasRelatedArtifact()
public RelatedArtifact addRelatedArtifact()
public PlanDefinition addRelatedArtifact(RelatedArtifact t)
public RelatedArtifact getRelatedArtifactFirstRep()
relatedArtifact, creating it if it does not already existpublic List<CanonicalType> getLibrary()
library (A reference to a Library resource containing any formal logic used by the plan definition.)public PlanDefinition setLibrary(List<CanonicalType> theLibrary)
this for easy method chainingpublic boolean hasLibrary()
public CanonicalType addLibraryElement()
library (A reference to a Library resource containing any formal logic used by the plan definition.)public PlanDefinition addLibrary(String value)
value - library (A reference to a Library resource containing any formal logic used by the plan definition.)public boolean hasLibrary(String value)
value - library (A reference to a Library resource containing any formal logic used by the plan definition.)public List<PlanDefinition.PlanDefinitionGoalComponent> getGoal()
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.)public PlanDefinition setGoal(List<PlanDefinition.PlanDefinitionGoalComponent> theGoal)
this for easy method chainingpublic boolean hasGoal()
public PlanDefinition.PlanDefinitionGoalComponent addGoal()
public PlanDefinition addGoal(PlanDefinition.PlanDefinitionGoalComponent t)
public PlanDefinition.PlanDefinitionGoalComponent getGoalFirstRep()
goal, creating it if it does not already existpublic List<PlanDefinition.PlanDefinitionActionComponent> getAction()
action (An action or group of actions to be taken as part of the plan.)public PlanDefinition setAction(List<PlanDefinition.PlanDefinitionActionComponent> theAction)
this for easy method chainingpublic boolean hasAction()
public PlanDefinition.PlanDefinitionActionComponent addAction()
public PlanDefinition addAction(PlanDefinition.PlanDefinitionActionComponent t)
public PlanDefinition.PlanDefinitionActionComponent getActionFirstRep()
action, creating it if it does not already existprotected void listChildren(List<Property> children)
listChildren in class MetadataResourcepublic Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
getNamedProperty in class DomainResourceorg.hl7.fhir.exceptions.FHIRExceptionpublic Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
getProperty in class MetadataResourceorg.hl7.fhir.exceptions.FHIRExceptionpublic Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
setProperty in class MetadataResourceorg.hl7.fhir.exceptions.FHIRExceptionpublic Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
setProperty in class MetadataResourceorg.hl7.fhir.exceptions.FHIRExceptionpublic Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
makeProperty in class MetadataResourceorg.hl7.fhir.exceptions.FHIRExceptionpublic String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
getTypesForProperty in class MetadataResourceorg.hl7.fhir.exceptions.FHIRExceptionpublic Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
addChild in class MetadataResourceorg.hl7.fhir.exceptions.FHIRExceptionpublic String fhirType()
fhirType in interface org.hl7.fhir.instance.model.api.IBasefhirType in class MetadataResourcepublic PlanDefinition copy()
copy in class MetadataResourcepublic void copyValues(PlanDefinition dst)
protected PlanDefinition typedCopy()
public boolean equalsDeep(Base other_)
equalsDeep in class MetadataResourcepublic boolean equalsShallow(Base other_)
equalsShallow in class MetadataResourcepublic boolean isEmpty()
isEmpty in interface org.hl7.fhir.instance.model.api.IBaseisEmpty in class MetadataResourcepublic ResourceType getResourceType()
getResourceType in class ResourceCopyright © 2014–2021 Health Level 7. All rights reserved.