public class Goal extends DomainResource
| Modifier and Type | Class and Description |
|---|---|
static class |
Goal.GoalOutcomeComponent |
static class |
Goal.GoalStatus |
static class |
Goal.GoalStatusEnumFactory |
| Modifier and Type | Field and Description |
|---|---|
protected List<Reference> |
addresses
The identified conditions and other health record elements that are intended to be addressed by the goal.
|
protected List<Resource> |
addressesTarget
The actual objects that are the target of the reference (The identified conditions and other health record elements that are intended to be addressed by the goal.)
|
protected Reference |
author
Indicates whose goal this is - patient goal, practitioner goal, etc.
|
protected Resource |
authorTarget
The actual object that is the target of the reference (Indicates whose goal this is - patient goal, practitioner goal, etc.)
|
protected List<CodeableConcept> |
category
Indicates a category the goal falls within.
|
static ca.uhn.fhir.rest.gclient.TokenClientParam |
CATEGORY
Fluent Client search parameter constant for category
|
protected StringType |
description
Human-readable description of a specific desired objective of care.
|
protected List<Identifier> |
identifier
This records identifiers associated with this care plan that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g.
|
static ca.uhn.fhir.rest.gclient.TokenClientParam |
IDENTIFIER
Fluent Client search parameter constant for identifier
|
static ca.uhn.fhir.model.api.Include |
INCLUDE_PATIENT
Constant for fluent queries to be used to add include statements.
|
static ca.uhn.fhir.model.api.Include |
INCLUDE_SUBJECT
Constant for fluent queries to be used to add include statements.
|
protected List<Annotation> |
note
Any comments related to the goal.
|
protected List<Goal.GoalOutcomeComponent> |
outcome
Identifies the change (or lack of change) at the point where the goal was deepmed to be cancelled or achieved.
|
static ca.uhn.fhir.rest.gclient.ReferenceClientParam |
PATIENT
Fluent Client search parameter constant for patient
|
protected CodeableConcept |
priority
Identifies the mutually agreed level of importance associated with reaching/sustaining the goal.
|
static String |
SP_CATEGORY
Search parameter: category
|
static String |
SP_IDENTIFIER
Search parameter: identifier
|
static String |
SP_PATIENT
Search parameter: patient
|
static String |
SP_STATUS
Search parameter: status
|
static String |
SP_SUBJECT
Search parameter: subject
|
static String |
SP_TARGETDATE
Search parameter: targetdate
|
protected Type |
start
The date or event after which the goal should begin being pursued.
|
protected Enumeration<Goal.GoalStatus> |
status
Indicates whether the goal has been reached and is still considered relevant.
|
static ca.uhn.fhir.rest.gclient.TokenClientParam |
STATUS
Fluent Client search parameter constant for status
|
protected DateType |
statusDate
Identifies when the current status.
|
protected CodeableConcept |
statusReason
Captures the reason for the current status.
|
protected Reference |
subject
Identifies the patient, group or organization for whom the goal is being established.
|
static ca.uhn.fhir.rest.gclient.ReferenceClientParam |
SUBJECT
Fluent Client search parameter constant for subject
|
protected Resource |
subjectTarget
The actual object that is the target of the reference (Identifies the patient, group or organization for whom the goal is being established.)
|
protected Type |
target
Indicates either the date or the duration after start by which the goal should be met.
|
static ca.uhn.fhir.rest.gclient.DateClientParam |
TARGETDATE
Fluent Client search parameter constant for targetdate
|
contained, extension, modifierExtension, textid, implicitRules, language, meta| Constructor and Description |
|---|
Goal()
Constructor
|
Goal(StringType description,
Enumeration<Goal.GoalStatus> status)
Constructor
|
addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasModifierExtension, hasText, setTextcopyValues, getId, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMetagetStructureFhirVersionEnum, setIdcastToActionDefinition, castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToModuleMetadata, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToUnsignedInt, castToUri, children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINNclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitgetId, getIdElement, getLanguageElement, getUserData, setId, setUserDataprotected List<Identifier> identifier
protected Reference subject
protected Resource subjectTarget
protected Type target
protected List<CodeableConcept> category
protected StringType description
protected Enumeration<Goal.GoalStatus> status
protected DateType statusDate
protected CodeableConcept statusReason
protected Reference author
protected Resource authorTarget
protected CodeableConcept priority
protected List<Reference> addresses
protected List<Resource> addressesTarget
protected List<Annotation> note
protected List<Goal.GoalOutcomeComponent> outcome
public static final String SP_TARGETDATE
Description: Reach goal on or before
Type: date
Path: Goal.targetDate
public static final ca.uhn.fhir.rest.gclient.DateClientParam TARGETDATE
Description: Reach goal on or before
Type: date
Path: Goal.targetDate
public static final String SP_CATEGORY
Description: E.g. Treatment, dietary, behavioral, etc.
Type: token
Path: Goal.category
public static final ca.uhn.fhir.rest.gclient.TokenClientParam CATEGORY
Description: E.g. Treatment, dietary, behavioral, etc.
Type: token
Path: Goal.category
public static final String SP_PATIENT
Description: Who this goal is intended for
Type: reference
Path: Goal.subject
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PATIENT
Description: Who this goal is intended for
Type: reference
Path: Goal.subject
public static final ca.uhn.fhir.model.api.Include INCLUDE_PATIENT
public static final String SP_STATUS
Description: proposed | planned | accepted | rejected | in-progress | achieved | sustaining | on-hold | cancelled
Type: token
Path: Goal.status
public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
Description: proposed | planned | accepted | rejected | in-progress | achieved | sustaining | on-hold | cancelled
Type: token
Path: Goal.status
public static final String SP_SUBJECT
Description: Who this goal is intended for
Type: reference
Path: Goal.subject
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SUBJECT
Description: Who this goal is intended for
Type: reference
Path: Goal.subject
public static final ca.uhn.fhir.model.api.Include INCLUDE_SUBJECT
public static final String SP_IDENTIFIER
Description: External Ids for this goal
Type: token
Path: Goal.identifier
public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
Description: External Ids for this goal
Type: token
Path: Goal.identifier
public Goal()
public Goal(StringType description, Enumeration<Goal.GoalStatus> status)
public List<Identifier> getIdentifier()
identifier (This records identifiers associated with this care plan that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).)public boolean hasIdentifier()
public Identifier addIdentifier()
identifier (This records identifiers associated with this care plan that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).)public Goal addIdentifier(Identifier t)
public Reference getSubject()
subject (Identifies the patient, group or organization for whom the goal is being established.)public boolean hasSubject()
public Goal setSubject(Reference value)
value - subject (Identifies the patient, group or organization for whom the goal is being established.)public Resource getSubjectTarget()
subject The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (Identifies the patient, group or organization for whom the goal is being established.)public Goal setSubjectTarget(Resource value)
value - subject The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (Identifies the patient, group or organization for whom the goal is being established.)public Type getStart()
start (The date or event after which the goal should begin being pursued.)public DateType getStartDateType() throws org.hl7.fhir.exceptions.FHIRException
start (The date or event after which the goal should begin being pursued.)org.hl7.fhir.exceptions.FHIRExceptionpublic boolean hasStartDateType()
public CodeableConcept getStartCodeableConcept() throws org.hl7.fhir.exceptions.FHIRException
start (The date or event after which the goal should begin being pursued.)org.hl7.fhir.exceptions.FHIRExceptionpublic boolean hasStartCodeableConcept()
public boolean hasStart()
public Goal setStart(Type value)
value - start (The date or event after which the goal should begin being pursued.)public Type getTarget()
target (Indicates either the date or the duration after start by which the goal should be met.)public DateType getTargetDateType() throws org.hl7.fhir.exceptions.FHIRException
target (Indicates either the date or the duration after start by which the goal should be met.)org.hl7.fhir.exceptions.FHIRExceptionpublic boolean hasTargetDateType()
public Duration getTargetDuration() throws org.hl7.fhir.exceptions.FHIRException
target (Indicates either the date or the duration after start by which the goal should be met.)org.hl7.fhir.exceptions.FHIRExceptionpublic boolean hasTargetDuration()
public boolean hasTarget()
public Goal setTarget(Type value)
value - target (Indicates either the date or the duration after start by which the goal should be met.)public List<CodeableConcept> getCategory()
category (Indicates a category the goal falls within.)public boolean hasCategory()
public CodeableConcept addCategory()
category (Indicates a category the goal falls within.)public Goal addCategory(CodeableConcept t)
public StringType getDescriptionElement()
description (Human-readable description of a specific desired objective of care.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the valuepublic boolean hasDescriptionElement()
public boolean hasDescription()
public Goal setDescriptionElement(StringType value)
value - description (Human-readable description of a specific desired objective of care.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the valuepublic String getDescription()
public Goal setDescription(String value)
value - Human-readable description of a specific desired objective of care.public Enumeration<Goal.GoalStatus> getStatusElement()
status (Indicates whether the goal has been reached and is still considered relevant.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the valuepublic boolean hasStatusElement()
public boolean hasStatus()
public Goal setStatusElement(Enumeration<Goal.GoalStatus> value)
value - status (Indicates whether the goal has been reached and is still considered relevant.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the valuepublic Goal.GoalStatus getStatus()
public Goal setStatus(Goal.GoalStatus value)
value - Indicates whether the goal has been reached and is still considered relevant.public DateType getStatusDateElement()
statusDate (Identifies when the current status. I.e. When initially created, when achieved, when cancelled, etc.). This is the underlying object with id, value and extensions. The accessor "getStatusDate" gives direct access to the valuepublic boolean hasStatusDateElement()
public boolean hasStatusDate()
public Goal setStatusDateElement(DateType value)
value - statusDate (Identifies when the current status. I.e. When initially created, when achieved, when cancelled, etc.). This is the underlying object with id, value and extensions. The accessor "getStatusDate" gives direct access to the valuepublic Date getStatusDate()
public Goal setStatusDate(Date value)
value - Identifies when the current status. I.e. When initially created, when achieved, when cancelled, etc.public CodeableConcept getStatusReason()
statusReason (Captures the reason for the current status.)public boolean hasStatusReason()
public Goal setStatusReason(CodeableConcept value)
value - statusReason (Captures the reason for the current status.)public Reference getAuthor()
author (Indicates whose goal this is - patient goal, practitioner goal, etc.)public boolean hasAuthor()
public Goal setAuthor(Reference value)
value - author (Indicates whose goal this is - patient goal, practitioner goal, etc.)public Resource getAuthorTarget()
author The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (Indicates whose goal this is - patient goal, practitioner goal, etc.)public Goal setAuthorTarget(Resource value)
value - author The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (Indicates whose goal this is - patient goal, practitioner goal, etc.)public CodeableConcept getPriority()
priority (Identifies the mutually agreed level of importance associated with reaching/sustaining the goal.)public boolean hasPriority()
public Goal setPriority(CodeableConcept value)
value - priority (Identifies the mutually agreed level of importance associated with reaching/sustaining the goal.)public List<Reference> getAddresses()
addresses (The identified conditions and other health record elements that are intended to be addressed by the goal.)public boolean hasAddresses()
public Reference addAddresses()
addresses (The identified conditions and other health record elements that are intended to be addressed by the goal.)public Goal addAddresses(Reference t)
public List<Resource> getAddressesTarget()
addresses (The actual objects that are the target of the reference. The reference library doesn't populate this, but you can use this to hold the resources if you resolvethemt. The identified conditions and other health record elements that are intended to be addressed by the goal.)public List<Annotation> getNote()
note (Any comments related to the goal.)public boolean hasNote()
public Annotation addNote()
note (Any comments related to the goal.)public Goal addNote(Annotation t)
public List<Goal.GoalOutcomeComponent> getOutcome()
outcome (Identifies the change (or lack of change) at the point where the goal was deepmed to be cancelled or achieved.)public boolean hasOutcome()
public Goal.GoalOutcomeComponent addOutcome()
outcome (Identifies the change (or lack of change) at the point where the goal was deepmed to be cancelled or achieved.)public Goal addOutcome(Goal.GoalOutcomeComponent t)
protected void listChildren(List<Property> childrenList)
listChildren in class DomainResourcepublic Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
getProperty in class DomainResourceorg.hl7.fhir.exceptions.FHIRExceptionpublic void setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
setProperty in class DomainResourceorg.hl7.fhir.exceptions.FHIRExceptionpublic void setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
setProperty in class DomainResourceorg.hl7.fhir.exceptions.FHIRExceptionpublic Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
makeProperty in class DomainResourceorg.hl7.fhir.exceptions.FHIRExceptionpublic Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
addChild in class DomainResourceorg.hl7.fhir.exceptions.FHIRExceptionpublic String fhirType()
fhirType in class DomainResourcepublic Goal copy()
copy in class DomainResourcepublic boolean equalsDeep(Base other)
equalsDeep in class DomainResourcepublic boolean equalsShallow(Base other)
equalsShallow in class DomainResourcepublic boolean isEmpty()
isEmpty in interface org.hl7.fhir.instance.model.api.IBaseisEmpty in class DomainResourcepublic ResourceType getResourceType()
getResourceType in class ResourceCopyright © 2014–2018 University Health Network. All rights reserved.