Codesystem-w3c-provenance-activity-type.xml

Definition for Code System W3cProvenanceActivityType

<CodeSystem xmlns="http://hl7.org/fhir">
  <id value="w3c-provenance-activity-type"/> 
  <meta> 
    <lastUpdated value="2017-12-20T15:52:34.818+11:00"/> 
    <profile value="http://hl7.org/fhir/StructureDefinition/shareablecodesystem"/> 
  </meta> 
  <text> 
    <status value="generated"/> 
    <div xmlns="http://www.w3.org/1999/xhtml"> 
  &quot;The PROV data model, PROV-DM, a generic data model for provenance that allows domain
       and application specific representations of provenance to be translated into such a data
       model and interchanged between systems. Thus, heterogeneous systems can export their native
       provenance into such a core data model, and applications that need to make sense of provenance
       can then import it, process it, and reason over it.
  A key goal of PROV is the specification of a machine-processable data model for provenance.
       However, communicating provenance between humans is also important when teaching, illustrating,
       formalizing, and discussing provenance-related issues.  With these two requirements in
       mind, this document introduces PROV-N, the PROV notation, a syntax designed to write instances
       of the PROV data model according to the following design principles: •Technology independence.
       PROV-N provides a simple syntax that can be mapped to several technologies. 
  •Human readability. PROV-N follows a functional syntax style that is meant to be easily
       human-readable so it can be used in illustrative examples, such as those presented in
       the PROV documents suite. 
  •Formality. PROV-N is defined through a formal grammar amenable to be used with parser
       generators.&quot;
    
      <hr/>  
      <h2> W3cProvenanceActivityType</h2> 
      <div> 
        <p> This value set includes W3C PROV Data Model Activity concepts, which are treated as codes
           in this valueset.  Some adaptations were made to make these concepts suitable values for
           the Provenance.activity element. Coded concepts are from PROV-DM and the display names
           are their counterparts in PROV-N (human readable notation syntax specification).[code
           system OID: http://www.w3.org/TR/2013/REC-prov-dm-20130430/ and http://www.w3.org/TR/2013/REC-prov-n
          -20130430/]</p> 

      </div> 
      <p> This code system http://hl7.org/fhir/w3c-provenance-activity-type defines the following
         codes:</p> 
      <table class="codes">
        <tr> 
          <td style="white-space:nowrap">
            <b> Code</b> 
          </td> 
          <td> 
            <b> Display</b> 
          </td> 
          <td> 
            <b> Definition</b> 
          </td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">Generation
            <a name="w3c-provenance-activity-type-Generation"> </a> 
          </td> 
          <td> wasGeneratedBy</td> 
          <td> 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.</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">Usage
            <a name="w3c-provenance-activity-type-Usage"> </a> 
          </td> 
          <td> used</td> 
          <td> 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.</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">Communication
            <a name="w3c-provenance-activity-type-Communication"> </a> 
          </td> 
          <td> wasInformedBy</td> 
          <td> 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.</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">Start
            <a name="w3c-provenance-activity-type-Start"> </a> 
          </td> 
          <td> wasStartedBy</td> 
          <td> 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.</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">End
            <a name="w3c-provenance-activity-type-End"> </a> 
          </td> 
          <td> wasEndedBy</td> 
          <td> 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.</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">Invalidation
            <a name="w3c-provenance-activity-type-Invalidation"> </a> 
          </td> 
          <td> wasInvalidatedBy</td> 
          <td> 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.</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">Derivation
            <a name="w3c-provenance-activity-type-Derivation"> </a> 
          </td> 
          <td> wasDerivedFrom</td> 
          <td> 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.</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">Revision
            <a name="w3c-provenance-activity-type-Revision"> </a> 
          </td> 
          <td> wasRevisionOf</td> 
          <td> 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.</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">Quotation
            <a name="w3c-provenance-activity-type-Quotation"> </a> 
          </td> 
          <td> wasQuotedFrom</td> 
          <td> 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.</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">Primary-Source
            <a name="w3c-provenance-activity-type-Primary-Source"> </a> 
          </td> 
          <td> wasPrimarySourceOf</td> 
          <td> 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.</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">Attribution
            <a name="w3c-provenance-activity-type-Attribution"> </a> 
          </td> 
          <td> wasAttributedTo</td> 
          <td> Ascribing of an entity (object/document) to an agent.</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">Collection
            <a name="w3c-provenance-activity-type-Collection"> </a> 
          </td> 
          <td> isCollectionOf</td> 
          <td>  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.</td> 
        </tr> 
      </table> 
    </div> 
  </text> 
  <url value="http://hl7.org/fhir/w3c-provenance-activity-type"/> 
  <version value="1.1.0"/> 
  <name value="W3cProvenanceActivityType"/> 
  <status value="draft"/> 
  <experimental value="true"/> 
  <date value="2017-02-19"/> 
  <publisher value="HL7 International"/> 
  <contact> 
    <name value="FHIR project team"/> 
    <telecom> 
      <system value="url"/> 
      <value value="http://hl7.org/fhir"/> 
    </telecom> 
  </contact> 
  <description value="This value set includes W3C PROV Data Model Activity concepts, which are treated as codes
   in this valueset.  Some adaptations were made to make these concepts suitable values for
   the Provenance.activity element. Coded concepts are from PROV-DM and the display names
   are their counterparts in PROV-N (human readable notation syntax specification).[code
   system OID: http://www.w3.org/TR/2013/REC-prov-dm-20130430/ and http://www.w3.org/TR/2013/REC-prov-n
  -20130430/]"/> 
  <caseSensitive value="true"/> 
  <content value="complete"/> 
  <concept> 
    <code value="Generation"/> 
    <display value="wasGeneratedBy"/> 
    <definition value="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."/> 
  </concept> 
  <concept> 
    <code value="Usage"/> 
    <display value="used"/> 
    <definition value="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."/> 
  </concept> 
  <concept> 
    <code value="Communication"/> 
    <display value="wasInformedBy"/> 
    <definition value="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."/> 
  </concept> 
  <concept> 
    <code value="Start"/> 
    <display value="wasStartedBy"/> 
    <definition value="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."/> 
  </concept> 
  <concept> 
    <code value="End"/> 
    <display value="wasEndedBy"/> 
    <definition value="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."/> 
  </concept> 
  <concept> 
    <code value="Invalidation"/> 
    <display value="wasInvalidatedBy"/> 
    <definition value="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."/> 
  </concept> 
  <concept> 
    <code value="Derivation"/> 
    <display value="wasDerivedFrom"/> 
    <definition value="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."/> 
  </concept> 
  <concept> 
    <code value="Revision"/> 
    <display value="wasRevisionOf"/> 
    <definition value="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."/> 
  </concept> 
  <concept> 
    <code value="Quotation"/> 
    <display value="wasQuotedFrom"/> 
    <definition value="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."/> 
  </concept> 
  <concept> 
    <code value="Primary-Source"/> 
    <display value="wasPrimarySourceOf"/> 
    <definition value="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."/> 
  </concept> 
  <concept> 
    <code value="Attribution"/> 
    <display value="wasAttributedTo"/> 
    <definition value="Ascribing of an entity (object/document) to an agent."/> 
  </concept> 
  <concept> 
    <code value="Collection"/> 
    <display value="isCollectionOf"/> 
    <definition value=" 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."/> 
  </concept> 
</CodeSystem>