Extensions for Using Data Elements from FHIR DSTU2 in FHIR R4B - Downloaded Version null See the Directory of published versions
| Page standards status: Trial-use | Maturity Level: 0 |
<CodeSystem xmlns="http://hl7.org/fhir">
<id value="v3-HL7UpdateMode"/>
<text>
<status value="generated"/>
<div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: CodeSystem v3-HL7UpdateMode</b></p><a name="v3-HL7UpdateMode"> </a><a name="hcv3-HL7UpdateMode"> </a><p><b>Properties</b></p><p><b>This code system defines the following properties for its concepts</b></p><table class="grid"><tr><td><b>Name</b></td><td><b>Code</b></td><td><b>URI</b></td><td><b>Type</b></td></tr><tr><td>status</td><td>status</td><td>http://hl7.org/fhir/concept-properties#status</td><td>code</td></tr><tr><td>Inactive</td><td>inactive</td><td>http://hl7.org/fhir/concept-properties#inactive</td><td>boolean</td></tr><tr><td>effectiveDate</td><td>effectiveDate</td><td>http://hl7.org/fhir/concept-properties#effectiveDate</td><td>dateTime</td></tr><tr><td>deprecationDate</td><td>deprecationDate</td><td>http://hl7.org/fhir/concept-properties#deprecationDate</td><td>dateTime</td></tr><tr><td>retirementDate</td><td>retirementDate</td><td>http://hl7.org/fhir/concept-properties#retirementDate</td><td>dateTime</td></tr><tr><td>Not Selectable</td><td>notSelectable</td><td>http://hl7.org/fhir/concept-properties#notSelectable</td><td>boolean</td></tr><tr><td>Parent</td><td>parent</td><td>http://hl7.org/fhir/concept-properties#parent</td><td>code</td></tr><tr><td>Child</td><td>child</td><td>http://hl7.org/fhir/concept-properties#child</td><td>code</td></tr><tr><td>partOf</td><td>partOf</td><td>http://hl7.org/fhir/concept-properties#partOf</td><td>code</td></tr><tr><td>synonym</td><td>synonym</td><td>http://hl7.org/fhir/concept-properties#synonym</td><td>code</td></tr><tr><td>comment</td><td>comment</td><td>http://hl7.org/fhir/concept-properties#comment</td><td>string</td></tr><tr><td>itemWeight</td><td>itemWeight</td><td>http://hl7.org/fhir/concept-properties#itemWeight</td><td>decimal</td></tr></table><p><b>Concepts</b></p><p>This case-sensitive code system <code>http://hl7.org/fhir/v3/HL7UpdateMode</code> defines the following codes in an undefined hierarchy:</p><table class="codes"><tr><td><b>Lvl</b></td><td style="white-space:nowrap"><b>Code</b></td><td><b>Display</b></td><td><b>Definition</b></td><td><b>Not Selectable</b></td></tr><tr><td>1</td><td style="white-space:nowrap">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.)</td><td>false</td></tr><tr><td>1</td><td style="white-space:nowrap">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.</td><td>false</td></tr><tr><td>1</td><td style="white-space:nowrap">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.</td><td>false</td></tr><tr><td>1</td><td style="white-space:nowrap">K<a name="v3-HL7UpdateMode-K"> </a></td><td>Key</td><td>Description:This item is part of the identifying information for this object.</td><td>false</td></tr><tr><td>1</td><td style="white-space:nowrap">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.</td><td>false</td></tr><tr><td>1</td><td style="white-space:nowrap">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.)</td><td>false</td></tr><tr><td>1</td><td style="white-space:nowrap">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.</td><td>false</td></tr><tr><td>1</td><td style="white-space:nowrap">U<a name="v3-HL7UpdateMode-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.</td><td>false</td></tr><tr><td>1</td><td style="white-space:nowrap">_SetUpdateMode<a name="v3-HL7UpdateMode-_SetUpdateMode"> </a></td><td>SetUpdateMode</td><td>These concepts apply when the element and/or message is updating a set of items.</td><td>true</td></tr><tr><td>2</td><td style="white-space:nowrap"> 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.</td><td>false</td></tr><tr><td>2</td><td style="white-space:nowrap"> 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.</td><td>false</td></tr><tr><td>2</td><td style="white-space:nowrap"> 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.</td><td>false</td></tr><tr><td>2</td><td style="white-space:nowrap"> 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.</td><td>false</td></tr><tr><td>1</td><td style="white-space:nowrap">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.</td><td>false</td></tr><tr><td>1</td><td style="white-space:nowrap">I<a name="v3-HL7UpdateMode-I"> </a></td><td>Ignore</td><td>Ignore this role, it is not relevant to the update.</td><td>false</td></tr><tr><td>1</td><td style="white-space:nowrap">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.</td><td>false</td></tr></table></div>
</text>
<extension url="http://hl7.org/fhir/StructureDefinition/valueset-oid">
<valueUri value="urn:oid:2.16.840.1.113883.5.57"/>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/package-source">
<extension url="packageId">
<valueId value="hl7.fhir.uv.xver-r2.r4b"/>
</extension>
<extension url="version">
<valueString value="0.1.0"/>
</extension>
<extension url="uri">
<valueUri
value="http://hl7.org/fhir/uv/xver/ImplementationGuide/hl7.fhir.uv.xver-r2.r4b"/>
</extension>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
<valueCode value="fhir"/>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
<valueInteger value="0">
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom">
<valueCanonical
value="http://hl7.org/fhir/uv/xver/ImplementationGuide/hl7.fhir.uv.xver-r2.r4b"/>
</extension>
</valueInteger>
</extension>
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
<valueCode value="trial-use">
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom">
<valueCanonical
value="http://hl7.org/fhir/uv/xver/ImplementationGuide/hl7.fhir.uv.xver-r2.r4b"/>
</extension>
</valueCode>
</extension>
<url value="http://hl7.org/fhir/v3/HL7UpdateMode"/>
<version value="1.0.2"/>
<name value="v3-HL7UpdateMode"/>
<status value="draft"/>
<date value="2026-03-20T11:13:27+11:00"/>
<publisher value="FHIR Infrastructure"/>
<contact>
<name value="FHIR Infrastructure"/>
<telecom>
<system value="url"/>
<value value="http://www.hl7.org/Special/committees/fiwg"/>
</telecom>
</contact>
<jurisdiction>
<coding>
<system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/>
<code value="001"/>
<display value="World"/>
</coding>
</jurisdiction>
<caseSensitive value="true"/>
<content value="complete"/>
<property>
<code value="status"/>
<uri value="http://hl7.org/fhir/concept-properties#status"/>
<type value="code"/>
</property>
<property>
<code value="inactive"/>
<uri value="http://hl7.org/fhir/concept-properties#inactive"/>
<type value="boolean"/>
</property>
<property>
<code value="effectiveDate"/>
<uri value="http://hl7.org/fhir/concept-properties#effectiveDate"/>
<type value="dateTime"/>
</property>
<property>
<code value="deprecationDate"/>
<uri value="http://hl7.org/fhir/concept-properties#deprecationDate"/>
<type value="dateTime"/>
</property>
<property>
<code value="retirementDate"/>
<uri value="http://hl7.org/fhir/concept-properties#retirementDate"/>
<type value="dateTime"/>
</property>
<property>
<code value="notSelectable"/>
<uri value="http://hl7.org/fhir/concept-properties#notSelectable"/>
<type value="boolean"/>
</property>
<property>
<code value="parent"/>
<uri value="http://hl7.org/fhir/concept-properties#parent"/>
<type value="code"/>
</property>
<property>
<code value="child"/>
<uri value="http://hl7.org/fhir/concept-properties#child"/>
<type value="code"/>
</property>
<property>
<code value="partOf"/>
<uri value="http://hl7.org/fhir/concept-properties#partOf"/>
<type value="code"/>
</property>
<property>
<code value="synonym"/>
<uri value="http://hl7.org/fhir/concept-properties#synonym"/>
<type value="code"/>
</property>
<property>
<code value="comment"/>
<uri value="http://hl7.org/fhir/concept-properties#comment"/>
<type value="string"/>
</property>
<property>
<code value="itemWeight"/>
<uri value="http://hl7.org/fhir/concept-properties#itemWeight"/>
<type value="decimal"/>
</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.)"/>
<property>
<code value="notSelectable"/>
<valueBoolean value="false"/>
</property>
</concept>
<concept>
<code value="AR"/>
<display value="Add or Replace"/>
<definition
value="Description:The item was (or is to be) either added or replaced."/>
<property>
<code value="notSelectable"/>
<valueBoolean value="false"/>
</property>
</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."/>
<property>
<code value="notSelectable"/>
<valueBoolean value="false"/>
</property>
</concept>
<concept>
<code value="K"/>
<display value="Key"/>
<definition
value="Description:This item is part of the identifying information for this object."/>
<property>
<code value="notSelectable"/>
<valueBoolean value="false"/>
</property>
</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."/>
<property>
<code value="notSelectable"/>
<valueBoolean value="false"/>
</property>
</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.)"/>
<property>
<code value="notSelectable"/>
<valueBoolean value="false"/>
</property>
</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."/>
<property>
<code value="notSelectable"/>
<valueBoolean value="false"/>
</property>
</concept>
<concept>
<code value="U"/>
<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."/>
<property>
<code value="notSelectable"/>
<valueBoolean value="false"/>
</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>
<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="notSelectable"/>
<valueBoolean value="false"/>
</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="notSelectable"/>
<valueBoolean value="false"/>
</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="notSelectable"/>
<valueBoolean value="false"/>
</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="notSelectable"/>
<valueBoolean value="false"/>
</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="notSelectable"/>
<valueBoolean value="false"/>
</property>
</concept>
<concept>
<code value="I"/>
<display value="Ignore"/>
<definition value="Ignore this role, it is not relevant to the update."/>
<property>
<code value="notSelectable"/>
<valueBoolean value="false"/>
</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="notSelectable"/>
<valueBoolean value="false"/>
</property>
</concept>
</CodeSystem>