STU3 Candidate

This page is part of the FHIR Specification (v1.8.0: STU 3 Draft). 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: R3 R2

Extension: What has happened over time

(No assigned work group)

Maturity Level : 0

Context: Any

URL for this extension:


http://hl7.org/fhir/StructureDefinition/valueset-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: ValueSet

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

Summary

Name	Card.	Type	Description & Constraints
extension	0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/valueset-history What has happened over time: 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: ValueSet
extension	0..1	Extension	The name of this set of history entries
extension	0 .. 0
url	1..1	uri	"name"
valueString	1..1	string	Value of extension
extension	0..*	Extension	Audit of all changes for a history entry
extension	1..1	Extension	Date the change was made
extension	0 .. 0
url	1..1	uri	"date"
valueDateTime	1..1	dateTime	Value of extension
extension	1..1	Extension	Version marker after the change was made
extension	0 .. 0
url	1..1	uri	"id"
valueString	1..1	string	Value of extension
extension	1..1	Extension	Who made the change
extension	0 .. 0
url	1..1	uri	"author"
valueString	1..1	string	Value of extension
extension	0..1	Extension	Information about the change
extension	0 .. 0
url	1..1	uri	"notes"
valueString	1..1	string	Value of extension
url	1..1	uri	"revision"
value[x]	0 .. 0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/valueset-history"
value[x]	0 .. 0
Documentation for this format

Fulle Structure

Name	Card.	Type	Description & Constraints
extension	0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/valueset-history What has happened over time: 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: ValueSet
extension	0..1	Extension	The name of this set of history entries
extension	0 .. 0
url	1..1	uri	"name"
valueString	1..1	string	Value of extension
extension	0..*	Extension	Audit of all changes for a history entry
extension	1..1	Extension	Date the change was made
extension	0 .. 0
url	1..1	uri	"date"
valueDateTime	1..1	dateTime	Value of extension
extension	1..1	Extension	Version marker after the change was made
extension	0 .. 0
url	1..1	uri	"id"
valueString	1..1	string	Value of extension
extension	1..1	Extension	Who made the change
extension	0 .. 0
url	1..1	uri	"author"
valueString	1..1	string	Value of extension
extension	0..1	Extension	Information about the change
extension	0 .. 0
url	1..1	uri	"notes"
valueString	1..1	string	Value of extension
url	1..1	uri	"revision"
value[x]	0 .. 0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/valueset-history"
value[x]	0 .. 0
Documentation for this format

XML Template

<!-- What has happened over time -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/valueset-history" >
 <-- extension sliced by url  in the specified orderOpen-->
 <extension url="name"> 0..1 Extension  <!-- 0..1 The name of this set of history entries -->
  <valueString value="[string]"/><!-- 1..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|Meta 
      Value of extension --></value[x]>
 </extension>
</extension>

JSON Template

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

Summary

Name	Card.	Type	Description & Constraints
extension	0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/valueset-history What has happened over time: 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: ValueSet
extension	0..1	Extension	The name of this set of history entries
extension	0 .. 0
url	1..1	uri	"name"
valueString	1..1	string	Value of extension
extension	0..*	Extension	Audit of all changes for a history entry
extension	1..1	Extension	Date the change was made
extension	0 .. 0
url	1..1	uri	"date"
valueDateTime	1..1	dateTime	Value of extension
extension	1..1	Extension	Version marker after the change was made
extension	0 .. 0
url	1..1	uri	"id"
valueString	1..1	string	Value of extension
extension	1..1	Extension	Who made the change
extension	0 .. 0
url	1..1	uri	"author"
valueString	1..1	string	Value of extension
extension	0..1	Extension	Information about the change
extension	0 .. 0
url	1..1	uri	"notes"
valueString	1..1	string	Value of extension
url	1..1	uri	"revision"
value[x]	0 .. 0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/valueset-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/valueset-history What has happened over time: 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: ValueSet
extension	0..1	Extension	The name of this set of history entries
extension	0 .. 0
url	1..1	uri	"name"
valueString	1..1	string	Value of extension
extension	0..*	Extension	Audit of all changes for a history entry
extension	1..1	Extension	Date the change was made
extension	0 .. 0
url	1..1	uri	"date"
valueDateTime	1..1	dateTime	Value of extension
extension	1..1	Extension	Version marker after the change was made
extension	0 .. 0
url	1..1	uri	"id"
valueString	1..1	string	Value of extension
extension	1..1	Extension	Who made the change
extension	0 .. 0
url	1..1	uri	"author"
valueString	1..1	string	Value of extension
extension	0..1	Extension	Information about the change
extension	0 .. 0
url	1..1	uri	"notes"
valueString	1..1	string	Value of extension
url	1..1	uri	"revision"
value[x]	0 .. 0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/valueset-history"
value[x]	0 .. 0
Documentation for this format

XML Template

<!-- What has happened over time -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/valueset-history" >
 <-- extension sliced by url  in the specified orderOpen-->
 <extension url="name"> 0..1 Extension  <!-- 0..1 The name of this set of history entries -->
  <valueString value="[string]"/><!-- 1..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|Meta 
      Value of extension --></value[x]>
 </extension>
</extension>

JSON Template

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

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')]) )