Terminology Change Set Exchange
1.0.0 - STU1 Ballot International flag

Terminology Change Set Exchange, published by HL7 International / Terminology Infrastructure. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/termchangeset-ig/ and changes regularly. See the Directory of published versions

Resource Profile: TerminologyChangeSetProvenance - Detailed Descriptions

Page standards status: Draft Maturity Level: 0

Definitions for the terminology-changeset-provenance-profile resource profile.

Guidance on how to interpret the contents of this table can be found here

0. Provenance
2. Provenance.occurred[x]
Control1..?
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
SlicingThis element introduces a set of slices on Provenance.occurred[x]. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • type @ $this
  • 4. Provenance.occurred[x]:occurredPeriod
    Slice NameoccurredPeriod
    ShortAuthoring change sets occur over a period of time so it is most appropriate to capture as an occurredPeriod vs. occurredDateTime. This window may reflect the technical timeframe when changes occurred, or a broader scoping window used to gather changes to define a change set.
    Control1..1
    TypePeriod
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    6. Provenance.occurred[x]:occurredPeriod.end
    Control1..?
    8. Provenance.reason
    ShortThe reason for authoring the change set - most likely value is METAMGT, but allowing flexibility here as needed
    Control1..1
    10. Provenance.activity
    ShortFor a terminology change set, this should always be an update to a terminology
    Control1..?
    12. Provenance.activity.coding
    14. Provenance.activity.coding.system
    Fixed Valuehttp://terminology.hl7.org/CodeSystem/v3-DataOperation
    16. Provenance.activity.coding.code
    Fixed ValueUPDATE
    18. Provenance.agent
    Control2..?
    SlicingThis element introduces a set of slices on Provenance.agent. The slices areUnordered and Open at End, and can be differentiated using the following discriminators:
    • value @ type.coding.code
    • 20. Provenance.agent:author
      Slice Nameauthor
      ShortThe individual(s) who contributed changes reflected in the Terminology Change Set
      Control1..*
      22. Provenance.agent:author.type
      Control1..?
      24. Provenance.agent:author.type.coding
      Control1..1
      26. Provenance.agent:author.type.coding.system
      Control1..?
      Fixed Valuehttp://terminology.hl7.org/CodeSystem/provenance-participant-type
      28. Provenance.agent:author.type.coding.code
      Control1..?
      Fixed Valueauthor
      30. Provenance.agent:author.who
      32. Provenance.agent:author.who.display
      34. Provenance.agent:custodian
      Slice Namecustodian
      ShortThe entity that is accountable for maintaining a true and accurate copy of the Terminology Change Set
      Control1..1
      36. Provenance.agent:custodian.type
      Control1..?
      38. Provenance.agent:custodian.type.coding
      Control1..1
      40. Provenance.agent:custodian.type.coding.system
      Control1..?
      Fixed Valuehttp://terminology.hl7.org/CodeSystem/provenance-participant-type
      42. Provenance.agent:custodian.type.coding.code
      Control1..?
      Fixed Valuecustodian
      44. Provenance.agent:custodian.who
      46. Provenance.agent:custodian.who.display
      48. Provenance.entity
      Control1..?
      SlicingThis element introduces a set of slices on Provenance.entity. The slices areUnordered and Open at End, and can be differentiated using the following discriminators:
      • value @ role
      • 50. Provenance.entity.what
        ShortThe baseline version of the CodeSystem to which this Change Set is intended to be applied.
        52. Provenance.entity.what.identifier
        NoteThis is a business identifier, not a resource identifier (see discussion)
        54. Provenance.entity.what.identifier.value
        ShortUnique identifier for the baseline version of the CodeSystem to which this Change Set is intended to be applied.
        Must Supporttrue
        56. Provenance.entity.what.display
        ShortText alternative representation of the baseline version of the CodeSystem to which this Change Set is intended to be applied.
        58. Provenance.entity:revision
        Slice Namerevision
        Control1..1
        60. Provenance.entity:revision.role
        Fixed Valuerevision