Generated Narrative: CodeSystem v3-HL7UpdateMode

Language: en

Properties

This code system defines the following properties for its concepts

NameCodeURITypeDescription
SpecializesSpecializesCodingThe child code is a more narrow version of the concept represented by the parent code. I.e. Every child concept is also a valid parent concept. Used to allow determination of subsumption. Must be transitive, irreflexive, antisymmetric.
GeneralizesGeneralizesCodingInverse of Specializes. Only included as a derived relationship.
internalIdinternalIdhttp://terminology.hl7.org/CodeSystem/utg-concept-properties#v3-internal-idcodeThe internal identifier for the concept in the HL7 Access database repository.
Statusstatushttp://hl7.org/fhir/concept-properties#statuscodeDesignation of a concept's state. Normally is not populated unless the state is retired..
Not SelectablenotSelectablehttp://hl7.org/fhir/concept-properties#notSelectablebooleanIndicates that the code is abstract - only intended to be used as a selector for other concepts

Concepts

This case-sensitive code system http://terminology.hl7.org/CodeSystem/v3-HL7UpdateMode defines the following codes in a Is-A hierarchy:

LvlCodeDisplayDefinitioninternalIdStatusNot Selectable
1A Add**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.)22624active
1AR Add or Replace**Description:**The item was (or is to be) either added or replaced.22654active
1D Remove**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.10020active
1K Key**Description:**This item is part of the identifying information for this object.10022active
1N No Change**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.22655active
1R Replace**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.)10019active
1REF Reference**Description:**This item provides enough information to allow a processing system to locate the full applicable record by identifying the object.22623active
1U Unknown**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.22622active
1_SetUpdateMode SetUpdateModeThese concepts apply when the element and/or message is updating a set of items.21082retiredtrue
2  ESA Set AddAdd the message element to the collection of items on the receiving system that correspond to the message element.10025retired
2  ESAC Set Add or ChangeChange 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.10028retired
2  ESC Set ChangeChange the item on the receiving system that corresponds to this message element; do not process if a matching element does not exist.10027retired
2  ESD Set DeleteDelete the item on the receiving system that corresponds to this message element.10026retired
1AU Add or Update**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.22621retired
1I IgnoreIgnore this role, it is not relevant to the update.10021retired
1V VerifyVerify - this message element must match a value already in the receiving systems database in order to process the message.10023retired
 <status value="active"/> <experimental value="false"/> <date value="2019-03-20"/> <publisher value="Health Level Seven International"/> <contact> <telecom> <system value="url"/> <value value="http://hl7.org"/> </telecom> <telecom> <system value="email"/> <value value="hq@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."/> <copyright value="This material derives from the HL7 Terminology THO. THO is copyright ©1989+ Health Level Seven International and is made available under the CC0 designation. For more licensing information see: https://terminology.hl7.org/license.html"/> <caseSensitive value="true"/> <hierarchyMeaning value="is-a"/> <content value="complete"/> <property> <extension url="http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-symmetry"> <valueCode value="antisymmetric"/> </extension> <extension url="http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-transitivity"> <valueCode value="transitive"/> </extension> <extension url="http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-reflexivity"> <valueCode value="irreflexive"/> </extension> <extension url="http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-isNavigable"> <valueBoolean value="true"/> </extension> <extension url="http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-relationshipKind"> <valueCode value="Specializes"/> </extension> <extension url="http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-inverseName"> <valueString value="Generalizes"/> </extension> <code value="Specializes"/> <description value="The child code is a more narrow version of the concept represented by the parent code. I.e. Every child concept is also a valid parent concept. Used to allow determination of subsumption. Must be transitive, irreflexive, antisymmetric."/> <type value="Coding"/> </property> <property> <extension url="http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-symmetry"> <valueCode value="antisymmetric"/> </extension> <extension url="http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-transitivity"> <valueCode value="transitive"/> </extension> <extension url="http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-reflexivity"> <valueCode value="irreflexive"/> </extension> <extension url="http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-isNavigable"> <valueBoolean value="true"/> </extension> <extension url="http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-relationshipKind"> <valueCode value="Generalizes"/> </extension> <extension url="http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-inverseName"> <valueString value="Specializes"/> </extension> <code value="Generalizes"/> <description value="Inverse of Specializes. Only included as a derived relationship."/> <type value="Coding"/> </property> <property> <code value="internalId"/> <uri value="http://terminology.hl7.org/CodeSystem/utg-concept-properties#v3-internal-id"/> <description value="The internal identifier for the concept in the HL7 Access database repository."/> <type value="code"/> </property> <property> <code value="status"/> <uri value="http://hl7.org/fhir/concept-properties#status"/> <description value="Designation of a concept's state. Normally is not populated unless the state is retired.."/> <type value="code"/> </property> <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> <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="status"/> <valueCode value="active"/> </property> <property> <code value="internalId"/> <valueCode value="22624"/> </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="status"/> <valueCode value="active"/> </property> <property> <code value="internalId"/> <valueCode value="22654"/> </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="status"/> <valueCode value="active"/> </property> <property> <code value="internalId"/> <valueCode value="10020"/> </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="status"/> <valueCode value="active"/> </property> <property> <code value="internalId"/> <valueCode value="10022"/> </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="status"/> <valueCode value="active"/> </property> <property> <code value="internalId"/> <valueCode value="22655"/> </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="status"/> <valueCode value="active"/> </property> <property> <code value="internalId"/> <valueCode value="10019"/> </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="status"/> <valueCode value="active"/> </property> <property> <code value="internalId"/> <valueCode value="22623"/> </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="status"/> <valueCode value="active"/> </property> <property> <code value="internalId"/> <valueCode value="22622"/> </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> <property> <code value="internalId"/> <valueCode value="21082"/> </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> <property> <code value="internalId"/> <valueCode value="10025"/> </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> <property> <code value="internalId"/> <valueCode value="10028"/> </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> <property> <code value="internalId"/> <valueCode value="10027"/> </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> <property> <code value="internalId"/> <valueCode value="10026"/> </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> <property> <code value="internalId"/> <valueCode value="22621"/> </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> <property> <code value="internalId"/> <valueCode value="10021"/> </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> <property> <code value="internalId"/> <valueCode value="10023"/> </property> </concept> </CodeSystem>