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

FHIR IG analytics

Packagehl7.fhir.uv.xver-r4.r4b
Resource TypeCodeSystem
IdCodeSystem-v3-HL7UpdateMode.json
FHIR VersionR4B

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

Properties

This code system defines the following properties for its concepts

NameCodeURITypeDescription
Not SelectablenotSelectablehttp://hl7.org/fhir/concept-properties#notSelectablebooleanIndicates that the code is abstract - only intended to be used as a selector for other concepts
statusstatushttp://hl7.org/fhir/concept-properties#statuscodeA property that indicates the status of the concept. One of active, experimental, deprecated, retired

Concepts

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

LvlCodeDisplayDefinitionNot Selectablestatus
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.)
1AR Add or ReplaceDescription:The item was (or is to be) either added or replaced.
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.
1K KeyDescription:This item is part of the identifying information for this object.
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.
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.)
1REF ReferenceDescription:This item provides enough information to allow a processing system to locate the full applicable record by identifying the object.
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.
1_SetUpdateMode SetUpdateModeThese concepts apply when the element and/or message is updating a set of items.trueretired
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 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.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",
  "text": {
    "status": "generated",
    "div": "<!-- snip (see above) -->"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
      "valueCode": "external"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger": 0
    },
    {
      "extension": [
        {
          "url": "packageId",
          "valueId": "hl7.fhir.uv.xver-r4.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://terminology.hl7.org/CodeSystem/v3-HL7UpdateMode",
  "version": "2018-08-12",
  "name": "v3.HL7UpdateMode",
  "title": "v3 Code System HL7UpdateMode",
  "status": "active",
  "experimental": false,
  "date": "2018-08-12T00:00:00+10:00",
  "publisher": "FHIR Infrastructure",
  "contact": [
    {
      "name": "FHIR Infrastructure",
      "telecom": [
        {
          "system": "url",
          "value": "http://www.hl7.org/Special/committees/fiwg"
        }
      ]
    }
  ],
  "description": "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": "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code": "001",
          "display": "World"
        }
      ]
    }
  ],
  "caseSensitive": true,
  "valueSet": "http://terminology.hl7.org/ValueSet/v3-HL7UpdateMode|3.0.0",
  "hierarchyMeaning": "is-a",
  "content": "complete",
  "property": [
    {
      "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"
    },
    {
      "code": "status",
      "uri": "http://hl7.org/fhir/concept-properties#status",
      "description": "A property that indicates the status of the concept. One of active, experimental, deprecated, retired",
      "type": "code"
    }
  ],
  "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.)"
    },
    {
      "code": "AR",
      "display": "Add or Replace",
      "definition": "Description:The item was (or is to be) either added or replaced."
    },
    {
      "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."
    },
    {
      "code": "K",
      "display": "Key",
      "definition": "Description:This item is part of the identifying information for this object."
    },
    {
      "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."
    },
    {
      "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.)"
    },
    {
      "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."
    },
    {
      "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."
    },
    {
      "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": "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": "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": "ESD",
          "display": "Set Delete",
          "definition": "Delete the item on the receiving system that corresponds to this message element.",
          "property": [
            {
              "code": "status",
              "valueCode": "retired"
            }
          ]
        }
      ]
    },
    {
      "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"
        }
      ]
    }
  ]
}