Class 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
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
static enum
static class
static class
static enum
static class
static enum
static class
static enum
static class
-
Field Summary
Modifier and TypeFieldDescriptionprotected DateType
The date on which the resource content was approved by the publisher.protected List
<ContactDetail> An individiual or organization primarily involved in the creation and maintenance of the content.protected List
<CodeableConcept> Indicates the sites on the subject's body where the procedure should be performed (I.e.protected CodeableConcept
Detailed description of the type of activity; e.g.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for composed-ofstatic final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for contextstatic final ca.uhn.fhir.rest.gclient.QuantityClientParam
Fluent Client search parameter constant for context-quantitystatic final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for context-typestatic final ca.uhn.fhir.rest.gclient.CompositeClientParam
<ca.uhn.fhir.rest.gclient.TokenClientParam, ca.uhn.fhir.rest.gclient.QuantityClientParam> Fluent Client search parameter constant for context-type-quantitystatic final ca.uhn.fhir.rest.gclient.CompositeClientParam
<ca.uhn.fhir.rest.gclient.TokenClientParam, ca.uhn.fhir.rest.gclient.TokenClientParam> Fluent Client search parameter constant for context-type-valueprotected MarkdownType
A copyright statement relating to the activity definition and/or its contents.static final ca.uhn.fhir.rest.gclient.DateClientParam
Fluent Client search parameter constant for datestatic final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for depends-onstatic final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for derived-fromstatic final ca.uhn.fhir.rest.gclient.StringClientParam
Fluent Client search parameter constant for descriptionprotected BooleanType
Set this to true if the definition is to indicate that a particular activity should NOT be performed.Provides detailed dosage instructions in the same way that they are described for MedicationRequest resources.Dynamic values that will be evaluated to produce values for elements of the resulting resource.protected List
<ContactDetail> An individual or organization primarily responsible for internal coherence of the content.static final ca.uhn.fhir.rest.gclient.DateClientParam
Fluent Client search parameter constant for effectiveprotected Period
The period during which the activity definition content was or is planned to be in active use.protected List
<ContactDetail> An individual or organization responsible for officially endorsing the content for use in some setting.protected List
<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
Fluent Client search parameter constant for identifierstatic final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.protected Enumeration
<ActivityDefinition.RequestIntent> Indicates the level of authority/intentionality associated with the activity and where the request should fit into the workflow chain.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for jurisdictionA description of the kind of resource the activity definition is representing.protected DateType
The date on which the resource content was last reviewed.protected List
<CanonicalType> A reference to a Library resource containing any formal logic used by the activity definition.protected Reference
Identifies the facility where the activity will occur; e.g.protected Location
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
Fluent Client search parameter constant for nameDefines observation requirements for the action to be performed, such as body weight or surface area.protected List
<ObservationDefinition> The actual objects that are the target of the reference (Defines observation requirements for the action to be performed, such as body weight or surface area.)Defines the observations that are expected to be produced by the action.protected List
<ObservationDefinition> The actual objects that are the target of the reference (Defines the observations that are expected to be produced by the action.)Indicates who should participate in performing the action described.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for predecessorprotected Enumeration
<ActivityDefinition.RequestPriority> Indicates how quickly the activity should be addressed with respect to other requests.protected Type
Identifies the food, drug or other product being consumed or supplied in the activity.protected CanonicalType
A profile to which the target of the activity definition is expected to conform.static final ca.uhn.fhir.rest.gclient.StringClientParam
Fluent Client search parameter constant for publisherprotected MarkdownType
Explanation of why this activity definition is needed and why it has been designed as it has.protected Quantity
Identifies the quantity expected to be consumed at once (per dose, per meal, etc.).protected List
<RelatedArtifact> Related artifacts such as additional documentation, justification, or bibliographic references.protected List
<ContactDetail> An individual or organization primarily responsible for review of some aspect of the content.static final String
Search parameter: composed-ofstatic final String
Search parameter: contextstatic final String
Search parameter: context-quantitystatic final String
Search parameter: context-typestatic final String
Search parameter: context-type-quantitystatic final String
Search parameter: context-type-valuestatic final String
Search parameter: datestatic final String
Search parameter: depends-onstatic final String
Search parameter: derived-fromstatic final String
Search parameter: descriptionstatic final String
Search parameter: effectivestatic final String
Search parameter: identifierstatic final String
Search parameter: jurisdictionstatic final String
Search parameter: namestatic final String
Search parameter: predecessorstatic final String
Search parameter: publisherstatic final String
Search parameter: statusstatic final String
Search parameter: successorstatic final String
Search parameter: titlestatic final String
Search parameter: topicstatic final String
Search parameter: urlstatic final String
Search parameter: versionDefines specimen requirements for the action to be performed, such as required specimens for a lab test.protected List
<SpecimenDefinition> The actual objects that are the target of the reference (Defines specimen requirements for the action to be performed, such as required specimens for a lab test.)static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for statusprotected Type
A code or group definition that describes the intended subject of the activity being defined.protected StringType
An explanatory or alternate title for the activity definition giving additional information about its content.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for successorprotected Type
The period, timing or frequency upon which the described activity is to occur.static final ca.uhn.fhir.rest.gclient.StringClientParam
Fluent Client search parameter constant for titleprotected List
<CodeableConcept> Descriptive topics related to the content of the activity.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for topicprotected CanonicalType
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
Fluent Client search parameter constant for urlprotected StringType
A detailed description of how the activity definition is used from a clinical perspective.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for versionFields inherited from class org.hl7.fhir.r4.model.MetadataResource
contact, date, description, experimental, jurisdiction, name, publisher, status, title, url, useContext, version
Fields inherited from class org.hl7.fhir.r4.model.DomainResource
contained, extension, modifierExtension, text
Fields inherited from class org.hl7.fhir.r4.model.Resource
id, implicitRules, language, meta
Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
RES_ID, RES_LAST_UPDATED, RES_PROFILE, RES_SECURITY, RES_TAG, SP_RES_ID, SP_RES_LAST_UPDATED, SP_RES_PROFILE, SP_RES_SECURITY, SP_RES_TAG
Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET
-
Constructor Summary
ConstructorDescriptionConstructorConstructor -
Method Summary
Modifier and TypeMethodDescriptionaddLibrary
(String value) Deprecated.Use Reference#setResource(IBaseResource) insteadDeprecated.Use Reference#setResource(IBaseResource) insteadDeprecated.Use Reference#setResource(IBaseResource) insteadaddTopic()
copy()
void
boolean
equalsDeep
(Base other_) boolean
equalsShallow
(Base other_) fhirType()
getCode()
getDate()
boolean
boolean
getKind()
getName()
getNamedProperty
(int _hash, String _name, boolean _checkValid) Deprecated.Use Reference#setResource(IBaseResource) insteadDeprecated.Use Reference#setResource(IBaseResource) insteadBase[]
getProperty
(int hash, String name, boolean checkValid) Deprecated.Use Reference#setResource(IBaseResource) insteadgetTitle()
getTopic()
String[]
getTypesForProperty
(int hash, String name) getUrl()
getUsage()
boolean
boolean
boolean
boolean
boolean
hasCode()
boolean
boolean
boolean
boolean
hasDate()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasKind()
boolean
boolean
boolean
boolean
boolean
hasLibrary
(String value) boolean
boolean
hasName()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasTitle()
boolean
boolean
hasTopic()
boolean
boolean
boolean
hasUrl()
boolean
boolean
hasUsage()
boolean
boolean
boolean
boolean
boolean
isEmpty()
protected void
listChildren
(List<Property> children) makeProperty
(int hash, String name) void
removeChild
(String name, Base value) setApprovalDate
(Date value) setApprovalDateElement
(DateType value) setAuthor
(List<ContactDetail> theAuthor) setBodySite
(List<CodeableConcept> theBodySite) setCode
(CodeableConcept value) setContact
(List<ContactDetail> theContact) setCopyright
(String value) setCopyrightElement
(MarkdownType value) setDateElement
(DateTimeType value) setDescription
(String value) setDoNotPerform
(boolean value) setDynamicValue
(List<ActivityDefinition.ActivityDefinitionDynamicValueComponent> theDynamicValue) setEditor
(List<ContactDetail> theEditor) setEffectivePeriod
(Period value) setEndorser
(List<ContactDetail> theEndorser) setExperimental
(boolean value) setIdentifier
(List<Identifier> theIdentifier) setJurisdiction
(List<CodeableConcept> theJurisdiction) setLastReviewDate
(Date value) setLastReviewDateElement
(DateType value) setLibrary
(List<CanonicalType> theLibrary) setLocation
(Reference value) setLocationTarget
(Location value) setNameElement
(StringType value) setObservationRequirement
(List<Reference> theObservationRequirement) setObservationResultRequirement
(List<Reference> theObservationResultRequirement) setParticipant
(List<ActivityDefinition.ActivityDefinitionParticipantComponent> theParticipant) setProduct
(Type value) setProfile
(String value) setProfileElement
(CanonicalType value) setProperty
(int hash, String name, Base value) setProperty
(String name, Base value) setPublisher
(String value) setPublisherElement
(StringType value) setPurpose
(String value) setPurposeElement
(MarkdownType value) setQuantity
(Quantity value) setRelatedArtifact
(List<RelatedArtifact> theRelatedArtifact) setReviewer
(List<ContactDetail> theReviewer) setSpecimenRequirement
(List<Reference> theSpecimenRequirement) setSubject
(Type value) setSubtitle
(String value) setSubtitleElement
(StringType value) setTitleElement
(StringType value) setTopic
(List<CodeableConcept> theTopic) setTransform
(String value) setTransformElement
(CanonicalType value) setUrlElement
(UriType value) setUsageElement
(StringType value) setUseContext
(List<UsageContext> theUseContext) setVersion
(String value) setVersionElement
(StringType value) protected ActivityDefinition
Methods inherited from class org.hl7.fhir.r4.model.MetadataResource
copyValues, present, toString
Methods inherited from class org.hl7.fhir.r4.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText
Methods inherited from class org.hl7.fhir.r4.model.Resource
copyValues, getId, getIdBase, getIdElement, getIdPart, getImplicitRules, getImplicitRulesElement, getLanguage, 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.r4.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
Methods inherited from class org.hl7.fhir.r4.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExpression, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPopulation, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getXhtml, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, 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, isDeleted, setId
-
Field Details
-
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. -
subtitle
An explanatory or alternate title for the activity definition giving additional information about its content. -
subject
A code or group definition that describes the intended subject of the activity being defined. -
purpose
Explanation of why this activity definition is needed and why it has been designed as it has. -
usage
A detailed description of how the activity definition is used from a clinical perspective. -
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. -
approvalDate
The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. -
lastReviewDate
The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. -
effectivePeriod
The period during which the activity definition content was or is planned to be in active use. -
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. -
author
An individiual or organization primarily involved in the creation and maintenance of the content. -
editor
An individual or organization primarily responsible for internal coherence of the content. -
reviewer
An individual or organization primarily responsible for review of some aspect of the content. -
endorser
An individual or organization responsible for officially endorsing the content for use in some setting. -
library
A reference to a Library resource containing any formal logic used by the activity definition. -
kind
A description of the kind of resource the activity definition is representing. For example, a MedicationRequest, a ServiceRequest, or a CommunicationRequest. Typically, but not always, this is a Request resource. -
profile
A profile to which the target of the activity definition is expected to conform. -
code
Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter. -
intent
Indicates the level of authority/intentionality associated with the activity and where the request should fit into the workflow chain. -
priority
Indicates how quickly the activity should be addressed with respect to other requests. -
doNotPerform
Set this to true if the definition is to indicate that a particular activity should NOT be performed. If true, this element should be interpreted to reinforce a negative coding. For example NPO as a code with a doNotPerform of true would still indicate to NOT perform the action. -
timing
The period, timing or frequency upon which the described activity is to occur. -
location
Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc. -
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
Indicates who should participate in performing the action described. -
product
Identifies the food, drug or other product being consumed or supplied in the activity. -
quantity
Identifies the quantity expected to be consumed at once (per dose, per meal, etc.). -
dosage
Provides detailed dosage instructions in the same way that they are described for MedicationRequest resources. -
bodySite
Indicates the sites on the subject's body where the procedure should be performed (I.e. the target sites). -
specimenRequirement
Defines specimen requirements for the action to be performed, such as required specimens for a lab test. -
specimenRequirementTarget
The actual objects that are the target of the reference (Defines specimen requirements for the action to be performed, such as required specimens for a lab test.) -
observationRequirement
Defines observation requirements for the action to be performed, such as body weight or surface area. -
observationRequirementTarget
The actual objects that are the target of the reference (Defines observation requirements for the action to be performed, such as body weight or surface area.) -
observationResultRequirement
Defines the observations that are expected to be produced by the action. -
observationResultRequirementTarget
The actual objects that are the target of the reference (Defines the observations that are expected to be produced by the action.) -
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. -
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 request resource that would contain the result. -
SP_DATE
Search parameter: dateDescription: The activity definition publication date
Type: date
Path: ActivityDefinition.date
- See Also:
-
DATE
Fluent Client search parameter constant for dateDescription: The activity definition publication date
Type: date
Path: ActivityDefinition.date
-
SP_IDENTIFIER
Search parameter: identifierDescription: External identifier for the activity definition
Type: token
Path: ActivityDefinition.identifier
- See Also:
-
IDENTIFIER
Fluent Client search parameter constant for identifierDescription: External identifier for the activity definition
Type: token
Path: ActivityDefinition.identifier
-
SP_SUCCESSOR
Search parameter: successorDescription: What resource is being referenced
Type: reference
Path: ActivityDefinition.relatedArtifact.resource
- See Also:
-
SUCCESSOR
Fluent Client search parameter constant for successorDescription: What resource is being referenced
Type: reference
Path: ActivityDefinition.relatedArtifact.resource
-
INCLUDE_SUCCESSOR
Constant for fluent queries to be used to add include statements. Specifies the path value of "ActivityDefinition:successor". -
SP_CONTEXT_TYPE_VALUE
Search parameter: context-type-valueDescription: A use context type and value assigned to the activity definition
Type: composite
Path:
- See Also:
-
CONTEXT_TYPE_VALUE
public static final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.TokenClientParam> CONTEXT_TYPE_VALUEFluent Client search parameter constant for context-type-valueDescription: A use context type and value assigned to the activity definition
Type: composite
Path:
-
SP_JURISDICTION
Search parameter: jurisdictionDescription: Intended jurisdiction for the activity definition
Type: token
Path: ActivityDefinition.jurisdiction
- See Also:
-
JURISDICTION
Fluent Client search parameter constant for jurisdictionDescription: Intended jurisdiction for the activity definition
Type: token
Path: ActivityDefinition.jurisdiction
-
SP_DESCRIPTION
Search parameter: descriptionDescription: The description of the activity definition
Type: string
Path: ActivityDefinition.description
- See Also:
-
DESCRIPTION
Fluent Client search parameter constant for descriptionDescription: The description of the activity definition
Type: string
Path: ActivityDefinition.description
-
SP_DERIVED_FROM
Search parameter: derived-fromDescription: What resource is being referenced
Type: reference
Path: ActivityDefinition.relatedArtifact.resource
- See Also:
-
DERIVED_FROM
Fluent Client search parameter constant for derived-fromDescription: What resource is being referenced
Type: reference
Path: ActivityDefinition.relatedArtifact.resource
-
INCLUDE_DERIVED_FROM
Constant for fluent queries to be used to add include statements. Specifies the path value of "ActivityDefinition:derived-from". -
SP_CONTEXT_TYPE
Search parameter: context-typeDescription: A type of use context assigned to the activity definition
Type: token
Path: ActivityDefinition.useContext.code
- See Also:
-
CONTEXT_TYPE
Fluent Client search parameter constant for context-typeDescription: A type of use context assigned to the activity definition
Type: token
Path: ActivityDefinition.useContext.code
-
SP_PREDECESSOR
Search parameter: predecessorDescription: What resource is being referenced
Type: reference
Path: ActivityDefinition.relatedArtifact.resource
- See Also:
-
PREDECESSOR
Fluent Client search parameter constant for predecessorDescription: What resource is being referenced
Type: reference
Path: ActivityDefinition.relatedArtifact.resource
-
INCLUDE_PREDECESSOR
Constant for fluent queries to be used to add include statements. Specifies the path value of "ActivityDefinition:predecessor". -
SP_TITLE
Search parameter: titleDescription: The human-friendly name of the activity definition
Type: string
Path: ActivityDefinition.title
- See Also:
-
TITLE
Fluent Client search parameter constant for titleDescription: The human-friendly name of the activity definition
Type: string
Path: ActivityDefinition.title
-
SP_COMPOSED_OF
Search parameter: composed-ofDescription: What resource is being referenced
Type: reference
Path: ActivityDefinition.relatedArtifact.resource
- See Also:
-
COMPOSED_OF
Fluent Client search parameter constant for composed-ofDescription: What resource is being referenced
Type: reference
Path: ActivityDefinition.relatedArtifact.resource
-
INCLUDE_COMPOSED_OF
Constant for fluent queries to be used to add include statements. Specifies the path value of "ActivityDefinition:composed-of". -
SP_VERSION
Search parameter: versionDescription: The business version of the activity definition
Type: token
Path: ActivityDefinition.version
- See Also:
-
VERSION
Fluent Client search parameter constant for versionDescription: The business version of the activity definition
Type: token
Path: ActivityDefinition.version
-
SP_URL
Search parameter: urlDescription: The uri that identifies the activity definition
Type: uri
Path: ActivityDefinition.url
- See Also:
-
URL
Fluent Client search parameter constant for urlDescription: The uri that identifies the activity definition
Type: uri
Path: ActivityDefinition.url
-
SP_CONTEXT_QUANTITY
Search parameter: context-quantityDescription: A quantity- or range-valued use context assigned to the activity definition
Type: quantity
Path: ActivityDefinition.useContext.valueQuantity, ActivityDefinition.useContext.valueRange
- See Also:
-
CONTEXT_QUANTITY
Fluent Client search parameter constant for context-quantityDescription: A quantity- or range-valued use context assigned to the activity definition
Type: quantity
Path: ActivityDefinition.useContext.valueQuantity, ActivityDefinition.useContext.valueRange
-
SP_EFFECTIVE
Search parameter: effectiveDescription: The time during which the activity definition is intended to be in use
Type: date
Path: ActivityDefinition.effectivePeriod
- See Also:
-
EFFECTIVE
Fluent Client search parameter constant for effectiveDescription: The time during which the activity definition is intended to be in use
Type: date
Path: ActivityDefinition.effectivePeriod
-
SP_DEPENDS_ON
Search parameter: depends-onDescription: What resource is being referenced
Type: reference
Path: ActivityDefinition.relatedArtifact.resource, ActivityDefinition.library
- See Also:
-
DEPENDS_ON
Fluent Client search parameter constant for depends-onDescription: What resource is being referenced
Type: reference
Path: ActivityDefinition.relatedArtifact.resource, ActivityDefinition.library
-
INCLUDE_DEPENDS_ON
Constant for fluent queries to be used to add include statements. Specifies the path value of "ActivityDefinition:depends-on". -
SP_NAME
Search parameter: nameDescription: Computationally friendly name of the activity definition
Type: string
Path: ActivityDefinition.name
- See Also:
-
NAME
Fluent Client search parameter constant for nameDescription: Computationally friendly name of the activity definition
Type: string
Path: ActivityDefinition.name
-
SP_CONTEXT
Search parameter: contextDescription: A use context assigned to the activity definition
Type: token
Path: ActivityDefinition.useContext.valueCodeableConcept
- See Also:
-
CONTEXT
Fluent Client search parameter constant for contextDescription: A use context assigned to the activity definition
Type: token
Path: ActivityDefinition.useContext.valueCodeableConcept
-
SP_PUBLISHER
Search parameter: publisherDescription: Name of the publisher of the activity definition
Type: string
Path: ActivityDefinition.publisher
- See Also:
-
PUBLISHER
Fluent Client search parameter constant for publisherDescription: Name of the publisher of the activity definition
Type: string
Path: ActivityDefinition.publisher
-
SP_TOPIC
Search parameter: topicDescription: Topics associated with the module
Type: token
Path: ActivityDefinition.topic
- See Also:
-
TOPIC
Fluent Client search parameter constant for topicDescription: Topics associated with the module
Type: token
Path: ActivityDefinition.topic
-
SP_CONTEXT_TYPE_QUANTITY
Search parameter: context-type-quantityDescription: A use context type and quantity- or range-based value assigned to the activity definition
Type: composite
Path:
- See Also:
-
CONTEXT_TYPE_QUANTITY
public static final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.QuantityClientParam> CONTEXT_TYPE_QUANTITYFluent Client search parameter constant for context-type-quantityDescription: A use context type and quantity- or range-based value assigned to the activity definition
Type: composite
Path:
-
SP_STATUS
Search parameter: statusDescription: The current status of the activity definition
Type: token
Path: ActivityDefinition.status
- See Also:
-
STATUS
Fluent Client search parameter constant for statusDescription: The current status of the activity definition
Type: token
Path: ActivityDefinition.status
-
-
Constructor Details
-
ActivityDefinition
public ActivityDefinition()Constructor -
ActivityDefinition
Constructor
-
-
Method Details
-
getUrlElement
- Overrides:
getUrlElement
in classMetadataResource
- 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; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this activity definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the activity definition is stored on different servers.). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value
-
hasUrlElement
- Overrides:
hasUrlElement
in classMetadataResource
-
hasUrl
- Overrides:
hasUrl
in classMetadataResource
-
setUrlElement
- Overrides:
setUrlElement
in classMetadataResource
- Parameters:
value
-MetadataResource.url
(An absolute URI that is used to identify this activity definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this activity definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the activity definition is stored on different servers.). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value
-
getUrl
- Overrides:
getUrl
in classMetadataResource
- Returns:
- An absolute URI that is used to identify this activity definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this activity definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the activity definition is stored on different servers.
-
setUrl
- Overrides:
setUrl
in classMetadataResource
- 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; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this activity definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the activity definition is stored on different servers.
-
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
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasIdentifier
-
addIdentifier
-
addIdentifier
-
getIdentifierFirstRep
- Returns:
- The first repetition of repeating field
identifier
, creating it if it does not already exist
-
getVersionElement
- Overrides:
getVersionElement
in classMetadataResource
- Returns:
MetadataResource.version
(The identifier that is used to identify this version of the 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
- Overrides:
hasVersionElement
in classMetadataResource
-
hasVersion
- Overrides:
hasVersion
in classMetadataResource
-
setVersionElement
- Overrides:
setVersionElement
in classMetadataResource
- Parameters:
value
-MetadataResource.version
(The identifier that is used to identify this version of the 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
- Overrides:
getVersion
in classMetadataResource
- 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
- Overrides:
setVersion
in classMetadataResource
- 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
- Overrides:
getNameElement
in classMetadataResource
- 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
- Overrides:
hasNameElement
in classMetadataResource
-
hasName
- Overrides:
hasName
in classMetadataResource
-
setNameElement
- Overrides:
setNameElement
in classMetadataResource
- 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
- Overrides:
getName
in classMetadataResource
- 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
- Overrides:
setName
in classMetadataResource
- 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
- Overrides:
getTitleElement
in classMetadataResource
- 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
- Overrides:
hasTitleElement
in classMetadataResource
-
hasTitle
- Overrides:
hasTitle
in classMetadataResource
-
setTitleElement
- Overrides:
setTitleElement
in classMetadataResource
- Parameters:
value
-MetadataResource.title
(A short, descriptive, user-friendly title for the activity definition.). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value
-
getTitle
- Overrides:
getTitle
in classMetadataResource
- Returns:
- A short, descriptive, user-friendly title for the activity definition.
-
setTitle
- Overrides:
setTitle
in classMetadataResource
- Parameters:
value
- A short, descriptive, user-friendly title for the activity definition.
-
getSubtitleElement
- Returns:
subtitle
(An explanatory or alternate title for the activity definition giving additional information about its content.). This is the underlying object with id, value and extensions. The accessor "getSubtitle" gives direct access to the value
-
hasSubtitleElement
-
hasSubtitle
-
setSubtitleElement
- Parameters:
value
-subtitle
(An explanatory or alternate title for the activity definition giving additional information about its content.). This is the underlying object with id, value and extensions. The accessor "getSubtitle" gives direct access to the value
-
getSubtitle
- Returns:
- An explanatory or alternate title for the activity definition giving additional information about its content.
-
setSubtitle
- Parameters:
value
- An explanatory or alternate title for the activity definition giving additional information about its content.
-
getStatusElement
- Overrides:
getStatusElement
in classMetadataResource
- 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
- Overrides:
hasStatusElement
in classMetadataResource
-
hasStatus
- Overrides:
hasStatus
in classMetadataResource
-
setStatusElement
- Overrides:
setStatusElement
in classMetadataResource
- 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
- Overrides:
getStatus
in classMetadataResource
- Returns:
- The status of this activity definition. Enables tracking the life-cycle of the content.
-
setStatus
- Overrides:
setStatus
in classMetadataResource
- Parameters:
value
- The status of this activity definition. Enables tracking the life-cycle of the content.
-
getExperimentalElement
- Overrides:
getExperimentalElement
in classMetadataResource
- 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
- Overrides:
hasExperimentalElement
in classMetadataResource
-
hasExperimental
- Overrides:
hasExperimental
in classMetadataResource
-
setExperimentalElement
- Overrides:
setExperimentalElement
in classMetadataResource
- Parameters:
value
-MetadataResource.experimental
(A Boolean value to indicate that this 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
- Overrides:
getExperimental
in classMetadataResource
- 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
- Overrides:
setExperimental
in classMetadataResource
- 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.
-
getSubject
- Returns:
subject
(A code or group definition that describes the intended subject of the activity being defined.)
-
getSubjectCodeableConcept
- Returns:
subject
(A code or group definition that describes the intended subject of the activity being defined.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasSubjectCodeableConcept
-
getSubjectReference
- Returns:
subject
(A code or group definition that describes the intended subject of the activity being defined.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasSubjectReference
-
hasSubject
-
setSubject
- Parameters:
value
-subject
(A code or group definition that describes the intended subject of the activity being defined.)
-
getDateElement
- Overrides:
getDateElement
in classMetadataResource
- Returns:
MetadataResource.date
(The date (and optionally time) when the activity definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the activity definition changes.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value
-
hasDateElement
- Overrides:
hasDateElement
in classMetadataResource
-
hasDate
- Overrides:
hasDate
in classMetadataResource
-
setDateElement
- Overrides:
setDateElement
in classMetadataResource
- Parameters:
value
-MetadataResource.date
(The date (and optionally time) when the activity definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the activity definition changes.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value
-
getDate
- Overrides:
getDate
in classMetadataResource
- Returns:
- The date (and optionally time) when the activity definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the activity definition changes.
-
setDate
- Overrides:
setDate
in classMetadataResource
- Parameters:
value
- The date (and optionally time) when the activity definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the activity definition changes.
-
getPublisherElement
- Overrides:
getPublisherElement
in classMetadataResource
- Returns:
MetadataResource.publisher
(The name of the organization or individual 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
- Overrides:
hasPublisherElement
in classMetadataResource
-
hasPublisher
- Overrides:
hasPublisher
in classMetadataResource
-
setPublisherElement
- Overrides:
setPublisherElement
in classMetadataResource
- Parameters:
value
-MetadataResource.publisher
(The name of the organization or individual 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
- Overrides:
getPublisher
in classMetadataResource
- Returns:
- The name of the organization or individual that published the activity definition.
-
setPublisher
- Overrides:
setPublisher
in classMetadataResource
- Parameters:
value
- The name of the organization or individual that published the activity definition.
-
getContact
- Overrides:
getContact
in classMetadataResource
- Returns:
MetadataResource.contact
(Contact details to assist a user in finding and communicating with the publisher.)
-
setContact
- Overrides:
setContact
in classMetadataResource
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasContact
- Overrides:
hasContact
in classMetadataResource
-
addContact
- Overrides:
addContact
in classMetadataResource
-
addContact
- Overrides:
addContact
in classMetadataResource
-
getContactFirstRep
- Overrides:
getContactFirstRep
in classMetadataResource
- Returns:
- The first repetition of repeating field
MetadataResource.contact
, creating it if it does not already exist
-
getDescriptionElement
- Overrides:
getDescriptionElement
in classMetadataResource
- 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
- Overrides:
hasDescriptionElement
in classMetadataResource
-
hasDescription
- Overrides:
hasDescription
in classMetadataResource
-
setDescriptionElement
- Overrides:
setDescriptionElement
in classMetadataResource
- Parameters:
value
-MetadataResource.description
(A free text natural language description of the 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
- Overrides:
getDescription
in classMetadataResource
- Returns:
- A free text natural language description of the activity definition from a consumer's perspective.
-
setDescription
- Overrides:
setDescription
in classMetadataResource
- Parameters:
value
- A free text natural language description of the activity definition from a consumer's perspective.
-
getUseContext
- Overrides:
getUseContext
in classMetadataResource
- Returns:
MetadataResource.useContext
(The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate activity definition instances.)
-
setUseContext
- Overrides:
setUseContext
in classMetadataResource
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasUseContext
- Overrides:
hasUseContext
in classMetadataResource
-
addUseContext
- Overrides:
addUseContext
in classMetadataResource
-
addUseContext
- Overrides:
addUseContext
in classMetadataResource
-
getUseContextFirstRep
- Overrides:
getUseContextFirstRep
in classMetadataResource
- Returns:
- The first repetition of repeating field
MetadataResource.useContext
, creating it if it does not already exist
-
getJurisdiction
- Overrides:
getJurisdiction
in classMetadataResource
- Returns:
MetadataResource.jurisdiction
(A legal or geographic region in which the activity definition is intended to be used.)
-
setJurisdiction
- Overrides:
setJurisdiction
in classMetadataResource
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasJurisdiction
- Overrides:
hasJurisdiction
in classMetadataResource
-
addJurisdiction
- Overrides:
addJurisdiction
in classMetadataResource
-
addJurisdiction
- Overrides:
addJurisdiction
in classMetadataResource
-
getJurisdictionFirstRep
- Overrides:
getJurisdictionFirstRep
in classMetadataResource
- Returns:
- The first repetition of repeating field
MetadataResource.jurisdiction
, creating it if it does not already exist
-
getPurposeElement
- Returns:
purpose
(Explanation 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
-
hasPurpose
-
setPurposeElement
- Parameters:
value
-purpose
(Explanation 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
- Returns:
- Explanation of why this activity definition is needed and why it has been designed as it has.
-
setPurpose
- Parameters:
value
- Explanation of why this activity definition is needed and why it has been designed as it has.
-
getUsageElement
- Returns:
usage
(A detailed description of how the activity definition is used from a clinical perspective.). This is the underlying object with id, value and extensions. The accessor "getUsage" gives direct access to the value
-
hasUsageElement
-
hasUsage
-
setUsageElement
- Parameters:
value
-usage
(A detailed description of how the activity definition is used from a clinical perspective.). This is the underlying object with id, value and extensions. The accessor "getUsage" gives direct access to the value
-
getUsage
- Returns:
- A detailed description of how the activity definition is used from a clinical perspective.
-
setUsage
- Parameters:
value
- A detailed description of how the activity definition is used from a clinical perspective.
-
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
-
hasCopyright
-
setCopyrightElement
- 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
- 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
- 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.
-
getApprovalDateElement
- Returns:
approvalDate
(The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.). This is the underlying object with id, value and extensions. The accessor "getApprovalDate" gives direct access to the value
-
hasApprovalDateElement
-
hasApprovalDate
-
setApprovalDateElement
- Parameters:
value
-approvalDate
(The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.). This is the underlying object with id, value and extensions. The accessor "getApprovalDate" gives direct access to the value
-
getApprovalDate
- Returns:
- The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
-
setApprovalDate
- Parameters:
value
- The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
-
getLastReviewDateElement
- Returns:
lastReviewDate
(The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.). This is the underlying object with id, value and extensions. The accessor "getLastReviewDate" gives direct access to the value
-
hasLastReviewDateElement
-
hasLastReviewDate
-
setLastReviewDateElement
- Parameters:
value
-lastReviewDate
(The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.). This is the underlying object with id, value and extensions. The accessor "getLastReviewDate" gives direct access to the value
-
getLastReviewDate
- Returns:
- The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
-
setLastReviewDate
- Parameters:
value
- The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
-
getEffectivePeriod
- Returns:
effectivePeriod
(The period during which the activity definition content was or is planned to be in active use.)
-
hasEffectivePeriod
-
setEffectivePeriod
- Parameters:
value
-effectivePeriod
(The period during which the activity definition content was or is planned to be in active use.)
-
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
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasTopic
-
addTopic
-
addTopic
-
getTopicFirstRep
- Returns:
- The first repetition of repeating field
topic
, creating it if it does not already exist
-
getAuthor
- Returns:
author
(An individiual or organization primarily involved in the creation and maintenance of the content.)
-
setAuthor
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasAuthor
-
addAuthor
-
addAuthor
-
getAuthorFirstRep
- Returns:
- The first repetition of repeating field
author
, creating it if it does not already exist
-
getEditor
- Returns:
editor
(An individual or organization primarily responsible for internal coherence of the content.)
-
setEditor
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasEditor
-
addEditor
-
addEditor
-
getEditorFirstRep
- Returns:
- The first repetition of repeating field
editor
, creating it if it does not already exist
-
getReviewer
- Returns:
reviewer
(An individual or organization primarily responsible for review of some aspect of the content.)
-
setReviewer
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasReviewer
-
addReviewer
-
addReviewer
-
getReviewerFirstRep
- Returns:
- The first repetition of repeating field
reviewer
, creating it if it does not already exist
-
getEndorser
- Returns:
endorser
(An individual or organization responsible for officially endorsing the content for use in some setting.)
-
setEndorser
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasEndorser
-
addEndorser
-
addEndorser
-
getEndorserFirstRep
- Returns:
- The first repetition of repeating field
endorser
, creating it if it does not already exist
-
getRelatedArtifact
- Returns:
relatedArtifact
(Related artifacts such as additional documentation, justification, or bibliographic references.)
-
setRelatedArtifact
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasRelatedArtifact
-
addRelatedArtifact
-
addRelatedArtifact
-
getRelatedArtifactFirstRep
- Returns:
- The first repetition of repeating field
relatedArtifact
, creating it if it does not already exist
-
getLibrary
- Returns:
library
(A reference to a Library resource containing any formal logic used by the activity definition.)
-
setLibrary
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasLibrary
-
addLibraryElement
- Returns:
library
(A reference to a Library resource containing any formal logic used by the activity definition.)
-
addLibrary
- Parameters:
value
-library
(A reference to a Library resource containing any formal logic used by the activity definition.)
-
hasLibrary
- Parameters:
value
-library
(A reference to a Library resource containing any formal logic used by the activity definition.)
-
getKindElement
- Returns:
kind
(A description of the kind of resource the activity definition is representing. For example, a MedicationRequest, a ServiceRequest, 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
-
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 ServiceRequest, 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
- Returns:
- A description of the kind of resource the activity definition is representing. For example, a MedicationRequest, a ServiceRequest, or a CommunicationRequest. Typically, but not always, this is a Request resource.
-
setKind
- Parameters:
value
- A description of the kind of resource the activity definition is representing. For example, a MedicationRequest, a ServiceRequest, or a CommunicationRequest. Typically, but not always, this is a Request resource.
-
getProfileElement
- Returns:
profile
(A profile to which the target of the activity definition is expected to conform.). This is the underlying object with id, value and extensions. The accessor "getProfile" gives direct access to the value
-
hasProfileElement
-
hasProfile
-
setProfileElement
- Parameters:
value
-profile
(A profile to which the target of the activity definition is expected to conform.). This is the underlying object with id, value and extensions. The accessor "getProfile" gives direct access to the value
-
getProfile
- Returns:
- A profile to which the target of the activity definition is expected to conform.
-
setProfile
- Parameters:
value
- A profile to which the target of the activity definition is expected to conform.
-
getCode
- Returns:
code
(Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter.)
-
hasCode
-
setCode
- Parameters:
value
-code
(Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter.)
-
getIntentElement
- Returns:
intent
(Indicates the level of authority/intentionality associated with the activity and where the request should fit into the workflow chain.). This is the underlying object with id, value and extensions. The accessor "getIntent" gives direct access to the value
-
hasIntentElement
-
hasIntent
-
setIntentElement
- Parameters:
value
-intent
(Indicates the level of authority/intentionality associated with the activity and where the request should fit into the workflow chain.). This is the underlying object with id, value and extensions. The accessor "getIntent" gives direct access to the value
-
getIntent
- Returns:
- Indicates the level of authority/intentionality associated with the activity and where the request should fit into the workflow chain.
-
setIntent
- Parameters:
value
- Indicates the level of authority/intentionality associated with the activity and where the request should fit into the workflow chain.
-
getPriorityElement
- Returns:
priority
(Indicates how quickly the activity should be addressed with respect to other requests.). This is the underlying object with id, value and extensions. The accessor "getPriority" gives direct access to the value
-
hasPriorityElement
-
hasPriority
-
setPriorityElement
- Parameters:
value
-priority
(Indicates how quickly the activity should be addressed with respect to other requests.). This is the underlying object with id, value and extensions. The accessor "getPriority" gives direct access to the value
-
getPriority
- Returns:
- Indicates how quickly the activity should be addressed with respect to other requests.
-
setPriority
- Parameters:
value
- Indicates how quickly the activity should be addressed with respect to other requests.
-
getDoNotPerformElement
- Returns:
doNotPerform
(Set this to true if the definition is to indicate that a particular activity should NOT be performed. If true, this element should be interpreted to reinforce a negative coding. For example NPO as a code with a doNotPerform of true would still indicate to NOT perform the action.). This is the underlying object with id, value and extensions. The accessor "getDoNotPerform" gives direct access to the value
-
hasDoNotPerformElement
-
hasDoNotPerform
-
setDoNotPerformElement
- Parameters:
value
-doNotPerform
(Set this to true if the definition is to indicate that a particular activity should NOT be performed. If true, this element should be interpreted to reinforce a negative coding. For example NPO as a code with a doNotPerform of true would still indicate to NOT perform the action.). This is the underlying object with id, value and extensions. The accessor "getDoNotPerform" gives direct access to the value
-
getDoNotPerform
- Returns:
- Set this to true if the definition is to indicate that a particular activity should NOT be performed. If true, this element should be interpreted to reinforce a negative coding. For example NPO as a code with a doNotPerform of true would still indicate to NOT perform the action.
-
setDoNotPerform
- Parameters:
value
- Set this to true if the definition is to indicate that a particular activity should NOT be performed. If true, this element should be interpreted to reinforce a negative coding. For example NPO as a code with a doNotPerform of true would still indicate to NOT perform the action.
-
getTiming
- Returns:
timing
(The period, timing or frequency upon which the described activity is to occur.)
-
getTimingTiming
- Returns:
timing
(The period, timing or frequency upon which the described activity is to occur.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasTimingTiming
-
getTimingDateTimeType
- Returns:
timing
(The period, timing or frequency upon which the described activity is to occur.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasTimingDateTimeType
-
getTimingAge
- Returns:
timing
(The period, timing or frequency upon which the described activity is to occur.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasTimingAge
-
getTimingPeriod
- Returns:
timing
(The period, timing or frequency upon which the described activity is to occur.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasTimingPeriod
-
getTimingRange
- Returns:
timing
(The period, timing or frequency upon which the described activity is to occur.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasTimingRange
-
getTimingDuration
- Returns:
timing
(The period, timing or frequency upon which the described activity is to occur.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasTimingDuration
-
hasTiming
-
setTiming
- Parameters:
value
-timing
(The period, timing or frequency upon which the described activity is to occur.)
-
getLocation
- Returns:
location
(Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.)
-
hasLocation
-
setLocation
- Parameters:
value
-location
(Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.)
-
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
- 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
- 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
-
addParticipant
-
addParticipant
-
getParticipantFirstRep
- Returns:
- The first repetition of repeating field
participant
, creating it if it does not already exist
-
getProduct
- Returns:
product
(Identifies the food, drug or other product being consumed or supplied in the activity.)
-
getProductReference
- Returns:
product
(Identifies the food, drug or other product being consumed or supplied in the activity.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasProductReference
-
getProductCodeableConcept
- Returns:
product
(Identifies the food, drug or other product being consumed or supplied in the activity.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasProductCodeableConcept
-
hasProduct
-
setProduct
- Parameters:
value
-product
(Identifies the food, drug or other product being consumed or supplied in the activity.)
-
getQuantity
- Returns:
quantity
(Identifies the quantity expected to be consumed at once (per dose, per meal, etc.).)
-
hasQuantity
-
setQuantity
- Parameters:
value
-quantity
(Identifies the quantity expected to be consumed at once (per dose, per meal, etc.).)
-
getDosage
- Returns:
dosage
(Provides detailed dosage instructions in the same way that they are described for MedicationRequest resources.)
-
setDosage
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasDosage
-
addDosage
-
addDosage
-
getDosageFirstRep
- Returns:
- The first repetition of repeating field
dosage
, creating it if it does not already exist
-
getBodySite
- Returns:
bodySite
(Indicates the sites on the subject's body where the procedure should be performed (I.e. the target sites).)
-
setBodySite
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasBodySite
-
addBodySite
-
addBodySite
-
getBodySiteFirstRep
- Returns:
- The first repetition of repeating field
bodySite
, creating it if it does not already exist
-
getSpecimenRequirement
- Returns:
specimenRequirement
(Defines specimen requirements for the action to be performed, such as required specimens for a lab test.)
-
setSpecimenRequirement
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasSpecimenRequirement
-
addSpecimenRequirement
-
addSpecimenRequirement
-
getSpecimenRequirementFirstRep
- Returns:
- The first repetition of repeating field
specimenRequirement
, creating it if it does not already exist
-
getSpecimenRequirementTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
addSpecimenRequirementTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
getObservationRequirement
- Returns:
observationRequirement
(Defines observation requirements for the action to be performed, such as body weight or surface area.)
-
setObservationRequirement
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasObservationRequirement
-
addObservationRequirement
-
addObservationRequirement
-
getObservationRequirementFirstRep
- Returns:
- The first repetition of repeating field
observationRequirement
, creating it if it does not already exist
-
getObservationRequirementTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
addObservationRequirementTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
getObservationResultRequirement
- Returns:
observationResultRequirement
(Defines the observations that are expected to be produced by the action.)
-
setObservationResultRequirement
public ActivityDefinition setObservationResultRequirement(List<Reference> theObservationResultRequirement) - Returns:
- Returns a reference to
this
for easy method chaining
-
hasObservationResultRequirement
-
addObservationResultRequirement
-
addObservationResultRequirement
-
getObservationResultRequirementFirstRep
- Returns:
- The first repetition of repeating field
observationResultRequirement
, creating it if it does not already exist
-
getObservationResultRequirementTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
addObservationResultRequirementTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
getTransformElement
- 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.). This is the underlying object with id, value and extensions. The accessor "getTransform" gives direct access to the value
-
hasTransformElement
-
hasTransform
-
setTransformElement
- 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.). This is the underlying object with id, value and extensions. The accessor "getTransform" gives direct access to the value
-
getTransform
- Returns:
- 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.
-
setTransform
- Parameters:
value
- 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
- 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 request 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
-
addDynamicValue
-
addDynamicValue
-
getDynamicValueFirstRep
- Returns:
- The first repetition of repeating field
dynamicValue
, creating it if it does not already exist
-
listChildren
- Overrides:
listChildren
in classMetadataResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getNamedProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getProperty
in classMetadataResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
setProperty
in classMetadataResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
- Overrides:
setProperty
in classMetadataResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
removeChild
- Overrides:
removeChild
in classMetadataResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
- Overrides:
makeProperty
in classMetadataResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getTypesForProperty
in classMetadataResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
- Overrides:
addChild
in classMetadataResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
- Specified by:
fhirType
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
fhirType
in classMetadataResource
-
copy
- Specified by:
copy
in classMetadataResource
-
copyValues
-
typedCopy
-
equalsDeep
- Overrides:
equalsDeep
in classMetadataResource
-
equalsShallow
- Overrides:
equalsShallow
in classMetadataResource
-
isEmpty
- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
isEmpty
in classMetadataResource
-
getResourceType
- Specified by:
getResourceType
in classResource
-