Package org.hl7.fhir.r5.model

Class PlanDefinition.PlanDefinitionGoalComponent

java.lang.Object

org.hl7.fhir.r5.model.Base

org.hl7.fhir.r5.model.Element

org.hl7.fhir.r5.model.BackboneElement

org.hl7.fhir.r5.model.PlanDefinition.PlanDefinitionGoalComponent

All Implemented Interfaces:

ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseBackboneElement, org.hl7.fhir.instance.model.api.IBaseElement, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions

Enclosing class:

PlanDefinition

public static class PlanDefinition.PlanDefinitionGoalComponent
extends BackboneElement
implements org.hl7.fhir.instance.model.api.IBaseBackboneElement

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.hl7.fhir.r5.model.Base

Base.ProfileSource, Base.ValidationInfo, Base.ValidationMode, Base.ValidationReason

Field Summary

Fields

Modifier and Type	Field	Description
protected List<CodeableConcept>	addresses	Identifies problems, conditions, issues, or concerns the goal is intended to address.
protected CodeableConcept	category	Indicates a category the goal falls within.
protected CodeableConcept	description	Human-readable and/or coded description of a specific desired objective of care, such as "control blood pressure" or "negotiate an obstacle course" or "dance with child at wedding".
protected List<RelatedArtifact>	documentation	Didactic or other informational resources associated with the goal that provide further supporting information about the goal.
protected CodeableConcept	priority	Identifies the expected level of importance associated with reaching/sustaining the defined goal.
protected CodeableConcept	start	The event after which the goal should begin being pursued.
protected List<PlanDefinition.PlanDefinitionGoalTargetComponent>	target	Indicates what should be done and within what timeframe.

Fields inherited from class org.hl7.fhir.r5.model.BackboneElement

modifierExtension

Fields inherited from class org.hl7.fhir.r5.model.Element

extension, id

Constructor Summary

Constructors

Constructor	Description
PlanDefinitionGoalComponent()	Constructor
PlanDefinitionGoalComponent(CodeableConcept description)	Constructor

Method Summary

