Extensions for Using Data Elements from FHIR STU3 in FHIR R5
0.1.0 - STU International flag

Extensions for Using Data Elements from FHIR STU3 in FHIR R5 - Downloaded Version null See the Directory of published versions

: v3 Code System HL7UpdateMode - XML Representation

Page standards status: Trial-use Maturity Level: 0

Raw xml | Download


<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><td><b>Description</b></td></tr><tr><td>Not Selectable</td><td>notSelectable</td><td>http://hl7.org/fhir/concept-properties#notSelectable</td><td>boolean</td><td>Indicates that the code is abstract - only intended to be used as a selector for other concepts</td></tr><tr><td>Inactive</td><td>inactive</td><td>http://hl7.org/fhir/concept-properties#inactive</td><td>boolean</td><td>True if the concept is not considered active - e.g. not a valid concept any more</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 a Is-A 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><td><b>Inactive</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/><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/><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/><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/><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/><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/><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/><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:&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.</td><td/><td/></tr><tr style="background-color: #ffeeee"><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><td>true</td></tr><tr style="background-color: #ffeeee"><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/><td>true</td></tr><tr style="background-color: #ffeeee"><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/><td>true</td></tr><tr style="background-color: #ffeeee"><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/><td>true</td></tr><tr style="background-color: #ffeeee"><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/><td>true</td></tr><tr style="background-color: #ffeeee"><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/><td>true</td></tr><tr style="background-color: #ffeeee"><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/><td>true</td></tr><tr style="background-color: #ffeeee"><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/><td>true</td></tr></table></div>
  </text>
  <extension
             url="http://hl7.org/fhir/StructureDefinition/structuredefinition-ballot-status">
    <valueString value="External"/>
  </extension>
  <extension
             url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
    <valueInteger value="0"/>
  </extension>
  <extension url="http://hl7.org/fhir/StructureDefinition/package-source">
    <extension url="packageId">
      <valueId value="hl7.fhir.uv.xver-r3.r5"/>
    </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-r3.r5"/>
    </extension>
  </extension>
  <extension
             url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
    <valueCode value="fhir"/>
  </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-r3.r5"/>
      </extension>
    </valueCode>
  </extension>
  <url value="http://hl7.org/fhir/v3/HL7UpdateMode"/>
  <version value="2016-11-11"/>
  <name value="v3 Code System HL7UpdateMode"/>
  <status value="active"/>
  <experimental value="false"/>
  <date value="2016-11-10T07:00:00-06: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>
  <description
               value="The possible modes of updating that occur when an attribute is received by a system that already contains values for that attribute."/>
  <jurisdiction>
    <coding>
      <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/>
      <code value="001"/>
      <display value="World"/>
    </coding>
  </jurisdiction>
  <caseSensitive value="true"/>
  <valueSet value="http://hl7.org/fhir/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="inactive"/>
    <uri value="http://hl7.org/fhir/concept-properties#inactive"/>
    <description
                 value="True if the concept is not considered active - e.g. not a valid concept any more"/>
    <type value="boolean"/>
  </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="inactive"/>
      <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="inactive"/>
        <valueBoolean value="true"/>
      </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="inactive"/>
        <valueBoolean value="true"/>
      </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="inactive"/>
        <valueBoolean value="true"/>
      </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="inactive"/>
        <valueBoolean value="true"/>
      </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="inactive"/>
      <valueBoolean value="true"/>
    </property>
  </concept>
  <concept>
    <code value="I"/>
    <display value="Ignore"/>
    <definition value="Ignore this role, it is not relevant to the update."/>
    <property>
      <code value="inactive"/>
      <valueBoolean value="true"/>
    </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="inactive"/>
      <valueBoolean value="true"/>
    </property>
  </concept>
</CodeSystem>