Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Element NameChange Type
CodeSystem.UrlNew Code System (for HL7 created CS; externals have different rules; see HTA/Vocab guidance on changing URLs for external code systems)
CodeSystem.IdentifierNew Code System (if an OID or V2 mnemonic; externals have different rules see above)
CodeSystem.VersionN/A
CodeSystem.NameMajor
CodeSystem.TitleMinor
CodeSystem.StatusMajor
CodeSystem.ExperimentalNot Currently In Use for UTG
CodeSystem.DateNot Currently In Use for UTG
CodeSystem.PublisherMinor
CodeSystem.ContactMinor
CodeSystem.DescriptionMinor   May be subjective if no change other than Major unless only change is improved clarity or perform editorial corrections. 

CodeSystem.UseContext

Not Currently In Use for UTG
CodeSystem.JurisdictionNot Currently In Use for UTG
CodeSystem.PurposeNot Currently In Use for UTG

CodeSystem.Copyright

Minor, unless change from unencumbered to encumbered.
CodeSystem.CaseSensitiveNot Widely Used in UTG (only two objects)
CodeSystem.ValueSetPro-forma in UTG, Cannot Change Value
CodeSystem.HierarchyMeaningMajor
CodeSystem.CompositionalNot Currently In Use for UTG
CodeSystem.VersionNeededNot Currently In Use for UTG - but under consideration for ballot-bound code systems
CodeSystem.ContentN/A (header element)       
CodeSystem.SupplementsNot Currently In Use for UTG
CodeSystem.CountNot Currently In Use for UTG
CodeSystem.Filter (and sub-elements)Not Currently In Use for UTG
CodeSystem.Property (including CodeSystem.Concept.Property.Code and .Value)

Major for Concept Status and defining property changes (like isSelectable), status changes (to/from Active to Retired, Active→Backwards Compatible, Minor for non-defining property changes (like synonymCode), concept Status change of Active→Backwards-compatibility, addition of language translations of the text bits (print names, descriptions, etc.).  

Minor for non-defining property changes (like editorial property value changes).

Not sure about Active→Deprecated?  or Deprecated→Backward Compatible)?      (probably minor)

CodeSystem.Concept (and all sub-elements)All changes to concepts by default are an increment of the major number.   Any proposed change could include a proposal to change the minor number instead if the change is asserted to be minor in the change proposal. 
concept.codecode Code never changed changes so N/A
concept.displayMajor?   if changed to one of the alternate already existing designations?  If fix to typo? . Typos are minor.
concept.definitionMajor?   If correction of a typo?   Removal of spurious text erroneously inserted during import or during the old maintenance process?  (see Adding example?   Additional Discussion meta-value?  (see https://terminology.hl7.org/CodeSystem-v3-Confidentiality.html code 'V' ; see also  https://terminology.hl7.org/CodeSystem-v3-AcknowledgementDetailType.html ). Typos are minor.
concept.designation.Major?   If add language translation to a concept?   If correct error in translation?   Change designation.use?  All major.
concept.propertyMajor?  changing vs. adding?   keeping same property but changing the type if erroneous?  is it different by property?   e.g. property 'synonym' added:  Major?  Minor?   property 'parent' added (add code to another hierarchy but leave it also where it currently is)are  Minor for non-defining property changes (like editorial property value changes).
Are there special or different rules about certain 'special' code systems, such ac as UTG concept properties, or concept domains, or v2tables?special and/or extensive properties used only in theseV2 Tables?Yes, handled on a case by case basis. 

Value Sets

  1. For value sets, we must evaluate all of the attributes defined in VSD to determine which ones will trigger what kind of version change, ie new object, increment of major number, increment of minor number.
  2. VSD attribute list:
    1. All Revision History attributes - updates to these are only from updates to other elements, so do not trigger and version ID things by themselves
    2. Creation Information - only set once when created with version 1.0.0
    3. Value Set Definition Naming
      1. Value Set Definition Naming.Name - update triggers major number increment; new entry for an additional name such as in a different language, triggers minor number increment
      2. Value Set Definition Naming.Name Language - update triggers minor number increment
      3. Value Set Definition Naming.Preferred Name Indicator - update triggers minor number increment
    4.  Value Set Definition
      1. Value Set Identifier - change to the identifier triggers new value set; addition of one or more secondary identifiers with no change to primary triggers minor number increment
      2. Scope - change to the scope triggers new value set, unless just editorial text change to scope text, in which case it triggers minor number increment
      3. Immutable - change to the flag triggers new value set
      4. Definition URL - change triggers minor number increment (verify with team)
      5. Intellectual Property Information - change triggers major number increment unless change is spelling or other editorial corrections in which case it is minor number increment
      6. Experimental - change to flag triggers major number increment
      7. Source Reference - change triggers major number increment unless editorial in nature which triggers minor number increment
      8. Keyword - change triggers minor number increment (verify with team)
      9. Use - change triggers major number increment (verify with team)
    5. Value Set Version
      1. Comments - change or additional comments trigger minor number increment
      2. Version Identifier - change triggers new value set
      3. Activity Status - change triggers major number increment
      4. Activity Status Date - change triggers major number increment
      5. Author - change triggers minor number increment
      6. Steward - change triggers major number increment
      7. Trusted Value Set Expansion Source - change triggers major number increment
      8. Type -  change triggers major number increment
      9. Workflow Status - change triggers major number increment
    6. Content Logical Definition
      1. Locked Date - change triggers major number increment
      2. ActiveOnly - change triggers major number increment
      3. CLD Syntax Reference -  change triggers major number increment
      4. Content Expression - if change supports scope change and the coverage or granularity of the value set is changed, then it is a new value set.   If the syntax is modified to improve efficiency of processing or simply the syntax but the intent is unchanged in terms of coverage and granularity then it is a major number increment.   Changes to code system basis is a new value set (verify with team). 
      5. Non-computable syntax expression - change is either a new value set or a major change depending upon the interpretation (verify with team)

...