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

FHIR IG analytics

Packagehl7.fhir.uv.xver-r2.r4b
Resource TypeCodeSystem
IdCodeSystem-v3-HL7UpdateMode.json
FHIR VersionR4B
Sourcehttp://hl7.org/fhir/xver-r2.r4b/0.0.1-snapshot-2/CodeSystem-v3-HL7UpdateMode.html
URLhttp://hl7.org/fhir/v3/HL7UpdateMode
Version1.0.2
Statusdraft
Date2025-09-13T15:10:02-04:00
Namev3-HL7UpdateMode
Realmuv
Authorityhl7
Contentcomplete

Resources that use this resource

ValueSet
R2-v3-HL7UpdateMode-for-R4BCross-version VS for R2.v3 Code System HL7UpdateMode for use in FHIR R4B
R3-v3-HL7UpdateMode-for-R4BCross-version VS for R3.v3 Code System HL7UpdateMode for use in FHIR R4B
R2-v3-HL7UpdateMode-for-R5Cross-version VS for R2.v3 Code System HL7UpdateMode for use in FHIR R5
R3-v3-HL7UpdateMode-for-R5Cross-version VS for R3.v3 Code System HL7UpdateMode for use in FHIR R5

Resources that this resource uses

No resources found


Narrative

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

Generated Narrative: CodeSystem v3-HL7UpdateMode

Properties

This code system defines the following properties for its concepts

NameCodeURIType
statusstatushttp://hl7.org/fhir/concept-properties#statuscode
Inactiveinactivehttp://hl7.org/fhir/concept-properties#inactiveboolean
effectiveDateeffectiveDatehttp://hl7.org/fhir/concept-properties#effectiveDatedateTime
deprecationDatedeprecationDatehttp://hl7.org/fhir/concept-properties#deprecationDatedateTime
retirementDateretirementDatehttp://hl7.org/fhir/concept-properties#retirementDatedateTime
Not SelectablenotSelectablehttp://hl7.org/fhir/concept-properties#notSelectableboolean
Parentparenthttp://hl7.org/fhir/concept-properties#parentcode
Childchildhttp://hl7.org/fhir/concept-properties#childcode
partOfpartOfhttp://hl7.org/fhir/concept-properties#partOfcode
synonymsynonymhttp://hl7.org/fhir/concept-properties#synonymcode
commentcommenthttp://hl7.org/fhir/concept-properties#commentstring
itemWeightitemWeighthttp://hl7.org/fhir/concept-properties#itemWeightdecimal

Concepts

This case-sensitive code system http://hl7.org/fhir/v3/HL7UpdateMode defines the following codes in an undefined hierarchy:

LvlCodeDisplayDefinitionNot Selectable
1A AddDescription: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.)false
1AR Add or ReplaceDescription:The item was (or is to be) either added or replaced.false
1D RemoveDescription: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.false
1K KeyDescription:This item is part of the identifying information for this object.false
1N No ChangeDescription: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.false
1R ReplaceDescription: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.)false
1REF ReferenceDescription:This item provides enough information to allow a processing system to locate the full applicable record by identifying the object.false
1U UnknownDescription: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.false
1_SetUpdateMode SetUpdateModeThese concepts apply when the element and/or message is updating a set of items.true
2  ESA Set AddAdd the message element to the collection of items on the receiving system that correspond to the message element.false
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.false
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.false
2  ESD Set DeleteDelete the item on the receiving system that corresponds to this message element.false
1AU Add or UpdateDescription: 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.false
1I IgnoreIgnore this role, it is not relevant to the update.false
1V VerifyVerify - this message element must match a value already in the receiving systems database in order to process the message.false

Source1

