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

This resource allows for the definition of some activity to be performed, independent of a particular patient, practitioner, or other performance context.
See Also:
  • Field Details

    • identifier

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

      protected StringType subtitle
      An explanatory or alternate title for the activity definition giving additional information about its content.
    • subject

      protected Type subject
      A code or group definition that describes the intended subject of the activity being defined.
    • 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.
    • approvalDate

      The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
    • lastReviewDate

      The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
    • effectivePeriod

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

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

      An individiual or organization primarily involved in the creation and maintenance of the content.
    • editor

      An individual or organization primarily responsible for internal coherence of the content.
    • reviewer

      An individual or organization primarily responsible for review of some aspect of the content.
    • endorser

      An individual or organization responsible for officially endorsing the content for use in some setting.
    • relatedArtifact

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

      A reference to a Library resource containing any formal logic used by the activity definition.
    • kind

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

      A profile to which the target of the activity definition is expected to conform.
    • code

      protected CodeableConcept code
      Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter.
    • intent

      Indicates the level of authority/intentionality associated with the activity and where the request should fit into the workflow chain.
    • priority

      Indicates how quickly the activity should be addressed with respect to other requests.
    • doNotPerform

      Set this to true if the definition is to indicate that a particular activity should NOT be performed. If true, this element should be interpreted to reinforce a negative coding. For example NPO as a code with a doNotPerform of true would still indicate to NOT perform the action.
    • timing

      protected Type timing
      The period, timing or frequency upon which the described activity is to occur.
    • location

      protected Reference location
      Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.
    • locationTarget

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

      Indicates who should participate in performing the action described.
    • product

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

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

      Defines specimen requirements for the action to be performed, such as required specimens for a lab test.
    • specimenRequirementTarget

      The actual objects that are the target of the reference (Defines specimen requirements for the action to be performed, such as required specimens for a lab test.)
    • observationRequirement

      Defines observation requirements for the action to be performed, such as body weight or surface area.
    • observationRequirementTarget

      The actual objects that are the target of the reference (Defines observation requirements for the action to be performed, such as body weight or surface area.)
    • observationResultRequirement

      Defines the observations that are expected to be produced by the action.
    • observationResultRequirementTarget

      The actual objects that are the target of the reference (Defines the observations that are expected to be produced by the action.)
    • transform

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

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

      public static final String SP_DATE
      Search parameter: date

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

      See Also:
    • DATE

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

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

    • SP_IDENTIFIER

      public static final String SP_IDENTIFIER
      Search parameter: identifier

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

      See Also:
    • IDENTIFIER

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

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

    • SP_SUCCESSOR

      public static final String SP_SUCCESSOR
      Search parameter: successor

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

      See Also:
    • SUCCESSOR

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SUCCESSOR
      Fluent Client search parameter constant for successor

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

    • INCLUDE_SUCCESSOR

      public static final ca.uhn.fhir.model.api.Include INCLUDE_SUCCESSOR
      Constant for fluent queries to be used to add include statements. Specifies the path value of "ActivityDefinition:successor".
    • SP_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:

      See Also:
    • CONTEXT_TYPE_VALUE

      public static final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.TokenClientParam> CONTEXT_TYPE_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:

    • 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:
    • JURISDICTION

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

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

    • SP_DESCRIPTION

      public static final String SP_DESCRIPTION
      Search parameter: description

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

      See Also:
    • DESCRIPTION

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

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

    • SP_DERIVED_FROM

      public static final String SP_DERIVED_FROM
      Search parameter: derived-from

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

      See Also:
    • DERIVED_FROM

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam DERIVED_FROM
      Fluent Client search parameter constant for derived-from

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

    • INCLUDE_DERIVED_FROM

      public static final ca.uhn.fhir.model.api.Include INCLUDE_DERIVED_FROM
      Constant for fluent queries to be used to add include statements. Specifies the path value of "ActivityDefinition:derived-from".
    • SP_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:
    • 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_PREDECESSOR

      public static final String SP_PREDECESSOR
      Search parameter: predecessor

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

      See Also:
    • PREDECESSOR

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PREDECESSOR
      Fluent Client search parameter constant for predecessor

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

    • INCLUDE_PREDECESSOR

      public static final ca.uhn.fhir.model.api.Include INCLUDE_PREDECESSOR
      Constant for fluent queries to be used to add include statements. Specifies the path value of "ActivityDefinition:predecessor".
    • SP_TITLE

      public static final String SP_TITLE
      Search parameter: title

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

      See Also:
    • TITLE

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

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

    • SP_COMPOSED_OF

      public static final String SP_COMPOSED_OF
      Search parameter: composed-of

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

      See Also:
    • COMPOSED_OF

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam COMPOSED_OF
      Fluent Client search parameter constant for composed-of

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

    • INCLUDE_COMPOSED_OF

      public static final ca.uhn.fhir.model.api.Include INCLUDE_COMPOSED_OF
      Constant for fluent queries to be used to add include statements. Specifies the path value of "ActivityDefinition:composed-of".
    • SP_VERSION

      public static final String SP_VERSION
      Search parameter: version

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

      See Also:
    • VERSION

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

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

    • SP_URL

      public static final String SP_URL
      Search parameter: url

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

      See Also:
    • 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_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.valueQuantity, ActivityDefinition.useContext.valueRange

      See Also:
    • 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.valueQuantity, ActivityDefinition.useContext.valueRange

    • 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:
    • EFFECTIVE

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

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

    • SP_DEPENDS_ON

      public static final String SP_DEPENDS_ON
      Search parameter: depends-on

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

      See Also:
    • DEPENDS_ON

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam DEPENDS_ON
      Fluent Client search parameter constant for depends-on

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

    • INCLUDE_DEPENDS_ON

      public static final ca.uhn.fhir.model.api.Include INCLUDE_DEPENDS_ON
      Constant for fluent queries to be used to add include statements. Specifies the path value of "ActivityDefinition:depends-on".
    • SP_NAME

      public static final String SP_NAME
      Search parameter: name

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

      See Also:
    • 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_CONTEXT

      public static final String SP_CONTEXT
      Search parameter: context

      Description: A use context assigned to the activity definition
      Type: token
      Path: ActivityDefinition.useContext.valueCodeableConcept

      See Also:
    • 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.valueCodeableConcept

    • 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:
    • PUBLISHER

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

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

    • SP_TOPIC

      public static final String SP_TOPIC
      Search parameter: topic

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

      See Also:
    • 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_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:

      See Also:
    • CONTEXT_TYPE_QUANTITY

      public static final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.QuantityClientParam> CONTEXT_TYPE_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:

    • 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:
    • STATUS

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

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

  • Constructor Details

  • Method Details