V3-HL7UpdateMode.cs.xml

The possible modes of updating that occur when an attribute is received by a system that already contains values for that attribute.

<?xml version="1.0" encoding="UTF-8"?>

<CodeSystem xmlns="http://hl7.org/fhir">
  <id value="v3-HL7UpdateMode"/> 
  <meta> 
    <lastUpdated value="2018-08-12T00:00:00.000+10:00"/> 
  </meta> 
  <text> 
    <status value="generated"/> 
    <div xmlns="http://www.w3.org/1999/xhtml">
      <p> Release Date: 2018-08-12</p> 

      <table class="grid">
 
        <tr> 
          <td> 
            <b> Level</b> 
          </td> 
          <td> 
            <b> Code</b> 
          </td> 
          <td> 
            <b> Display</b> 
          </td> 
          <td> 
            <b> Definition</b> 
          </td> 
        </tr> 
 
        <tr> 
          <td> 1</td> 
          <td> A
            <a name="v3-HL7UpdateMode-A"> </a> 
          </td> 
          <td> Add</td> 
          <td> 
                        
                           Description:The item was (or is to be) added, having not been
               present immediately before. (If it is already present, this may be treated as an error
               condition.)
            <br/>  

                     
          </td> 
        </tr> 
 
        <tr> 
          <td> 1</td> 
          <td> AR
            <a name="v3-HL7UpdateMode-AR"> </a> 
          </td> 
          <td> Add or Replace</td> 
          <td> 
                        
                           Description:The item was (or is to be) either added or replaced.
               
            <br/>  

                     
          </td> 
        </tr> 
 
        <tr> 
          <td> 1</td> 
          <td> D
            <a name="v3-HL7UpdateMode-D"> </a> 
          </td> 
          <td> Remove</td> 
          <td> 
                        
                           Description:The item was (or is to be) removed (sometimes referred
               to as deleted). If the item is part of a collection, delete any matching items.
            <br/>  

                     
          </td> 
        </tr> 
 
        <tr> 
          <td> 1</td> 
          <td> K
            <a name="v3-HL7UpdateMode-K"> </a> 
          </td> 
          <td> Key</td> 
          <td> 
                        
                           Description:This item is part of the identifying information
               for this object.
            <br/>  

                     
          </td> 
        </tr> 
 
        <tr> 
          <td> 1</td> 
          <td> N
            <a name="v3-HL7UpdateMode-N"> </a> 
          </td> 
          <td> No Change</td> 
          <td> 
                        
                           Description:There was (or is to be) no change to the item.
               This is primarily used when this element has not changed, but other attributes in the
               instance have changed. 
            <br/>  

                     
          </td> 
        </tr> 
 
        <tr> 
          <td> 1</td> 
          <td> R
            <a name="v3-HL7UpdateMode-R"> </a> 
          </td> 
          <td> Replace</td> 
          <td> 
                        
                           Description:The item existed previously and has (or is to be)
               revised. (If an item does not already exist, this may be treated as an error condition.)
            <br/>  

                     
          </td> 
        </tr> 
 
        <tr> 
          <td> 1</td> 
          <td> REF
            <a name="v3-HL7UpdateMode-REF"> </a> 
          </td> 
          <td> Reference</td> 
          <td> 
                        
                           Description:This item provides enough information to allow
               a processing system to locate the full applicable record by identifying the object.
            <br/>  

                     
          </td> 
        </tr> 
 
        <tr> 
          <td> 1</td> 
          <td> U
            <a name="v3-HL7UpdateMode-U"> </a> 
          </td> 
          <td> Unknown</td> 
          <td> 
                        
                           Description:Description:&lt;/b&gt;It is not specified whether
               or what kind of change has occurred to the item, or whether the item is present as a reference
               or identifying property. 
            <br/>  

                     
          </td> 
        </tr> 
 
        <tr> 
          <td> 1</td> 
          <td> 
            <span style="color: grey">
              <i> (_SetUpdateMode)</i> 
            </span>  
            <b> 
              <i> Abstract</i> 
            </b> 
          </td> 
          <td> 
            <a name="v3-HL7UpdateMode-_SetUpdateMode"> </a> 
          </td> 
          <td> 
                        These concepts apply when the element and/or message is updating
               a set of items.
            <br/>  

                     
          </td> 
        </tr> 
 
        <tr> 
          <td> 2</td> 
          <td>   ESA
            <a name="v3-HL7UpdateMode-ESA"> </a> 
          </td> 
          <td> Set Add</td> 
          <td> 
                        Add the message element to the collection of items on the receiving
               system that correspond to the message element.
            <br/>  

                     
          </td> 
        </tr> 
 
        <tr> 
          <td> 2</td> 
          <td>   ESAC
            <a name="v3-HL7UpdateMode-ESAC"> </a> 
          </td> 
          <td> Set Add or Change</td> 
          <td> 
                        Change the item on the receiving system that corresponds to this
               message element; if a matching element does not exist, add a new one created with the
               values in the message.
            <br/>  

                     
          </td> 
        </tr> 
 
        <tr> 
          <td> 2</td> 
          <td>   ESC
            <a name="v3-HL7UpdateMode-ESC"> </a> 
          </td> 
          <td> Set Change</td> 
          <td> 
                        Change the item on the receiving system that corresponds to this
               message element; do not process if a matching element does not exist.
            <br/>  

                     
          </td> 
        </tr> 
 
        <tr> 
          <td> 2</td> 
          <td>   ESD
            <a name="v3-HL7UpdateMode-ESD"> </a> 
          </td> 
          <td> Set Delete</td> 
          <td> 
                        Delete the item on the receiving system that corresponds to this
               message element.
            <br/>  

                     
          </td> 
        </tr> 
 
        <tr> 
          <td> 1</td> 
          <td> AU
            <a name="v3-HL7UpdateMode-AU"> </a> 
          </td> 
          <td> Add or Update</td> 
          <td> 
                        
                           Description: AU: If this item exists, update it with these
               values. If it does not exist, create it with these values. If the item is part of the
               collection, update each item that matches this item, and if no items match, add a new
               item to the collection.
            <br/>  

                     
          </td> 
        </tr> 
 
        <tr> 
          <td> 1</td> 
          <td> I
            <a name="v3-HL7UpdateMode-I"> </a> 
          </td> 
          <td> Ignore</td> 
          <td> 
                        Ignore this role, it is not relevant to the update.
            <br/>  

                     
          </td> 
        </tr> 
 
        <tr> 
          <td> 1</td> 
          <td> V
            <a name="v3-HL7UpdateMode-V"> </a> 
          </td> 
          <td> Verify</td> 
          <td> 
                        Verify - this message element must match a value already in the
               receiving systems database in order to process the message.
            <br/>  

                     
          </td> 
        </tr> 

      </table> 

    </div> 
  </text> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
    <valueCode value="external"/> 
  </extension> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
    <valueInteger value="0"/> 
  </extension> 
  <url value="http://terminology.hl7.org/CodeSystem/v3-HL7UpdateMode"/> 
  <identifier> 
    <system value="urn:ietf:rfc:3986"/> 
    <value value="urn:oid:2.16.840.1.113883.5.57"/> 
  </identifier> 
  <version value="2018-08-12"/> 
  <name value="v3.HL7UpdateMode"/> 
  <title value="v3 Code System HL7UpdateMode"/> 
  <status value="active"/> 
  <experimental value="false"/> 
  <date value="2018-08-12T00:00:00+10:00"/> 
  <publisher value="HL7, Inc"/> 
  <contact> 
    <telecom> 
      <system value="url"/> 
      <value value="http://hl7.org"/> 
    </telecom> 
  </contact> 
  <description value=" The possible modes of updating that occur when an attribute is received by a system that
     already contains values for that attribute."/> 
  <caseSensitive value="true"/> 
  <valueSet value="http://terminology.hl7.org/ValueSet/v3-HL7UpdateMode"/> 
  <hierarchyMeaning value="is-a"/> 
  <content value="complete"/> 
  <property> 
    <code value="notSelectable"/> 
    <uri value="http://hl7.org/fhir/concept-properties#notSelectable"/> 
    <description value="Indicates that the code is abstract - only intended to be used as a selector for other
       concepts"/> 
    <type value="boolean"/> 
  </property> 
  <property> 
    <code value="status"/> 
    <uri value="http://hl7.org/fhir/concept-properties#status"/> 
    <description value="A property that indicates the status of the concept. One of active, experimental, deprecated,
       retired"/> 
    <type value="code"/> 
  </property> 
  <concept> 
    <code value="A"/> 
    <display value="Add"/> 
    <definition value="Description:The item was (or is to be) added, having not been present immediately before.
       (If it is already present, this may be treated as an error condition.)"/> 
  </concept> 
  <concept> 
    <code value="AR"/> 
    <display value="Add or Replace"/> 
    <definition value="Description:The item was (or is to be) either added or replaced."/> 
  </concept> 
  <concept> 
    <code value="D"/> 
    <display value="Remove"/> 
    <definition value="Description:The item was (or is to be) removed (sometimes referred to as deleted). If
       the item is part of a collection, delete any matching items."/> 
  </concept> 
  <concept> 
    <code value="K"/> 
    <display value="Key"/> 
    <definition value="Description:This item is part of the identifying information for this object."/> 
  </concept> 
  <concept> 
    <code value="N"/> 
    <display value="No Change"/> 
    <definition value="Description:There was (or is to be) no change to the item. This is primarily used when
       this element has not changed, but other attributes in the instance have changed."/> 
  </concept> 
  <concept> 
    <code value="R"/> 
    <display value="Replace"/> 
    <definition value="Description:The item existed previously and has (or is to be) revised. (If an item does
       not already exist, this may be treated as an error condition.)"/> 
  </concept> 
  <concept> 
    <code value="REF"/> 
    <display value="Reference"/> 
    <definition value="Description:This item provides enough information to allow a processing system to locate
       the full applicable record by identifying the object."/> 
  </concept> 
  <concept> 
    <code value="U"/> 
    <display value="Unknown"/> 
    <definition value="Description:Description:&lt;/b&gt;It is not specified whether or what kind of change has
       occurred to the item, or whether the item is present as a reference or identifying property."/> 
  </concept> 
  <concept> 
    <code value="_SetUpdateMode"/> 
    <display value="SetUpdateMode"/> 
    <definition value="These concepts apply when the element and/or message is updating a set of items."/> 
    <property> 
      <code value="notSelectable"/> 
      <valueBoolean value="true"/> 
    </property> 
    <property> 
      <code value="status"/> 
      <valueCode value="retired"/> 
    </property> 
    <concept> 
      <code value="ESA"/> 
      <display value="Set Add"/> 
      <definition value="Add the message element to the collection of items on the receiving system that correspond
         to the message element."/> 
      <property> 
        <code value="status"/> 
        <valueCode value="retired"/> 
      </property> 
    </concept> 
    <concept> 
      <code value="ESAC"/> 
      <display value="Set Add or Change"/> 
      <definition value="Change the item on the receiving system that corresponds to this message element; if a
         matching element does not exist, add a new one created with the values in the message."/> 
      <property> 
        <code value="status"/> 
        <valueCode value="retired"/> 
      </property> 
    </concept> 
    <concept> 
      <code value="ESC"/> 
      <display value="Set Change"/> 
      <definition value="Change the item on the receiving system that corresponds to this message element; do not
         process if a matching element does not exist."/> 
      <property> 
        <code value="status"/> 
        <valueCode value="retired"/> 
      </property> 
    </concept> 
    <concept> 
      <code value="ESD"/> 
      <display value="Set Delete"/> 
      <definition value="Delete the item on the receiving system that corresponds to this message element."/> 
      <property> 
        <code value="status"/> 
        <valueCode value="retired"/> 
      </property> 
    </concept> 
  </concept> 
  <concept> 
    <code value="AU"/> 
    <display value="Add or Update"/> 
    <definition value="Description: AU: If this item exists, update it with these values. If it does not exist,
       create it with these values. If the item is part of the collection, update each item that
       matches this item, and if no items match, add a new item to the collection."/> 
    <property> 
      <code value="status"/> 
      <valueCode value="retired"/> 
    </property> 
  </concept> 
  <concept> 
    <code value="I"/> 
    <display value="Ignore"/> 
    <definition value="Ignore this role, it is not relevant to the update."/> 
    <property> 
      <code value="status"/> 
      <valueCode value="retired"/> 
    </property> 
  </concept> 
  <concept> 
    <code value="V"/> 
    <display value="Verify"/> 
    <definition value="Verify - this message element must match a value already in the receiving systems database
       in order to process the message."/> 
    <property> 
      <code value="status"/> 
      <valueCode value="retired"/> 
    </property> 
  </concept> 
</CodeSystem>