HL7 Terminology
1.0.0 - Publication

This page is part of the HL7 Terminology (v1.0.0: Release) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions

HL7UpdateMode - JSON Representation

(back to description)

Raw json

Source view

{
  "resourceType" : "CodeSystem",
  "id" : "v3-HL7UpdateMode",
  "language" : "en",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\" xml:lang=\"en\" lang=\"en\"><h2>HL7UpdateMode</h2><div><p>The possible modes of updating that occur when an attribute is received by a system that already contains values for that attribute.</p>\n</div><p><b>Properties</b></p><table class=\"grid\"><tr><td><b>Code</b></td><td><b>URL</b></td><td><b>Description</b></td><td><b>Type</b></td></tr><tr><td>Specializes</td><td/><td>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.</td><td>Coding</td></tr><tr><td>Generalizes</td><td/><td>Inverse of Specializes.  Only included as a derived relationship.</td><td>Coding</td></tr><tr><td>internalId</td><td>http://terminology.hl7.org/CodeSystem/utg-concept-properties#v3-internal-id</td><td>The internal identifier for the concept in the HL7 Access database repository.</td><td>code</td></tr><tr><td>status</td><td>http://hl7.org/fhir/concept-properties#status</td><td>Designation of a concept's state.  Normally is not populated unless the state is retired..</td><td>code</td></tr><tr><td>notSelectable</td><td>http://hl7.org/fhir/concept-properties#notSelectable</td><td>Indicates that the code is abstract - only intended to be used as a selector for other concepts</td><td>boolean</td></tr></table><p>This code system http://terminology.hl7.org/CodeSystem/v3-HL7UpdateMode defines the following codes:</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>internalId</b></td><td><b>status</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>22624</td><td>active</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>22654</td><td>active</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>10020</td><td>active</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>10022</td><td>active</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>22655</td><td>active</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>10019</td><td>active</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>22623</td><td>active</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>22622</td><td>active</td><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>21082</td><td>retired</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>10025</td><td>retired</td><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>10028</td><td>retired</td><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>10027</td><td>retired</td><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>10026</td><td>retired</td><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>22621</td><td>retired</td><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>10021</td><td>retired</td><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>10023</td><td>retired</td><td/></tr></table></div>"
  },
  "url" : "http://terminology.hl7.org/CodeSystem/v3-HL7UpdateMode",
  "identifier" : [
    {
      "system" : "urn:ietf:rfc:3986",
      "value" : "urn:oid:2.16.840.1.113883.5.57"
    }
  ],
  "version" : "2.0.0",
  "name" : "HL7UpdateMode",
  "title" : "HL7UpdateMode",
  "status" : "active",
  "date" : "2019-03-20T00:00:00-04:00",
  "publisher" : "Health Level 7",
  "contact" : [
    {
      "name" : "Health Level Seven"
    }
  ],
  "description" : "The possible modes of updating that occur when an attribute is received by a system that already contains values for that attribute.",
  "hierarchyMeaning" : "is-a",
  "content" : "complete",
  "property" : [
    {
      "extension" : [
        {
          "url" : "http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-symmetry",
          "valueCode" : "antisymmetric"
        },
        {
          "url" : "http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-transitivity",
          "valueCode" : "transitive"
        },
        {
          "url" : "http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-reflexivity",
          "valueCode" : "irreflexive"
        },
        {
          "url" : "http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-isNavigable",
          "valueBoolean" : true
        },
        {
          "url" : "http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-relationshipKind",
          "valueCode" : "Specializes"
        },
        {
          "url" : "http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-inverseName",
          "valueString" : "Generalizes"
        }
      ],
      "code" : "Specializes",
      "description" : "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" : "Coding"
    },
    {
      "extension" : [
        {
          "url" : "http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-symmetry",
          "valueCode" : "antisymmetric"
        },
        {
          "url" : "http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-transitivity",
          "valueCode" : "transitive"
        },
        {
          "url" : "http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-reflexivity",
          "valueCode" : "irreflexive"
        },
        {
          "url" : "http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-isNavigable",
          "valueBoolean" : true
        },
        {
          "url" : "http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-relationshipKind",
          "valueCode" : "Generalizes"
        },
        {
          "url" : "http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-inverseName",
          "valueString" : "Specializes"
        }
      ],
      "code" : "Generalizes",
      "description" : "Inverse of Specializes.  Only included as a derived relationship.",
      "type" : "Coding"
    },
    {
      "code" : "internalId",
      "uri" : "http://terminology.hl7.org/CodeSystem/utg-concept-properties#v3-internal-id",
      "description" : "The internal identifier for the concept in the HL7 Access database repository.",
      "type" : "code"
    },
    {
      "code" : "status",
      "uri" : "http://hl7.org/fhir/concept-properties#status",
      "description" : "Designation of a concept's state.  Normally is not populated unless the state is retired..",
      "type" : "code"
    },
    {
      "code" : "notSelectable",
      "uri" : "http://hl7.org/fhir/concept-properties#notSelectable",
      "description" : "Indicates that the code is abstract - only intended to be used as a selector for other concepts",
      "type" : "boolean"
    }
  ],
  "concept" : [
    {
      "code" : "A",
      "display" : "Add",
      "definition" : "**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" : "status",
          "valueCode" : "active"
        },
        {
          "code" : "internalId",
          "valueCode" : "22624"
        }
      ]
    },
    {
      "code" : "AR",
      "display" : "Add or Replace",
      "definition" : "**Description:**The item was (or is to be) either added or replaced.",
      "property" : [
        {
          "code" : "status",
          "valueCode" : "active"
        },
        {
          "code" : "internalId",
          "valueCode" : "22654"
        }
      ]
    },
    {
      "code" : "D",
      "display" : "Remove",
      "definition" : "**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" : "status",
          "valueCode" : "active"
        },
        {
          "code" : "internalId",
          "valueCode" : "10020"
        }
      ]
    },
    {
      "code" : "K",
      "display" : "Key",
      "definition" : "**Description:**This item is part of the identifying information for this object.",
      "property" : [
        {
          "code" : "status",
          "valueCode" : "active"
        },
        {
          "code" : "internalId",
          "valueCode" : "10022"
        }
      ]
    },
    {
      "code" : "N",
      "display" : "No Change",
      "definition" : "**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" : "status",
          "valueCode" : "active"
        },
        {
          "code" : "internalId",
          "valueCode" : "22655"
        }
      ]
    },
    {
      "code" : "R",
      "display" : "Replace",
      "definition" : "**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" : "status",
          "valueCode" : "active"
        },
        {
          "code" : "internalId",
          "valueCode" : "10019"
        }
      ]
    },
    {
      "code" : "REF",
      "display" : "Reference",
      "definition" : "**Description:**This item provides enough information to allow a processing system to locate the full applicable record by identifying the object.",
      "property" : [
        {
          "code" : "status",
          "valueCode" : "active"
        },
        {
          "code" : "internalId",
          "valueCode" : "22623"
        }
      ]
    },
    {
      "code" : "U",
      "display" : "Unknown",
      "definition" : "**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" : "status",
          "valueCode" : "active"
        },
        {
          "code" : "internalId",
          "valueCode" : "22622"
        }
      ]
    },
    {
      "code" : "_SetUpdateMode",
      "display" : "SetUpdateMode",
      "definition" : "These concepts apply when the element and/or message is updating a set of items.",
      "property" : [
        {
          "code" : "notSelectable",
          "valueBoolean" : true
        },
        {
          "code" : "status",
          "valueCode" : "retired"
        },
        {
          "code" : "internalId",
          "valueCode" : "21082"
        }
      ],
      "concept" : [
        {
          "code" : "ESA",
          "display" : "Set Add",
          "definition" : "Add the message element to the collection of items on the receiving system that correspond to the message element.",
          "property" : [
            {
              "code" : "status",
              "valueCode" : "retired"
            },
            {
              "code" : "internalId",
              "valueCode" : "10025"
            }
          ]
        },
        {
          "code" : "ESAC",
          "display" : "Set Add or Change",
          "definition" : "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" : "status",
              "valueCode" : "retired"
            },
            {
              "code" : "internalId",
              "valueCode" : "10028"
            }
          ]
        },
        {
          "code" : "ESC",
          "display" : "Set Change",
          "definition" : "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" : "status",
              "valueCode" : "retired"
            },
            {
              "code" : "internalId",
              "valueCode" : "10027"
            }
          ]
        },
        {
          "code" : "ESD",
          "display" : "Set Delete",
          "definition" : "Delete the item on the receiving system that corresponds to this message element.",
          "property" : [
            {
              "code" : "status",
              "valueCode" : "retired"
            },
            {
              "code" : "internalId",
              "valueCode" : "10026"
            }
          ]
        }
      ]
    },
    {
      "code" : "AU",
      "display" : "Add or Update",
      "definition" : "**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" : "status",
          "valueCode" : "retired"
        },
        {
          "code" : "internalId",
          "valueCode" : "22621"
        }
      ]
    },
    {
      "code" : "I",
      "display" : "Ignore",
      "definition" : "Ignore this role, it is not relevant to the update.",
      "property" : [
        {
          "code" : "status",
          "valueCode" : "retired"
        },
        {
          "code" : "internalId",
          "valueCode" : "10021"
        }
      ]
    },
    {
      "code" : "V",
      "display" : "Verify",
      "definition" : "Verify - this message element must match a value already in the receiving systems database in order to process the message.",
      "property" : [
        {
          "code" : "status",
          "valueCode" : "retired"
        },
        {
          "code" : "internalId",
          "valueCode" : "10023"
        }
      ]
    }
  ]
}