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
public class ActivityDefinition extends MetadataResource
This resource allows for the definition of some activity to be performed, independent of a particular patient, practitioner, or other performance context.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classActivityDefinition.ActivityDefinitionDynamicValueComponentstatic classActivityDefinition.ActivityDefinitionParticipantComponentstatic classActivityDefinition.RequestResourceTypestatic classActivityDefinition.RequestResourceTypeEnumFactory
-
Field Summary
Fields Modifier and Type Field Description protected DateTypeapprovalDateThe date on which the resource content was approved by the publisher.protected List<ContactDetail>authorAn individiual or organization primarily involved in the creation and maintenance of the content.protected List<CodeableConcept>bodySiteIndicates the sites on the subject's body where the procedure should be performed (I.e.protected CodeableConceptcodeDetailed description of the type of activity; e.g.static ca.uhn.fhir.rest.gclient.ReferenceClientParamCOMPOSED_OFFluent Client search parameter constant for composed-ofprotected List<ContactDetail>contactContact details to assist a user in finding and communicating with the publisher.static ca.uhn.fhir.rest.gclient.TokenClientParamCONTEXTFluent Client search parameter constant for contextstatic ca.uhn.fhir.rest.gclient.QuantityClientParamCONTEXT_QUANTITYFluent Client search parameter constant for context-quantitystatic ca.uhn.fhir.rest.gclient.TokenClientParamCONTEXT_TYPEFluent Client search parameter constant for context-typestatic 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-quantitystatic 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-valueprotected MarkdownTypecopyrightA copyright statement relating to the activity definition and/or its contents.protected DateTimeTypedateThe date (and optionally time) when the activity definition was published.static ca.uhn.fhir.rest.gclient.DateClientParamDATEFluent Client search parameter constant for datestatic ca.uhn.fhir.rest.gclient.ReferenceClientParamDEPENDS_ONFluent Client search parameter constant for depends-onstatic ca.uhn.fhir.rest.gclient.ReferenceClientParamDERIVED_FROMFluent Client search parameter constant for derived-fromprotected MarkdownTypedescriptionA free text natural language description of the activity definition from a consumer's perspective.static ca.uhn.fhir.rest.gclient.StringClientParamDESCRIPTIONFluent Client search parameter constant for descriptionprotected BooleanTypedoNotPerformSet this to true if the definition is to indicate that a particular activity should NOT be performed.protected List<Dosage>dosageProvides detailed dosage instructions in the same way that they are described for MedicationRequest resources.protected List<ActivityDefinition.ActivityDefinitionDynamicValueComponent>dynamicValueDynamic values that will be evaluated to produce values for elements of the resulting resource.protected List<ContactDetail>editorAn individual or organization primarily responsible for internal coherence of the content.static ca.uhn.fhir.rest.gclient.DateClientParamEFFECTIVEFluent Client search parameter constant for effectiveprotected PeriodeffectivePeriodThe period during which the activity definition content was or is planned to be in active use.protected List<ContactDetail>endorserAn individual or organization responsible for officially endorsing the content for use in some setting.protected BooleanTypeexperimentalA 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>identifierA 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 ca.uhn.fhir.rest.gclient.TokenClientParamIDENTIFIERFluent Client search parameter constant for identifierstatic ca.uhn.fhir.model.api.IncludeINCLUDE_COMPOSED_OFConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_DEPENDS_ONConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_DERIVED_FROMConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_PREDECESSORConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_SUCCESSORConstant for fluent queries to be used to add include statements.protected Enumeration<Enumerations.RequestIntent>intentIndicates the level of authority/intentionality associated with the activity and where the request should fit into the workflow chain.protected List<CodeableConcept>jurisdictionA legal or geographic region in which the activity definition is intended to be used.static ca.uhn.fhir.rest.gclient.TokenClientParamJURISDICTIONFluent Client search parameter constant for jurisdictionprotected Enumeration<ActivityDefinition.RequestResourceType>kindA description of the kind of resource the activity definition is representing.static ca.uhn.fhir.rest.gclient.TokenClientParamKINDFluent Client search parameter constant for kindprotected DateTypelastReviewDateThe date on which the resource content was last reviewed.protected List<CanonicalType>libraryA reference to a Library resource containing any formal logic used by the activity definition.protected CodeableReferencelocationIdentifies the facility where the activity will occur; e.g.protected StringTypenameA natural language name identifying the activity definition.static ca.uhn.fhir.rest.gclient.StringClientParamNAMEFluent Client search parameter constant for nameprotected List<Reference>observationRequirementDefines observation requirements for the action to be performed, such as body weight or surface area.protected List<Reference>observationResultRequirementDefines the observations that are expected to be produced by the action.protected List<ActivityDefinition.ActivityDefinitionParticipantComponent>participantIndicates who should participate in performing the action described.static ca.uhn.fhir.rest.gclient.ReferenceClientParamPREDECESSORFluent Client search parameter constant for predecessorprotected Enumeration<Enumerations.RequestPriority>priorityIndicates how quickly the activity should be addressed with respect to other requests.protected DataTypeproductIdentifies the food, drug or other product being consumed or supplied in the activity.protected CanonicalTypeprofileA profile to which the target of the activity definition is expected to conform.protected StringTypepublisherThe name of the organization or individual that published the activity definition.static ca.uhn.fhir.rest.gclient.StringClientParamPUBLISHERFluent Client search parameter constant for publisherprotected MarkdownTypepurposeExplanation of why this activity definition is needed and why it has been designed as it has.protected QuantityquantityIdentifies the quantity expected to be consumed at once (per dose, per meal, etc.).protected List<RelatedArtifact>relatedArtifactRelated artifacts such as additional documentation, justification, or bibliographic references.protected List<ContactDetail>reviewerAn individual or organization primarily responsible for review of some aspect of the content.static StringSP_COMPOSED_OFSearch parameter: composed-ofstatic StringSP_CONTEXTSearch parameter: contextstatic StringSP_CONTEXT_QUANTITYSearch parameter: context-quantitystatic StringSP_CONTEXT_TYPESearch parameter: context-typestatic StringSP_CONTEXT_TYPE_QUANTITYSearch parameter: context-type-quantitystatic StringSP_CONTEXT_TYPE_VALUESearch parameter: context-type-valuestatic StringSP_DATESearch parameter: datestatic StringSP_DEPENDS_ONSearch parameter: depends-onstatic StringSP_DERIVED_FROMSearch parameter: derived-fromstatic StringSP_DESCRIPTIONSearch parameter: descriptionstatic StringSP_EFFECTIVESearch parameter: effectivestatic StringSP_IDENTIFIERSearch parameter: identifierstatic StringSP_JURISDICTIONSearch parameter: jurisdictionstatic StringSP_KINDSearch parameter: kindstatic StringSP_NAMESearch parameter: namestatic StringSP_PREDECESSORSearch parameter: predecessorstatic StringSP_PUBLISHERSearch parameter: publisherstatic StringSP_STATUSSearch parameter: statusstatic StringSP_SUCCESSORSearch parameter: successorstatic StringSP_TITLESearch parameter: titlestatic StringSP_TOPICSearch parameter: topicstatic StringSP_URLSearch parameter: urlstatic StringSP_VERSIONSearch parameter: versionprotected List<Reference>specimenRequirementDefines specimen requirements for the action to be performed, such as required specimens for a lab test.protected Enumeration<Enumerations.PublicationStatus>statusThe status of this activity definition.static ca.uhn.fhir.rest.gclient.TokenClientParamSTATUSFluent Client search parameter constant for statusprotected DataTypesubjectA code, group definition, or canonical reference that describes or identifies the intended subject of the activity being defined.protected StringTypesubtitleAn explanatory or alternate title for the activity definition giving additional information about its content.static ca.uhn.fhir.rest.gclient.ReferenceClientParamSUCCESSORFluent Client search parameter constant for successorprotected DataTypetimingThe timing or frequency upon which the described activity is to occur.protected StringTypetitleA short, descriptive, user-friendly title for the activity definition.static ca.uhn.fhir.rest.gclient.StringClientParamTITLEFluent Client search parameter constant for titleprotected List<CodeableConcept>topicDescriptive topics related to the content of the activity.static ca.uhn.fhir.rest.gclient.TokenClientParamTOPICFluent Client search parameter constant for topicprotected CanonicalTypetransformA 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 UriTypeurlAn 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 ca.uhn.fhir.rest.gclient.UriClientParamURLFluent Client search parameter constant for urlprotected StringTypeusageA detailed description of how the activity definition is used from a clinical perspective.protected List<UsageContext>useContextThe content was developed with a focus and intent of supporting the contexts that are listed.protected StringTypeversionThe identifier that is used to identify this version of the activity definition when it is referenced in a specification, model, design or instance.static ca.uhn.fhir.rest.gclient.TokenClientParamVERSIONFluent Client search parameter constant for version-
Fields inherited from class org.hl7.fhir.r5.model.DomainResource
contained, extension, modifierExtension, SP_TEXT, text, TEXT
-
Fields inherited from class org.hl7.fhir.r5.model.Resource
id, implicitRules, language, meta
-
-
Constructor Summary
Constructors Constructor Description ActivityDefinition()ConstructorActivityDefinition(Enumerations.PublicationStatus status)Constructor
-
Method Summary
-
Methods inherited from class org.hl7.fhir.r5.model.MetadataResource
copyValues, getApprovalDateMax, getAuthorMax, getEditorMax, getEffectivePeriodMax, getEndorserMax, getLastReviewDateMax, getRelatedArtifactMax, getReviewerMax, getTopicMax
-
Methods 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, toString
-
Methods 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, setText
-
Methods 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, setMeta
-
Methods inherited from class org.hl7.fhir.r5.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
-
Methods 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, 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
-
-
-
-
Field Detail
-
url
protected UriType 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
protected List<Identifier> identifier
A formal identifier that is used to identify this activity definition when it is represented in other formats, or referenced in a specification, model, design or an instance.
-
version
protected StringType 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
protected StringType 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
protected StringType title
A short, descriptive, user-friendly title for the activity definition.
-
subtitle
protected StringType subtitle
An explanatory or alternate title for the activity definition giving additional information about its content.
-
status
protected Enumeration<Enumerations.PublicationStatus> status
The status of this activity definition. Enables tracking the life-cycle of the content.
-
experimental
protected BooleanType 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
protected DataType 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
protected DateTimeType 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
protected StringType publisher
The name of the organization or individual that published the activity definition.
-
contact
protected List<ContactDetail> contact
Contact details to assist a user in finding and communicating with the publisher.
-
description
protected MarkdownType description
A free text natural language description of the activity definition from a consumer's perspective.
-
useContext
protected List<UsageContext> 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
protected List<CodeableConcept> jurisdiction
A legal or geographic region in which the activity definition is intended to be used.
-
purpose
protected MarkdownType purpose
Explanation of why this activity definition is needed and why it has been designed as it has.
-
usage
protected StringType usage
A detailed description of how the activity definition is used from a clinical perspective.
-
copyright
protected MarkdownType copyright
A copyright statement relating to the activity definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the activity definition.
-
approvalDate
protected DateType approvalDate
The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
-
lastReviewDate
protected DateType lastReviewDate
The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
-
effectivePeriod
protected Period effectivePeriod
The period during which the activity definition content was or is planned to be in active use.
-
topic
protected List<CodeableConcept> topic
Descriptive topics related to the content of the activity. Topics provide a high-level categorization of the activity that can be useful for filtering and searching.
-
author
protected List<ContactDetail> author
An individiual or organization primarily involved in the creation and maintenance of the content.
-
editor
protected List<ContactDetail> editor
An individual or organization primarily responsible for internal coherence of the content.
-
reviewer
protected List<ContactDetail> reviewer
An individual or organization primarily responsible for review of some aspect of the content.
-
endorser
protected List<ContactDetail> endorser
An individual or organization responsible for officially endorsing the content for use in some setting.
-
relatedArtifact
protected List<RelatedArtifact> relatedArtifact
Related artifacts such as additional documentation, justification, or bibliographic references.
-
library
protected List<CanonicalType> library
A reference to a Library resource containing any formal logic used by the activity definition.
-
kind
protected Enumeration<ActivityDefinition.RequestResourceType> 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
protected CanonicalType profile
A profile to which the target of the activity definition is expected to conform.
-
code
protected CodeableConcept code
Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter.
-
intent
protected Enumeration<Enumerations.RequestIntent> intent
Indicates the level of authority/intentionality associated with the activity and where the request should fit into the workflow chain.
-
priority
protected Enumeration<Enumerations.RequestPriority> priority
Indicates how quickly the activity should be addressed with respect to other requests.
-
doNotPerform
protected BooleanType 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
protected DataType timing
The timing or frequency upon which the described activity is to occur.
-
location
protected CodeableReference location
Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.
-
participant
protected List<ActivityDefinition.ActivityDefinitionParticipantComponent> participant
Indicates who should participate in performing the action described.
-
product
protected DataType product
Identifies the food, drug or other product being consumed or supplied in the activity.
-
quantity
protected Quantity quantity
Identifies the quantity expected to be consumed at once (per dose, per meal, etc.).
-
dosage
protected List<Dosage> dosage
Provides detailed dosage instructions in the same way that they are described for MedicationRequest resources.
-
bodySite
protected List<CodeableConcept> bodySite
Indicates the sites on the subject's body where the procedure should be performed (I.e. the target sites).
-
specimenRequirement
protected List<Reference> specimenRequirement
Defines specimen requirements for the action to be performed, such as required specimens for a lab test.
-
observationRequirement
protected List<Reference> observationRequirement
Defines observation requirements for the action to be performed, such as body weight or surface area.
-
observationResultRequirement
protected List<Reference> observationResultRequirement
Defines the observations that are expected to be produced by the action.
-
transform
protected CanonicalType 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
protected List<ActivityDefinition.ActivityDefinitionDynamicValueComponent> dynamicValue
Dynamic values that will be evaluated to produce values for elements of the resulting resource. For example, if the dosage of a medication must be computed based on the patient's weight, a dynamic value would be used to specify an expression that calculated the weight, and the path on the request resource that would contain the result.
-
SP_COMPOSED_OF
public static final String SP_COMPOSED_OF
Search parameter: composed-ofDescription: What resource is being referenced
Type: reference
Path: ActivityDefinition.relatedArtifact.where(type='composed-of').resource
- See Also:
- Constant Field Values
-
COMPOSED_OF
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam COMPOSED_OF
Fluent Client search parameter constant for composed-ofDescription: What resource is being referenced
Type: reference
Path: ActivityDefinition.relatedArtifact.where(type='composed-of').resource
-
INCLUDE_COMPOSED_OF
public static final ca.uhn.fhir.model.api.Include INCLUDE_COMPOSED_OF
Constant for fluent queries to be used to add include statements. Specifies the path value of "ActivityDefinition:composed-of".
-
SP_CONTEXT_QUANTITY
public static final String 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:
- Constant Field Values
-
CONTEXT_QUANTITY
public static final ca.uhn.fhir.rest.gclient.QuantityClientParam 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
public static final String 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:
- Constant Field Values
-
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_QUANTITY
Fluent 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
public static final String 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:
- Constant Field Values
-
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_VALUE
Fluent 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
public static final String 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:
- Constant Field Values
-
CONTEXT_TYPE
public static final ca.uhn.fhir.rest.gclient.TokenClientParam 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
public static final String SP_CONTEXT
Search parameter: contextDescription: A use context assigned to the activity definition
Type: token
Path: (ActivityDefinition.useContext.value as CodeableConcept)
- See Also:
- Constant Field Values
-
CONTEXT
public static final ca.uhn.fhir.rest.gclient.TokenClientParam 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
public static final String SP_DATE
Search parameter: dateDescription: The activity definition publication date
Type: date
Path: ActivityDefinition.date
- See Also:
- Constant Field Values
-
DATE
public static final ca.uhn.fhir.rest.gclient.DateClientParam DATE
Fluent Client search parameter constant for dateDescription: The activity definition publication date
Type: date
Path: ActivityDefinition.date
-
SP_DEPENDS_ON
public static final String 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:
- Constant Field Values
-
DEPENDS_ON
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam 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
public static final ca.uhn.fhir.model.api.Include INCLUDE_DEPENDS_ON
Constant for fluent queries to be used to add include statements. Specifies the path value of "ActivityDefinition:depends-on".
-
SP_DERIVED_FROM
public static final String SP_DERIVED_FROM
Search parameter: derived-fromDescription: What resource is being referenced
Type: reference
Path: ActivityDefinition.relatedArtifact.where(type='derived-from').resource
- See Also:
- Constant Field Values
-
DERIVED_FROM
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam DERIVED_FROM
Fluent Client search parameter constant for derived-fromDescription: What resource is being referenced
Type: reference
Path: ActivityDefinition.relatedArtifact.where(type='derived-from').resource
-
INCLUDE_DERIVED_FROM
public static final ca.uhn.fhir.model.api.Include INCLUDE_DERIVED_FROM
Constant for fluent queries to be used to add include statements. Specifies the path value of "ActivityDefinition:derived-from".
-
SP_DESCRIPTION
public static final String SP_DESCRIPTION
Search parameter: descriptionDescription: The description of the activity definition
Type: string
Path: ActivityDefinition.description
- See Also:
- Constant Field Values
-
DESCRIPTION
public static final ca.uhn.fhir.rest.gclient.StringClientParam DESCRIPTION
Fluent Client search parameter constant for descriptionDescription: The description of the activity definition
Type: string
Path: ActivityDefinition.description
-
SP_EFFECTIVE
public static final String 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:
- Constant Field Values
-
EFFECTIVE
public static final ca.uhn.fhir.rest.gclient.DateClientParam 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
public static final String SP_IDENTIFIER
Search parameter: identifierDescription: External identifier for the activity definition
Type: token
Path: ActivityDefinition.identifier
- See Also:
- Constant Field Values
-
IDENTIFIER
public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
Fluent Client search parameter constant for identifierDescription: External identifier for the activity definition
Type: token
Path: ActivityDefinition.identifier
-
SP_JURISDICTION
public static final String SP_JURISDICTION
Search parameter: jurisdictionDescription: Intended jurisdiction for the activity definition
Type: token
Path: ActivityDefinition.jurisdiction
- See Also:
- Constant Field Values
-
JURISDICTION
public static final ca.uhn.fhir.rest.gclient.TokenClientParam JURISDICTION
Fluent Client search parameter constant for jurisdictionDescription: Intended jurisdiction for the activity definition
Type: token
Path: ActivityDefinition.jurisdiction
-
SP_KIND
public static final String SP_KIND
Search parameter: kindDescription: The kind of activity definition
Type: token
Path: ActivityDefinition.kind
- See Also:
- Constant Field Values
-
KIND
public static final ca.uhn.fhir.rest.gclient.TokenClientParam KIND
Fluent Client search parameter constant for kindDescription: The kind of activity definition
Type: token
Path: ActivityDefinition.kind
-
SP_NAME
public static final String SP_NAME
Search parameter: nameDescription: Computationally friendly name of the activity definition
Type: string
Path: ActivityDefinition.name
- See Also:
- Constant Field Values
-
NAME
public static final ca.uhn.fhir.rest.gclient.StringClientParam NAME
Fluent Client search parameter constant for nameDescription: Computationally friendly name of the activity definition
Type: string
Path: ActivityDefinition.name
-
SP_PREDECESSOR
public static final String SP_PREDECESSOR
Search parameter: predecessorDescription: What resource is being referenced
Type: reference
Path: ActivityDefinition.relatedArtifact.where(type='predecessor').resource
- See Also:
- Constant Field Values
-
PREDECESSOR
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PREDECESSOR
Fluent Client search parameter constant for predecessorDescription: What resource is being referenced
Type: reference
Path: ActivityDefinition.relatedArtifact.where(type='predecessor').resource
-
INCLUDE_PREDECESSOR
public static final ca.uhn.fhir.model.api.Include INCLUDE_PREDECESSOR
Constant for fluent queries to be used to add include statements. Specifies the path value of "ActivityDefinition:predecessor".
-
SP_PUBLISHER
public static final String SP_PUBLISHER
Search parameter: publisherDescription: Name of the publisher of the activity definition
Type: string
Path: ActivityDefinition.publisher
- See Also:
- Constant Field Values
-
PUBLISHER
public static final ca.uhn.fhir.rest.gclient.StringClientParam PUBLISHER
Fluent Client search parameter constant for publisherDescription: Name of the publisher of the activity definition
Type: string
Path: ActivityDefinition.publisher
-
SP_STATUS
public static final String SP_STATUS
Search parameter: statusDescription: The current status of the activity definition
Type: token
Path: ActivityDefinition.status
- See Also:
- Constant Field Values
-
STATUS
public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
Fluent Client search parameter constant for statusDescription: The current status of the activity definition
Type: token
Path: ActivityDefinition.status
-
SP_SUCCESSOR
public static final String SP_SUCCESSOR
Search parameter: successorDescription: What resource is being referenced
Type: reference
Path: ActivityDefinition.relatedArtifact.where(type='successor').resource
- See Also:
- Constant Field Values
-
SUCCESSOR
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SUCCESSOR
Fluent Client search parameter constant for successorDescription: What resource is being referenced
Type: reference
Path: ActivityDefinition.relatedArtifact.where(type='successor').resource
-
INCLUDE_SUCCESSOR
public static final ca.uhn.fhir.model.api.Include INCLUDE_SUCCESSOR
Constant for fluent queries to be used to add include statements. Specifies the path value of "ActivityDefinition:successor".
-
SP_TITLE
public static final String SP_TITLE
Search parameter: titleDescription: The human-friendly name of the activity definition
Type: string
Path: ActivityDefinition.title
- See Also:
- Constant Field Values
-
TITLE
public static final ca.uhn.fhir.rest.gclient.StringClientParam TITLE
Fluent Client search parameter constant for titleDescription: The human-friendly name of the activity definition
Type: string
Path: ActivityDefinition.title
-
SP_TOPIC
public static final String SP_TOPIC
Search parameter: topicDescription: Topics associated with the module
Type: token
Path: ActivityDefinition.topic
- See Also:
- Constant Field Values
-
TOPIC
public static final ca.uhn.fhir.rest.gclient.TokenClientParam TOPIC
Fluent Client search parameter constant for topicDescription: Topics associated with the module
Type: token
Path: ActivityDefinition.topic
-
SP_URL
public static final String SP_URL
Search parameter: urlDescription: The uri that identifies the activity definition
Type: uri
Path: ActivityDefinition.url
- See Also:
- Constant Field Values
-
URL
public static final ca.uhn.fhir.rest.gclient.UriClientParam URL
Fluent Client search parameter constant for urlDescription: The uri that identifies the activity definition
Type: uri
Path: ActivityDefinition.url
-
SP_VERSION
public static final String SP_VERSION
Search parameter: versionDescription: The business version of the activity definition
Type: token
Path: ActivityDefinition.version
- See Also:
- Constant Field Values
-
VERSION
public static final ca.uhn.fhir.rest.gclient.TokenClientParam VERSION
Fluent Client search parameter constant for versionDescription: The business version of the activity definition
Type: token
Path: ActivityDefinition.version
-
-
Constructor Detail
-
ActivityDefinition
public ActivityDefinition()
Constructor
-
ActivityDefinition
public ActivityDefinition(Enumerations.PublicationStatus status)
Constructor
-
-
Method Detail
-
getUrlElement
public UriType 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
public boolean hasUrlElement()
- Specified by:
hasUrlElementin classCanonicalResource
-
hasUrl
public boolean hasUrl()
- Specified by:
hasUrlin classCanonicalResource
-
setUrlElement
public ActivityDefinition setUrlElement(UriType value)
- 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
public String 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
public ActivityDefinition setUrl(String value)
- 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
public List<Identifier> 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
public ActivityDefinition setIdentifier(List<Identifier> theIdentifier)
- Specified by:
setIdentifierin classCanonicalResource- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasIdentifier
public boolean hasIdentifier()
- Specified by:
hasIdentifierin classCanonicalResource
-
addIdentifier
public Identifier addIdentifier()
- Specified by:
addIdentifierin classCanonicalResource
-
addIdentifier
public ActivityDefinition addIdentifier(Identifier t)
- Specified by:
addIdentifierin classCanonicalResource
-
getIdentifierFirstRep
public Identifier getIdentifierFirstRep()
- Specified by:
getIdentifierFirstRepin classCanonicalResource- Returns:
- The first repetition of repeating field
identifier, creating it if it does not already exist {3}
-
getVersionElement
public StringType 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
public boolean hasVersionElement()
- Specified by:
hasVersionElementin classCanonicalResource
-
hasVersion
public boolean hasVersion()
- Specified by:
hasVersionin classCanonicalResource
-
setVersionElement
public ActivityDefinition setVersionElement(StringType value)
- 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
public String 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
public ActivityDefinition setVersion(String value)
- 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
public StringType 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
public boolean hasNameElement()
- Specified by:
hasNameElementin classCanonicalResource
-
hasName
public boolean hasName()
- Specified by:
hasNamein classCanonicalResource
-
setNameElement
public ActivityDefinition setNameElement(StringType value)
- 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
public String 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
public ActivityDefinition setName(String value)
- 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
public StringType 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
public boolean hasTitleElement()
- Specified by:
hasTitleElementin classCanonicalResource
-
hasTitle
public boolean hasTitle()
- Specified by:
hasTitlein classCanonicalResource
-
setTitleElement
public ActivityDefinition setTitleElement(StringType value)
- 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
public String getTitle()
- Specified by:
getTitlein classCanonicalResource- Returns:
- A short, descriptive, user-friendly title for the activity definition.
-
setTitle
public ActivityDefinition setTitle(String value)
- Specified by:
setTitlein classCanonicalResource- Parameters:
value- A short, descriptive, user-friendly title for the activity definition.
-
getSubtitleElement
public StringType 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
public boolean hasSubtitleElement()
-
hasSubtitle
public boolean hasSubtitle()
-
setSubtitleElement
public ActivityDefinition setSubtitleElement(StringType value)
- 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
public String getSubtitle()
- Returns:
- An explanatory or alternate title for the activity definition giving additional information about its content.
-
setSubtitle
public ActivityDefinition setSubtitle(String value)
- Parameters:
value- An explanatory or alternate title for the activity definition giving additional information about its content.
-
getStatusElement
public Enumeration<Enumerations.PublicationStatus> 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
public boolean hasStatusElement()
- Specified by:
hasStatusElementin classCanonicalResource
-
hasStatus
public boolean hasStatus()
- Specified by:
hasStatusin classCanonicalResource
-
setStatusElement
public ActivityDefinition setStatusElement(Enumeration<Enumerations.PublicationStatus> value)
- 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
public Enumerations.PublicationStatus getStatus()
- Specified by:
getStatusin classCanonicalResource- Returns:
- The status of this activity definition. Enables tracking the life-cycle of the content.
-
setStatus
public ActivityDefinition setStatus(Enumerations.PublicationStatus value)
- Specified by:
setStatusin classCanonicalResource- Parameters:
value- The status of this activity definition. Enables tracking the life-cycle of the content.
-
getExperimentalElement
public BooleanType 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
public boolean hasExperimentalElement()
- Specified by:
hasExperimentalElementin classCanonicalResource
-
hasExperimental
public boolean hasExperimental()
- Specified by:
hasExperimentalin classCanonicalResource
-
setExperimentalElement
public ActivityDefinition setExperimentalElement(BooleanType value)
- 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
public boolean 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
public ActivityDefinition setExperimental(boolean value)
- 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
public DataType 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
public CodeableConcept getSubjectCodeableConcept() throws org.hl7.fhir.exceptions.FHIRException
- 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
public boolean hasSubjectCodeableConcept()
-
getSubjectReference
public Reference getSubjectReference() throws org.hl7.fhir.exceptions.FHIRException
- 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
public boolean hasSubjectReference()
-
getSubjectCanonicalType
public CanonicalType getSubjectCanonicalType() throws org.hl7.fhir.exceptions.FHIRException
- 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
public boolean hasSubjectCanonicalType()
-
hasSubject
public boolean hasSubject()
-
setSubject
public ActivityDefinition setSubject(DataType value)
- 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
public DateTimeType 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
public boolean hasDateElement()
- Specified by:
hasDateElementin classCanonicalResource
-
hasDate
public boolean hasDate()
- Specified by:
hasDatein classCanonicalResource
-
setDateElement
public ActivityDefinition setDateElement(DateTimeType value)
- 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
public Date 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
public ActivityDefinition setDate(Date value)
- 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
public StringType 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
public boolean hasPublisherElement()
- Specified by:
hasPublisherElementin classCanonicalResource
-
hasPublisher
public boolean hasPublisher()
- Specified by:
hasPublisherin classCanonicalResource
-
setPublisherElement
public ActivityDefinition setPublisherElement(StringType value)
- 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
public String getPublisher()
- Specified by:
getPublisherin classCanonicalResource- Returns:
- The name of the organization or individual that published the activity definition.
-
setPublisher
public ActivityDefinition setPublisher(String value)
- Specified by:
setPublisherin classCanonicalResource- Parameters:
value- The name of the organization or individual that published the activity definition.
-
getContact
public List<ContactDetail> getContact()
- Specified by:
getContactin classCanonicalResource- Returns:
contact(Contact details to assist a user in finding and communicating with the publisher.)
-
setContact
public ActivityDefinition setContact(List<ContactDetail> theContact)
- Specified by:
setContactin classCanonicalResource- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasContact
public boolean hasContact()
- Specified by:
hasContactin classCanonicalResource
-
addContact
public ContactDetail addContact()
- Specified by:
addContactin classCanonicalResource
-
addContact
public ActivityDefinition addContact(ContactDetail t)
- Specified by:
addContactin classCanonicalResource
-
getContactFirstRep
public ContactDetail getContactFirstRep()
- Specified by:
getContactFirstRepin classCanonicalResource- Returns:
- The first repetition of repeating field
contact, creating it if it does not already exist {3}
-
getDescriptionElement
public MarkdownType 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
public boolean hasDescriptionElement()
- Specified by:
hasDescriptionElementin classCanonicalResource
-
hasDescription
public boolean hasDescription()
- Specified by:
hasDescriptionin classCanonicalResource
-
setDescriptionElement
public ActivityDefinition setDescriptionElement(MarkdownType value)
- 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
public String getDescription()
- Specified by:
getDescriptionin classCanonicalResource- Returns:
- A free text natural language description of the activity definition from a consumer's perspective.
-
setDescription
public ActivityDefinition setDescription(String value)
- Specified by:
setDescriptionin classCanonicalResource- Parameters:
value- A free text natural language description of the activity definition from a consumer's perspective.
-
getUseContext
public List<UsageContext> 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
public ActivityDefinition setUseContext(List<UsageContext> theUseContext)
- Specified by:
setUseContextin classCanonicalResource- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasUseContext
public boolean hasUseContext()
- Specified by:
hasUseContextin classCanonicalResource
-
addUseContext
public UsageContext addUseContext()
- Specified by:
addUseContextin classCanonicalResource
-
addUseContext
public ActivityDefinition addUseContext(UsageContext t)
- Specified by:
addUseContextin classCanonicalResource
-
getUseContextFirstRep
public UsageContext getUseContextFirstRep()
- Specified by:
getUseContextFirstRepin classCanonicalResource- Returns:
- The first repetition of repeating field
useContext, creating it if it does not already exist {3}
-
getJurisdiction
public List<CodeableConcept> getJurisdiction()
- Specified by:
getJurisdictionin classCanonicalResource- Returns:
jurisdiction(A legal or geographic region in which the activity definition is intended to be used.)
-
setJurisdiction
public ActivityDefinition setJurisdiction(List<CodeableConcept> theJurisdiction)
- Specified by:
setJurisdictionin classCanonicalResource- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasJurisdiction
public boolean hasJurisdiction()
- Specified by:
hasJurisdictionin classCanonicalResource
-
addJurisdiction
public CodeableConcept addJurisdiction()
- Specified by:
addJurisdictionin classCanonicalResource
-
addJurisdiction
public ActivityDefinition addJurisdiction(CodeableConcept t)
- Specified by:
addJurisdictionin classCanonicalResource
-
getJurisdictionFirstRep
public CodeableConcept getJurisdictionFirstRep()
- Specified by:
getJurisdictionFirstRepin classCanonicalResource- Returns:
- The first repetition of repeating field
jurisdiction, creating it if it does not already exist {3}
-
getPurposeElement
public MarkdownType 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
public boolean hasPurposeElement()
- Specified by:
hasPurposeElementin classCanonicalResource
-
hasPurpose
public boolean hasPurpose()
- Specified by:
hasPurposein classCanonicalResource
-
setPurposeElement
public ActivityDefinition setPurposeElement(MarkdownType value)
- 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
public String getPurpose()
- Specified by:
getPurposein classCanonicalResource- Returns:
- Explanation of why this activity definition is needed and why it has been designed as it has.
-
setPurpose
public ActivityDefinition setPurpose(String value)
- Specified by:
setPurposein classCanonicalResource- Parameters:
value- Explanation of why this activity definition is needed and why it has been designed as it has.
-
getUsageElement
public StringType getUsageElement()
- Returns:
usage(A detailed description of how the 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
public boolean hasUsageElement()
-
hasUsage
public boolean hasUsage()
-
setUsageElement
public ActivityDefinition setUsageElement(StringType value)
- 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
public String getUsage()
- Returns:
- A detailed description of how the activity definition is used from a clinical perspective.
-
setUsage
public ActivityDefinition setUsage(String value)
- Parameters:
value- A detailed description of how the activity definition is used from a clinical perspective.
-
getCopyrightElement
public MarkdownType 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
public boolean hasCopyrightElement()
- Specified by:
hasCopyrightElementin classCanonicalResource
-
hasCopyright
public boolean hasCopyright()
- Specified by:
hasCopyrightin classCanonicalResource
-
setCopyrightElement
public ActivityDefinition setCopyrightElement(MarkdownType value)
- 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
public String 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
public ActivityDefinition setCopyright(String value)
- 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
public DateType 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
public boolean hasApprovalDateElement()
- Specified by:
hasApprovalDateElementin classMetadataResource
-
hasApprovalDate
public boolean hasApprovalDate()
- Specified by:
hasApprovalDatein classMetadataResource
-
setApprovalDateElement
public ActivityDefinition setApprovalDateElement(DateType value)
- 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
public Date 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
public ActivityDefinition setApprovalDate(Date value)
- 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
public DateType 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
public boolean hasLastReviewDateElement()
- Specified by:
hasLastReviewDateElementin classMetadataResource
-
hasLastReviewDate
public boolean hasLastReviewDate()
- Specified by:
hasLastReviewDatein classMetadataResource
-
setLastReviewDateElement
public ActivityDefinition setLastReviewDateElement(DateType value)
- 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
public Date 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
public ActivityDefinition setLastReviewDate(Date value)
- 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
public Period 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
public boolean hasEffectivePeriod()
- Specified by:
hasEffectivePeriodin classMetadataResource
-
setEffectivePeriod
public ActivityDefinition setEffectivePeriod(Period value)
- 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
public List<CodeableConcept> 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
public ActivityDefinition setTopic(List<CodeableConcept> theTopic)
- Specified by:
setTopicin classMetadataResource- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasTopic
public boolean hasTopic()
- Specified by:
hasTopicin classMetadataResource
-
addTopic
public CodeableConcept addTopic()
- Specified by:
addTopicin classMetadataResource
-
addTopic
public ActivityDefinition addTopic(CodeableConcept t)
- Specified by:
addTopicin classMetadataResource
-
getTopicFirstRep
public CodeableConcept getTopicFirstRep()
- Specified by:
getTopicFirstRepin classMetadataResource- Returns:
- The first repetition of repeating field
topic, creating it if it does not already exist {3}
-
getAuthor
public List<ContactDetail> getAuthor()
- Specified by:
getAuthorin classMetadataResource- Returns:
author(An individiual or organization primarily involved in the creation and maintenance of the content.)
-
setAuthor
public ActivityDefinition setAuthor(List<ContactDetail> theAuthor)
- Specified by:
setAuthorin classMetadataResource- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasAuthor
public boolean hasAuthor()
- Specified by:
hasAuthorin classMetadataResource
-
addAuthor
public ContactDetail addAuthor()
- Specified by:
addAuthorin classMetadataResource
-
addAuthor
public ActivityDefinition addAuthor(ContactDetail t)
- Specified by:
addAuthorin classMetadataResource
-
getAuthorFirstRep
public ContactDetail getAuthorFirstRep()
- Specified by:
getAuthorFirstRepin classMetadataResource- Returns:
- The first repetition of repeating field
author, creating it if it does not already exist {3}
-
getEditor
public List<ContactDetail> getEditor()
- Specified by:
getEditorin classMetadataResource- Returns:
editor(An individual or organization primarily responsible for internal coherence of the content.)
-
setEditor
public ActivityDefinition setEditor(List<ContactDetail> theEditor)
- Specified by:
setEditorin classMetadataResource- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasEditor
public boolean hasEditor()
- Specified by:
hasEditorin classMetadataResource
-
addEditor
public ContactDetail addEditor()
- Specified by:
addEditorin classMetadataResource
-
addEditor
public ActivityDefinition addEditor(ContactDetail t)
- Specified by:
addEditorin classMetadataResource
-
getEditorFirstRep
public ContactDetail getEditorFirstRep()
- Specified by:
getEditorFirstRepin classMetadataResource- Returns:
- The first repetition of repeating field
editor, creating it if it does not already exist {3}
-
getReviewer
public List<ContactDetail> getReviewer()
- Specified by:
getReviewerin classMetadataResource- Returns:
reviewer(An individual or organization primarily responsible for review of some aspect of the content.)
-
setReviewer
public ActivityDefinition setReviewer(List<ContactDetail> theReviewer)
- Specified by:
setReviewerin classMetadataResource- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasReviewer
public boolean hasReviewer()
- Specified by:
hasReviewerin classMetadataResource
-
addReviewer
public ContactDetail addReviewer()
- Specified by:
addReviewerin classMetadataResource
-
addReviewer
public ActivityDefinition addReviewer(ContactDetail t)
- Specified by:
addReviewerin classMetadataResource
-
getReviewerFirstRep
public ContactDetail getReviewerFirstRep()
- Specified by:
getReviewerFirstRepin classMetadataResource- Returns:
- The first repetition of repeating field
reviewer, creating it if it does not already exist {3}
-
getEndorser
public List<ContactDetail> getEndorser()
- Specified by:
getEndorserin classMetadataResource- Returns:
endorser(An individual or organization responsible for officially endorsing the content for use in some setting.)
-
setEndorser
public ActivityDefinition setEndorser(List<ContactDetail> theEndorser)
- Specified by:
setEndorserin classMetadataResource- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasEndorser
public boolean hasEndorser()
- Specified by:
hasEndorserin classMetadataResource
-
addEndorser
public ContactDetail addEndorser()
- Specified by:
addEndorserin classMetadataResource
-
addEndorser
public ActivityDefinition addEndorser(ContactDetail t)
- Specified by:
addEndorserin classMetadataResource
-
getEndorserFirstRep
public ContactDetail getEndorserFirstRep()
- Specified by:
getEndorserFirstRepin classMetadataResource- Returns:
- The first repetition of repeating field
endorser, creating it if it does not already exist {3}
-
getRelatedArtifact
public List<RelatedArtifact> getRelatedArtifact()
- Specified by:
getRelatedArtifactin classMetadataResource- Returns:
relatedArtifact(Related artifacts such as additional documentation, justification, or bibliographic references.)
-
setRelatedArtifact
public ActivityDefinition setRelatedArtifact(List<RelatedArtifact> theRelatedArtifact)
- Specified by:
setRelatedArtifactin classMetadataResource- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasRelatedArtifact
public boolean hasRelatedArtifact()
- Specified by:
hasRelatedArtifactin classMetadataResource
-
addRelatedArtifact
public RelatedArtifact addRelatedArtifact()
- Specified by:
addRelatedArtifactin classMetadataResource
-
addRelatedArtifact
public ActivityDefinition addRelatedArtifact(RelatedArtifact t)
- Specified by:
addRelatedArtifactin classMetadataResource
-
getRelatedArtifactFirstRep
public RelatedArtifact getRelatedArtifactFirstRep()
- Specified by:
getRelatedArtifactFirstRepin classMetadataResource- Returns:
- The first repetition of repeating field
relatedArtifact, creating it if it does not already exist {3}
-
getLibrary
public List<CanonicalType> getLibrary()
- Returns:
library(A reference to a Library resource containing any formal logic used by the activity definition.)
-
setLibrary
public ActivityDefinition setLibrary(List<CanonicalType> theLibrary)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasLibrary
public boolean hasLibrary()
-
addLibraryElement
public CanonicalType addLibraryElement()
- Returns:
library(A reference to a Library resource containing any formal logic used by the activity definition.)
-
addLibrary
public ActivityDefinition addLibrary(String value)
- Parameters:
value-library(A reference to a Library resource containing any formal logic used by the activity definition.)
-
hasLibrary
public boolean hasLibrary(String value)
- Parameters:
value-library(A reference to a Library resource containing any formal logic used by the activity definition.)
-
getKindElement
public Enumeration<ActivityDefinition.RequestResourceType> 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
public boolean hasKindElement()
-
hasKind
public boolean hasKind()
-
setKindElement
public ActivityDefinition setKindElement(Enumeration<ActivityDefinition.RequestResourceType> 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
public ActivityDefinition.RequestResourceType 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
public ActivityDefinition setKind(ActivityDefinition.RequestResourceType value)
- 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
public CanonicalType 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
public boolean hasProfileElement()
-
hasProfile
public boolean hasProfile()
-
setProfileElement
public ActivityDefinition setProfileElement(CanonicalType value)
- 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
public String getProfile()
- Returns:
- A profile to which the target of the activity definition is expected to conform.
-
setProfile
public ActivityDefinition setProfile(String value)
- Parameters:
value- A profile to which the target of the activity definition is expected to conform.
-
getCode
public CodeableConcept getCode()
- Returns:
code(Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter.)
-
hasCode
public boolean hasCode()
-
setCode
public ActivityDefinition setCode(CodeableConcept value)
- Parameters:
value-code(Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter.)
-
getIntentElement
public Enumeration<Enumerations.RequestIntent> 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
public boolean hasIntentElement()
-
hasIntent
public boolean hasIntent()
-
setIntentElement
public ActivityDefinition setIntentElement(Enumeration<Enumerations.RequestIntent> value)
- 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
public Enumerations.RequestIntent getIntent()
- Returns:
- Indicates the level of authority/intentionality associated with the activity and where the request should fit into the workflow chain.
-
setIntent
public ActivityDefinition setIntent(Enumerations.RequestIntent value)
- Parameters:
value- Indicates the level of authority/intentionality associated with the activity and where the request should fit into the workflow chain.
-
getPriorityElement
public Enumeration<Enumerations.RequestPriority> 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
public boolean hasPriorityElement()
-
hasPriority
public boolean hasPriority()
-
setPriorityElement
public ActivityDefinition setPriorityElement(Enumeration<Enumerations.RequestPriority> value)
- 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
public Enumerations.RequestPriority getPriority()
- Returns:
- Indicates how quickly the activity should be addressed with respect to other requests.
-
setPriority
public ActivityDefinition setPriority(Enumerations.RequestPriority value)
- Parameters:
value- Indicates how quickly the activity should be addressed with respect to other requests.
-
getDoNotPerformElement
public BooleanType 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
public boolean hasDoNotPerformElement()
-
hasDoNotPerform
public boolean hasDoNotPerform()
-
setDoNotPerformElement
public ActivityDefinition setDoNotPerformElement(BooleanType value)
- 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
public boolean 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
public ActivityDefinition setDoNotPerform(boolean value)
- 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
public DataType getTiming()
- Returns:
timing(The timing or frequency upon which the described activity is to occur.)
-
getTimingTiming
public Timing getTimingTiming() throws org.hl7.fhir.exceptions.FHIRException
- Returns:
timing(The timing or frequency upon which the described activity is to occur.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasTimingTiming
public boolean hasTimingTiming()
-
getTimingAge
public Age getTimingAge() throws org.hl7.fhir.exceptions.FHIRException
- Returns:
timing(The timing or frequency upon which the described activity is to occur.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasTimingAge
public boolean hasTimingAge()
-
getTimingRange
public Range getTimingRange() throws org.hl7.fhir.exceptions.FHIRException
- Returns:
timing(The timing or frequency upon which the described activity is to occur.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasTimingRange
public boolean hasTimingRange()
-
getTimingDuration
public Duration getTimingDuration() throws org.hl7.fhir.exceptions.FHIRException
- Returns:
timing(The timing or frequency upon which the described activity is to occur.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasTimingDuration
public boolean hasTimingDuration()
-
hasTiming
public boolean hasTiming()
-
setTiming
public ActivityDefinition setTiming(DataType value)
- Parameters:
value-timing(The timing or frequency upon which the described activity is to occur.)
-
getLocation
public CodeableReference getLocation()
- Returns:
location(Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.)
-
hasLocation
public boolean hasLocation()
-
setLocation
public ActivityDefinition setLocation(CodeableReference value)
- Parameters:
value-location(Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.)
-
getParticipant
public List<ActivityDefinition.ActivityDefinitionParticipantComponent> getParticipant()
- Returns:
participant(Indicates who should participate in performing the action described.)
-
setParticipant
public ActivityDefinition setParticipant(List<ActivityDefinition.ActivityDefinitionParticipantComponent> theParticipant)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasParticipant
public boolean hasParticipant()
-
addParticipant
public ActivityDefinition.ActivityDefinitionParticipantComponent addParticipant()
-
addParticipant
public ActivityDefinition addParticipant(ActivityDefinition.ActivityDefinitionParticipantComponent t)
-
getParticipantFirstRep
public ActivityDefinition.ActivityDefinitionParticipantComponent getParticipantFirstRep()
- Returns:
- The first repetition of repeating field
participant, creating it if it does not already exist {3}
-
getProduct
public DataType getProduct()
- Returns:
product(Identifies the food, drug or other product being consumed or supplied in the activity.)
-
getProductReference
public Reference getProductReference() throws org.hl7.fhir.exceptions.FHIRException
- Returns:
product(Identifies the food, drug or other product being consumed or supplied in the activity.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasProductReference
public boolean hasProductReference()
-
getProductCodeableConcept
public CodeableConcept getProductCodeableConcept() throws org.hl7.fhir.exceptions.FHIRException
- Returns:
product(Identifies the food, drug or other product being consumed or supplied in the activity.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasProductCodeableConcept
public boolean hasProductCodeableConcept()
-
hasProduct
public boolean hasProduct()
-
setProduct
public ActivityDefinition setProduct(DataType value)
- Parameters:
value-product(Identifies the food, drug or other product being consumed or supplied in the activity.)
-
getQuantity
public Quantity getQuantity()
- Returns:
quantity(Identifies the quantity expected to be consumed at once (per dose, per meal, etc.).)
-
hasQuantity
public boolean hasQuantity()
-
setQuantity
public ActivityDefinition setQuantity(Quantity value)
- Parameters:
value-quantity(Identifies the quantity expected to be consumed at once (per dose, per meal, etc.).)
-
getDosage
public List<Dosage> getDosage()
- Returns:
dosage(Provides detailed dosage instructions in the same way that they are described for MedicationRequest resources.)
-
setDosage
public ActivityDefinition setDosage(List<Dosage> theDosage)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasDosage
public boolean hasDosage()
-
addDosage
public ActivityDefinition addDosage(Dosage t)
-
getDosageFirstRep
public Dosage getDosageFirstRep()
- Returns:
- The first repetition of repeating field
dosage, creating it if it does not already exist {3}
-
getBodySite
public List<CodeableConcept> getBodySite()
- Returns:
bodySite(Indicates the sites on the subject's body where the procedure should be performed (I.e. the target sites).)
-
setBodySite
public ActivityDefinition setBodySite(List<CodeableConcept> theBodySite)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasBodySite
public boolean hasBodySite()
-
addBodySite
public CodeableConcept addBodySite()
-
addBodySite
public ActivityDefinition addBodySite(CodeableConcept t)
-
getBodySiteFirstRep
public CodeableConcept getBodySiteFirstRep()
- Returns:
- The first repetition of repeating field
bodySite, creating it if it does not already exist {3}
-
getSpecimenRequirement
public List<Reference> getSpecimenRequirement()
- Returns:
specimenRequirement(Defines specimen requirements for the action to be performed, such as required specimens for a lab test.)
-
setSpecimenRequirement
public ActivityDefinition setSpecimenRequirement(List<Reference> theSpecimenRequirement)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasSpecimenRequirement
public boolean hasSpecimenRequirement()
-
addSpecimenRequirement
public Reference addSpecimenRequirement()
-
addSpecimenRequirement
public ActivityDefinition addSpecimenRequirement(Reference t)
-
getSpecimenRequirementFirstRep
public Reference getSpecimenRequirementFirstRep()
- Returns:
- The first repetition of repeating field
specimenRequirement, creating it if it does not already exist {3}
-
getObservationRequirement
public List<Reference> getObservationRequirement()
- Returns:
observationRequirement(Defines observation requirements for the action to be performed, such as body weight or surface area.)
-
setObservationRequirement
public ActivityDefinition setObservationRequirement(List<Reference> theObservationRequirement)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasObservationRequirement
public boolean hasObservationRequirement()
-
addObservationRequirement
public Reference addObservationRequirement()
-
addObservationRequirement
public ActivityDefinition addObservationRequirement(Reference t)
-
getObservationRequirementFirstRep
public Reference getObservationRequirementFirstRep()
- Returns:
- The first repetition of repeating field
observationRequirement, creating it if it does not already exist {3}
-
getObservationResultRequirement
public List<Reference> 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
public boolean hasObservationResultRequirement()
-
addObservationResultRequirement
public Reference addObservationResultRequirement()
-
addObservationResultRequirement
public ActivityDefinition addObservationResultRequirement(Reference t)
-
getObservationResultRequirementFirstRep
public Reference getObservationResultRequirementFirstRep()
- Returns:
- The first repetition of repeating field
observationResultRequirement, creating it if it does not already exist {3}
-
getTransformElement
public CanonicalType 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
public boolean hasTransformElement()
-
hasTransform
public boolean hasTransform()
-
setTransformElement
public ActivityDefinition setTransformElement(CanonicalType value)
- Parameters:
value-transform(A reference to a StructureMap resource that defines a transform that can be executed to produce the intent resource using the ActivityDefinition instance as the input.). This is the underlying object with id, value and extensions. The accessor "getTransform" gives direct access to the value
-
getTransform
public String 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
public ActivityDefinition setTransform(String value)
- 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
public List<ActivityDefinition.ActivityDefinitionDynamicValueComponent> getDynamicValue()
- Returns:
dynamicValue(Dynamic values that will be evaluated to produce values for elements of the resulting resource. For example, if the dosage of a medication must be computed based on the patient's weight, a dynamic value would be used to specify an expression that calculated the weight, and the path on the 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
public boolean hasDynamicValue()
-
addDynamicValue
public ActivityDefinition.ActivityDefinitionDynamicValueComponent addDynamicValue()
-
addDynamicValue
public ActivityDefinition addDynamicValue(ActivityDefinition.ActivityDefinitionDynamicValueComponent t)
-
getDynamicValueFirstRep
public ActivityDefinition.ActivityDefinitionDynamicValueComponent getDynamicValueFirstRep()
- Returns:
- The first repetition of repeating field
dynamicValue, creating it if it does not already exist {3}
-
listChildren
protected void listChildren(List<Property> children)
- 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
public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classMetadataResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- 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
public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
addChildin classMetadataResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
public String fhirType()
- Specified by:
fhirTypein interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
fhirTypein classMetadataResource
-
copy
public ActivityDefinition copy()
- Specified by:
copyin classMetadataResource
-
copyValues
public void copyValues(ActivityDefinition dst)
-
typedCopy
protected ActivityDefinition typedCopy()
-
equalsDeep
public boolean equalsDeep(Base other_)
- Overrides:
equalsDeepin classMetadataResource
-
equalsShallow
public boolean equalsShallow(Base other_)
- Overrides:
equalsShallowin classMetadataResource
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmptyin interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
isEmptyin classMetadataResource
-
getResourceType
public ResourceType getResourceType()
- Specified by:
getResourceTypein classResource
-
-