Package org.hl7.fhir.dstu3.model

Class ActivityDefinition

java.lang.Object

org.hl7.fhir.dstu3.model.Base

org.hl7.fhir.dstu3.model.BaseResource

org.hl7.fhir.dstu3.model.Resource

org.hl7.fhir.dstu3.model.DomainResource

org.hl7.fhir.dstu3.model.MetadataResource

org.hl7.fhir.dstu3.model.ActivityDefinition

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 ActivityDefinition
extends MetadataResource

This resource allows for the definition of some activity to be performed, independent of a particular patient, practitioner, or other performance context.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ActivityDefinition.ActivityDefinitionDynamicValueComponent
static enum	ActivityDefinition.ActivityDefinitionKind
static class	ActivityDefinition.ActivityDefinitionKindEnumFactory
static class	ActivityDefinition.ActivityDefinitionParticipantComponent
static enum	ActivityDefinition.ActivityParticipantType
static class	ActivityDefinition.ActivityParticipantTypeEnumFactory

Field Summary

Fields

Modifier and Type	Field	Description
protected DateType	approvalDate	The date on which the resource content was approved by the publisher.
protected List<CodeableConcept>	bodySite	Indicates the sites on the subject's body where the procedure should be performed (I.e.
protected CodeableConcept	code	Detailed description of the type of activity; e.g.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	COMPOSED_OF	Fluent Client search parameter constant for composed-of
protected 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 activity definition and/or its contents.
static final ca.uhn.fhir.rest.gclient.DateClientParam	DATE	Fluent Client search parameter constant for date
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	DEPENDS_ON	Fluent Client search parameter constant for depends-on
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	DERIVED_FROM	Fluent Client search parameter constant for derived-from
static final ca.uhn.fhir.rest.gclient.StringClientParam	DESCRIPTION	Fluent Client search parameter constant for description
protected List<Dosage>	dosage	Provides detailed dosage instructions in the same way that they are described for MedicationRequest resources.
protected List<ActivityDefinition.ActivityDefinitionDynamicValueComponent>	dynamicValue	Dynamic values that will be evaluated to produce values for elements of the resulting resource.
static final ca.uhn.fhir.rest.gclient.DateClientParam	EFFECTIVE	Fluent Client search parameter constant for effective
protected Period	effectivePeriod	The period during which the activity definition content was or is planned to be in active use.
protected List<Identifier>	identifier	A formal identifier that is used to identify this activity definition when it is represented in other formats, or referenced in a specification, model, design or an instance.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	IDENTIFIER	Fluent Client search parameter constant for identifier
static final ca.uhn.fhir.model.api.Include	INCLUDE_COMPOSED_OF	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_DEPENDS_ON	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_DERIVED_FROM	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_PREDECESSOR	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_SUCCESSOR	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	JURISDICTION	Fluent Client search parameter constant for jurisdiction
protected Enumeration<ActivityDefinition.ActivityDefinitionKind>	kind	A description of the kind of resource the activity definition is representing.
protected 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 asset.
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 asset.)
protected Reference	location	Identifies the facility where the activity will occur; e.g.
protected Location	locationTarget	The actual object that is the target of the reference (Identifies the facility where the activity will occur; e.g.
static final ca.uhn.fhir.rest.gclient.StringClientParam	NAME	Fluent Client search parameter constant for name
protected List<ActivityDefinition.ActivityDefinitionParticipantComponent>	participant	Indicates who should participate in performing the action described.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	PREDECESSOR	Fluent Client search parameter constant for predecessor
protected Type	product	Identifies the food, drug or other product being consumed or supplied in the activity.
static final ca.uhn.fhir.rest.gclient.StringClientParam	PUBLISHER	Fluent Client search parameter constant for publisher
protected MarkdownType	purpose	Explaination of why this activity definition is needed and why it has been designed as it has.
protected SimpleQuantity	quantity	Identifies the quantity expected to be consumed at once (per dose, per meal, etc.).
protected List<RelatedArtifact>	relatedArtifact	Related artifacts such as additional documentation, justification, or bibliographic references.
static final String	SP_COMPOSED_OF	Search parameter: composed-of
static final String	SP_DATE	Search parameter: date
static final String	SP_DEPENDS_ON	Search parameter: depends-on
static final String	SP_DERIVED_FROM	Search parameter: derived-from
static final String	SP_DESCRIPTION	Search parameter: description
static final String	SP_EFFECTIVE	Search parameter: effective
static final String	SP_IDENTIFIER	Search parameter: identifier
static final String	SP_JURISDICTION	Search parameter: jurisdiction
static final String	SP_NAME	Search parameter: name
static final String	SP_PREDECESSOR	Search parameter: predecessor
static final String	SP_PUBLISHER	Search parameter: publisher
static final String	SP_STATUS	Search parameter: status
static final String	SP_SUCCESSOR	Search parameter: successor
static final String	SP_TITLE	Search parameter: title
static final String	SP_TOPIC	Search parameter: topic
static final String	SP_URL	Search parameter: url
static final String	SP_VERSION	Search parameter: version
static final ca.uhn.fhir.rest.gclient.TokenClientParam	STATUS	Fluent Client search parameter constant for status
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	SUCCESSOR	Fluent Client search parameter constant for successor
protected Type	timing	The period, timing or frequency upon which the described activity is to occur.
static final 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 activity.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	TOPIC	Fluent Client search parameter constant for topic
protected Reference	transform	A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input.
protected StructureMap	transformTarget	The actual object that is the target of the reference (A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input.)
static final ca.uhn.fhir.rest.gclient.UriClientParam	URL	Fluent Client search parameter constant for url
protected StringType	usage	A detailed description of how the asset is used from a clinical perspective.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	VERSION	Fluent Client search parameter constant for version

Fields 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

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors

Constructor	Description
ActivityDefinition()	Constructor
ActivityDefinition(Enumeration<Enumerations.PublicationStatus> status)	Constructor

Method Summary

Modifier and Type	Method	Description
CodeableConcept	addBodySite()
ActivityDefinition	addBodySite(CodeableConcept t)
Base	addChild(String name)
ContactDetail	addContact()
ActivityDefinition	addContact(ContactDetail t)
Contributor	addContributor()
ActivityDefinition	addContributor(Contributor t)
Dosage	addDosage()
ActivityDefinition	addDosage(Dosage t)
ActivityDefinition.ActivityDefinitionDynamicValueComponent	addDynamicValue()
ActivityDefinition	addDynamicValue(ActivityDefinition.ActivityDefinitionDynamicValueComponent t)
Identifier	addIdentifier()
ActivityDefinition	addIdentifier(Identifier t)
CodeableConcept	addJurisdiction()
ActivityDefinition	addJurisdiction(CodeableConcept t)
Reference	addLibrary()
ActivityDefinition	addLibrary(Reference t)
Library	addLibraryTarget()	Deprecated. Use Reference#setResource(IBaseResource) instead
ActivityDefinition.ActivityDefinitionParticipantComponent	addParticipant()
ActivityDefinition	addParticipant(ActivityDefinition.ActivityDefinitionParticipantComponent t)
RelatedArtifact	addRelatedArtifact()
ActivityDefinition	addRelatedArtifact(RelatedArtifact t)
CodeableConcept	addTopic()
ActivityDefinition	addTopic(CodeableConcept t)
UsageContext	addUseContext()
ActivityDefinition	addUseContext(UsageContext t)
ActivityDefinition	copy()
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
Date	getApprovalDate()
DateType	getApprovalDateElement()
List<CodeableConcept>	getBodySite()
CodeableConcept	getBodySiteFirstRep()
CodeableConcept	getCode()
List<ContactDetail>	getContact()
ContactDetail	getContactFirstRep()
List<Contributor>	getContributor()
Contributor	getContributorFirstRep()
String	getCopyright()
MarkdownType	getCopyrightElement()
Date	getDate()
DateTimeType	getDateElement()
String	getDescription()
MarkdownType	getDescriptionElement()
List<Dosage>	getDosage()
Dosage	getDosageFirstRep()
List<ActivityDefinition.ActivityDefinitionDynamicValueComponent>	getDynamicValue()
ActivityDefinition.ActivityDefinitionDynamicValueComponent	getDynamicValueFirstRep()
Period	getEffectivePeriod()
boolean	getExperimental()
BooleanType	getExperimentalElement()
List<Identifier>	getIdentifier()
Identifier	getIdentifierFirstRep()
List<CodeableConcept>	getJurisdiction()
CodeableConcept	getJurisdictionFirstRep()
ActivityDefinition.ActivityDefinitionKind	getKind()
Enumeration<ActivityDefinition.ActivityDefinitionKind>	getKindElement()
Date	getLastReviewDate()
DateType	getLastReviewDateElement()
List<Reference>	getLibrary()
Reference	getLibraryFirstRep()
List<Library>	getLibraryTarget()	Deprecated. Use Reference#setResource(IBaseResource) instead
Reference	getLocation()
Location	getLocationTarget()
String	getName()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
StringType	getNameElement()
List<ActivityDefinition.ActivityDefinitionParticipantComponent>	getParticipant()
ActivityDefinition.ActivityDefinitionParticipantComponent	getParticipantFirstRep()
Type	getProduct()
CodeableConcept	getProductCodeableConcept()
Reference	getProductReference()
Base[]	getProperty(int hash, String name, boolean checkValid)
String	getPublisher()
StringType	getPublisherElement()
String	getPurpose()
MarkdownType	getPurposeElement()
SimpleQuantity	getQuantity()
List<RelatedArtifact>	getRelatedArtifact()
RelatedArtifact	getRelatedArtifactFirstRep()
ResourceType	getResourceType()
Enumerations.PublicationStatus	getStatus()
Enumeration<Enumerations.PublicationStatus>	getStatusElement()
Type	getTiming()
DateTimeType	getTimingDateTimeType()
Period	getTimingPeriod()
Range	getTimingRange()
Timing	getTimingTiming()
String	getTitle()
StringType	getTitleElement()
List<CodeableConcept>	getTopic()
CodeableConcept	getTopicFirstRep()
Reference	getTransform()
StructureMap	getTransformTarget()
String[]	getTypesForProperty(int hash, String name)
String	getUrl()
UriType	getUrlElement()
String	getUsage()
StringType	getUsageElement()
List<UsageContext>	getUseContext()
UsageContext	getUseContextFirstRep()
String	getVersion()
StringType	getVersionElement()
boolean	hasApprovalDate()
boolean	hasApprovalDateElement()
boolean	hasBodySite()
boolean	hasCode()
boolean	hasContact()
boolean	hasContributor()
boolean	hasCopyright()
boolean	hasCopyrightElement()
boolean	hasDate()
boolean	hasDateElement()
boolean	hasDescription()
boolean	hasDescriptionElement()
boolean	hasDosage()
boolean	hasDynamicValue()
boolean	hasEffectivePeriod()
boolean	hasExperimental()
boolean	hasExperimentalElement()
boolean	hasIdentifier()
boolean	hasJurisdiction()
boolean	hasKind()
boolean	hasKindElement()
boolean	hasLastReviewDate()
boolean	hasLastReviewDateElement()
boolean	hasLibrary()
boolean	hasLocation()
boolean	hasName()
boolean	hasNameElement()
boolean	hasParticipant()
boolean	hasProduct()
boolean	hasProductCodeableConcept()
boolean	hasProductReference()
boolean	hasPublisher()
boolean	hasPublisherElement()
boolean	hasPurpose()
boolean	hasPurposeElement()
boolean	hasQuantity()
boolean	hasRelatedArtifact()
boolean	hasStatus()
boolean	hasStatusElement()
boolean	hasTiming()
boolean	hasTimingDateTimeType()
boolean	hasTimingPeriod()
boolean	hasTimingRange()
boolean	hasTimingTiming()
boolean	hasTitle()
boolean	hasTitleElement()
boolean	hasTopic()
boolean	hasTransform()
boolean	hasUrl()
boolean	hasUrlElement()
boolean	hasUsage()
boolean	hasUsageElement()
boolean	hasUseContext()
boolean	hasVersion()
boolean	hasVersionElement()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
ActivityDefinition	setApprovalDate(Date value)
ActivityDefinition	setApprovalDateElement(DateType value)
ActivityDefinition	setBodySite(List<CodeableConcept> theBodySite)
ActivityDefinition	setCode(CodeableConcept value)
ActivityDefinition	setContact(List<ContactDetail> theContact)
ActivityDefinition	setContributor(List<Contributor> theContributor)
ActivityDefinition	setCopyright(String value)
ActivityDefinition	setCopyrightElement(MarkdownType value)
ActivityDefinition	setDate(Date value)
ActivityDefinition	setDateElement(DateTimeType value)
ActivityDefinition	setDescription(String value)
ActivityDefinition	setDescriptionElement(MarkdownType value)
ActivityDefinition	setDosage(List<Dosage> theDosage)
ActivityDefinition	setDynamicValue(List<ActivityDefinition.ActivityDefinitionDynamicValueComponent> theDynamicValue)
ActivityDefinition	setEffectivePeriod(Period value)
ActivityDefinition	setExperimental(boolean value)
ActivityDefinition	setExperimentalElement(BooleanType value)
ActivityDefinition	setIdentifier(List<Identifier> theIdentifier)
ActivityDefinition	setJurisdiction(List<CodeableConcept> theJurisdiction)
ActivityDefinition	setKind(ActivityDefinition.ActivityDefinitionKind value)
ActivityDefinition	setKindElement(Enumeration<ActivityDefinition.ActivityDefinitionKind> value)
ActivityDefinition	setLastReviewDate(Date value)
ActivityDefinition	setLastReviewDateElement(DateType value)
ActivityDefinition	setLibrary(List<Reference> theLibrary)
ActivityDefinition	setLocation(Reference value)
ActivityDefinition	setLocationTarget(Location value)
ActivityDefinition	setName(String value)
ActivityDefinition	setNameElement(StringType value)
ActivityDefinition	setParticipant(List<ActivityDefinition.ActivityDefinitionParticipantComponent> theParticipant)
ActivityDefinition	setProduct(Type value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
ActivityDefinition	setPublisher(String value)
ActivityDefinition	setPublisherElement(StringType value)
ActivityDefinition	setPurpose(String value)
ActivityDefinition	setPurposeElement(MarkdownType value)
ActivityDefinition	setQuantity(SimpleQuantity value)
ActivityDefinition	setRelatedArtifact(List<RelatedArtifact> theRelatedArtifact)
ActivityDefinition	setStatus(Enumerations.PublicationStatus value)
ActivityDefinition	setStatusElement(Enumeration<Enumerations.PublicationStatus> value)
ActivityDefinition	setTiming(Type value)
ActivityDefinition	setTitle(String value)
ActivityDefinition	setTitleElement(StringType value)
ActivityDefinition	setTopic(List<CodeableConcept> theTopic)
ActivityDefinition	setTransform(Reference value)
ActivityDefinition	setTransformTarget(StructureMap value)
ActivityDefinition	setUrl(String value)
ActivityDefinition	setUrlElement(UriType value)
ActivityDefinition	setUsage(String value)
ActivityDefinition	setUsageElement(StringType value)
ActivityDefinition	setUseContext(List<UsageContext> theUseContext)
ActivityDefinition	setVersion(String value)
ActivityDefinition	setVersionElement(StringType value)
protected ActivityDefinition	typedCopy()

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, getIdPart, 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

protected List<Identifier> identifier

A formal identifier that is used to identify this activity definition when it is represented in other formats, or referenced in a specification, model, design or an instance.

purpose

protected MarkdownType purpose

Explaination of why this activity definition is needed and why it has been designed as it has.

usage

protected StringType usage

A detailed description of how the asset is used from a clinical perspective.

approvalDate

protected DateType 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

protected DateType 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

protected Period effectivePeriod

The period during which the activity definition content was or is planned to be in active use.

topic

protected List<CodeableConcept> topic

Descriptive topics related to the content of the activity. Topics provide a high-level categorization of the activity that can be useful for filtering and searching.

contributor

protected List<Contributor> contributor

A contributor to the content of the asset, including authors, editors, reviewers, and endorsers.

copyright

protected MarkdownType copyright

A copyright statement relating to the activity definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the activity definition.

relatedArtifact

protected List<RelatedArtifact> relatedArtifact

Related artifacts such as additional documentation, justification, or bibliographic references.

library

protected List<Reference> library

A reference to a Library resource containing any formal logic used by the asset.

libraryTarget

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 asset.)

kind

protected Enumeration<ActivityDefinition.ActivityDefinitionKind> kind

A description of the kind of resource the activity definition is representing. For example, a MedicationRequest, a ProcedureRequest, or a CommunicationRequest. Typically, but not always, this is a Request resource.

code

protected CodeableConcept code

Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter.

timing

protected Type timing

The period, timing or frequency upon which the described activity is to occur.

location

protected Reference location

Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.

locationTarget

protected Location locationTarget

The actual object that is the target of the reference (Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.)

participant

protected List<ActivityDefinition.ActivityDefinitionParticipantComponent> participant

Indicates who should participate in performing the action described.

product

protected Type product

Identifies the food, drug or other product being consumed or supplied in the activity.

quantity

protected SimpleQuantity quantity

Identifies the quantity expected to be consumed at once (per dose, per meal, etc.).

dosage

protected List<Dosage> dosage

Provides detailed dosage instructions in the same way that they are described for MedicationRequest resources.

bodySite

protected List<CodeableConcept> bodySite

Indicates the sites on the subject's body where the procedure should be performed (I.e. the target sites).

transform

protected Reference transform

A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input.

transformTarget

protected StructureMap transformTarget

The actual object that is the target of the reference (A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input.)

dynamicValue

protected List<ActivityDefinition.ActivityDefinitionDynamicValueComponent> dynamicValue

Dynamic values that will be evaluated to produce values for elements of the resulting resource. For example, if the dosage of a medication must be computed based on the patient's weight, a dynamic value would be used to specify an expression that calculated the weight, and the path on the intent resource that would contain the result.

SP_DATE

public static final String SP_DATE

Search parameter: date

Description: The activity definition publication date
Type: date
Path: ActivityDefinition.date

See Also:

• Constant Field Values

DATE

public static final ca.uhn.fhir.rest.gclient.DateClientParam DATE

Fluent Client search parameter constant for date

Description: The activity definition publication date
Type: date
Path: ActivityDefinition.date

SP_IDENTIFIER

public static final String SP_IDENTIFIER

Search parameter: identifier

Description: External identifier for the activity definition
Type: token
Path: ActivityDefinition.identifier

See Also:

• Constant Field Values

IDENTIFIER

public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER

Fluent Client search parameter constant for identifier

Description: External identifier for the activity definition
Type: token
Path: ActivityDefinition.identifier

SP_SUCCESSOR

public static final String SP_SUCCESSOR

Search parameter: successor

Description: What resource is being referenced
Type: reference
Path: ActivityDefinition.relatedArtifact.resource

See Also:

• Constant Field Values

SUCCESSOR

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SUCCESSOR

Fluent Client search parameter constant for successor

Description: What resource is being referenced
Type: reference
Path: ActivityDefinition.relatedArtifact.resource

INCLUDE_SUCCESSOR

public static final ca.uhn.fhir.model.api.Include INCLUDE_SUCCESSOR

Constant for fluent queries to be used to add include statements. Specifies the path value of "ActivityDefinition:successor".

SP_JURISDICTION

public static final String SP_JURISDICTION

Search parameter: jurisdiction

Description: Intended jurisdiction for the activity definition
Type: token
Path: ActivityDefinition.jurisdiction

See Also:

• Constant Field Values

JURISDICTION

public static final ca.uhn.fhir.rest.gclient.TokenClientParam JURISDICTION

Fluent Client search parameter constant for jurisdiction

Description: Intended jurisdiction for the activity definition
Type: token
Path: ActivityDefinition.jurisdiction

SP_DESCRIPTION

public static final String SP_DESCRIPTION

Search parameter: description

Description: The description of the activity definition
Type: string
Path: ActivityDefinition.description

See Also:

• Constant Field Values

DESCRIPTION

public static final ca.uhn.fhir.rest.gclient.StringClientParam DESCRIPTION

Fluent Client search parameter constant for description

Description: The description of the activity definition
Type: string
Path: ActivityDefinition.description

SP_DERIVED_FROM

public static final String SP_DERIVED_FROM

Search parameter: derived-from

Description: What resource is being referenced
Type: reference
Path: ActivityDefinition.relatedArtifact.resource

See Also:

• Constant Field Values

DERIVED_FROM

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam DERIVED_FROM

Fluent Client search parameter constant for derived-from

Description: What resource is being referenced
Type: reference
Path: ActivityDefinition.relatedArtifact.resource

INCLUDE_DERIVED_FROM

public static final ca.uhn.fhir.model.api.Include INCLUDE_DERIVED_FROM

Constant for fluent queries to be used to add include statements. Specifies the path value of "ActivityDefinition:derived-from".

SP_PREDECESSOR

public static final String SP_PREDECESSOR

Search parameter: predecessor

Description: What resource is being referenced
Type: reference
Path: ActivityDefinition.relatedArtifact.resource

See Also:

• Constant Field Values

PREDECESSOR

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PREDECESSOR

Fluent Client search parameter constant for predecessor

Description: What resource is being referenced
Type: reference
Path: ActivityDefinition.relatedArtifact.resource

INCLUDE_PREDECESSOR

public static final ca.uhn.fhir.model.api.Include INCLUDE_PREDECESSOR

Constant for fluent queries to be used to add include statements. Specifies the path value of "ActivityDefinition:predecessor".

SP_TITLE

public static final String SP_TITLE

Search parameter: title

Description: The human-friendly name of the activity definition
Type: string
Path: ActivityDefinition.title

See Also:

• Constant Field Values

TITLE

public static final ca.uhn.fhir.rest.gclient.StringClientParam TITLE

Fluent Client search parameter constant for title

Description: The human-friendly name of the activity definition
Type: string
Path: ActivityDefinition.title

SP_COMPOSED_OF

public static final String SP_COMPOSED_OF

Search parameter: composed-of

Description: What resource is being referenced
Type: reference
Path: ActivityDefinition.relatedArtifact.resource

See Also:

• Constant Field Values

COMPOSED_OF

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam COMPOSED_OF

Fluent Client search parameter constant for composed-of

Description: What resource is being referenced
Type: reference
Path: ActivityDefinition.relatedArtifact.resource

INCLUDE_COMPOSED_OF

public static final ca.uhn.fhir.model.api.Include INCLUDE_COMPOSED_OF

Constant for fluent queries to be used to add include statements. Specifies the path value of "ActivityDefinition:composed-of".

SP_VERSION

public static final String SP_VERSION

Search parameter: version

Description: The business version of the activity definition
Type: token
Path: ActivityDefinition.version

See Also:

• Constant Field Values

VERSION

public static final ca.uhn.fhir.rest.gclient.TokenClientParam VERSION

Fluent Client search parameter constant for version

Description: The business version of the activity definition
Type: token
Path: ActivityDefinition.version

SP_URL

public static final String SP_URL

Search parameter: url

Description: The uri that identifies the activity definition
Type: uri
Path: ActivityDefinition.url

See Also:

• Constant Field Values

URL

public static final ca.uhn.fhir.rest.gclient.UriClientParam URL

Fluent Client search parameter constant for url

Description: The uri that identifies the activity definition
Type: uri
Path: ActivityDefinition.url

SP_EFFECTIVE

public static final String SP_EFFECTIVE

Search parameter: effective

Description: The time during which the activity definition is intended to be in use
Type: date
Path: ActivityDefinition.effectivePeriod

See Also:

• Constant Field Values

EFFECTIVE

public static final ca.uhn.fhir.rest.gclient.DateClientParam EFFECTIVE

Fluent Client search parameter constant for effective

Description: The time during which the activity definition is intended to be in use
Type: date
Path: ActivityDefinition.effectivePeriod

SP_DEPENDS_ON

public static final String SP_DEPENDS_ON

Search parameter: depends-on

Description: What resource is being referenced
Type: reference
Path: ActivityDefinition.relatedArtifact.resource, ActivityDefinition.library

See Also:

• Constant Field Values

DEPENDS_ON

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam DEPENDS_ON

Fluent Client search parameter constant for depends-on

Description: What resource is being referenced
Type: reference
Path: ActivityDefinition.relatedArtifact.resource, ActivityDefinition.library

INCLUDE_DEPENDS_ON

public static final ca.uhn.fhir.model.api.Include INCLUDE_DEPENDS_ON

Constant for fluent queries to be used to add include statements. Specifies the path value of "ActivityDefinition:depends-on".

SP_NAME

public static final String SP_NAME

Search parameter: name

Description: Computationally friendly name of the activity definition
Type: string
Path: ActivityDefinition.name

See Also:

• Constant Field Values

NAME

public static final ca.uhn.fhir.rest.gclient.StringClientParam NAME

Fluent Client search parameter constant for name

Description: Computationally friendly name of the activity definition
Type: string
Path: ActivityDefinition.name

SP_PUBLISHER

public static final String SP_PUBLISHER

Search parameter: publisher

Description: Name of the publisher of the activity definition
Type: string
Path: ActivityDefinition.publisher

See Also:

• Constant Field Values

PUBLISHER

public static final ca.uhn.fhir.rest.gclient.StringClientParam PUBLISHER

Fluent Client search parameter constant for publisher

Description: Name of the publisher of the activity definition
Type: string
Path: ActivityDefinition.publisher

SP_TOPIC

public static final String SP_TOPIC

Search parameter: topic

Description: Topics associated with the module
Type: token
Path: ActivityDefinition.topic

See Also:

• Constant Field Values

TOPIC

public static final ca.uhn.fhir.rest.gclient.TokenClientParam TOPIC

Fluent Client search parameter constant for topic

Description: Topics associated with the module
Type: token
Path: ActivityDefinition.topic

SP_STATUS

public static final String SP_STATUS

Search parameter: status

Description: The current status of the activity definition
Type: token
Path: ActivityDefinition.status

See Also:

• Constant Field Values

STATUS

public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS

Fluent Client search parameter constant for status

Description: The current status of the activity definition
Type: token
Path: ActivityDefinition.status

Constructor Details

ActivityDefinition

public ActivityDefinition()

Constructor

ActivityDefinition

public ActivityDefinition(Enumeration<Enumerations.PublicationStatus> status)

Constructor

Method Details

getUrlElement

public UriType getUrlElement()

Overrides:

getUrlElement in class MetadataResource

Returns:

MetadataResource.url (An absolute URI that is used to identify this activity 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 activity definition is (or will be) published. The URL SHOULD include the major version of the activity 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

public boolean hasUrlElement()

Overrides:

hasUrlElement in class MetadataResource

hasUrl

public boolean hasUrl()

Overrides:

hasUrl in class MetadataResource

setUrlElement

public ActivityDefinition setUrlElement(UriType value)

Overrides:

setUrlElement in class MetadataResource

Parameters:

value - MetadataResource.url (An absolute URI that is used to identify this activity 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 activity definition is (or will be) published. The URL SHOULD include the major version of the activity 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

public String getUrl()

Overrides:

getUrl in class MetadataResource

Returns:

An absolute URI that is used to identify this activity 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 activity definition is (or will be) published. The URL SHOULD include the major version of the activity definition. For more information see [Technical and Business Versions](resource.html#versions).

setUrl

public ActivityDefinition setUrl(String value)

Overrides:

setUrl in class MetadataResource

Parameters:

value - An absolute URI that is used to identify this activity 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 activity definition is (or will be) published. The URL SHOULD include the major version of the activity definition. For more information see [Technical and Business Versions](resource.html#versions).

getIdentifier

public List<Identifier> getIdentifier()

Returns:

identifier (A formal identifier that is used to identify this activity definition when it is represented in other formats, or referenced in a specification, model, design or an instance.)

setIdentifier

public ActivityDefinition setIdentifier(List<Identifier> theIdentifier)

Returns:

Returns a reference to this for easy method chaining

hasIdentifier

public boolean hasIdentifier()

addIdentifier

public Identifier addIdentifier()

addIdentifier

public ActivityDefinition addIdentifier(Identifier t)

getIdentifierFirstRep

public Identifier getIdentifierFirstRep()

Returns:

The first repetition of repeating field identifier, creating it if it does not already exist

getVersionElement

public StringType getVersionElement()

Overrides:

getVersionElement in class MetadataResource

Returns:

MetadataResource.version (The identifier that is used to identify this version of the activity definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the activity 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 assets.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value

hasVersionElement

public boolean hasVersionElement()

Overrides:

hasVersionElement in class MetadataResource

hasVersion

public boolean hasVersion()

Overrides:

hasVersion in class MetadataResource

setVersionElement

public ActivityDefinition setVersionElement(StringType value)

Overrides:

setVersionElement in class MetadataResource

Parameters:

value - MetadataResource.version (The identifier that is used to identify this version of the activity definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the activity 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 assets.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value

getVersion

public String getVersion()

Overrides:

getVersion in class MetadataResource

Returns:

The identifier that is used to identify this version of the activity definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the activity 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 assets.

setVersion

public ActivityDefinition setVersion(String value)

Overrides:

setVersion in class MetadataResource

Parameters:

value - The identifier that is used to identify this version of the activity definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the activity 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 assets.

getNameElement

public StringType getNameElement()

Overrides:

getNameElement in class MetadataResource

Returns:

MetadataResource.name (A natural language name identifying the activity 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

public boolean hasNameElement()

Overrides:

hasNameElement in class MetadataResource

hasName

public boolean hasName()

Overrides:

hasName in class MetadataResource

setNameElement

public ActivityDefinition setNameElement(StringType value)

Overrides:

setNameElement in class MetadataResource

Parameters:

value - MetadataResource.name (A natural language name identifying the activity 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

public String getName()

Overrides:

getName in class MetadataResource

Returns:

A natural language name identifying the activity definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.

setName

public ActivityDefinition setName(String value)

Overrides:

setName in class MetadataResource

Parameters:

value - A natural language name identifying the activity definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.

getTitleElement

public StringType getTitleElement()

Overrides:

getTitleElement in class MetadataResource

Returns:

MetadataResource.title (A short, descriptive, user-friendly title for the activity definition.). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value

hasTitleElement

public boolean hasTitleElement()

Overrides:

hasTitleElement in class MetadataResource

hasTitle

public boolean hasTitle()

Overrides:

hasTitle in class MetadataResource

setTitleElement

public ActivityDefinition setTitleElement(StringType value)

Overrides:

setTitleElement in class MetadataResource

Parameters:

value - MetadataResource.title (A short, descriptive, user-friendly title for the activity definition.). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value

getTitle

public String getTitle()

Overrides:

getTitle in class MetadataResource

Returns:

A short, descriptive, user-friendly title for the activity definition.

setTitle

public ActivityDefinition setTitle(String value)

Overrides:

setTitle in class MetadataResource

Parameters:

value - A short, descriptive, user-friendly title for the activity definition.

getStatusElement

public Enumeration<Enumerations.PublicationStatus> getStatusElement()

Overrides:

getStatusElement in class MetadataResource

Returns:

MetadataResource.status (The status of this activity 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

public boolean hasStatusElement()

Overrides:

hasStatusElement in class MetadataResource

hasStatus

public boolean hasStatus()

Overrides:

hasStatus in class MetadataResource

setStatusElement

public ActivityDefinition setStatusElement(Enumeration<Enumerations.PublicationStatus> value)

Overrides:

setStatusElement in class MetadataResource

Parameters:

value - MetadataResource.status (The status of this activity 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

public Enumerations.PublicationStatus getStatus()

Overrides:

getStatus in class MetadataResource

Returns:

The status of this activity definition. Enables tracking the life-cycle of the content.

setStatus

public ActivityDefinition setStatus(Enumerations.PublicationStatus value)

Overrides:

setStatus in class MetadataResource

Parameters:

value - The status of this activity definition. Enables tracking the life-cycle of the content.

getExperimentalElement

public BooleanType getExperimentalElement()

Overrides:

getExperimentalElement in class MetadataResource

Returns:

MetadataResource.experimental (A boolean value to indicate that this activity 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

public boolean hasExperimentalElement()

Overrides:

hasExperimentalElement in class MetadataResource

hasExperimental

public boolean hasExperimental()

Overrides:

hasExperimental in class MetadataResource

setExperimentalElement

public ActivityDefinition setExperimentalElement(BooleanType value)

Overrides:

setExperimentalElement in class MetadataResource

Parameters:

value - MetadataResource.experimental (A boolean value to indicate that this activity 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

public boolean getExperimental()

Overrides:

getExperimental in class MetadataResource

Returns:

A boolean value to indicate that this activity definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.

setExperimental

public ActivityDefinition setExperimental(boolean value)

Overrides:

setExperimental in class MetadataResource

Parameters:

value - A boolean value to indicate that this activity definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.

getDateElement

public DateTimeType getDateElement()

Overrides:

getDateElement in class MetadataResource

Returns:

MetadataResource.date (The date (and optionally time) when the activity 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 activity definition changes.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value

hasDateElement

public boolean hasDateElement()

Overrides:

hasDateElement in class MetadataResource

hasDate

public boolean hasDate()

Overrides:

hasDate in class MetadataResource

setDateElement

public ActivityDefinition setDateElement(DateTimeType value)

Overrides:

setDateElement in class MetadataResource

Parameters:

value - MetadataResource.date (The date (and optionally time) when the activity 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 activity definition changes.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value

getDate

public Date getDate()

Overrides:

getDate in class MetadataResource

Returns:

The date (and optionally time) when the activity 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 activity definition changes.

setDate

public ActivityDefinition setDate(Date value)

Overrides:

setDate in class MetadataResource

Parameters:

value - The date (and optionally time) when the activity 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 activity definition changes.

getPublisherElement

public StringType getPublisherElement()

Overrides:

getPublisherElement in class MetadataResource

Returns:

MetadataResource.publisher (The name of the individual or organization that published the activity definition.). This is the underlying object with id, value and extensions. The accessor "getPublisher" gives direct access to the value

hasPublisherElement

public boolean hasPublisherElement()

Overrides:

hasPublisherElement in class MetadataResource

hasPublisher

public boolean hasPublisher()

Overrides:

hasPublisher in class MetadataResource

setPublisherElement

public ActivityDefinition setPublisherElement(StringType value)

Overrides:

setPublisherElement in class MetadataResource

Parameters:

value - MetadataResource.publisher (The name of the individual or organization that published the activity definition.). This is the underlying object with id, value and extensions. The accessor "getPublisher" gives direct access to the value

getPublisher

public String getPublisher()

Overrides:

getPublisher in class MetadataResource

Returns:

The name of the individual or organization that published the activity definition.

setPublisher

public ActivityDefinition setPublisher(String value)

Overrides:

setPublisher in class MetadataResource

Parameters:

value - The name of the individual or organization that published the activity definition.

getDescriptionElement

public MarkdownType getDescriptionElement()

Overrides:

getDescriptionElement in class MetadataResource

Returns:

MetadataResource.description (A free text natural language description of the activity 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

public boolean hasDescriptionElement()

Overrides:

hasDescriptionElement in class MetadataResource

hasDescription

public boolean hasDescription()

Overrides:

hasDescription in class MetadataResource

setDescriptionElement

public ActivityDefinition setDescriptionElement(MarkdownType value)

Overrides:

setDescriptionElement in class MetadataResource

Parameters:

value - MetadataResource.description (A free text natural language description of the activity 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

public String getDescription()

Overrides:

getDescription in class MetadataResource

Returns:

A free text natural language description of the activity definition from a consumer's perspective.

setDescription

public ActivityDefinition setDescription(String value)

Overrides:

setDescription in class MetadataResource

Parameters:

value - A free text natural language description of the activity definition from a consumer's perspective.

getPurposeElement

public MarkdownType getPurposeElement()

Returns:

purpose (Explaination of why this activity 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

public boolean hasPurposeElement()

hasPurpose

public boolean hasPurpose()

setPurposeElement

public ActivityDefinition setPurposeElement(MarkdownType value)

Parameters:

value - purpose (Explaination of why this activity 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

public String getPurpose()

Returns:

Explaination of why this activity definition is needed and why it has been designed as it has.

setPurpose

public ActivityDefinition setPurpose(String value)

Parameters:

value - Explaination of why this activity definition is needed and why it has been designed as it has.

getUsageElement

public StringType 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

public boolean hasUsageElement()

hasUsage

public boolean hasUsage()

setUsageElement

public ActivityDefinition setUsageElement(StringType value)

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

public String getUsage()

Returns:

A detailed description of how the asset is used from a clinical perspective.

setUsage

public ActivityDefinition setUsage(String value)

Parameters:

value - A detailed description of how the asset is used from a clinical perspective.

getApprovalDateElement

public DateType 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

public boolean hasApprovalDateElement()

hasApprovalDate

public boolean hasApprovalDate()

setApprovalDateElement

public ActivityDefinition setApprovalDateElement(DateType value)

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

public Date 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

public ActivityDefinition setApprovalDate(Date value)

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

public DateType 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

public boolean hasLastReviewDateElement()

hasLastReviewDate

public boolean hasLastReviewDate()

setLastReviewDateElement

public ActivityDefinition setLastReviewDateElement(DateType value)

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

public Date 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

public ActivityDefinition setLastReviewDate(Date value)

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

public Period getEffectivePeriod()

Returns:

effectivePeriod (The period during which the activity definition content was or is planned to be in active use.)

hasEffectivePeriod

public boolean hasEffectivePeriod()

setEffectivePeriod

public ActivityDefinition setEffectivePeriod(Period value)

Parameters:

value - effectivePeriod (The period during which the activity definition content was or is planned to be in active use.)

getUseContext

public List<UsageContext> getUseContext()

Overrides:

getUseContext in class MetadataResource

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 activity definition instances.)

setUseContext

public ActivityDefinition setUseContext(List<UsageContext> theUseContext)

Overrides:

setUseContext in class MetadataResource

Returns:

Returns a reference to this for easy method chaining

hasUseContext

public boolean hasUseContext()

Overrides:

hasUseContext in class MetadataResource

addUseContext

public UsageContext addUseContext()

Overrides:

addUseContext in class MetadataResource

addUseContext

public ActivityDefinition addUseContext(UsageContext t)

Overrides:

addUseContext in class MetadataResource

getUseContextFirstRep

public UsageContext getUseContextFirstRep()

Overrides:

getUseContextFirstRep in class MetadataResource

Returns:

The first repetition of repeating field MetadataResource.useContext, creating it if it does not already exist

getJurisdiction

public List<CodeableConcept> getJurisdiction()

Overrides:

getJurisdiction in class MetadataResource

Returns:

MetadataResource.jurisdiction (A legal or geographic region in which the activity definition is intended to be used.)

setJurisdiction

public ActivityDefinition setJurisdiction(List<CodeableConcept> theJurisdiction)

Overrides:

setJurisdiction in class MetadataResource

Returns:

Returns a reference to this for easy method chaining

hasJurisdiction

public boolean hasJurisdiction()

Overrides:

hasJurisdiction in class MetadataResource

addJurisdiction

public CodeableConcept addJurisdiction()

Overrides:

addJurisdiction in class MetadataResource

addJurisdiction

public ActivityDefinition addJurisdiction(CodeableConcept t)

Overrides:

addJurisdiction in class MetadataResource

getJurisdictionFirstRep

public CodeableConcept getJurisdictionFirstRep()

Overrides:

getJurisdictionFirstRep in class MetadataResource

Returns:

The first repetition of repeating field MetadataResource.jurisdiction, creating it if it does not already exist

getTopic

public List<CodeableConcept> getTopic()

Returns:

topic (Descriptive topics related to the content of the activity. Topics provide a high-level categorization of the activity that can be useful for filtering and searching.)

setTopic

public ActivityDefinition setTopic(List<CodeableConcept> theTopic)

Returns:

Returns a reference to this for easy method chaining

hasTopic

public boolean hasTopic()

addTopic

public CodeableConcept addTopic()

addTopic

public ActivityDefinition addTopic(CodeableConcept t)

getTopicFirstRep

public CodeableConcept getTopicFirstRep()

Returns:

The first repetition of repeating field topic, creating it if it does not already exist

getContributor

public List<Contributor> getContributor()

Returns:

contributor (A contributor to the content of the asset, including authors, editors, reviewers, and endorsers.)

setContributor

public ActivityDefinition setContributor(List<Contributor> theContributor)

Returns:

Returns a reference to this for easy method chaining

hasContributor

public boolean hasContributor()

addContributor

public Contributor addContributor()

addContributor

public ActivityDefinition addContributor(Contributor t)

getContributorFirstRep

public Contributor getContributorFirstRep()

Returns:

The first repetition of repeating field contributor, creating it if it does not already exist

getContact

public List<ContactDetail> getContact()

Overrides:

getContact in class MetadataResource

Returns:

MetadataResource.contact (Contact details to assist a user in finding and communicating with the publisher.)

setContact

public ActivityDefinition setContact(List<ContactDetail> theContact)

Overrides:

setContact in class MetadataResource

Returns:

Returns a reference to this for easy method chaining

hasContact

public boolean hasContact()

Overrides:

hasContact in class MetadataResource

addContact

public ContactDetail addContact()

Overrides:

addContact in class MetadataResource

addContact

public ActivityDefinition addContact(ContactDetail t)

Overrides:

addContact in class MetadataResource

getContactFirstRep

public ContactDetail getContactFirstRep()

Overrides:

getContactFirstRep in class MetadataResource

Returns:

The first repetition of repeating field MetadataResource.contact, creating it if it does not already exist

getCopyrightElement

public MarkdownType getCopyrightElement()

Returns:

copyright (A copyright statement relating to the activity definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the activity definition.). This is the underlying object with id, value and extensions. The accessor "getCopyright" gives direct access to the value

hasCopyrightElement

public boolean hasCopyrightElement()

hasCopyright

public boolean hasCopyright()

setCopyrightElement

public ActivityDefinition setCopyrightElement(MarkdownType value)

Parameters:

value - copyright (A copyright statement relating to the activity definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the activity definition.). This is the underlying object with id, value and extensions. The accessor "getCopyright" gives direct access to the value

getCopyright

public String getCopyright()

Returns:

A copyright statement relating to the activity definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the activity definition.

setCopyright

public ActivityDefinition setCopyright(String value)

Parameters:

value - A copyright statement relating to the activity definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the activity definition.

getRelatedArtifact

public List<RelatedArtifact> getRelatedArtifact()

Returns:

relatedArtifact (Related artifacts such as additional documentation, justification, or bibliographic references.)

setRelatedArtifact

public ActivityDefinition setRelatedArtifact(List<RelatedArtifact> theRelatedArtifact)

Returns:

Returns a reference to this for easy method chaining

hasRelatedArtifact

public boolean hasRelatedArtifact()

addRelatedArtifact

public RelatedArtifact addRelatedArtifact()

addRelatedArtifact

public ActivityDefinition addRelatedArtifact(RelatedArtifact t)

getRelatedArtifactFirstRep

public RelatedArtifact getRelatedArtifactFirstRep()

Returns:

The first repetition of repeating field relatedArtifact, creating it if it does not already exist

getLibrary

public List<Reference> getLibrary()

Returns:

library (A reference to a Library resource containing any formal logic used by the asset.)

setLibrary

public ActivityDefinition setLibrary(List<Reference> theLibrary)

Returns:

Returns a reference to this for easy method chaining

hasLibrary

public boolean hasLibrary()

addLibrary

public Reference addLibrary()

addLibrary

public ActivityDefinition addLibrary(Reference t)

getLibraryFirstRep

public Reference getLibraryFirstRep()

Returns:

The first repetition of repeating field library, creating it if it does not already exist

getLibraryTarget

@Deprecated
public List<Library> getLibraryTarget()

Deprecated.

Use Reference#setResource(IBaseResource) instead

addLibraryTarget

@Deprecated
public Library addLibraryTarget()

Deprecated.

Use Reference#setResource(IBaseResource) instead

getKindElement

public Enumeration<ActivityDefinition.ActivityDefinitionKind> getKindElement()

Returns:

kind (A description of the kind of resource the activity definition is representing. For example, a MedicationRequest, a ProcedureRequest, or a CommunicationRequest. Typically, but not always, this is a Request resource.). This is the underlying object with id, value and extensions. The accessor "getKind" gives direct access to the value

hasKindElement

public boolean hasKindElement()

hasKind

public boolean hasKind()

setKindElement

public ActivityDefinition setKindElement(Enumeration<ActivityDefinition.ActivityDefinitionKind> value)

Parameters:

value - kind (A description of the kind of resource the activity definition is representing. For example, a MedicationRequest, a ProcedureRequest, or a CommunicationRequest. Typically, but not always, this is a Request resource.). This is the underlying object with id, value and extensions. The accessor "getKind" gives direct access to the value

getKind

public ActivityDefinition.ActivityDefinitionKind getKind()

Returns:

A description of the kind of resource the activity definition is representing. For example, a MedicationRequest, a ProcedureRequest, or a CommunicationRequest. Typically, but not always, this is a Request resource.

setKind

public ActivityDefinition setKind(ActivityDefinition.ActivityDefinitionKind value)

Parameters:

value - A description of the kind of resource the activity definition is representing. For example, a MedicationRequest, a ProcedureRequest, or a CommunicationRequest. Typically, but not always, this is a Request resource.

getCode

public CodeableConcept getCode()

Returns:

code (Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter.)

hasCode

public boolean hasCode()

setCode

public ActivityDefinition setCode(CodeableConcept value)

Parameters:

value - code (Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter.)

getTiming

public Type getTiming()

Returns:

timing (The period, timing or frequency upon which the described activity is to occur.)

getTimingTiming

public Timing getTimingTiming()
                       throws org.hl7.fhir.exceptions.FHIRException

Returns:

timing (The period, timing or frequency upon which the described activity is to occur.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasTimingTiming

public boolean hasTimingTiming()

getTimingDateTimeType

public DateTimeType getTimingDateTimeType()
                                   throws org.hl7.fhir.exceptions.FHIRException

Returns:

timing (The period, timing or frequency upon which the described activity is to occur.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasTimingDateTimeType

public boolean hasTimingDateTimeType()

getTimingPeriod

public Period getTimingPeriod()
                       throws org.hl7.fhir.exceptions.FHIRException

Returns:

timing (The period, timing or frequency upon which the described activity is to occur.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasTimingPeriod

public boolean hasTimingPeriod()

getTimingRange

public Range getTimingRange()
                     throws org.hl7.fhir.exceptions.FHIRException

Returns:

timing (The period, timing or frequency upon which the described activity is to occur.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasTimingRange

public boolean hasTimingRange()

hasTiming

public boolean hasTiming()

setTiming

public ActivityDefinition setTiming(Type value)
                             throws org.hl7.fhir.exceptions.FHIRFormatError

Parameters:

value - timing (The period, timing or frequency upon which the described activity is to occur.)

Throws:

org.hl7.fhir.exceptions.FHIRFormatError

getLocation

public Reference getLocation()

Returns:

location (Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.)

hasLocation

public boolean hasLocation()

setLocation

public ActivityDefinition setLocation(Reference value)

Parameters:

value - location (Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.)

getLocationTarget

public Location getLocationTarget()

Returns:

location 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 facility where the activity will occur; e.g. home, hospital, specific clinic, etc.)

setLocationTarget

public ActivityDefinition setLocationTarget(Location value)

Parameters:

value - location 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 facility where the activity will occur; e.g. home, hospital, specific clinic, etc.)

getParticipant

public List<ActivityDefinition.ActivityDefinitionParticipantComponent> getParticipant()

Returns:

participant (Indicates who should participate in performing the action described.)

setParticipant

public ActivityDefinition setParticipant(List<ActivityDefinition.ActivityDefinitionParticipantComponent> theParticipant)

Returns:

Returns a reference to this for easy method chaining

hasParticipant

public boolean hasParticipant()

addParticipant

public ActivityDefinition.ActivityDefinitionParticipantComponent addParticipant()

addParticipant

public ActivityDefinition addParticipant(ActivityDefinition.ActivityDefinitionParticipantComponent t)

getParticipantFirstRep

public ActivityDefinition.ActivityDefinitionParticipantComponent getParticipantFirstRep()

Returns:

The first repetition of repeating field participant, creating it if it does not already exist

getProduct

public Type getProduct()

Returns:

product (Identifies the food, drug or other product being consumed or supplied in the activity.)

getProductReference

public Reference getProductReference()
                              throws org.hl7.fhir.exceptions.FHIRException

Returns:

product (Identifies the food, drug or other product being consumed or supplied in the activity.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasProductReference

public boolean hasProductReference()

getProductCodeableConcept

public CodeableConcept getProductCodeableConcept()
                                          throws org.hl7.fhir.exceptions.FHIRException

Returns:

product (Identifies the food, drug or other product being consumed or supplied in the activity.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasProductCodeableConcept

public boolean hasProductCodeableConcept()

hasProduct

public boolean hasProduct()

setProduct

public ActivityDefinition setProduct(Type value)
                              throws org.hl7.fhir.exceptions.FHIRFormatError

Parameters:

value - product (Identifies the food, drug or other product being consumed or supplied in the activity.)

Throws:

org.hl7.fhir.exceptions.FHIRFormatError

getQuantity

public SimpleQuantity getQuantity()

Returns:

quantity (Identifies the quantity expected to be consumed at once (per dose, per meal, etc.).)

hasQuantity

public boolean hasQuantity()

setQuantity

public ActivityDefinition setQuantity(SimpleQuantity value)

Parameters:

value - quantity (Identifies the quantity expected to be consumed at once (per dose, per meal, etc.).)

getDosage

public List<Dosage> getDosage()

Returns:

dosage (Provides detailed dosage instructions in the same way that they are described for MedicationRequest resources.)

setDosage

public ActivityDefinition setDosage(List<Dosage> theDosage)

Returns:

Returns a reference to this for easy method chaining

hasDosage

public boolean hasDosage()

addDosage

public Dosage addDosage()

addDosage

public ActivityDefinition addDosage(Dosage t)

getDosageFirstRep

public Dosage getDosageFirstRep()

Returns:

The first repetition of repeating field dosage, creating it if it does not already exist

getBodySite

public List<CodeableConcept> getBodySite()

Returns:

bodySite (Indicates the sites on the subject's body where the procedure should be performed (I.e. the target sites).)

setBodySite

public ActivityDefinition setBodySite(List<CodeableConcept> theBodySite)

Returns:

Returns a reference to this for easy method chaining

hasBodySite

public boolean hasBodySite()

addBodySite

public CodeableConcept addBodySite()

addBodySite

public ActivityDefinition addBodySite(CodeableConcept t)

getBodySiteFirstRep

public CodeableConcept getBodySiteFirstRep()

Returns:

The first repetition of repeating field bodySite, creating it if it does not already exist

getTransform

public Reference getTransform()

Returns:

transform (A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input.)

hasTransform

public boolean hasTransform()

setTransform

public ActivityDefinition setTransform(Reference value)

Parameters:

value - transform (A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input.)

getTransformTarget

public StructureMap getTransformTarget()

Returns:

transform 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. (A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input.)

setTransformTarget

public ActivityDefinition setTransformTarget(StructureMap value)

Parameters:

value - transform 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. (A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input.)

getDynamicValue

public List<ActivityDefinition.ActivityDefinitionDynamicValueComponent> getDynamicValue()

Returns:

dynamicValue (Dynamic values that will be evaluated to produce values for elements of the resulting resource. For example, if the dosage of a medication must be computed based on the patient's weight, a dynamic value would be used to specify an expression that calculated the weight, and the path on the intent resource that would contain the result.)

setDynamicValue

public ActivityDefinition setDynamicValue(List<ActivityDefinition.ActivityDefinitionDynamicValueComponent> theDynamicValue)

Returns:

Returns a reference to this for easy method chaining

hasDynamicValue

public boolean hasDynamicValue()

addDynamicValue

public ActivityDefinition.ActivityDefinitionDynamicValueComponent addDynamicValue()

addDynamicValue

public ActivityDefinition addDynamicValue(ActivityDefinition.ActivityDefinitionDynamicValueComponent t)

getDynamicValueFirstRep

public ActivityDefinition.ActivityDefinitionDynamicValueComponent getDynamicValueFirstRep()

Returns:

The first repetition of repeating field dynamicValue, creating it if it does not already exist

listChildren

protected void listChildren(List<Property> children)

Overrides:

listChildren in class MetadataResource

getNamedProperty

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

Overrides:

getNamedProperty in class MetadataResource

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 MetadataResource

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 MetadataResource

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

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

Overrides:

setProperty in class MetadataResource

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

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

Overrides:

makeProperty in class MetadataResource

Throws:

org.hl7.fhir.exceptions.FHIRException

getTypesForProperty

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

Overrides:

getTypesForProperty in class MetadataResource

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

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

Overrides:

addChild in class MetadataResource

Throws:

org.hl7.fhir.exceptions.FHIRException

fhirType

public String fhirType()

Specified by:

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

Overrides:

fhirType in class MetadataResource

copy

public ActivityDefinition copy()

Specified by:

copy in class MetadataResource

typedCopy

protected ActivityDefinition typedCopy()

equalsDeep

public boolean equalsDeep(Base other_)

Overrides:

equalsDeep in class MetadataResource

equalsShallow

public boolean equalsShallow(Base other_)

Overrides:

equalsShallow in class MetadataResource

isEmpty

public boolean isEmpty()

Specified by:

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

Overrides:

isEmpty in class MetadataResource

getResourceType

public ResourceType getResourceType()

Specified by:

getResourceType in class Resource