This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 3). 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
What has happened over time
{ "resourceType": "StructureDefinition", "id": "valueset-history", "url": "http://hl7.org/fhir/StructureDefinition/valueset-history", "name": "What has happened over time", "status": "draft", "publisher": "HL7", "date": "2016-03-31T08:01:25+11:00", "description": "Information on changes made to the Value Set Definition over time, and also has a contained audit trail of all such changes.", "fhirVersion": "1.4.0", "kind": "datatype", "abstract": false, "contextType": "resource", "context": [ "ValueSet" ], "baseType": "Extension", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension", "derivation": "constraint", "snapshot": { "element": [ { "path": "Extension", "short": "What has happened over time", "definition": "Information on changes made to the Value Set Definition over time, and also has a contained audit trail of all such changes.", "min": 0, "max": "*", "base": { "path": "Extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "isModifier": false }, { "path": "Extension.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references).", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "*" }, "type": [ { "code": "id" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "path": "Extension.extension", "slicing": { "discriminator": [ "url" ], "ordered": false, "rules": "open" }, "short": "Extension", "definition": "An Extension", "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ] }, { "path": "Extension.extension", "name": "name", "short": "The name of this set of history entries", "definition": "Label for a set of entries, such as a version.", "comments": "Typically, a value set will have a set of history entries for each major publication milestone.", "min": 0, "max": "1", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "isModifier": false }, { "path": "Extension.extension.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references).", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "*" }, "type": [ { "code": "id" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "path": "Extension.extension.extension", "name": "extension", "short": "Extension", "definition": "An Extension", "min": 0, "max": "0", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ] }, { "path": "Extension.extension.url", "representation": [ "xmlAttr" ], "short": "identifies the meaning of the extension", "definition": "Source of the definition for the extension code - a logical name or a URL.", "comments": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition should be version specific. This will ideally be the URI for the Resource Profile defining the extension, with the code for the extension after a #.", "min": 1, "max": "1", "base": { "path": "Extension.url", "min": 1, "max": "1" }, "type": [ { "code": "uri" } ], "fixedUri": "name", "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "path": "Extension.extension.valueString", "short": "Value of extension", "definition": "Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).", "min": 1, "max": "1", "base": { "path": "Extension.value[x]", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "path": "Extension.extension", "name": "revision", "short": "Audit of all changes for a history entry", "definition": "A list of specific changes, who made them and when.", "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "isModifier": false }, { "path": "Extension.extension.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references).", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "*" }, "type": [ { "code": "id" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "path": "Extension.extension.extension", "slicing": { "discriminator": [ "url" ], "ordered": false, "rules": "open" }, "short": "Extension", "definition": "An Extension", "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ] }, { "path": "Extension.extension.extension", "name": "date", "short": "Date the change was made", "definition": "Date the change took place.", "min": 1, "max": "1", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "isModifier": false }, { "path": "Extension.extension.extension.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references).", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "*" }, "type": [ { "code": "id" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "path": "Extension.extension.extension.extension", "name": "extension", "short": "Extension", "definition": "An Extension", "min": 0, "max": "0", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ] }, { "path": "Extension.extension.extension.url", "representation": [ "xmlAttr" ], "short": "identifies the meaning of the extension", "definition": "Source of the definition for the extension code - a logical name or a URL.", "comments": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition should be version specific. This will ideally be the URI for the Resource Profile defining the extension, with the code for the extension after a #.", "min": 1, "max": "1", "base": { "path": "Extension.url", "min": 1, "max": "1" }, "type": [ { "code": "uri" } ], "fixedUri": "date", "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "path": "Extension.extension.extension.valueDateTime", "short": "Value of extension", "definition": "Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).", "min": 1, "max": "1", "base": { "path": "Extension.value[x]", "min": 0, "max": "1" }, "type": [ { "code": "dateTime" } ], "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "path": "Extension.extension.extension", "name": "id", "short": "Version marker after the change was made", "definition": "Unique id for the specific change.", "min": 1, "max": "1", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "isModifier": false }, { "path": "Extension.extension.extension.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references).", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "*" }, "type": [ { "code": "id" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "path": "Extension.extension.extension.extension", "name": "extension", "short": "Extension", "definition": "An Extension", "min": 0, "max": "0", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ] }, { "path": "Extension.extension.extension.url", "representation": [ "xmlAttr" ], "short": "identifies the meaning of the extension", "definition": "Source of the definition for the extension code - a logical name or a URL.", "comments": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition should be version specific. This will ideally be the URI for the Resource Profile defining the extension, with the code for the extension after a #.", "min": 1, "max": "1", "base": { "path": "Extension.url", "min": 1, "max": "1" }, "type": [ { "code": "uri" } ], "fixedUri": "id", "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "path": "Extension.extension.extension.valueString", "short": "Value of extension", "definition": "Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).", "min": 1, "max": "1", "base": { "path": "Extension.value[x]", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "path": "Extension.extension.extension", "name": "author", "short": "Who made the change", "definition": "Person or device responsible for the change.", "min": 1, "max": "1", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "isModifier": false }, { "path": "Extension.extension.extension.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references).", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "*" }, "type": [ { "code": "id" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "path": "Extension.extension.extension.extension", "name": "extension", "short": "Extension", "definition": "An Extension", "min": 0, "max": "0", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ] }, { "path": "Extension.extension.extension.url", "representation": [ "xmlAttr" ], "short": "identifies the meaning of the extension", "definition": "Source of the definition for the extension code - a logical name or a URL.", "comments": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition should be version specific. This will ideally be the URI for the Resource Profile defining the extension, with the code for the extension after a #.", "min": 1, "max": "1", "base": { "path": "Extension.url", "min": 1, "max": "1" }, "type": [ { "code": "uri" } ], "fixedUri": "author", "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "path": "Extension.extension.extension.valueString", "short": "Value of extension", "definition": "Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).", "min": 1, "max": "1", "base": { "path": "Extension.value[x]", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "path": "Extension.extension.extension", "name": "notes", "short": "Information about the change", "definition": "Description of exactly what was changed and how.", "min": 0, "max": "1", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "isModifier": false }, { "path": "Extension.extension.extension.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references).", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "*" }, "type": [ { "code": "id" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "path": "Extension.extension.extension.extension", "name": "extension", "short": "Extension", "definition": "An Extension", "min": 0, "max": "0", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ] }, { "path": "Extension.extension.extension.url", "representation": [ "xmlAttr" ], "short": "identifies the meaning of the extension", "definition": "Source of the definition for the extension code - a logical name or a URL.", "comments": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition should be version specific. This will ideally be the URI for the Resource Profile defining the extension, with the code for the extension after a #.", "min": 1, "max": "1", "base": { "path": "Extension.url", "min": 1, "max": "1" }, "type": [ { "code": "uri" } ], "fixedUri": "notes", "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "path": "Extension.extension.extension.valueString", "short": "Value of extension", "definition": "Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).", "min": 1, "max": "1", "base": { "path": "Extension.value[x]", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "path": "Extension.extension.url", "representation": [ "xmlAttr" ], "short": "identifies the meaning of the extension", "definition": "Source of the definition for the extension code - a logical name or a URL.", "comments": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition should be version specific. This will ideally be the URI for the Resource Profile defining the extension, with the code for the extension after a #.", "min": 1, "max": "1", "base": { "path": "Extension.url", "min": 1, "max": "1" }, "type": [ { "code": "uri" } ], "fixedUri": "revision", "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "path": "Extension.extension.value[x]", "short": "Value of extension", "definition": "Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).", "min": 0, "max": "0", "base": { "path": "Extension.value[x]", "min": 0, "max": "1" }, "type": [ { "code": "boolean" }, { "code": "integer" }, { "code": "decimal" }, { "code": "base64Binary" }, { "code": "instant" }, { "code": "string" }, { "code": "uri" }, { "code": "date" }, { "code": "dateTime" }, { "code": "time" }, { "code": "code" }, { "code": "oid" }, { "code": "id" }, { "code": "unsignedInt" }, { "code": "positiveInt" }, { "code": "markdown" }, { "code": "Annotation" }, { "code": "Attachment" }, { "code": "Identifier" }, { "code": "CodeableConcept" }, { "code": "Coding" }, { "code": "Quantity" }, { "code": "Range" }, { "code": "Period" }, { "code": "Ratio" }, { "code": "SampledData" }, { "code": "Signature" }, { "code": "HumanName" }, { "code": "Address" }, { "code": "ContactPoint" }, { "code": "Timing" }, { "code": "Reference" }, { "code": "Meta" } ], "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "path": "Extension.url", "representation": [ "xmlAttr" ], "short": "identifies the meaning of the extension", "definition": "Source of the definition for the extension code - a logical name or a URL.", "comments": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition should be version specific. This will ideally be the URI for the Resource Profile defining the extension, with the code for the extension after a #.", "min": 1, "max": "1", "base": { "path": "Extension.url", "min": 1, "max": "1" }, "type": [ { "code": "uri" } ], "fixedUri": "http://hl7.org/fhir/StructureDefinition/valueset-history", "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "path": "Extension.value[x]", "short": "Value of extension", "definition": "Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).", "min": 0, "max": "0", "base": { "path": "Extension.value[x]", "min": 0, "max": "1" }, "type": [ { "code": "boolean" }, { "code": "integer" }, { "code": "decimal" }, { "code": "base64Binary" }, { "code": "instant" }, { "code": "string" }, { "code": "uri" }, { "code": "date" }, { "code": "dateTime" }, { "code": "time" }, { "code": "code" }, { "code": "oid" }, { "code": "id" }, { "code": "unsignedInt" }, { "code": "positiveInt" }, { "code": "markdown" }, { "code": "Annotation" }, { "code": "Attachment" }, { "code": "Identifier" }, { "code": "CodeableConcept" }, { "code": "Coding" }, { "code": "Quantity" }, { "code": "Range" }, { "code": "Period" }, { "code": "Ratio" }, { "code": "SampledData" }, { "code": "Signature" }, { "code": "HumanName" }, { "code": "Address" }, { "code": "ContactPoint" }, { "code": "Timing" }, { "code": "Reference" }, { "code": "Meta" } ], "mapping": [ { "identity": "rim", "map": "N/A" } ] } ] }, "differential": { "element": [ { "path": "Extension", "short": "What has happened over time", "definition": "Information on changes made to the Value Set Definition over time, and also has a contained audit trail of all such changes.", "min": 0, "max": "*", "type": [ { "code": "Extension" } ], "isModifier": false }, { "path": "Extension.extension", "name": "name", "short": "The name of this set of history entries", "definition": "Label for a set of entries, such as a version.", "comments": "Typically, a value set will have a set of history entries for each major publication milestone.", "min": 0, "max": "1", "type": [ { "code": "Extension" } ], "isModifier": false }, { "path": "Extension.extension.extension", "name": "extension", "max": "0" }, { "path": "Extension.extension.url", "type": [ { "code": "uri" } ], "fixedUri": "name" }, { "path": "Extension.extension.value[x]", "min": 1, "type": [ { "code": "string" } ] }, { "path": "Extension.extension", "name": "revision", "short": "Audit of all changes for a history entry", "definition": "A list of specific changes, who made them and when.", "min": 0, "max": "*", "type": [ { "code": "Extension" } ], "isModifier": false }, { "path": "Extension.extension.extension", "name": "date", "short": "Date the change was made", "definition": "Date the change took place.", "min": 1, "max": "1", "type": [ { "code": "Extension" } ], "isModifier": false }, { "path": "Extension.extension.extension.extension", "name": "extension", "max": "0" }, { "path": "Extension.extension.extension.url", "type": [ { "code": "uri" } ], "fixedUri": "date" }, { "path": "Extension.extension.extension.value[x]", "min": 1, "type": [ { "code": "dateTime" } ] }, { "path": "Extension.extension.extension", "name": "id", "short": "Version marker after the change was made", "definition": "Unique id for the specific change.", "min": 1, "max": "1", "type": [ { "code": "Extension" } ], "isModifier": false }, { "path": "Extension.extension.extension.extension", "name": "extension", "max": "0" }, { "path": "Extension.extension.extension.url", "type": [ { "code": "uri" } ], "fixedUri": "id" }, { "path": "Extension.extension.extension.value[x]", "min": 1, "type": [ { "code": "string" } ] }, { "path": "Extension.extension.extension", "name": "author", "short": "Who made the change", "definition": "Person or device responsible for the change.", "min": 1, "max": "1", "type": [ { "code": "Extension" } ], "isModifier": false }, { "path": "Extension.extension.extension.extension", "name": "extension", "max": "0" }, { "path": "Extension.extension.extension.url", "type": [ { "code": "uri" } ], "fixedUri": "author" }, { "path": "Extension.extension.extension.value[x]", "min": 1, "type": [ { "code": "string" } ] }, { "path": "Extension.extension.extension", "name": "notes", "short": "Information about the change", "definition": "Description of exactly what was changed and how.", "min": 0, "max": "1", "type": [ { "code": "Extension" } ], "isModifier": false }, { "path": "Extension.extension.extension.extension", "name": "extension", "max": "0" }, { "path": "Extension.extension.extension.url", "type": [ { "code": "uri" } ], "fixedUri": "notes" }, { "path": "Extension.extension.extension.value[x]", "min": 1, "type": [ { "code": "string" } ] }, { "path": "Extension.extension.url", "type": [ { "code": "uri" } ], "fixedUri": "revision" }, { "path": "Extension.extension.value[x]", "min": 0, "max": "0" }, { "path": "Extension.url", "type": [ { "code": "uri" } ], "fixedUri": "http://hl7.org/fhir/StructureDefinition/valueset-history" }, { "path": "Extension.value[x]", "min": 0, "max": "0" } ] } }
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.