Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: R5 Ballot - see ballot notes). 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: 1

Informative

Use Context: Any

Summary

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

Version: 5.0.0-ballot

Name: history

Title: null

Modifier: This extension is not a modifier extension

Status: draft

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

Committee: Vocabulary Work Group

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 ID CodeSystem

Summary

Name	Card.	Type	Description & Constraints
history	0..*	Extension	URL = 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 ID CodeSystem
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	0..0
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
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
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
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"
value[x]	0..0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/codesystem-history"
value[x]	0..0
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..*	Extension	URL = 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 ID CodeSystem
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	0..0
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
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
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
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"
value[x]	0..0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/codesystem-history"
value[x]	0..0
Documentation for this format

XML Template

<!-- history -->

<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"> I 0..1 Extension  <!-- I 0..1 The name of this set of history entries -->
  <valueString value="[string]"/><!-- I 1..1 Value of extension -->
 </extension>
 <extension url="revision"> I 0..* Extension  <!-- I 0..* Audit of all changes for a history entry -->
  <value[x]><!-- I 0..0 base64Binary|boolean|canonical|code|
    date|dateTime|decimal|id|instant|integer|integer64|markdown|oid|positiveInt|
    string|time|unsignedInt|uri|url|uuid|Address|Age|Annotation|Attachment|
    CodeableConcept|CodeableReference|Coding|ContactPoint|Count|Distance|
    Duration|HumanName|Identifier|Money|Period|Quantity|Range|Ratio|RatioRange|
    Reference|SampledData|Signature|Timing|ContactDetail|DataRequirement|
    Expression|ParameterDefinition|RelatedArtifact|TriggerDefinition|
    UsageContext|Availability|ExtendedContactDetail|Dosage|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 // I
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "name", // R! 
        "valueString" : "<string>" // I R! Value of extension
      },
      { // Audit of all changes for a history entry // I
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "revision" // R! 
// value[x]: Value of extension. One of these 54:
      },
    ],
    "extension" : [{ Extension }], // IAdditional content defined by implementations
    "extension" : { Extension }, // IThe name of this set of history entries
    "extension" : [{ Extension }], // IAudit of all changes for a history entry
    "url" : "http://hl7.org/fhir/StructureDefinition/codesystem-history" // R! 
  // value[x]: Value of extension: Prohibited
  }

Summary

Name	Card.	Type	Description & Constraints
history	0..*	Extension	URL = 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 ID CodeSystem
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	0..0
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
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
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
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"
value[x]	0..0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/codesystem-history"
value[x]	0..0
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..*	Extension	URL = 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 ID CodeSystem
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	0..0
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
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
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
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"
value[x]	0..0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/codesystem-history"
value[x]	0..0
Documentation for this format

XML Template

<!-- history -->

<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"> I 0..1 Extension  <!-- I 0..1 The name of this set of history entries -->
  <valueString value="[string]"/><!-- I 1..1 Value of extension -->
 </extension>
 <extension url="revision"> I 0..* Extension  <!-- I 0..* Audit of all changes for a history entry -->
  <value[x]><!-- I 0..0 base64Binary|boolean|canonical|code|
    date|dateTime|decimal|id|instant|integer|integer64|markdown|oid|positiveInt|
    string|time|unsignedInt|uri|url|uuid|Address|Age|Annotation|Attachment|
    CodeableConcept|CodeableReference|Coding|ContactPoint|Count|Distance|
    Duration|HumanName|Identifier|Money|Period|Quantity|Range|Ratio|RatioRange|
    Reference|SampledData|Signature|Timing|ContactDetail|DataRequirement|
    Expression|ParameterDefinition|RelatedArtifact|TriggerDefinition|
    UsageContext|Availability|ExtendedContactDetail|Dosage|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 // I
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "name", // R! 
        "valueString" : "<string>" // I R! Value of extension
      },
      { // Audit of all changes for a history entry // I
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "revision" // R! 
// value[x]: Value of extension. One of these 54:
      },
    ],
    "extension" : [{ Extension }], // IAdditional content defined by implementations
    "extension" : { Extension }, // IThe name of this set of history entries
    "extension" : [{ Extension }], // IAudit of all changes for a history entry
    "url" : "http://hl7.org/fhir/StructureDefinition/codesystem-history" // R! 
  // value[x]: Value of extension: Prohibited
  }

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')]))
ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: @value|f:*|h:div)
ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: @value|f:*|h:div)
ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
ele-1: On Extension.extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension.extension: @value|f:*|h:div)
ext-1: On Extension.extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
ele-1: On Extension.extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.extension.value[x]: @value|f:*|h:div)
ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: @value|f:*|h:div)
ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
ele-1: On Extension.extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension.extension: @value|f:*|h:div)
ext-1: On Extension.extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
ele-1: On Extension.extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension.extension: @value|f:*|h:div)
ext-1: On Extension.extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
ele-1: On Extension.extension.extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension.extension.extension: @value|f:*|h:div)
ext-1: On Extension.extension.extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension.extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
ele-1: On Extension.extension.extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.extension.extension.value[x]: @value|f:*|h:div)
ele-1: On Extension.extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension.extension: @value|f:*|h:div)
ext-1: On Extension.extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
ele-1: On Extension.extension.extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension.extension.extension: @value|f:*|h:div)
ext-1: On Extension.extension.extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension.extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
ele-1: On Extension.extension.extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.extension.extension.value[x]: @value|f:*|h:div)
ele-1: On Extension.extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension.extension: @value|f:*|h:div)
ext-1: On Extension.extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
ele-1: On Extension.extension.extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension.extension.extension: @value|f:*|h:div)
ext-1: On Extension.extension.extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension.extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
ele-1: On Extension.extension.extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.extension.extension.value[x]: @value|f:*|h:div)
ele-1: On Extension.extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension.extension: @value|f:*|h:div)
ext-1: On Extension.extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
ele-1: On Extension.extension.extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension.extension.extension: @value|f:*|h:div)
ext-1: On Extension.extension.extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension.extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
ele-1: On Extension.extension.extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.extension.extension.value[x]: @value|f:*|h:div)
ele-1: On Extension.extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.extension.value[x]: @value|f:*|h:div)
ele-1: On Extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.value[x]: @value|f:*|h:div)

Search

No Search Extensions defined for this resource

Examples of this extension

No examples found.