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 DomainResource
    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
    • 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.
      • 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.
      • 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.
      • 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.
      • 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 period, timing or frequency upon which the described activity is to occur.
      • location

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

        Description: 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-of

        Description: 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-quantity

        Description: 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-quantity

        Description: 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-quantity

        Description: 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-quantity

        Description: 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-value

        Description: 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-value

        Description: 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-type

        Description: 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-type

        Description: 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: context

        Description: 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 context

        Description: 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: date

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

        See Also:
        Constant Field Values
      • DATE

        public static final ca.uhn.fhir.rest.gclient.DateClientParam DATE
        Fluent Client search parameter constant for date

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

      • SP_DEPENDS_ON

        public static final String SP_DEPENDS_ON
        Search parameter: depends-on

        Description: 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-on

        Description: 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-from

        Description: 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-from

        Description: 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: description

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

        See Also:
        Constant Field Values
      • DESCRIPTION

        public static final ca.uhn.fhir.rest.gclient.StringClientParam DESCRIPTION
        Fluent Client search parameter constant for description

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

      • SP_EFFECTIVE

        public static final String SP_EFFECTIVE
        Search parameter: effective

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

        See Also:
        Constant Field Values
      • EFFECTIVE

        public static final ca.uhn.fhir.rest.gclient.DateClientParam EFFECTIVE
        Fluent Client search parameter constant for effective

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

      • SP_IDENTIFIER

        public static final String SP_IDENTIFIER
        Search parameter: identifier

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

        See Also:
        Constant Field Values
      • IDENTIFIER

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
        Fluent Client search parameter constant for identifier

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

      • SP_JURISDICTION

        public static final String SP_JURISDICTION
        Search parameter: jurisdiction

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

        See Also:
        Constant Field Values
      • JURISDICTION

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam JURISDICTION
        Fluent Client search parameter constant for jurisdiction

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

      • SP_NAME

        public static final String SP_NAME
        Search parameter: name

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

        See Also:
        Constant Field Values
      • NAME

        public static final ca.uhn.fhir.rest.gclient.StringClientParam NAME
        Fluent Client search parameter constant for name

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

      • SP_PREDECESSOR

        public static final String SP_PREDECESSOR
        Search parameter: predecessor

        Description: 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 predecessor

        Description: 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: publisher

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

        See Also:
        Constant Field Values
      • PUBLISHER

        public static final ca.uhn.fhir.rest.gclient.StringClientParam PUBLISHER
        Fluent Client search parameter constant for publisher

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

      • SP_STATUS

        public static final String SP_STATUS
        Search parameter: status

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

        See Also:
        Constant Field Values
      • STATUS

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
        Fluent Client search parameter constant for status

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

      • SP_SUCCESSOR

        public static final String SP_SUCCESSOR
        Search parameter: successor

        Description: 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 successor

        Description: 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: title

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

        See Also:
        Constant Field Values
      • TITLE

        public static final ca.uhn.fhir.rest.gclient.StringClientParam TITLE
        Fluent Client search parameter constant for title

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

      • SP_TOPIC

        public static final String SP_TOPIC
        Search parameter: topic

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

        See Also:
        Constant Field Values
      • TOPIC

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam TOPIC
        Fluent Client search parameter constant for topic

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

      • SP_URL

        public static final String SP_URL
        Search parameter: url

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

        See Also:
        Constant Field Values
      • URL

        public static final ca.uhn.fhir.rest.gclient.UriClientParam URL
        Fluent Client search parameter constant for url

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

      • SP_VERSION

        public static final String SP_VERSION
        Search parameter: version

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

        See Also:
        Constant Field Values
      • VERSION

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam VERSION
        Fluent Client search parameter constant for version

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

    • Method Detail

      • getUrlElement

        public UriType getUrlElement()
        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
      • hasUrl

        public boolean hasUrl()
      • setUrlElement

        public ActivityDefinition setUrlElement​(UriType value)
        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()
        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)
        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<IdentifiergetIdentifier()
        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.)
      • getVersionElement

        public StringType getVersionElement()
        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
      • setVersionElement

        public ActivityDefinition setVersionElement​(StringType value)
        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()
        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)
        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()
        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
      • hasName

        public boolean hasName()
      • setNameElement

        public ActivityDefinition setNameElement​(StringType value)
        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()
        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)
        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()
        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
      • setTitleElement

        public ActivityDefinition setTitleElement​(StringType value)
        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()
        Returns:
        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
      • 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.PublicationStatusgetStatusElement()
        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
      • getExperimentalElement

        public BooleanType getExperimentalElement()
        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
      • setExperimentalElement

        public ActivityDefinition setExperimentalElement​(BooleanType value)
        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()
        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)
        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
      • 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
      • 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
      • 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()
        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
      • hasDate

        public boolean hasDate()
      • setDateElement

        public ActivityDefinition setDateElement​(DateTimeType value)
        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()
        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)
        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()
        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
      • setPublisherElement

        public ActivityDefinition setPublisherElement​(StringType value)
        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()
        Returns:
        The name of the organization or individual that published the activity definition.
      • getDescriptionElement

        public MarkdownType getDescriptionElement()
        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
      • setDescriptionElement

        public ActivityDefinition setDescriptionElement​(MarkdownType value)
        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()
        Returns:
        A free text natural language description of the activity definition from a consumer's perspective.
      • setDescription

        public ActivityDefinition setDescription​(String value)
        Parameters:
        value - A free text natural language description of the activity definition from a consumer's perspective.
      • getUseContext

        public List<UsageContextgetUseContext()
        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.)
      • getPurposeElement

        public MarkdownType getPurposeElement()
        Returns:
        purpose (Explanation of why this activity definition is needed and why it has been designed as it has.). This is the underlying object with id, value and extensions. The accessor "getPurpose" gives direct access to the value
      • setPurposeElement

        public ActivityDefinition setPurposeElement​(MarkdownType value)
        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()
        Returns:
        Explanation of why this activity definition is needed and why it has been designed as it has.
      • setPurpose

        public ActivityDefinition setPurpose​(String value)
        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
      • 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()
        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
      • setCopyrightElement

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

        public String getCopyright()
        Returns:
        A copyright statement relating to the activity definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the activity definition.
      • setCopyright

        public ActivityDefinition setCopyright​(String value)
        Parameters:
        value - A copyright statement relating to the activity definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the activity definition.
      • getApprovalDateElement

        public DateType getApprovalDateElement()
        Returns:
        approvalDate (The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.). This is the underlying object with id, value and extensions. The accessor "getApprovalDate" gives direct access to the value
      • setApprovalDateElement

        public ActivityDefinition setApprovalDateElement​(DateType value)
        Parameters:
        value - approvalDate (The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.). This is the underlying object with id, value and extensions. The accessor "getApprovalDate" gives direct access to the value
      • getApprovalDate

        public Date getApprovalDate()
        Returns:
        The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
      • setApprovalDate

        public ActivityDefinition setApprovalDate​(Date value)
        Parameters:
        value - The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
      • getLastReviewDateElement

        public DateType getLastReviewDateElement()
        Returns:
        lastReviewDate (The date on which the resource content was last reviewed. Review happens periodically after approval but 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
      • setLastReviewDateElement

        public ActivityDefinition setLastReviewDateElement​(DateType value)
        Parameters:
        value - lastReviewDate (The date on which the resource content was last reviewed. Review happens periodically after approval but 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()
        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)
        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.
      • getTopic

        public List<CodeableConceptgetTopic()
        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.)
      • getAuthor

        public List<ContactDetailgetAuthor()
        Returns:
        author (An individiual or organization primarily involved in the creation and maintenance of the content.)
      • getEditor

        public List<ContactDetailgetEditor()
        Returns:
        editor (An individual or organization primarily responsible for internal coherence of the content.)
      • getEndorser

        public List<ContactDetailgetEndorser()
        Returns:
        endorser (An individual or organization responsible for officially endorsing the content for use in some setting.)
      • 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.RequestResourceTypegetKindElement()
        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
      • 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
      • 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()
      • getIntentElement

        public Enumeration<Enumerations.RequestIntentgetIntentElement()
        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
      • 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.
      • 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
      • 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 period, timing or frequency upon which the described activity is to occur.)
      • getTimingTiming

        public Timing getTimingTiming()
                               throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        timing (The period, timing or frequency upon which the described activity is to occur.)
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • getTimingDateTimeType

        public DateTimeType getTimingDateTimeType()
                                           throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        timing (The period, timing or frequency upon which the described activity is to occur.)
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • getTimingAge

        public Age getTimingAge()
                         throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        timing (The period, timing or frequency upon which the described activity is to occur.)
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • getTimingPeriod

        public Period getTimingPeriod()
                               throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        timing (The period, timing or frequency upon which the described activity is to occur.)
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • getTimingRange

        public Range getTimingRange()
                             throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        timing (The period, timing or frequency upon which the described activity is to occur.)
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • getTimingDuration

        public Duration getTimingDuration()
                                   throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        timing (The period, timing or frequency upon which the described activity is to occur.)
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • getLocation

        public Reference getLocation()
        Returns:
        location (Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.)
      • 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
      • 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
      • getQuantity

        public Quantity getQuantity()
        Returns:
        quantity (Identifies the quantity expected to be consumed at once (per dose, per meal, etc.).)
      • getDosage

        public List<DosagegetDosage()
        Returns:
        dosage (Provides detailed dosage instructions in the same way that they are described for MedicationRequest resources.)
      • getDosageFirstRep

        public Dosage getDosageFirstRep()
        Returns:
        The first repetition of repeating field dosage, 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
      • 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.ActivityDefinitionDynamicValueComponentgetDynamicValue()
        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.)
      • getProperty

        public Base[] getProperty​(int hash,
                                  String name,
                                  boolean checkValid)
                           throws org.hl7.fhir.exceptions.FHIRException
        Overrides:
        getProperty in class DomainResource
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • isEmpty

        public boolean isEmpty()
        Specified by:
        isEmpty in interface org.hl7.fhir.instance.model.api.IBase
        Overrides:
        isEmpty in class DomainResource