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

Enum W3cProvenanceActivityType

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

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    ATTRIBUTION
    Ascribing of an entity (object/document) to an agent.
    COLLECTION
    An aggregating activity that results in composition of an entity, which provides a structure to some constituents that must themselves be entities.
    COMMUNICATION
    The exchange of some unspecified entity by two activities, one activity using some entity generated by the other.
    DERIVATION
    A transformation of an entity into another, an update of an entity resulting in a new one, or the construction of a new entity based on a pre-existing entity.
    END
    When an activity is deemed to have been ended by an entity, known as trigger.
    GENERATION
    The completion of production of a new entity by an activity.
    INVALIDATION
    The start of the destruction, cessation, or expiry of an existing entity by an activity.
    NULL
    added to help the parsers
    PRIMARYSOURCE
    Refers to something produced by some agent with direct experience and knowledge about the topic, at the time of the topic's study, without benefit from hindsight.
    QUOTATION
    The repeat of (some or all of) an entity, such as text or image, by someone who might or might not be its original author.
    REVISION
    A derivation for which the resulting entity is a revised version of some original.
    START
    When an activity is deemed to have been started by an entity, known as trigger.
    USAGE
    the beginning of utilizing an entity by an activity.

  • Method Summary

    Modifier and Type
    Method
    Description
    static W3cProvenanceActivityType
    fromCode(String codeString)
     
    String
    getDefinition()
     
    String
    getDisplay()
     
    String
    getSystem()
     
    String
    toCode()
     
    static W3cProvenanceActivityType
    valueOf(String name)
    Returns the enum constant of this type with the specified name.
    static W3cProvenanceActivityType[]
    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

    • GENERATION

      public static final W3cProvenanceActivityType GENERATION
      The completion of production of a new entity by an activity. This entity did not exist before generation and becomes available for usage after this generation. Given that a generation is the completion of production of an entity, it is instantaneous.

    • USAGE

      public static final W3cProvenanceActivityType USAGE
      the beginning of utilizing an entity by an activity. Before usage, the activity had not begun to utilize this entity and could not have been affected by the entity. (Note: This definition is formulated for a given usage; it is permitted for an activity to have used a same entity multiple times.) Given that a usage is the beginning of utilizing an entity, it is instantaneous.

    • COMMUNICATION

      public static final W3cProvenanceActivityType COMMUNICATION
      The exchange of some unspecified entity by two activities, one activity using some entity generated by the other. A communication implies that activity a2 is dependent on another activity, a1, by way of some unspecified entity that is generated by a1 and used by a2.

    • START

      public static final W3cProvenanceActivityType START
      When an activity is deemed to have been started by an entity, known as trigger. The activity did not exist before its start. Any usage, generation, or invalidation involving an activity follows the activity's start. A start may refer to a trigger entity that set off the activity, or to an activity, known as starter, that generated the trigger. Given that a start is when an activity is deemed to have started, it is instantaneous.

    • END

      public static final W3cProvenanceActivityType END
      When an activity is deemed to have been ended by an entity, known as trigger. The activity no longer exists after its end. Any usage, generation, or invalidation involving an activity precedes the activity's end. An end may refer to a trigger entity that terminated the activity, or to an activity, known as ender that generated the trigger.

    • INVALIDATION

      public static final W3cProvenanceActivityType INVALIDATION
      The start of the destruction, cessation, or expiry of an existing entity by an activity. The entity is no longer available for use (or further invalidation) after invalidation. Any generation or usage of an entity precedes its invalidation. Given that an invalidation is the start of destruction, cessation, or expiry, it is instantaneous.

    • DERIVATION

      public static final W3cProvenanceActivityType DERIVATION
      A transformation of an entity into another, an update of an entity resulting in a new one, or the construction of a new entity based on a pre-existing entity. For an entity to be transformed from, created from, or resulting from an update to another, there must be some underpinning activity or activities performing the necessary action(s) resulting in such a derivation. A derivation can be described at various levels of precision. In its simplest form, derivation relates two entities. Optionally, attributes can be added to represent further information about the derivation. If the derivation is the result of a single known activity, then this activity can also be optionally expressed. To provide a completely accurate description of the derivation, the generation and usage of the generated and used entities, respectively, can be provided, so as to make the derivation path, through usage, activity, and generation, explicit. Optional information such as activity, generation, and usage can be linked to derivations to aid analysis of provenance and to facilitate provenance-based reproducibility.

    • REVISION

      public static final W3cProvenanceActivityType REVISION
      A derivation for which the resulting entity is a revised version of some original. The implication here is that the resulting entity contains substantial content from the original. A revision relation is a kind of derivation relation from a revised entity to a preceding entity.

    • QUOTATION

      public static final W3cProvenanceActivityType QUOTATION
      The repeat of (some or all of) an entity, such as text or image, by someone who might or might not be its original author. A quotation relation is a kind of derivation relation, for which an entity was derived from a preceding entity by copying, or 'quoting', some or all of it.

    • PRIMARYSOURCE

      public static final W3cProvenanceActivityType PRIMARYSOURCE
      Refers to something produced by some agent with direct experience and knowledge about the topic, at the time of the topic's study, without benefit from hindsight. Because of the directness of primary sources, they 'speak for themselves' in ways that cannot be captured through the filter of secondary sources. As such, it is important for secondary sources to reference those primary sources from which they were derived, so that their reliability can be investigated. It is also important to note that a given entity might be a primary source for one entity but not another. It is the reason why Primary Source is defined as a relation as opposed to a subtype of Entity.

    • ATTRIBUTION

      public static final W3cProvenanceActivityType ATTRIBUTION
      Ascribing of an entity (object/document) to an agent.

    • COLLECTION

      public static final W3cProvenanceActivityType COLLECTION
      An aggregating activity that results in composition of an entity, which provides a structure to some constituents that must themselves be entities. These constituents are said to be member of the collections.

    • NULL

      public static final W3cProvenanceActivityType NULL
      added to help the parsers

  • Method Details

    • values

      public static W3cProvenanceActivityType[] 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 W3cProvenanceActivityType 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 W3cProvenanceActivityType 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()