{
  "resourceType": "CodeSystem",
  "id": "v3-HL7UpdateMode",
  "text": {
    "status": "generated",
    "div": "<!-- snip (see above) -->"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/valueset-oid",
      "valueUri": "urn:oid:2.16.840.1.113883.5.57"
    },
    {
      "extension": [
        {
          "url": "packageId",
          "valueId": "hl7.fhir.uv.xver-r2.r4b"
        },
        {
          "url": "version",
          "valueString": "0.0.1-snapshot-2"
        }
      ],
      "url": "http://hl7.org/fhir/StructureDefinition/package-source"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode": "fhir"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger": 0,
      "_valueInteger": {
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical": "http://hl7.org/fhir/1.0/ImplementationGuide/hl7.fhir.uv.xver-r2.r4b"
          }
        ]
      }
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
      "valueCode": "trial-use",
      "_valueCode": {
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical": "http://hl7.org/fhir/1.0/ImplementationGuide/hl7.fhir.uv.xver-r2.r4b"
          }
        ]
      }
    }
  ],
  "url": "http://hl7.org/fhir/v3/HL7UpdateMode",
  "version": "1.0.2",
  "name": "v3-HL7UpdateMode",
  "status": "draft",
  "date": "2025-09-13T15:10:02-04:00",
  "publisher": "FHIR Infrastructure",
  "contact": [
    {
      "name": "FHIR Infrastructure",
      "telecom": [
        {
          "system": "url",
          "value": "http://www.hl7.org/Special/committees/fiwg"
        }
      ]
    }
  ],
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code": "001",
          "display": "World"
        }
      ]
    }
  ],
  "caseSensitive": true,
  "content": "complete",
  "property": [
    {
      "code": "status",
      "uri": "http://hl7.org/fhir/concept-properties#status",
      "type": "code"
    },
    {
      "code": "inactive",
      "uri": "http://hl7.org/fhir/concept-properties#inactive",
      "type": "boolean"
    },
    {
      "code": "effectiveDate",
      "uri": "http://hl7.org/fhir/concept-properties#effectiveDate",
      "type": "dateTime"
    },
    {
      "code": "deprecationDate",
      "uri": "http://hl7.org/fhir/concept-properties#deprecationDate",
      "type": "dateTime"
    },
    {
      "code": "retirementDate",
      "uri": "http://hl7.org/fhir/concept-properties#retirementDate",
      "type": "dateTime"
    },
    {
      "code": "notSelectable",
      "uri": "http://hl7.org/fhir/concept-properties#notSelectable",
      "type": "boolean"
    },
    {
      "code": "parent",
      "uri": "http://hl7.org/fhir/concept-properties#parent",
      "type": "code"
    },
    {
      "code": "child",
      "uri": "http://hl7.org/fhir/concept-properties#child",
      "type": "code"
    },
    {
      "code": "partOf",
      "uri": "http://hl7.org/fhir/concept-properties#partOf",
      "type": "code"
    },
    {
      "code": "synonym",
      "uri": "http://hl7.org/fhir/concept-properties#synonym",
      "type": "code"
    },
    {
      "code": "comment",
      "uri": "http://hl7.org/fhir/concept-properties#comment",
      "type": "string"
    },
    {
      "code": "itemWeight",
      "uri": "http://hl7.org/fhir/concept-properties#itemWeight",
      "type": "decimal"
    }
  ],
  "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": "notSelectable",
          "valueBoolean": false
        }
      ]
    },
    {
      "code": "AR",
      "display": "Add or Replace",
      "definition": "Description:The item was (or is to be) either added or replaced.",
      "property": [
        {
          "code": "notSelectable",
          "valueBoolean": false
        }
      ]
    },
    {
      "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": "notSelectable",
          "valueBoolean": false
        }
      ]
    },
    {
      "code": "K",
      "display": "Key",
      "definition": "Description:This item is part of the identifying information for this object.",
      "property": [
        {
          "code": "notSelectable",
          "valueBoolean": false
        }
      ]
    },
    {
      "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": "notSelectable",
          "valueBoolean": false
        }
      ]
    },
    {
      "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": "notSelectable",
          "valueBoolean": false
        }
      ]
    },
    {
      "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": "notSelectable",
          "valueBoolean": false
        }
      ]
    },
    {
      "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": "notSelectable",
          "valueBoolean": false
        }
      ]
    },
    {
      "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
        }
      ],
      "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": "notSelectable",
              "valueBoolean": false
            }
          ]
        },
        {
          "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": "notSelectable",
              "valueBoolean": false
            }
          ]
        },
        {
          "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": "notSelectable",
              "valueBoolean": false
            }
          ]
        },
        {
          "code": "ESD",
          "display": "Set Delete",
          "definition": "Delete the item on the receiving system that corresponds to this message element.",
          "property": [
            {
              "code": "notSelectable",
              "valueBoolean": false
            }
          ]
        }
      ]
    },
    {
      "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": "notSelectable",
          "valueBoolean": false
        }
      ]
    },
    {
      "code": "I",
      "display": "Ignore",
      "definition": "Ignore this role, it is not relevant to the update.",
      "property": [
        {
          "code": "notSelectable",
          "valueBoolean": false
        }
      ]
    },
    {
      "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": "notSelectable",
          "valueBoolean": false
        }
      ]
    }
  ]
}