FHIR Extensions Pack
5.2.0-ballot - 5.2.0 Ballot - September 2024) International flag

This page is part of the FHIR Core Extensions Registry (v5.2.0-ballot: Release 5.2) based on FHIR (HL7® FHIR® Standard) v5.0.0. The current version which supersedes this version is 5.1.0. For a full list of available versions, see the Directory of published versions

Extension: CodeSystem History

Official URL: http://hl7.org/fhir/StructureDefinition/codesystem-history Version: 5.2.0-ballot
Standards status: Trial-use Maturity Level: 3 Responsible: HL7 International / Terminology Infrastructure Computable Name: CSHistory
Other Identifiers: OID:2.16.840.1.113883.4.642.5.1146

Information on changes made to the Value Set Definition over time, and also has a contained audit trail of all such changes. This extension is retired. Recording history of a value set definition should be done using provenance bundles instead.

Context of Use

This extension may be used on the following element(s):

  • Element ID CodeSystem

Usage info

Usage:

  • This Extension is not used by any profiles in this Implementation Guide

Changes since version 1.0.0:

  • The resource metadata has changed (status, publisher, description)

    • Formal Views of Extension Content

    Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

    This structure is derived from Extension

    Summary

    Complex Extension: Information on changes made to the Value Set Definition over time, and also has a contained audit trail of all such changes. This extension is retired. Recording history of a value set definition should be done using provenance bundles instead.

    • name: string: Label for a set of entries, such as a version.
    • date: dateTime: Date the change took place.
    • id: string: Unique id for the specific change.
    • author: string: Person or device responsible for the change.
    • notes: string: Description of exactly what was changed and how.

    Maturity: 3

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..* Extension What has happened over time
    ... Slices for extension Content/Rules for all slices
    .... extension:name 0..1 Extension The name of this set of history entries
    ..... extension 0..0
    ..... url 1..1 uri "name"
    ..... value[x] 1..1 string Value of extension
    .... extension:revision 0..* Extension Audit of all changes for a history entry
    ..... extension 3..4 Extension Extension
    ..... Slices for extension Content/Rules for all slices
    ...... extension:date 1..1 Extension Date the change was made
    ....... extension 0..0
    ....... url 1..1 uri "date"
    ....... value[x] 1..1 dateTime Value of extension
    ..... Slices for extension Content/Rules for all slices
    ...... extension:id 1..1 Extension Version marker after the change was made
    ....... extension 0..0
    ....... url 1..1 uri "id"
    ....... value[x] 1..1 string Value of extension
    ..... Slices for extension Content/Rules for all slices
    ...... extension:author 1..1 Extension Who made the change
    ....... extension 0..0
    ....... url 1..1 uri "author"
    ....... value[x] 1..1 string Value of extension
    ..... Slices for extension Content/Rules for all slices
    ...... extension:notes 0..1 Extension Information about the change
    ....... extension 0..0
    ....... url 1..1 uri "notes"
    ....... value[x] 1..1 string Value of extension
    ..... url 1..1 uri "revision"
    ..... value[x] 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/codesystem-history"
    ... value[x] 0..0

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..* Extension What has happened over time
    ... id 0..1 id Unique id for inter-element referencing
    ... Slices for extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    .... extension:name 0..1 Extension The name of this set of history entries
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "name"
    ..... value[x] 1..1 string Value of extension
    .... extension:revision 0..* Extension Audit of all changes for a history entry
    ..... id 0..1 id Unique id for inter-element referencing
    ..... Slices for extension 3..4 Extension Extension
    Slice: Unordered, Open by value:url
    ..... Slices for extension Content/Rules for all slices
    ...... extension:date 1..1 Extension Date the change was made
    ....... id 0..1 id Unique id for inter-element referencing
    ....... extension 0..0
    ....... url 1..1 uri "date"
    ....... value[x] 1..1 dateTime Value of extension
    ..... Slices for extension Content/Rules for all slices
    ...... extension:id 1..1 Extension Version marker after the change was made
    ....... id 0..1 id Unique id for inter-element referencing
    ....... extension 0..0
    ....... url 1..1 uri "id"
    ....... value[x] 1..1 string Value of extension
    ..... Slices for extension Content/Rules for all slices
    ...... extension:author 1..1 Extension Who made the change
    ....... id 0..1 id Unique id for inter-element referencing
    ....... extension 0..0
    ....... url 1..1 uri "author"
    ....... value[x] 1..1 string Value of extension
    ..... Slices for extension Content/Rules for all slices
    ...... extension:notes 0..1 Extension Information about the change
    ....... id 0..1 id Unique id for inter-element referencing
    ....... extension 0..0
    ....... url 1..1 uri "notes"
    ....... value[x] 1..1 string Value of extension
    ..... url 1..1 uri "revision"
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/codesystem-history"

    doco Documentation for this format

    This structure is derived from Extension

    Summary

    Complex Extension: Information on changes made to the Value Set Definition over time, and also has a contained audit trail of all such changes. This extension is retired. Recording history of a value set definition should be done using provenance bundles instead.

    • name: string: Label for a set of entries, such as a version.
    • date: dateTime: Date the change took place.
    • id: string: Unique id for the specific change.
    • author: string: Person or device responsible for the change.
    • notes: string: Description of exactly what was changed and how.

    Maturity: 3

    Differential View

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..* Extension What has happened over time
    ... Slices for extension Content/Rules for all slices
    .... extension:name 0..1 Extension The name of this set of history entries
    ..... extension 0..0
    ..... url 1..1 uri "name"
    ..... value[x] 1..1 string Value of extension
    .... extension:revision 0..* Extension Audit of all changes for a history entry
    ..... extension 3..4 Extension Extension
    ..... Slices for extension Content/Rules for all slices
    ...... extension:date 1..1 Extension Date the change was made
    ....... extension 0..0
    ....... url 1..1 uri "date"
    ....... value[x] 1..1 dateTime Value of extension
    ..... Slices for extension Content/Rules for all slices
    ...... extension:id 1..1 Extension Version marker after the change was made
    ....... extension 0..0
    ....... url 1..1 uri "id"
    ....... value[x] 1..1 string Value of extension
    ..... Slices for extension Content/Rules for all slices
    ...... extension:author 1..1 Extension Who made the change
    ....... extension 0..0
    ....... url 1..1 uri "author"
    ....... value[x] 1..1 string Value of extension
    ..... Slices for extension Content/Rules for all slices
    ...... extension:notes 0..1 Extension Information about the change
    ....... extension 0..0
    ....... url 1..1 uri "notes"
    ....... value[x] 1..1 string Value of extension
    ..... url 1..1 uri "revision"
    ..... value[x] 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/codesystem-history"
    ... value[x] 0..0

    doco Documentation for this format

    Snapshot View

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..* Extension What has happened over time
    ... id 0..1 id Unique id for inter-element referencing
    ... Slices for extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    .... extension:name 0..1 Extension The name of this set of history entries
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "name"
    ..... value[x] 1..1 string Value of extension
    .... extension:revision 0..* Extension Audit of all changes for a history entry
    ..... id 0..1 id Unique id for inter-element referencing
    ..... Slices for extension 3..4 Extension Extension
    Slice: Unordered, Open by value:url
    ..... Slices for extension Content/Rules for all slices
    ...... extension:date 1..1 Extension Date the change was made
    ....... id 0..1 id Unique id for inter-element referencing
    ....... extension 0..0
    ....... url 1..1 uri "date"
    ....... value[x] 1..1 dateTime Value of extension
    ..... Slices for extension Content/Rules for all slices
    ...... extension:id 1..1 Extension Version marker after the change was made
    ....... id 0..1 id Unique id for inter-element referencing
    ....... extension 0..0
    ....... url 1..1 uri "id"
    ....... value[x] 1..1 string Value of extension
    ..... Slices for extension Content/Rules for all slices
    ...... extension:author 1..1 Extension Who made the change
    ....... id 0..1 id Unique id for inter-element referencing
    ....... extension 0..0
    ....... url 1..1 uri "author"
    ....... value[x] 1..1 string Value of extension
    ..... Slices for extension Content/Rules for all slices
    ...... extension:notes 0..1 Extension Information about the change
    ....... id 0..1 id Unique id for inter-element referencing
    ....... extension 0..0
    ....... url 1..1 uri "notes"
    ....... value[x] 1..1 string Value of extension
    ..... url 1..1 uri "revision"
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/codesystem-history"

    doco Documentation for this format

     

    Other representations of profile: CSV, Excel, Schematron

    Constraints

    IdGradePath(s)DetailsRequirements
    ele-1error**ALL** elementsAll FHIR elements must have a @value or children
    : hasValue() or (children().count() > id.count())
    ext-1error**ALL** extensionsMust have either extensions or value[x], not both
    : extension.exists() != value.exists()

    Search Parameters for this Extension

    (none found)