This page is part of the FHIR Specification (v1.0.2: DSTU 2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R4 R3 R2
The possible modes of updating that occur when an attribute is received by a system that already contains values for that attribute.
<ValueSet xmlns="http://hl7.org/fhir"> <id value="v3-HL7UpdateMode"/> <meta> <lastUpdated value="2015-07-31T00:00:00.000+10:00"/> <profile value="http://hl7.org/fhir/StructureDefinition/valueset-shareable-definition"/> </meta> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml"> <p>Release Date: 2015-07-31</p> <p>OID for code system: 2.16.840.1.113883.5.57</p> <p>OID for value set: 2.16.840.1.113883.1.11.10018 (this is the value set that includes the entire code system)</p> <h2>Description</h2> <p> The possible modes of updating that occur when an attribute is received by a system that already contains values for that attribute. <br/> </p> <hr/> <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="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="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="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="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="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="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="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="U"> </a> </td> <td>Unknown</td> <td> Description:Description:</b>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 style="background: #EFEFEF"> <td>1</td> <td> <span style="color: grey"> <i>(_SetUpdateMode)</i> </span> <b> <i>Deprecated</i> </b> </td> <td> <a name="_SetUpdateMode"> </a> </td> <td> These concepts apply when the element and/or message is updating a set of items. <br/> </td> </tr> <tr style="background: #EFEFEF"> <td>2</td> <td> ESA <a name="ESA"> </a> <b> <i>Deprecated</i> </b> </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 style="background: #EFEFEF"> <td>2</td> <td> ESAC <a name="ESAC"> </a> <b> <i>Deprecated</i> </b> </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 style="background: #EFEFEF"> <td>2</td> <td> ESC <a name="ESC"> </a> <b> <i>Deprecated</i> </b> </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 style="background: #EFEFEF"> <td>2</td> <td> ESD <a name="ESD"> </a> <b> <i>Deprecated</i> </b> </td> <td>Set Delete</td> <td> Delete the item on the receiving system that corresponds to this message element. <br/> </td> </tr> <tr style="background: #EFEFEF"> <td>1</td> <td>AU <a name="AU"> </a> <b> <i>Deprecated</i> </b> </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 style="background: #EFEFEF"> <td>1</td> <td>I <a name="I"> </a> <b> <i>Deprecated</i> </b> </td> <td>Ignore</td> <td> Ignore this role, it is not relevant to the update. <br/> </td> </tr> <tr style="background: #EFEFEF"> <td>1</td> <td>V <a name="V"> </a> <b> <i>Deprecated</i> </b> </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/valueset-oid"> <valueUri value="urn:oid:2.16.840.1.113883.1.11.10018"/> </extension> <url value="http://hl7.org/fhir/ValueSet/v3-HL7UpdateMode"/> <version value="2015-07-31"/> <name value="v3 Code System HL7UpdateMode"/> <status value="active"/> <experimental value="false"/> <publisher value="HL7, Inc"/> <contact> <telecom> <system value="other"/> <value value="http://hl7.org"/> </telecom> </contact> <date value="2015-07-31"/> <description value=" The possible modes of updating that occur when an attribute is received by a system that already contains values for that attribute."/> <codeSystem> <extension url="http://hl7.org/fhir/StructureDefinition/valueset-oid"> <valueUri value="urn:oid:2.16.840.1.113883.5.57"/> </extension> <system value="http://hl7.org/fhir/v3/HL7UpdateMode"/> <caseSensitive value="true"/> <concept> <code value="A"/> <abstract value="false"/> <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"/> <abstract value="false"/> <display value="Add or Replace"/> <definition value="Description:The item was (or is to be) either added or replaced."/> </concept> <concept> <code value="D"/> <abstract value="false"/> <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"/> <abstract value="false"/> <display value="Key"/> <definition value="Description:This item is part of the identifying information for this object."/> </concept> <concept> <code value="N"/> <abstract value="false"/> <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"/> <abstract value="false"/> <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"/> <abstract value="false"/> <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"/> <abstract value="false"/> <display value="Unknown"/> <definition value="Description:Description:</b>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> <extension url="http://hl7.org/fhir/StructureDefinition/valueset-deprecated"> <valueBoolean value="true"/> </extension> <code value="_SetUpdateMode"/> <abstract value="true"/> <display value="SetUpdateMode"/> <definition value="These concepts apply when the element and/or message is updating a set of items."/> <concept> <extension url="http://hl7.org/fhir/StructureDefinition/valueset-deprecated"> <valueBoolean value="true"/> </extension> <code value="ESA"/> <abstract value="false"/> <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."/> </concept> <concept> <extension url="http://hl7.org/fhir/StructureDefinition/valueset-deprecated"> <valueBoolean value="true"/> </extension> <code value="ESAC"/> <abstract value="false"/> <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."/> </concept> <concept> <extension url="http://hl7.org/fhir/StructureDefinition/valueset-deprecated"> <valueBoolean value="true"/> </extension> <code value="ESC"/> <abstract value="false"/> <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."/> </concept> <concept> <extension url="http://hl7.org/fhir/StructureDefinition/valueset-deprecated"> <valueBoolean value="true"/> </extension> <code value="ESD"/> <abstract value="false"/> <display value="Set Delete"/> <definition value="Delete the item on the receiving system that corresponds to this message element."/> </concept> </concept> <concept> <extension url="http://hl7.org/fhir/StructureDefinition/valueset-deprecated"> <valueBoolean value="true"/> </extension> <code value="AU"/> <abstract value="false"/> <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."/> </concept> <concept> <extension url="http://hl7.org/fhir/StructureDefinition/valueset-deprecated"> <valueBoolean value="true"/> </extension> <code value="I"/> <abstract value="false"/> <display value="Ignore"/> <definition value="Ignore this role, it is not relevant to the update."/> </concept> <concept> <extension url="http://hl7.org/fhir/StructureDefinition/valueset-deprecated"> <valueBoolean value="true"/> </extension> <code value="V"/> <abstract value="false"/> <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."/> </concept> </codeSystem> </ValueSet>
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.