Class ActivityDefinition
- java.lang.Object
-
- org.linuxforhealth.fhir.model.visitor.AbstractVisitable
-
- org.linuxforhealth.fhir.model.resource.Resource
-
- org.linuxforhealth.fhir.model.resource.DomainResource
-
- org.linuxforhealth.fhir.model.resource.ActivityDefinition
-
- All Implemented Interfaces:
Visitable
@Generated("org.linuxforhealth.fhir.tools.CodeGenerator") 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.Maturity level: FMM3 (Trial Use)
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ActivityDefinition.Builder
static class
ActivityDefinition.DynamicValue
Dynamic values that will be evaluated to produce values for elements of the resulting resource.static class
ActivityDefinition.Participant
Indicates who should participate in performing the action described.
-
Field Summary
-
Fields inherited from class org.linuxforhealth.fhir.model.resource.DomainResource
contained, extension, modifierExtension, text
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
accept(java.lang.String elementName, int elementIndex, Visitor visitor)
Accept a Visitor and invoke the appropriate visit methods.static ActivityDefinition.Builder
builder()
boolean
equals(java.lang.Object obj)
Date
getApprovalDate()
The date on which the resource content was approved by the publisher.java.util.List<ContactDetail>
getAuthor()
An individiual or organization primarily involved in the creation and maintenance of the content.java.util.List<CodeableConcept>
getBodySite()
Indicates the sites on the subject's body where the procedure should be performed (I.e.CodeableConcept
getCode()
Detailed description of the type of activity; e.g.java.util.List<ContactDetail>
getContact()
Contact details to assist a user in finding and communicating with the publisher.Markdown
getCopyright()
A copyright statement relating to the activity definition and/or its contents.DateTime
getDate()
The date (and optionally time) when the activity definition was published.Markdown
getDescription()
A free text natural language description of the activity definition from a consumer's perspective.Boolean
getDoNotPerform()
Set this to true if the definition is to indicate that a particular activity should NOT be performed.java.util.List<Dosage>
getDosage()
Provides detailed dosage instructions in the same way that they are described for MedicationRequest resources.java.util.List<ActivityDefinition.DynamicValue>
getDynamicValue()
Dynamic values that will be evaluated to produce values for elements of the resulting resource.java.util.List<ContactDetail>
getEditor()
An individual or organization primarily responsible for internal coherence of the content.Period
getEffectivePeriod()
The period during which the activity definition content was or is planned to be in active use.java.util.List<ContactDetail>
getEndorser()
An individual or organization responsible for officially endorsing the content for use in some setting.Boolean
getExperimental()
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.java.util.List<Identifier>
getIdentifier()
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.RequestIntent
getIntent()
Indicates the level of authority/intentionality associated with the activity and where the request should fit into the workflow chain.java.util.List<CodeableConcept>
getJurisdiction()
A legal or geographic region in which the activity definition is intended to be used.ActivityDefinitionKind
getKind()
A description of the kind of resource the activity definition is representing.Date
getLastReviewDate()
The date on which the resource content was last reviewed.java.util.List<Canonical>
getLibrary()
A reference to a Library resource containing any formal logic used by the activity definition.Reference
getLocation()
Identifies the facility where the activity will occur; e.g.String
getName()
A natural language name identifying the activity definition.java.util.List<Reference>
getObservationRequirement()
Defines observation requirements for the action to be performed, such as body weight or surface area.java.util.List<Reference>
getObservationResultRequirement()
Defines the observations that are expected to be produced by the action.java.util.List<ActivityDefinition.Participant>
getParticipant()
Indicates who should participate in performing the action described.RequestPriority
getPriority()
Indicates how quickly the activity should be addressed with respect to other requests.Element
getProduct()
Identifies the food, drug or other product being consumed or supplied in the activity.Canonical
getProfile()
A profile to which the target of the activity definition is expected to conform.String
getPublisher()
The name of the organization or individual that published the activity definition.Markdown
getPurpose()
Explanation of why this activity definition is needed and why it has been designed as it has.SimpleQuantity
getQuantity()
Identifies the quantity expected to be consumed at once (per dose, per meal, etc.).java.util.List<RelatedArtifact>
getRelatedArtifact()
Related artifacts such as additional documentation, justification, or bibliographic references.java.util.List<ContactDetail>
getReviewer()
An individual or organization primarily responsible for review of some aspect of the content.java.util.List<Reference>
getSpecimenRequirement()
Defines specimen requirements for the action to be performed, such as required specimens for a lab test.PublicationStatus
getStatus()
The status of this activity definition.Element
getSubject()
A code, group definition, or canonical reference that describes or identifies the intended subject of the activity being defined.String
getSubtitle()
An explanatory or alternate title for the activity definition giving additional information about its content.Element
getTiming()
The period, timing or frequency upon which the described activity is to occur.String
getTitle()
A short, descriptive, user-friendly title for the activity definition.java.util.List<CodeableConcept>
getTopic()
Descriptive topics related to the content of the activity.Canonical
getTransform()
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.Uri
getUrl()
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.String
getUsage()
A detailed description of how the activity definition is used from a clinical perspective.java.util.List<UsageContext>
getUseContext()
The content was developed with a focus and intent of supporting the contexts that are listed.String
getVersion()
The identifier that is used to identify this version of the activity definition when it is referenced in a specification, model, design or instance.boolean
hasChildren()
int
hashCode()
ActivityDefinition.Builder
toBuilder()
Create a new Builder from the contents of this Resource-
Methods inherited from class org.linuxforhealth.fhir.model.resource.DomainResource
getContained, getExtension, getModifierExtension, getText
-
Methods inherited from class org.linuxforhealth.fhir.model.resource.Resource
as, getId, getImplicitRules, getLanguage, getMeta, is
-
-
-
-
Method Detail
-
getUrl
public Uri getUrl()
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.- Returns:
- An immutable object of type
Uri
that may be null.
-
getIdentifier
public java.util.List<Identifier> getIdentifier()
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.- Returns:
- An unmodifiable list containing immutable objects of type
Identifier
that may be empty.
-
getVersion
public String getVersion()
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.- Returns:
- An immutable object of type
String
that may be null.
-
getName
public String getName()
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.- Returns:
- An immutable object of type
String
that may be null.
-
getTitle
public String getTitle()
A short, descriptive, user-friendly title for the activity definition.- Returns:
- An immutable object of type
String
that may be null.
-
getSubtitle
public String getSubtitle()
An explanatory or alternate title for the activity definition giving additional information about its content.- Returns:
- An immutable object of type
String
that may be null.
-
getStatus
public PublicationStatus getStatus()
The status of this activity definition. Enables tracking the life-cycle of the content.- Returns:
- An immutable object of type
PublicationStatus
that is non-null.
-
getExperimental
public Boolean getExperimental()
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.- Returns:
- An immutable object of type
Boolean
that may be null.
-
getSubject
public Element getSubject()
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.- Returns:
- An immutable object of type
CodeableConcept
,Reference
orCanonical
that may be null.
-
getDate
public DateTime getDate()
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.- Returns:
- An immutable object of type
DateTime
that may be null.
-
getPublisher
public String getPublisher()
The name of the organization or individual that published the activity definition.- Returns:
- An immutable object of type
String
that may be null.
-
getContact
public java.util.List<ContactDetail> getContact()
Contact details to assist a user in finding and communicating with the publisher.- Returns:
- An unmodifiable list containing immutable objects of type
ContactDetail
that may be empty.
-
getDescription
public Markdown getDescription()
A free text natural language description of the activity definition from a consumer's perspective.- Returns:
- An immutable object of type
Markdown
that may be null.
-
getUseContext
public java.util.List<UsageContext> getUseContext()
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.- Returns:
- An unmodifiable list containing immutable objects of type
UsageContext
that may be empty.
-
getJurisdiction
public java.util.List<CodeableConcept> getJurisdiction()
A legal or geographic region in which the activity definition is intended to be used.- Returns:
- An unmodifiable list containing immutable objects of type
CodeableConcept
that may be empty.
-
getPurpose
public Markdown getPurpose()
Explanation of why this activity definition is needed and why it has been designed as it has.- Returns:
- An immutable object of type
Markdown
that may be null.
-
getUsage
public String getUsage()
A detailed description of how the activity definition is used from a clinical perspective.- Returns:
- An immutable object of type
String
that may be null.
-
getCopyright
public Markdown getCopyright()
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.- Returns:
- An immutable object of type
Markdown
that may be null.
-
getApprovalDate
public Date getApprovalDate()
The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.- Returns:
- An immutable object of type
Date
that may be null.
-
getLastReviewDate
public Date getLastReviewDate()
The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.- Returns:
- An immutable object of type
Date
that may be null.
-
getEffectivePeriod
public Period getEffectivePeriod()
The period during which the activity definition content was or is planned to be in active use.- Returns:
- An immutable object of type
Period
that may be null.
-
getTopic
public java.util.List<CodeableConcept> getTopic()
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.- Returns:
- An unmodifiable list containing immutable objects of type
CodeableConcept
that may be empty.
-
getAuthor
public java.util.List<ContactDetail> getAuthor()
An individiual or organization primarily involved in the creation and maintenance of the content.- Returns:
- An unmodifiable list containing immutable objects of type
ContactDetail
that may be empty.
-
getEditor
public java.util.List<ContactDetail> getEditor()
An individual or organization primarily responsible for internal coherence of the content.- Returns:
- An unmodifiable list containing immutable objects of type
ContactDetail
that may be empty.
-
getReviewer
public java.util.List<ContactDetail> getReviewer()
An individual or organization primarily responsible for review of some aspect of the content.- Returns:
- An unmodifiable list containing immutable objects of type
ContactDetail
that may be empty.
-
getEndorser
public java.util.List<ContactDetail> getEndorser()
An individual or organization responsible for officially endorsing the content for use in some setting.- Returns:
- An unmodifiable list containing immutable objects of type
ContactDetail
that may be empty.
-
getRelatedArtifact
public java.util.List<RelatedArtifact> getRelatedArtifact()
Related artifacts such as additional documentation, justification, or bibliographic references.- Returns:
- An unmodifiable list containing immutable objects of type
RelatedArtifact
that may be empty.
-
getLibrary
public java.util.List<Canonical> getLibrary()
A reference to a Library resource containing any formal logic used by the activity definition.- Returns:
- An unmodifiable list containing immutable objects of type
Canonical
that may be empty.
-
getKind
public ActivityDefinitionKind getKind()
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.- Returns:
- An immutable object of type
ActivityDefinitionKind
that may be null.
-
getProfile
public Canonical getProfile()
A profile to which the target of the activity definition is expected to conform.- Returns:
- An immutable object of type
Canonical
that may be null.
-
getCode
public CodeableConcept getCode()
Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter.- Returns:
- An immutable object of type
CodeableConcept
that may be null.
-
getIntent
public RequestIntent getIntent()
Indicates the level of authority/intentionality associated with the activity and where the request should fit into the workflow chain.- Returns:
- An immutable object of type
RequestIntent
that may be null.
-
getPriority
public RequestPriority getPriority()
Indicates how quickly the activity should be addressed with respect to other requests.- Returns:
- An immutable object of type
RequestPriority
that may be null.
-
getDoNotPerform
public Boolean getDoNotPerform()
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.- Returns:
- An immutable object of type
Boolean
that may be null.
-
getTiming
public Element getTiming()
The period, timing or frequency upon which the described activity is to occur.
-
getLocation
public Reference getLocation()
Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.- Returns:
- An immutable object of type
Reference
that may be null.
-
getParticipant
public java.util.List<ActivityDefinition.Participant> getParticipant()
Indicates who should participate in performing the action described.- Returns:
- An unmodifiable list containing immutable objects of type
ActivityDefinition.Participant
that may be empty.
-
getProduct
public Element getProduct()
Identifies the food, drug or other product being consumed or supplied in the activity.- Returns:
- An immutable object of type
Reference
orCodeableConcept
that may be null.
-
getQuantity
public SimpleQuantity getQuantity()
Identifies the quantity expected to be consumed at once (per dose, per meal, etc.).- Returns:
- An immutable object of type
SimpleQuantity
that may be null.
-
getDosage
public java.util.List<Dosage> getDosage()
Provides detailed dosage instructions in the same way that they are described for MedicationRequest resources.- Returns:
- An unmodifiable list containing immutable objects of type
Dosage
that may be empty.
-
getBodySite
public java.util.List<CodeableConcept> getBodySite()
Indicates the sites on the subject's body where the procedure should be performed (I.e. the target sites).- Returns:
- An unmodifiable list containing immutable objects of type
CodeableConcept
that may be empty.
-
getSpecimenRequirement
public java.util.List<Reference> getSpecimenRequirement()
Defines specimen requirements for the action to be performed, such as required specimens for a lab test.- Returns:
- An unmodifiable list containing immutable objects of type
Reference
that may be empty.
-
getObservationRequirement
public java.util.List<Reference> getObservationRequirement()
Defines observation requirements for the action to be performed, such as body weight or surface area.- Returns:
- An unmodifiable list containing immutable objects of type
Reference
that may be empty.
-
getObservationResultRequirement
public java.util.List<Reference> getObservationResultRequirement()
Defines the observations that are expected to be produced by the action.- Returns:
- An unmodifiable list containing immutable objects of type
Reference
that may be empty.
-
getTransform
public Canonical getTransform()
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.- Returns:
- An immutable object of type
Canonical
that may be null.
-
getDynamicValue
public java.util.List<ActivityDefinition.DynamicValue> getDynamicValue()
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.- Returns:
- An unmodifiable list containing immutable objects of type
ActivityDefinition.DynamicValue
that may be empty.
-
hasChildren
public boolean hasChildren()
- Overrides:
hasChildren
in classDomainResource
-
accept
public void accept(java.lang.String elementName, int elementIndex, Visitor visitor)
Description copied from interface:Visitable
Accept a Visitor and invoke the appropriate visit methods. A typical implementation would look like this:if (visitor.preVisit(this)) { visitor.visitStart(elementName, elementIndex, this); if (visitor.visit(elementName, elementIndex, this)) { // visit children } visitor.visitEnd(elementName, elementIndex, this); visitor.postVisit(this); }
- Specified by:
accept
in interfaceVisitable
- Specified by:
accept
in classAbstractVisitable
- Parameters:
elementName
- the name of the element in the context of this visitelementIndex
- the index of the element in a list or -1 if it is not contained within a Listvisitor
- the visitor to use
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
toBuilder
public ActivityDefinition.Builder toBuilder()
Description copied from class:Resource
Create a new Builder from the contents of this Resource- Specified by:
toBuilder
in classDomainResource
-
builder
public static ActivityDefinition.Builder builder()
-
-