Package org.hl7.fhir.r4.model.codesystems

Enum V3ActMood

java.lang.Object
java.lang.Enum<V3ActMood>
org.hl7.fhir.r4.model.codesystems.V3ActMood
All Implemented Interfaces:
Serializable, Comparable<V3ActMood>
public enum V3ActMood extends Enum<V3ActMood>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    _ACTMOODACTREQUEST
    Definition: A request (or order) for an act that is part of a defined request/fulfillment cycle.
    _ACTMOODCOMPLETIONTRACK
    These are moods describing activities as they progress in the business cycle, from defined, through planned and ordered to completed.
    _ACTMOODDESIRE
    Definition: A desire to have an act occur.
    _ACTMOODPOTENTIAL
    Definition: A possible act.
    _ACTMOODPREDICATE
    Definition: An act that expresses condition statements for other acts.
    APT
    Definition: An act that has been scheduled to be performed at a specific place and time.
    ARQ
    Definition: A request act that is specialized for the appointment scheduling request/fulfillment cycle.
    CRT
    Deprecation Comment: This concept This codes should no longer be used.
    DEF
    Definition: A definition of a kind of act that can occur .
    EVN
    Definition: An act that actually happens (may be an ongoing act or a documentation of a past act).
    EVN_CRT
    Deprecation Comment: This concept This codes should no longer be used.
    EXPEC
    Definition: An act that is considered to have some noteworthy likelihood of occurring in the future (has_match = event).
    GOL
    Definition: An expectation that is considered to be desirable to occur in the future Examples:Target weight below 80Kg, Stop smoking, Regain ability to walk, goal is to administer thrombolytics to candidate patients presenting with acute myocardial infarction.
    GOL_CRT
    A criterion expressed over goals (ActMood.GOL).
    INT
    Definition: An intention or plan for an act.
    INT_CRT
    A criterion expressed over intents (ActMood.INT).
    NULL
    added to help the parsers
    OPT
    Definition: One of a set of acts that specify an option for the property values that the parent act may have.
    PERM
    Definition: A kind of act that defines a permission that has been granted.
    PERMRQ
    Definition: A request for a permission to perform the act.
    PRMS
    Definition: A commitment to perform an act (may be either solicited or unsolicited).
    PRMS_CRT
    A criterion expressed over promises (ActMood.PRMS).
    PRP
    Definition: A suggestion that an act might be performed.
    RMD
    Definition: A suggestion that an act should be performed with an acceptance of some degree of professional responsibility for the resulting act.
    RQO
    Definition: A request act that is specialized for an event request/fulfillment cycle.
    RQO_CRT
    A criterion expressed over requests or orders (ActMood.RQO).
    RSK
    Definition:An act that may occur in the future and which is regarded as undesirable Examples:Increased risk of DVT, at risk for sub-acute bacterial endocarditis.
    RSK_CRT
    A criterion expressed over risks (ActMood.RSK).
    SLOT
    Definition: A kind of act that may occur during the specified time period.

  • Method Summary

    Modifier and Type
    Method
    Description
    static V3ActMood
    fromCode(String codeString)
     
    String
    getDefinition()
     
    String
    getDisplay()
     
    String
    getSystem()
     
    String
    toCode()
     
    static V3ActMood
    valueOf(String name)
    Returns the enum constant of this type with the specified name.
    static V3ActMood[]
    values()
    Returns an array containing the constants of this enum type, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • _ACTMOODCOMPLETIONTRACK

      public static final V3ActMood _ACTMOODCOMPLETIONTRACK
      These are moods describing activities as they progress in the business cycle, from defined, through planned and ordered to completed.

    • _ACTMOODPOTENTIAL

      public static final V3ActMood _ACTMOODPOTENTIAL
      Definition: A possible act.

    • DEF

      public static final V3ActMood DEF
      Definition: A definition of a kind of act that can occur . OpenIssue: The semantic constructs embodied in DEF and CRT moods seem indistinguishable, and their uses can readily be determined by the context in which these are used. Therefore, this OpenIssue has been created to declare that it is likely that ActMood.DEF will be "retired" in the future in favor of the more general ActMood.CRT.

    • PERM

      public static final V3ActMood PERM
      Definition: A kind of act that defines a permission that has been granted.

    • SLOT

      public static final V3ActMood SLOT
      Definition: A kind of act that may occur during the specified time period.

    • EVN

      public static final V3ActMood EVN
      Definition: An act that actually happens (may be an ongoing act or a documentation of a past act).

    • INT

      public static final V3ActMood INT
      Definition: An intention or plan for an act. >UsageNotes: The final outcome of the intent, the act that is intended to occur, is always an event. However the final outcome may be reached indirectly via steps through other intents, such as promise, permission request, or an appointment that may lead to an actual event to occur. Alternatively, the intended act may never occur.

    • _ACTMOODDESIRE

      public static final V3ActMood _ACTMOODDESIRE
      Definition: A desire to have an act occur.

    • _ACTMOODACTREQUEST

      public static final V3ActMood _ACTMOODACTREQUEST
      Definition: A request (or order) for an act that is part of a defined request/fulfillment cycle. UsageNotes: Use of an HL7 defined request/fulfillment framework is not required to use this mood code.

    • ARQ

      public static final V3ActMood ARQ
      Definition: A request act that is specialized for the appointment scheduling request/fulfillment cycle. An appointment request is fulfilled only and completely by an appointment (APT), i.e., all that the appointment request intends is to create an appointment (the actual act may well not happen if that is the professional decision during the appointment).

    • PERMRQ

      public static final V3ActMood PERMRQ
      Definition: A request for a permission to perform the act. Typically a payer (or possibly a supervisor) is being requested to give permission to perform the act. As opposed to the RQO, the requestee is not asked to perform or cause to perform the act but only to give the permission.

    • RQO

      public static final V3ActMood RQO
      Definition: A request act that is specialized for an event request/fulfillment cycle. UsageNotes: The fulfillment cycle may involve intermediary fulfilling acts in moods such as PRMS, APT, or even another RQO before being fulfilled by the final event. UsageNotes: The concepts of a "request" and an "order" are viewed as different, because there is an implication of a mandate associated with order. In practice, however, this distinction has no general functional value in the inter-operation of health care computing. "Orders" are commonly refused for a variety of clinical and business reasons, and the notion of a "request" obligates the recipient (the fulfiller) to respond to the sender (the author). Indeed, in many regions, including Australia and Europe, the common term used is "request." Thus, the concept embodies both notions, as there is no useful distinction to be made. If a mandate is to be associated with a request, this will be embodied in the "local" business rules applied to the transactions. Should HL7 desire to provide a distinction between these in the future, the individual concepts could be added as specializations of this concept. The critical distinction here, is the difference between this concept and an "intent", of which it is a specialization. An intent involves decisions by a single party, the author. A request, however, involves decisions by two parties, the author and the fulfiller, with an obligation on the part of the fulfiller to respond to the request indicating that the fulfiller will indeed fulfill the request.

    • PRP

      public static final V3ActMood PRP
      Definition: A suggestion that an act might be performed. Not an explicit request, and professional responsibility may or may not be present.

    • RMD

      public static final V3ActMood RMD
      Definition: A suggestion that an act should be performed with an acceptance of some degree of professional responsibility for the resulting act. Not an explicit request. . UsageNotes: Where there is no clear definition or applicable concept of "professional responsibilityâ??, RMD becomes indistinguishable from PRP. .

    • PRMS

      public static final V3ActMood PRMS
      Definition: A commitment to perform an act (may be either solicited or unsolicited). The committer becomes responsible to the other party for executing the act, and, as a consequence, the other party may rely on the first party to perform or cause to perform the act. UsageNotes: Commitments may be retracted or cancelled.

    • APT

      public static final V3ActMood APT
      Definition: An act that has been scheduled to be performed at a specific place and time.

    • _ACTMOODPREDICATE

      public static final V3ActMood _ACTMOODPREDICATE
      Definition: An act that expresses condition statements for other acts.

    • CRT

      public static final V3ActMood CRT
      Deprecation Comment: This concept This codes should no longer be used. Instead, set attribute Act.isCriterionInd to "true" and use the desired mood for your criterion. Definition: A condition that must be true for the source act to be considered.

    • EVN_CRT

      public static final V3ActMood EVN_CRT
      Deprecation Comment: This concept This codes should no longer be used. Instead, set attribute Act.isCriterionInd to "true" and use the desired mood for your criterion. Definition: A criterion (CRT) that has_match = an event (EVN).

    • GOL_CRT

      public static final V3ActMood GOL_CRT
      A criterion expressed over goals (ActMood.GOL).

    • INT_CRT

      public static final V3ActMood INT_CRT
      A criterion expressed over intents (ActMood.INT).

    • PRMS_CRT

      public static final V3ActMood PRMS_CRT
      A criterion expressed over promises (ActMood.PRMS).

    • RQO_CRT

      public static final V3ActMood RQO_CRT
      A criterion expressed over requests or orders (ActMood.RQO).

    • RSK_CRT

      public static final V3ActMood RSK_CRT
      A criterion expressed over risks (ActMood.RSK).

    • EXPEC

      public static final V3ActMood EXPEC
      Definition: An act that is considered to have some noteworthy likelihood of occurring in the future (has_match = event). Examples:Prognosis of a condition, Expected date of discharge from hospital, patient will likely need an emergency decompression of the intracranial pressure by morning. UsageNotes:INT (intent) reflects a plan for the future, which is a declaration to do something. This contrasts with expectation, which is a prediction that something will happen in the future. GOL (goal) reflects a hope rather than a prediction. RSK (risk) reflects a potential negative event that may or may not be expected to happen.

    • GOL

      public static final V3ActMood GOL
      Definition: An expectation that is considered to be desirable to occur in the future Examples:Target weight below 80Kg, Stop smoking, Regain ability to walk, goal is to administer thrombolytics to candidate patients presenting with acute myocardial infarction. UsageNotes: INT (intent) reflects a plan for the future, which is a declaration to do something. This contrasts with goal which doesn't represent an intention to act, merely a hope for an eventual result. A goal is distinct from the intended actions to reach that goal. "I will reduce the dose of drug x to 20mg" is an intent. "I hope to be able to get the patient to the point where I can reduce the dose of drug x to 20mg" is a goal. EXPEC (expectation) reflects a prediction rather than a hope. RSK (risk) reflects a potential negative event rather than a hope.

    • RSK

      public static final V3ActMood RSK
      Definition:An act that may occur in the future and which is regarded as undesirable Examples:Increased risk of DVT, at risk for sub-acute bacterial endocarditis. UsageNotes:Note: An observation in RSK mood expresses the undesirable act, and not the underlying risk factor. A risk factor that is present (e.g. obesity, smoking, etc) should be expressed in event mood. INT (intent) reflects a plan for the future, which is a declaration to do something. This contrasts with RSK (risk), which is the potential that something negative will occur that may or may not ever happen. GOL (goal) reflects a hope to achieve something. EXPEC (expectation) is the prediction of a positive or negative event. This contrasts with RSK (risk), which is the potential that something negative will occur that may or may not ever happen, and may not be expected to happen.

    • OPT

      public static final V3ActMood OPT
      Definition: One of a set of acts that specify an option for the property values that the parent act may have. Typically used in definitions or orders to describe alternatives. An option can only be used as a group, that is, all assigned values must be used together. The actual mood of the act is the same as the parent act, and they must be linked by an actrelationship with type = OPTN.

    • NULL

      public static final V3ActMood NULL
      added to help the parsers

  • Method Details

    • values

      public static V3ActMood[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static V3ActMood valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null

    • fromCode

      public static V3ActMood fromCode(String codeString) throws org.hl7.fhir.exceptions.FHIRException
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • toCode

      public String toCode()

    • getSystem

      public String getSystem()

    • getDefinition

      public String getDefinition()

    • getDisplay

      public String getDisplay()