Modifier and Type	Method	Description
CodeableConcept	addAddresses()
PlanDefinition.PlanDefinitionGoalComponent	addAddresses(CodeableConcept t)
Base	addChild(String name)
RelatedArtifact	addDocumentation()
PlanDefinition.PlanDefinitionGoalComponent	addDocumentation(RelatedArtifact t)
PlanDefinition.PlanDefinitionGoalTargetComponent	addTarget()
PlanDefinition.PlanDefinitionGoalComponent	addTarget(PlanDefinition.PlanDefinitionGoalTargetComponent t)
PlanDefinition.PlanDefinitionGoalComponent	copy()
void	copyValues(PlanDefinition.PlanDefinitionGoalComponent dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
List<CodeableConcept>	getAddresses()
CodeableConcept	getAddressesFirstRep()
CodeableConcept	getCategory()
CodeableConcept	getDescription()
List<RelatedArtifact>	getDocumentation()
RelatedArtifact	getDocumentationFirstRep()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
CodeableConcept	getPriority()
Base[]	getProperty(int hash, String name, boolean checkValid)
CodeableConcept	getStart()
List<PlanDefinition.PlanDefinitionGoalTargetComponent>	getTarget()
PlanDefinition.PlanDefinitionGoalTargetComponent	getTargetFirstRep()
String[]	getTypesForProperty(int hash, String name)
boolean	hasAddresses()
boolean	hasCategory()
boolean	hasDescription()
boolean	hasDocumentation()
boolean	hasPriority()
boolean	hasStart()
boolean	hasTarget()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
void	removeChild(String name, Base value)
PlanDefinition.PlanDefinitionGoalComponent	setAddresses(List<CodeableConcept> theAddresses)
PlanDefinition.PlanDefinitionGoalComponent	setCategory(CodeableConcept value)
PlanDefinition.PlanDefinitionGoalComponent	setDescription(CodeableConcept value)
PlanDefinition.PlanDefinitionGoalComponent	setDocumentation(List<RelatedArtifact> theDocumentation)
PlanDefinition.PlanDefinitionGoalComponent	setPriority(CodeableConcept value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
PlanDefinition.PlanDefinitionGoalComponent	setStart(CodeableConcept value)
PlanDefinition.PlanDefinitionGoalComponent	setTarget(List<PlanDefinition.PlanDefinitionGoalTargetComponent> theTarget)

Methods inherited from class org.hl7.fhir.r5.model.BackboneElement

addModifierExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyExtensions, copyNewExtensions, copyValues, getExtensionByUrl, getExtensionsByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionFirstRep, hasExtension, hasExtension, hasModifierExtension, removeExtension, setModifierExtension

Methods inherited from class org.hl7.fhir.r5.model.Element

addExtension, addExtension, addExtension, copyExtensions, copyNewExtensions, copyValues, getExtension, getExtensionFirstRep, getExtensionString, getExtensionString, getFHIRPublicationVersion, getId, getIdBase, getIdElement, getStandardsStatus, hasExtension, hasExtension, hasId, hasIdElement, isDisallowExtensions, noExtensions, setDisallowExtensions, setExtension, setId, setIdBase, setIdElement, setStandardsStatus

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

addDefinition, addFormatCommentsPost, addFormatCommentsPre, addValidationMessage, canHavePrimitiveValue, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyFormatComments, copyUserData, copyValues, dateTimeValue, equals, getChildByName, getChildValueByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getValidationInfo, getValidationMessages, getXhtml, hasFormatComment, hasFormatCommentPost, hasFormatCommentPre, hasPrimitiveValue, hasType, hasUserData, hasValidated, hasValidationInfo, hasValidationMessages, isBooleanPrimitive, isCopyUserData, isDateTime, isMetadataBased, isPrimitive, isResource, listChildrenByName, listChildrenByName, primitiveValue, setCopyUserData, setUserData, setUserDataINN

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getFormatCommentsPost, getFormatCommentsPre, getUserData, hasFormatComment, setUserData

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

getUserData, setUserData

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

addExtension, getExtension, hasExtension

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

addModifierExtension, getModifierExtension, hasModifierExtension

Field Details

category

protected CodeableConcept category

Indicates a category the goal falls within.

description

protected CodeableConcept description

Human-readable and/or coded description of a specific desired objective of care, such as "control blood pressure" or "negotiate an obstacle course" or "dance with child at wedding".

priority

protected CodeableConcept priority

Identifies the expected level of importance associated with reaching/sustaining the defined goal.

start

protected CodeableConcept start

The event after which the goal should begin being pursued.

addresses

protected List<CodeableConcept> addresses

Identifies problems, conditions, issues, or concerns the goal is intended to address.

documentation

protected List<RelatedArtifact> documentation

Didactic or other informational resources associated with the goal that provide further supporting information about the goal. Information resources can include inline text commentary and links to web resources.

target

protected List<PlanDefinition.PlanDefinitionGoalTargetComponent> target

Indicates what should be done and within what timeframe.

Constructor Details

PlanDefinitionGoalComponent

public PlanDefinitionGoalComponent()

Constructor

PlanDefinitionGoalComponent

public PlanDefinitionGoalComponent(CodeableConcept description)

Constructor

Method Details

getCategory

public CodeableConcept getCategory()

Returns:

category (Indicates a category the goal falls within.)

hasCategory

public boolean hasCategory()

setCategory

public PlanDefinition.PlanDefinitionGoalComponent setCategory(CodeableConcept value)

Parameters:

value - category (Indicates a category the goal falls within.)

getDescription

public CodeableConcept getDescription()

Returns:

description (Human-readable and/or coded description of a specific desired objective of care, such as "control blood pressure" or "negotiate an obstacle course" or "dance with child at wedding".)

hasDescription

public boolean hasDescription()

setDescription

public PlanDefinition.PlanDefinitionGoalComponent setDescription(CodeableConcept value)

Parameters:

value - description (Human-readable and/or coded description of a specific desired objective of care, such as "control blood pressure" or "negotiate an obstacle course" or "dance with child at wedding".)

getPriority

public CodeableConcept getPriority()

Returns:

priority (Identifies the expected level of importance associated with reaching/sustaining the defined goal.)

hasPriority

public boolean hasPriority()

setPriority

public PlanDefinition.PlanDefinitionGoalComponent setPriority(CodeableConcept value)

Parameters:

value - priority (Identifies the expected level of importance associated with reaching/sustaining the defined goal.)

getStart

public CodeableConcept getStart()

Returns:

start (The event after which the goal should begin being pursued.)

hasStart

public boolean hasStart()

setStart

public PlanDefinition.PlanDefinitionGoalComponent setStart(CodeableConcept value)

Parameters:

value - start (The event after which the goal should begin being pursued.)

getAddresses

public List<CodeableConcept> getAddresses()

Returns:

addresses (Identifies problems, conditions, issues, or concerns the goal is intended to address.)

setAddresses

public PlanDefinition.PlanDefinitionGoalComponent setAddresses(List<CodeableConcept> theAddresses)

Returns:

Returns a reference to this for easy method chaining

hasAddresses

public boolean hasAddresses()

addAddresses

public CodeableConcept addAddresses()

addAddresses

public PlanDefinition.PlanDefinitionGoalComponent addAddresses(CodeableConcept t)

getAddressesFirstRep

public CodeableConcept getAddressesFirstRep()

Returns:

The first repetition of repeating field addresses, creating it if it does not already exist {3}

getDocumentation

public List<RelatedArtifact> getDocumentation()

Returns:

documentation (Didactic or other informational resources associated with the goal that provide further supporting information about the goal. Information resources can include inline text commentary and links to web resources.)

setDocumentation

public PlanDefinition.PlanDefinitionGoalComponent setDocumentation(List<RelatedArtifact> theDocumentation)

Returns:

Returns a reference to this for easy method chaining

hasDocumentation

public boolean hasDocumentation()

addDocumentation

public RelatedArtifact addDocumentation()

addDocumentation

public PlanDefinition.PlanDefinitionGoalComponent addDocumentation(RelatedArtifact t)

getDocumentationFirstRep

public RelatedArtifact getDocumentationFirstRep()

Returns:

The first repetition of repeating field documentation, creating it if it does not already exist {3}

getTarget

public List<PlanDefinition.PlanDefinitionGoalTargetComponent> getTarget()

Returns:

target (Indicates what should be done and within what timeframe.)

setTarget

public PlanDefinition.PlanDefinitionGoalComponent setTarget(List<PlanDefinition.PlanDefinitionGoalTargetComponent> theTarget)

Returns:

Returns a reference to this for easy method chaining

hasTarget

public boolean hasTarget()

addTarget

public PlanDefinition.PlanDefinitionGoalTargetComponent addTarget()

addTarget

public PlanDefinition.PlanDefinitionGoalComponent addTarget(PlanDefinition.PlanDefinitionGoalTargetComponent t)

getTargetFirstRep

public PlanDefinition.PlanDefinitionGoalTargetComponent getTargetFirstRep()

Returns:

The first repetition of repeating field target, creating it if it does not already exist {3}

listChildren

protected void listChildren(List<Property> children)

Overrides:

listChildren in class BackboneElement

getNamedProperty

public Property getNamedProperty(int _hash,
 String _name,
 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getNamedProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

getProperty

public Base[] getProperty(int hash,
 String name,
 boolean checkValid)
                   throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(int hash,
 String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

removeChild

public void removeChild(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

removeChild in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

public Base makeProperty(int hash,
 String name)
                  throws org.hl7.fhir.exceptions.FHIRException

Overrides:

makeProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

getTypesForProperty

public String[] getTypesForProperty(int hash,
 String name)
                             throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getTypesForProperty in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException

Overrides:

addChild in class BackboneElement

Throws:

org.hl7.fhir.exceptions.FHIRException

copy

public PlanDefinition.PlanDefinitionGoalComponent copy()

Specified by:

copy in class BackboneElement

copyValues

public void copyValues(PlanDefinition.PlanDefinitionGoalComponent dst)

equalsDeep

public boolean equalsDeep(Base other_)

Overrides:

equalsDeep in class BackboneElement

equalsShallow

public boolean equalsShallow(Base other_)

Overrides:

equalsShallow in class BackboneElement

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

isEmpty in class BackboneElement

fhirType

public String fhirType()

Specified by:

fhirType in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

fhirType in class BackboneElement

Returns:

the FHIR type name of the instance (not the java class name)