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
Nested ClassesModifier and TypeClassDescriptionstatic classstatic classstatic enumstatic class -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected DateTypeThe 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 CodeableConceptDetailed description of the type of activity; e.g.static final ca.uhn.fhir.rest.gclient.ReferenceClientParamFluent Client search parameter constant for composed-ofprotected List<ContactDetail>Contact details to assist a user in finding and communicating with the publisher.static final ca.uhn.fhir.rest.gclient.TokenClientParamFluent Client search parameter constant for contextstatic final ca.uhn.fhir.rest.gclient.QuantityClientParamFluent Client search parameter constant for context-quantitystatic final ca.uhn.fhir.rest.gclient.TokenClientParamFluent 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 MarkdownTypeA copyright statement relating to the activity definition and/or its contents.protected DateTimeTypeThe date (and optionally time) when the activity definition was published.static final ca.uhn.fhir.rest.gclient.DateClientParamFluent Client search parameter constant for datestatic final ca.uhn.fhir.rest.gclient.ReferenceClientParamFluent Client search parameter constant for depends-onstatic final ca.uhn.fhir.rest.gclient.ReferenceClientParamFluent Client search parameter constant for derived-fromprotected MarkdownTypeA free text natural language description of the activity definition from a consumer's perspective.static final ca.uhn.fhir.rest.gclient.StringClientParamFluent Client search parameter constant for descriptionprotected BooleanTypeSet 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.DateClientParamFluent Client search parameter constant for effectiveprotected PeriodThe 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 BooleanTypeA 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.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.TokenClientParamFluent Client search parameter constant for identifierstatic final ca.uhn.fhir.model.api.IncludeConstant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.IncludeConstant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.IncludeConstant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.IncludeConstant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.IncludeConstant for fluent queries to be used to add include statements.protected Enumeration<Enumerations.RequestIntent>Indicates the level of authority/intentionality associated with the activity and where the request should fit into the workflow chain.protected List<CodeableConcept>A legal or geographic region in which the activity definition is intended to be used.static final ca.uhn.fhir.rest.gclient.TokenClientParamFluent Client search parameter constant for jurisdictionA description of the kind of resource the activity definition is representing.static final ca.uhn.fhir.rest.gclient.TokenClientParamFluent Client search parameter constant for kindprotected DateTypeThe 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 CodeableReferenceIdentifies the facility where the activity will occur; e.g.protected StringTypeA natural language name identifying the activity definition.static final ca.uhn.fhir.rest.gclient.StringClientParamFluent Client search parameter constant for nameDefines 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.Indicates who should participate in performing the action described.static final ca.uhn.fhir.rest.gclient.ReferenceClientParamFluent Client search parameter constant for predecessorprotected Enumeration<Enumerations.RequestPriority>Indicates how quickly the activity should be addressed with respect to other requests.protected DataTypeIdentifies the food, drug or other product being consumed or supplied in the activity.protected CanonicalTypeA profile to which the target of the activity definition is expected to conform.protected StringTypeThe name of the organization or individual that published the activity definition.static final ca.uhn.fhir.rest.gclient.StringClientParamFluent Client search parameter constant for publisherprotected MarkdownTypeExplanation of why this activity definition is needed and why it has been designed as it has.protected QuantityIdentifies 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 StringSearch parameter: composed-ofstatic final StringSearch parameter: contextstatic final StringSearch parameter: context-quantitystatic final StringSearch parameter: context-typestatic final StringSearch parameter: context-type-quantitystatic final StringSearch parameter: context-type-valuestatic final StringSearch parameter: datestatic final StringSearch parameter: depends-onstatic final StringSearch parameter: derived-fromstatic final StringSearch parameter: descriptionstatic final StringSearch parameter: effectivestatic final StringSearch parameter: identifierstatic final StringSearch parameter: jurisdictionstatic final StringSearch parameter: kindstatic final StringSearch parameter: namestatic final StringSearch parameter: predecessorstatic final StringSearch parameter: publisherstatic final StringSearch parameter: statusstatic final StringSearch parameter: successorstatic final StringSearch parameter: titlestatic final StringSearch parameter: topicstatic final StringSearch parameter: urlstatic final StringSearch parameter: versionDefines specimen requirements for the action to be performed, such as required specimens for a lab test.protected Enumeration<Enumerations.PublicationStatus>The status of this activity definition.static final ca.uhn.fhir.rest.gclient.TokenClientParamFluent Client search parameter constant for statusprotected DataTypeA code, group definition, or canonical reference that describes or identifies the intended subject of the activity being defined.protected StringTypeAn explanatory or alternate title for the activity definition giving additional information about its content.static final ca.uhn.fhir.rest.gclient.ReferenceClientParamFluent Client search parameter constant for successorprotected DataTypeThe timing or frequency upon which the described activity is to occur.protected StringTypeA short, descriptive, user-friendly title for the activity definition.static final ca.uhn.fhir.rest.gclient.StringClientParamFluent Client search parameter constant for titleprotected List<CodeableConcept>Descriptive topics related to the content of the activity.static final ca.uhn.fhir.rest.gclient.TokenClientParamFluent Client search parameter constant for topicprotected CanonicalTypeA 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 UriTypeAn 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.static final ca.uhn.fhir.rest.gclient.UriClientParamFluent Client search parameter constant for urlprotected StringTypeA detailed description of how the activity definition is used from a clinical perspective.protected List<UsageContext>The content was developed with a focus and intent of supporting the contexts that are listed.protected StringTypeThe identifier that is used to identify this version of the activity definition when it is referenced in a specification, model, design or instance.static final ca.uhn.fhir.rest.gclient.TokenClientParamFluent Client search parameter constant for versionFields inherited from class org.hl7.fhir.r5.model.DomainResource
contained, extension, modifierExtension, SP_TEXT, text, TEXTFields inherited from class org.hl7.fhir.r5.model.Resource
id, implicitRules, language, metaFields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
RES_ID, SP_RES_IDFields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET -
Constructor Summary
ConstructorsConstructorDescriptionConstructorConstructor -
Method Summary
Modifier and TypeMethodDescriptionaddLibrary(String value) addTopic()copy()voidbooleanequalsDeep(Base other_) booleanequalsShallow(Base other_) fhirType()getCode()getDate()booleanbooleangetKind()getName()getNamedProperty(int _hash, String _name, boolean _checkValid) Base[]getProperty(int hash, String name, boolean checkValid) getTitle()getTopic()String[]getTypesForProperty(int hash, String name) getUrl()getUsage()booleanbooleanbooleanbooleanbooleanhasCode()booleanbooleanbooleanbooleanhasDate()booleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanhasKind()booleanbooleanbooleanbooleanbooleanhasLibrary(String value) booleanbooleanhasName()booleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanhasTitle()booleanbooleanhasTopic()booleanbooleanbooleanhasUrl()booleanbooleanhasUsage()booleanbooleanbooleanbooleanbooleanisEmpty()protected voidlistChildren(List<Property> children) makeProperty(int hash, String name) 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(CodeableReference value) setNameElement(StringType value) setObservationRequirement(List<Reference> theObservationRequirement) setObservationResultRequirement(List<Reference> theObservationResultRequirement) setParticipant(List<ActivityDefinition.ActivityDefinitionParticipantComponent> theParticipant) setProduct(DataType 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(DataType 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 ActivityDefinitionMethods inherited from class org.hl7.fhir.r5.model.MetadataResource
copyValues, getApprovalDateMax, getAuthorMax, getEditorMax, getEffectivePeriodMax, getEndorserMax, getLastReviewDateMax, getRelatedArtifactMax, getReviewerMax, getTopicMaxMethods inherited from class org.hl7.fhir.r5.model.CanonicalResource
copyValues, getContactMax, getCopyrightMax, getDateMax, getDescriptionMax, getExperimentalMax, getIdentifierMax, getJurisdictionMax, getNameMax, getPublisherMax, getPurposeMax, getStatusMax, getTitleMax, getUrlMax, getUseContextMax, getVersionedUrl, getVersionMax, getVUrl, present, supportsCopyright, supportsExperimental, toStringMethods inherited from class org.hl7.fhir.r5.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, setTextMethods inherited from class org.hl7.fhir.r5.model.Resource
copyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMetaMethods inherited from class org.hl7.fhir.r5.model.BaseResource
getStructureFhirVersionEnum, isResource, setIdMethods inherited from class org.hl7.fhir.r5.model.Base
children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyUserData, copyValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getXhtml, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINNMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
getId, getIdElement, getLanguageElement, getUserData, setId, setUserDataMethods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, hasFormatCommentMethods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
getMeta, getStructureFhirVersionEnum, setId
-
Field Details
-
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. -
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. -
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. -
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. -
title
A short, descriptive, user-friendly title for the activity definition. -
subtitle
An explanatory or alternate title for the activity definition giving additional information about its content. -
status
The status of this activity definition. Enables tracking the life-cycle of the content. -
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. -
subject
A code, group definition, or canonical reference that describes or identifies the intended subject of the activity being defined. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource. -
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. -
publisher
The name of the organization or individual that published the activity definition. -
contact
Contact details to assist a user in finding and communicating with the publisher. -
description
A free text natural language description of the activity definition from a consumer's perspective. -
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. -
jurisdiction
A legal or geographic region in which the activity definition is intended to be used. -
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 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. -
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. -
observationRequirement
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. -
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_COMPOSED_OF
Search parameter: composed-ofDescription: What resource is being referenced
Type: reference
Path: ActivityDefinition.relatedArtifact.where(type='composed-of').resource
- See Also:
-
COMPOSED_OF
Fluent Client search parameter constant for composed-ofDescription: What resource is being referenced
Type: reference
Path: ActivityDefinition.relatedArtifact.where(type='composed-of').resource
-
INCLUDE_COMPOSED_OF
Constant for fluent queries to be used to add include statements. Specifies the path value of "ActivityDefinition:composed-of". -
SP_CONTEXT_QUANTITY
Search parameter: context-quantityDescription: A quantity- or range-valued use context assigned to the activity definition
Type: quantity
Path: (ActivityDefinition.useContext.value as Quantity) | (ActivityDefinition.useContext.value as Range)
- 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.value as Quantity) | (ActivityDefinition.useContext.value as Range)
-
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: ActivityDefinition.useContext
- 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: ActivityDefinition.useContext
-
SP_CONTEXT_TYPE_VALUE
Search parameter: context-type-valueDescription: A use context type and value assigned to the activity definition
Type: composite
Path: ActivityDefinition.useContext
- 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: ActivityDefinition.useContext
-
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_CONTEXT
Search parameter: contextDescription: A use context assigned to the activity definition
Type: token
Path: (ActivityDefinition.useContext.value as CodeableConcept)
- See Also:
-
CONTEXT
Fluent Client search parameter constant for contextDescription: A use context assigned to the activity definition
Type: token
Path: (ActivityDefinition.useContext.value as CodeableConcept)
-
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_DEPENDS_ON
Search parameter: depends-onDescription: What resource is being referenced
Type: reference
Path: ActivityDefinition.relatedArtifact.where(type='depends-on').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.where(type='depends-on').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_DERIVED_FROM
Search parameter: derived-fromDescription: What resource is being referenced
Type: reference
Path: ActivityDefinition.relatedArtifact.where(type='derived-from').resource
- See Also:
-
DERIVED_FROM
Fluent Client search parameter constant for derived-fromDescription: What resource is being referenced
Type: reference
Path: ActivityDefinition.relatedArtifact.where(type='derived-from').resource
-
INCLUDE_DERIVED_FROM
Constant for fluent queries to be used to add include statements. Specifies the path value of "ActivityDefinition:derived-from". -
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_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_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_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_KIND
Search parameter: kindDescription: The kind of activity definition
Type: token
Path: ActivityDefinition.kind
- See Also:
-
KIND
Fluent Client search parameter constant for kindDescription: The kind of activity definition
Type: token
Path: ActivityDefinition.kind
-
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_PREDECESSOR
Search parameter: predecessorDescription: What resource is being referenced
Type: reference
Path: ActivityDefinition.relatedArtifact.where(type='predecessor').resource
- See Also:
-
PREDECESSOR
Fluent Client search parameter constant for predecessorDescription: What resource is being referenced
Type: reference
Path: ActivityDefinition.relatedArtifact.where(type='predecessor').resource
-
INCLUDE_PREDECESSOR
Constant for fluent queries to be used to add include statements. Specifies the path value of "ActivityDefinition:predecessor". -
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_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
-
SP_SUCCESSOR
Search parameter: successorDescription: What resource is being referenced
Type: reference
Path: ActivityDefinition.relatedArtifact.where(type='successor').resource
- See Also:
-
SUCCESSOR
Fluent Client search parameter constant for successorDescription: What resource is being referenced
Type: reference
Path: ActivityDefinition.relatedArtifact.where(type='successor').resource
-
INCLUDE_SUCCESSOR
Constant for fluent queries to be used to add include statements. Specifies the path value of "ActivityDefinition:successor". -
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_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_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_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
-
-
Constructor Details
-
ActivityDefinition
public ActivityDefinition()Constructor -
ActivityDefinition
Constructor
-
-
Method Details
-
getUrlElement
- Specified by:
getUrlElementin classCanonicalResource- Returns:
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
- Specified by:
hasUrlElementin classCanonicalResource
-
hasUrl
- Specified by:
hasUrlin classCanonicalResource
-
setUrlElement
- Specified by:
setUrlElementin classCanonicalResource- Parameters:
value-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
- Specified by:
getUrlin classCanonicalResource- 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
- Specified by:
setUrlin classCanonicalResource- 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
- Specified by:
getIdentifierin classCanonicalResource- 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
- Specified by:
setIdentifierin classCanonicalResource- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasIdentifier
- Specified by:
hasIdentifierin classCanonicalResource
-
addIdentifier
- Specified by:
addIdentifierin classCanonicalResource
-
addIdentifier
- Specified by:
addIdentifierin classCanonicalResource
-
getIdentifierFirstRep
- Specified by:
getIdentifierFirstRepin classCanonicalResource- Returns:
- The first repetition of repeating field
identifier, creating it if it does not already exist {3}
-
getVersionElement
- Specified by:
getVersionElementin classCanonicalResource- Returns:
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
- Specified by:
hasVersionElementin classCanonicalResource
-
hasVersion
- Specified by:
hasVersionin classCanonicalResource
-
setVersionElement
- Specified by:
setVersionElementin classCanonicalResource- Parameters:
value-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
- Specified by:
getVersionin classCanonicalResource- 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
- Specified by:
setVersionin classCanonicalResource- 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
- Specified by:
getNameElementin classCanonicalResource- Returns:
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
- Specified by:
hasNameElementin classCanonicalResource
-
hasName
- Specified by:
hasNamein classCanonicalResource
-
setNameElement
- Specified by:
setNameElementin classCanonicalResource- Parameters:
value-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
- Specified by:
getNamein classCanonicalResource- 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
- Specified by:
setNamein classCanonicalResource- 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
- Specified by:
getTitleElementin classCanonicalResource- Returns:
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
- Specified by:
hasTitleElementin classCanonicalResource
-
hasTitle
- Specified by:
hasTitlein classCanonicalResource
-
setTitleElement
- Specified by:
setTitleElementin classCanonicalResource- Parameters:
value-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
- Specified by:
getTitlein classCanonicalResource- Returns:
- A short, descriptive, user-friendly title for the activity definition.
-
setTitle
- Specified by:
setTitlein classCanonicalResource- 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
- Specified by:
getStatusElementin classCanonicalResource- Returns:
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
- Specified by:
hasStatusElementin classCanonicalResource
-
hasStatus
- Specified by:
hasStatusin classCanonicalResource
-
setStatusElement
- Specified by:
setStatusElementin classCanonicalResource- Parameters:
value-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
- Specified by:
getStatusin classCanonicalResource- Returns:
- The status of this activity definition. Enables tracking the life-cycle of the content.
-
setStatus
- Specified by:
setStatusin classCanonicalResource- Parameters:
value- The status of this activity definition. Enables tracking the life-cycle of the content.
-
getExperimentalElement
- Specified by:
getExperimentalElementin classCanonicalResource- Returns:
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
- Specified by:
hasExperimentalElementin classCanonicalResource
-
hasExperimental
- Specified by:
hasExperimentalin classCanonicalResource
-
setExperimentalElement
- Specified by:
setExperimentalElementin classCanonicalResource- Parameters:
value-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
- Specified by:
getExperimentalin classCanonicalResource- 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
- Specified by:
setExperimentalin classCanonicalResource- 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, group definition, or canonical reference that describes or identifies the intended subject of the activity being defined. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource.)
-
getSubjectCodeableConcept
- Returns:
subject(A code, group definition, or canonical reference that describes or identifies the intended subject of the activity being defined. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasSubjectCodeableConcept
-
getSubjectReference
- Returns:
subject(A code, group definition, or canonical reference that describes or identifies the intended subject of the activity being defined. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasSubjectReference
-
getSubjectCanonicalType
- Returns:
subject(A code, group definition, or canonical reference that describes or identifies the intended subject of the activity being defined. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasSubjectCanonicalType
-
hasSubject
-
setSubject
- Parameters:
value-subject(A code, group definition, or canonical reference that describes or identifies the intended subject of the activity being defined. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource.)
-
getDateElement
- Specified by:
getDateElementin classCanonicalResource- Returns:
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
- Specified by:
hasDateElementin classCanonicalResource
-
hasDate
- Specified by:
hasDatein classCanonicalResource
-
setDateElement
- Specified by:
setDateElementin classCanonicalResource- Parameters:
value-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
- Specified by:
getDatein classCanonicalResource- 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
- Specified by:
setDatein classCanonicalResource- 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
- Specified by:
getPublisherElementin classCanonicalResource- Returns:
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
- Specified by:
hasPublisherElementin classCanonicalResource
-
hasPublisher
- Specified by:
hasPublisherin classCanonicalResource
-
setPublisherElement
- Specified by:
setPublisherElementin classCanonicalResource- Parameters:
value-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
- Specified by:
getPublisherin classCanonicalResource- Returns:
- The name of the organization or individual that published the activity definition.
-
setPublisher
- Specified by:
setPublisherin classCanonicalResource- Parameters:
value- The name of the organization or individual that published the activity definition.
-
getContact
- Specified by:
getContactin classCanonicalResource- Returns:
contact(Contact details to assist a user in finding and communicating with the publisher.)
-
setContact
- Specified by:
setContactin classCanonicalResource- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasContact
- Specified by:
hasContactin classCanonicalResource
-
addContact
- Specified by:
addContactin classCanonicalResource
-
addContact
- Specified by:
addContactin classCanonicalResource
-
getContactFirstRep
- Specified by:
getContactFirstRepin classCanonicalResource- Returns:
- The first repetition of repeating field
contact, creating it if it does not already exist {3}
-
getDescriptionElement
- Specified by:
getDescriptionElementin classCanonicalResource- Returns:
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
- Specified by:
hasDescriptionElementin classCanonicalResource
-
hasDescription
- Specified by:
hasDescriptionin classCanonicalResource
-
setDescriptionElement
- Specified by:
setDescriptionElementin classCanonicalResource- Parameters:
value-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
- Specified by:
getDescriptionin classCanonicalResource- Returns:
- A free text natural language description of the activity definition from a consumer's perspective.
-
setDescription
- Specified by:
setDescriptionin classCanonicalResource- Parameters:
value- A free text natural language description of the activity definition from a consumer's perspective.
-
getUseContext
- Specified by:
getUseContextin classCanonicalResource- Returns:
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
- Specified by:
setUseContextin classCanonicalResource- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasUseContext
- Specified by:
hasUseContextin classCanonicalResource
-
addUseContext
- Specified by:
addUseContextin classCanonicalResource
-
addUseContext
- Specified by:
addUseContextin classCanonicalResource
-
getUseContextFirstRep
- Specified by:
getUseContextFirstRepin classCanonicalResource- Returns:
- The first repetition of repeating field
useContext, creating it if it does not already exist {3}
-
getJurisdiction
- Specified by:
getJurisdictionin classCanonicalResource- Returns:
jurisdiction(A legal or geographic region in which the activity definition is intended to be used.)
-
setJurisdiction
- Specified by:
setJurisdictionin classCanonicalResource- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasJurisdiction
- Specified by:
hasJurisdictionin classCanonicalResource
-
addJurisdiction
- Specified by:
addJurisdictionin classCanonicalResource
-
addJurisdiction
- Specified by:
addJurisdictionin classCanonicalResource
-
getJurisdictionFirstRep
- Specified by:
getJurisdictionFirstRepin classCanonicalResource- Returns:
- The first repetition of repeating field
jurisdiction, creating it if it does not already exist {3}
-
getPurposeElement
- Specified by:
getPurposeElementin classCanonicalResource- 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
- Specified by:
hasPurposeElementin classCanonicalResource
-
hasPurpose
- Specified by:
hasPurposein classCanonicalResource
-
setPurposeElement
- Specified by:
setPurposeElementin classCanonicalResource- 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
- Specified by:
getPurposein classCanonicalResource- Returns:
- Explanation of why this activity definition is needed and why it has been designed as it has.
-
setPurpose
- Specified by:
setPurposein classCanonicalResource- 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
- Specified by:
getCopyrightElementin classCanonicalResource- 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
- Specified by:
hasCopyrightElementin classCanonicalResource
-
hasCopyright
- Specified by:
hasCopyrightin classCanonicalResource
-
setCopyrightElement
- Specified by:
setCopyrightElementin classCanonicalResource- 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
- Specified by:
getCopyrightin classCanonicalResource- 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
- Specified by:
setCopyrightin classCanonicalResource- 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
- Specified by:
getApprovalDateElementin classMetadataResource- 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
- Specified by:
hasApprovalDateElementin classMetadataResource
-
hasApprovalDate
- Specified by:
hasApprovalDatein classMetadataResource
-
setApprovalDateElement
- Specified by:
setApprovalDateElementin classMetadataResource- 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
- Specified by:
getApprovalDatein classMetadataResource- 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
- Specified by:
setApprovalDatein classMetadataResource- 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
- Specified by:
getLastReviewDateElementin classMetadataResource- 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
- Specified by:
hasLastReviewDateElementin classMetadataResource
-
hasLastReviewDate
- Specified by:
hasLastReviewDatein classMetadataResource
-
setLastReviewDateElement
- Specified by:
setLastReviewDateElementin classMetadataResource- 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
- Specified by:
getLastReviewDatein classMetadataResource- 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
- Specified by:
setLastReviewDatein classMetadataResource- 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
- Specified by:
getEffectivePeriodin classMetadataResource- Returns:
effectivePeriod(The period during which the activity definition content was or is planned to be in active use.)
-
hasEffectivePeriod
- Specified by:
hasEffectivePeriodin classMetadataResource
-
setEffectivePeriod
- Specified by:
setEffectivePeriodin classMetadataResource- Parameters:
value-effectivePeriod(The period during which the activity definition content was or is planned to be in active use.)
-
getTopic
- Specified by:
getTopicin classMetadataResource- 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
- Specified by:
setTopicin classMetadataResource- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasTopic
- Specified by:
hasTopicin classMetadataResource
-
addTopic
- Specified by:
addTopicin classMetadataResource
-
addTopic
- Specified by:
addTopicin classMetadataResource
-
getTopicFirstRep
- Specified by:
getTopicFirstRepin classMetadataResource- Returns:
- The first repetition of repeating field
topic, creating it if it does not already exist {3}
-
getAuthor
- Specified by:
getAuthorin classMetadataResource- Returns:
author(An individiual or organization primarily involved in the creation and maintenance of the content.)
-
setAuthor
- Specified by:
setAuthorin classMetadataResource- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasAuthor
- Specified by:
hasAuthorin classMetadataResource
-
addAuthor
- Specified by:
addAuthorin classMetadataResource
-
addAuthor
- Specified by:
addAuthorin classMetadataResource
-
getAuthorFirstRep
- Specified by:
getAuthorFirstRepin classMetadataResource- Returns:
- The first repetition of repeating field
author, creating it if it does not already exist {3}
-
getEditor
- Specified by:
getEditorin classMetadataResource- Returns:
editor(An individual or organization primarily responsible for internal coherence of the content.)
-
setEditor
- Specified by:
setEditorin classMetadataResource- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasEditor
- Specified by:
hasEditorin classMetadataResource
-
addEditor
- Specified by:
addEditorin classMetadataResource
-
addEditor
- Specified by:
addEditorin classMetadataResource
-
getEditorFirstRep
- Specified by:
getEditorFirstRepin classMetadataResource- Returns:
- The first repetition of repeating field
editor, creating it if it does not already exist {3}
-
getReviewer
- Specified by:
getReviewerin classMetadataResource- Returns:
reviewer(An individual or organization primarily responsible for review of some aspect of the content.)
-
setReviewer
- Specified by:
setReviewerin classMetadataResource- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasReviewer
- Specified by:
hasReviewerin classMetadataResource
-
addReviewer
- Specified by:
addReviewerin classMetadataResource
-
addReviewer
- Specified by:
addReviewerin classMetadataResource
-
getReviewerFirstRep
- Specified by:
getReviewerFirstRepin classMetadataResource- Returns:
- The first repetition of repeating field
reviewer, creating it if it does not already exist {3}
-
getEndorser
- Specified by:
getEndorserin classMetadataResource- Returns:
endorser(An individual or organization responsible for officially endorsing the content for use in some setting.)
-
setEndorser
- Specified by:
setEndorserin classMetadataResource- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasEndorser
- Specified by:
hasEndorserin classMetadataResource
-
addEndorser
- Specified by:
addEndorserin classMetadataResource
-
addEndorser
- Specified by:
addEndorserin classMetadataResource
-
getEndorserFirstRep
- Specified by:
getEndorserFirstRepin classMetadataResource- Returns:
- The first repetition of repeating field
endorser, creating it if it does not already exist {3}
-
getRelatedArtifact
- Specified by:
getRelatedArtifactin classMetadataResource- Returns:
relatedArtifact(Related artifacts such as additional documentation, justification, or bibliographic references.)
-
setRelatedArtifact
- Specified by:
setRelatedArtifactin classMetadataResource- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasRelatedArtifact
- Specified by:
hasRelatedArtifactin classMetadataResource
-
addRelatedArtifact
- Specified by:
addRelatedArtifactin classMetadataResource
-
addRelatedArtifact
- Specified by:
addRelatedArtifactin classMetadataResource
-
getRelatedArtifactFirstRep
- Specified by:
getRelatedArtifactFirstRepin classMetadataResource- Returns:
- The first repetition of repeating field
relatedArtifact, creating it if it does not already exist {3}
-
getLibrary
- Returns:
library(A reference to a Library resource containing any formal logic used by the activity definition.)
-
setLibrary
- Returns:
- Returns a reference to
thisfor 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
- 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 timing or frequency upon which the described activity is to occur.)
-
getTimingTiming
- Returns:
timing(The timing or frequency upon which the described activity is to occur.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasTimingTiming
-
getTimingAge
- Returns:
timing(The timing or frequency upon which the described activity is to occur.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasTimingAge
-
getTimingRange
- Returns:
timing(The timing or frequency upon which the described activity is to occur.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasTimingRange
-
getTimingDuration
- Returns:
timing(The timing or frequency upon which the described activity is to occur.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasTimingDuration
-
hasTiming
-
setTiming
- Parameters:
value-timing(The 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.)
-
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
thisfor easy method chaining
-
hasParticipant
-
addParticipant
-
addParticipant
-
getParticipantFirstRep
- Returns:
- The first repetition of repeating field
participant, creating it if it does not already exist {3}
-
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
thisfor easy method chaining
-
hasDosage
-
addDosage
-
addDosage
-
getDosageFirstRep
- Returns:
- The first repetition of repeating field
dosage, creating it if it does not already exist {3}
-
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
thisfor easy method chaining
-
hasBodySite
-
addBodySite
-
addBodySite
-
getBodySiteFirstRep
- Returns:
- The first repetition of repeating field
bodySite, creating it if it does not already exist {3}
-
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
thisfor easy method chaining
-
hasSpecimenRequirement
-
addSpecimenRequirement
-
addSpecimenRequirement
-
getSpecimenRequirementFirstRep
- Returns:
- The first repetition of repeating field
specimenRequirement, creating it if it does not already exist {3}
-
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
thisfor easy method chaining
-
hasObservationRequirement
-
addObservationRequirement
-
addObservationRequirement
-
getObservationRequirementFirstRep
- Returns:
- The first repetition of repeating field
observationRequirement, creating it if it does not already exist {3}
-
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
thisfor easy method chaining
-
hasObservationResultRequirement
-
addObservationResultRequirement
-
addObservationResultRequirement
-
getObservationResultRequirementFirstRep
- Returns:
- The first repetition of repeating field
observationResultRequirement, creating it if it does not already exist {3}
-
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
thisfor easy method chaining
-
hasDynamicValue
-
addDynamicValue
-
addDynamicValue
-
getDynamicValueFirstRep
- Returns:
- The first repetition of repeating field
dynamicValue, creating it if it does not already exist {3}
-
listChildren
- Overrides:
listChildrenin classMetadataResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getNamedPropertyin classMetadataResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getPropertyin classMetadataResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
setPropertyin classMetadataResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
- Overrides:
setPropertyin classMetadataResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
- Overrides:
makePropertyin classMetadataResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getTypesForPropertyin classMetadataResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
- Overrides:
addChildin classMetadataResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
- Specified by:
fhirTypein interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
fhirTypein classMetadataResource
-
copy
- Specified by:
copyin classMetadataResource
-
copyValues
-
typedCopy
-
equalsDeep
- Overrides:
equalsDeepin classMetadataResource
-
equalsShallow
- Overrides:
equalsShallowin classMetadataResource
-
isEmpty
- Specified by:
isEmptyin interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
isEmptyin classMetadataResource
-
getResourceType
- Specified by:
getResourceTypein classResource
-