R4 Draft for Comment

This page is part of the FHIR Specification (v3.2.0: R4 Ballot 1). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R4B R4 R3

Extension: history

Vocabulary Work Group Maturity Level: 1InformativeUse Context: Any

URL for this extension: 

http://hl7.org/fhir/StructureDefinition/codesystem-history

Status: draft. Extension maintained by: HL7

Information on changes made to the Value Set Definition over time, and also has a contained audit trail of all such changes.

Context of Use: Use on element: CodeSystem

usage info: insert a list of places where this extension is used

Extension Content

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/codesystem-history
history: Information on changes made to the Value Set Definition over time, and also has a contained audit trail of all such changes.
Use on element: CodeSystem
... extension 0..1ExtensionThe name of this set of history entries
.... url 1..1uri"name"
.... valueString 0..1stringValue of extension
... extension 0..*ExtensionAudit of all changes for a history entry
.... extension 1..1ExtensionDate the change was made
..... url 1..1uri"date"
..... valueDateTime 0..1dateTimeValue of extension
.... extension 1..1ExtensionVersion marker after the change was made
..... url 1..1uri"id"
..... valueString 0..1stringValue of extension
.... extension 1..1ExtensionWho made the change
..... url 1..1uri"author"
..... valueString 0..1stringValue of extension
.... extension 0..1ExtensionInformation about the change
..... url 1..1uri"notes"
..... valueString 0..1stringValue of extension
.... url 1..1uri"revision"
.... value[x] 0..0
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/codesystem-history"
... value[x] 0..0

doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/codesystem-history
history: Information on changes made to the Value Set Definition over time, and also has a contained audit trail of all such changes.
Use on element: CodeSystem
... extension 0..1ExtensionThe name of this set of history entries
.... url 1..1uri"name"
.... valueString 0..1stringValue of extension
... extension 0..*ExtensionAudit of all changes for a history entry
.... extension 1..1ExtensionDate the change was made
..... url 1..1uri"date"
..... valueDateTime 0..1dateTimeValue of extension
.... extension 1..1ExtensionVersion marker after the change was made
..... url 1..1uri"id"
..... valueString 0..1stringValue of extension
.... extension 1..1ExtensionWho made the change
..... url 1..1uri"author"
..... valueString 0..1stringValue of extension
.... extension 0..1ExtensionInformation about the change
..... url 1..1uri"notes"
..... valueString 0..1stringValue of extension
.... url 1..1uri"revision"
.... value[x] 0..0
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/codesystem-history"
... value[x] 0..0

doco Documentation for this format

XML Template

<!-- history -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/codesystem-history" >
 <-- extension sliced by value:url  in the specified orderOpen-->
 <extension url="name"> 0..1 Extension  <!-- 0..1 The name of this set of history entries -->
  <valueString value="[string]"/><!-- 0..1 Value of extension -->
 </extension>
 <extension url="revision"> 0..* Extension  <!-- 0..* Audit of all changes for a history entry -->
  <value[x]><!-- 0..0 base64Binary|boolean|code|date|
    dateTime|decimal|id|instant|integer|markdown|oid|positiveInt|string|time|
    unsignedInt|uri|Address|Age|Annotation|Attachment|CodeableConcept|Coding|
    ContactPoint|Count|Distance|Duration|HumanName|Identifier|Money|Period|
    Quantity|Range|Ratio|Reference|SampledData|Signature|Timing|Dosage|
    ContactDetail|Contributor|DataRequirement|ParameterDefinition|
    RelatedArtifact|TriggerDefinition|UsageContext|Meta 
      Value of extension --></value[x]>
 </extension>
</extension>

JSON Template

{ // history
    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // The name of this set of history entries //
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "name", // R! 
        "valueString" : "<string>" //Value of extension
      },
      { // Audit of all changes for a history entry //
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "revision" // R! 
// value[x]: Value of extension. One of these 46:
      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/codesystem-history", // R! 
// value[x]: Value of extension. One of these 46:
  }

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/codesystem-history
history: Information on changes made to the Value Set Definition over time, and also has a contained audit trail of all such changes.
Use on element: CodeSystem
... extension 0..1ExtensionThe name of this set of history entries
.... url 1..1uri"name"
.... valueString 0..1stringValue of extension
... extension 0..*ExtensionAudit of all changes for a history entry
.... extension 1..1ExtensionDate the change was made
..... url 1..1uri"date"
..... valueDateTime 0..1dateTimeValue of extension
.... extension 1..1ExtensionVersion marker after the change was made
..... url 1..1uri"id"
..... valueString 0..1stringValue of extension
.... extension 1..1ExtensionWho made the change
..... url 1..1uri"author"
..... valueString 0..1stringValue of extension
.... extension 0..1ExtensionInformation about the change
..... url 1..1uri"notes"
..... valueString 0..1stringValue of extension
.... url 1..1uri"revision"
.... value[x] 0..0
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/codesystem-history"
... value[x] 0..0

doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/codesystem-history
history: Information on changes made to the Value Set Definition over time, and also has a contained audit trail of all such changes.
Use on element: CodeSystem
... extension 0..1ExtensionThe name of this set of history entries
.... url 1..1uri"name"
.... valueString 0..1stringValue of extension
... extension 0..*ExtensionAudit of all changes for a history entry
.... extension 1..1ExtensionDate the change was made
..... url 1..1uri"date"
..... valueDateTime 0..1dateTimeValue of extension
.... extension 1..1ExtensionVersion marker after the change was made
..... url 1..1uri"id"
..... valueString 0..1stringValue of extension
.... extension 1..1ExtensionWho made the change
..... url 1..1uri"author"
..... valueString 0..1stringValue of extension
.... extension 0..1ExtensionInformation about the change
..... url 1..1uri"notes"
..... valueString 0..1stringValue of extension
.... url 1..1uri"revision"
.... value[x] 0..0
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/codesystem-history"
... value[x] 0..0

doco Documentation for this format

XML Template

<!-- history -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/codesystem-history" >
 <-- extension sliced by value:url  in the specified orderOpen-->
 <extension url="name"> 0..1 Extension  <!-- 0..1 The name of this set of history entries -->
  <valueString value="[string]"/><!-- 0..1 Value of extension -->
 </extension>
 <extension url="revision"> 0..* Extension  <!-- 0..* Audit of all changes for a history entry -->
  <value[x]><!-- 0..0 base64Binary|boolean|code|date|
    dateTime|decimal|id|instant|integer|markdown|oid|positiveInt|string|time|
    unsignedInt|uri|Address|Age|Annotation|Attachment|CodeableConcept|Coding|
    ContactPoint|Count|Distance|Duration|HumanName|Identifier|Money|Period|
    Quantity|Range|Ratio|Reference|SampledData|Signature|Timing|Dosage|
    ContactDetail|Contributor|DataRequirement|ParameterDefinition|
    RelatedArtifact|TriggerDefinition|UsageContext|Meta 
      Value of extension --></value[x]>
 </extension>
</extension>

JSON Template

{ // history
    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // The name of this set of history entries //
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "name", // R! 
        "valueString" : "<string>" //Value of extension
      },
      { // Audit of all changes for a history entry //
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "revision" // R! 
// value[x]: Value of extension. One of these 46:
      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/codesystem-history", // R! 
// value[x]: Value of extension. One of these 46:
  }

 

Constraints

  • ele-1: All FHIR elements must have a @value or children (xpath: @value|f:*|h:div)
  • ext-1: Must have either extensions or value[x], not both (xpath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]))