FHIR © HL7.org  |  FHIRsmith 4.0.1  |  Server Home  |  XIG Home  |  XIG Stats  | 

FHIR IG analytics

Packagehl7.terminology.r3
Resource TypeCodeSystem
IdCodeSystem-v3-HL7UpdateMode.json
FHIR VersionR3

Resources that use this resource

No resources found


Resources that this resource uses

No resources found


Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: CodeSystem v3-HL7UpdateMode

Language: en

Properties

This code system defines the following properties for its concepts

NameCodeURITypeDescription
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:

LvlCodeDisplayDefinitionStatusNot 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.)active
1AR Add or Replace**Description:**The item was (or is to be) either added or replaced.active
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.active
1K Key**Description:**This item is part of the identifying information for this object.active
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.active
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.)active
1REF Reference**Description:**This item provides enough information to allow a processing system to locate the full applicable record by identifying the object.active
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.active
1_SetUpdateMode SetUpdateModeThese concepts apply when the element and/or message is updating a set of items.retiredtrue
2  ESA Set AddAdd the message element to the collection of items on the receiving system that correspond to the message element.retired
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.retired
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.retired
2  ESD Set DeleteDelete the item on the receiving system that corresponds to this message element.retired
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.retired
1I IgnoreIgnore this role, it is not relevant to the update.retired
1V VerifyVerify - this message element must match a value already in the receiving systems database in order to process the message.retired

Source1

{
  "resourceType": "CodeSystem",
  "id": "v3-HL7UpdateMode",
  "language": "en",
  "text": {
    "status": "generated",
    "div": "<!-- snip (see above) -->"
  },
  "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": "4.0.0",
  "name": "HL7UpdateMode",
  "title": "HL7UpdateMode",
  "status": "active",
  "experimental": false,
  "date": "2019-03-20",
  "publisher": "Health Level Seven International",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://hl7.org"
        },
        {
          "system": "email",
          "value": "hq@HL7.org"
        }
      ]
    }
  ],
  "description": "The possible modes of updating that occur when an attribute is received by a system that already contains values for that attribute.",
  "copyright": "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": true,
  "hierarchyMeaning": "is-a",
  "content": "complete",
  "property": [
    {
      "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": "AR",
      "display": "Add or Replace",
      "definition": "**Description:**The item was (or is to be) either added or replaced.",
      "property": [
        {
          "code": "status",
          "valueCode": "active"
        }
      ]
    },
    {
      "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": "K",
      "display": "Key",
      "definition": "**Description:**This item is part of the identifying information for this object.",
      "property": [
        {
          "code": "status",
          "valueCode": "active"
        }
      ]
    },
    {
      "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": "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": "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": "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": "_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"
        }
      ],
      "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": "I",
      "display": "Ignore",
      "definition": "Ignore this role, it is not relevant to the update.",
      "property": [
        {
          "code": "status",
          "valueCode": "retired"
        }
      ]
    },
    {
      "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"
        }
      ]
    }
  ]
}