This page is part of the FHIR Specification (v1.6.0: STU 3 Ballot 4). 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
Human-specified notes and other documentation
{
"resourceType": "StructureDefinition",
"id": "valueset-comment",
"url": "http://hl7.org/fhir/StructureDefinition/valueset-comment",
"name": "Human-specified notes and other documentation",
"status": "draft",
"publisher": "HL7",
"date": "2016-08-11T17:02:54+10:00",
"description": "Each comment is a time-stamped entry of arbitrary length that is not editable except by anyone in the author group.",
"fhirVersion": "1.6.0",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}
],
"kind": "complex-type",
"abstract": false,
"contextType": "resource",
"context": [
"ValueSet"
],
"type": "Extension",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension",
"derivation": "constraint",
"snapshot": {
"element": [
{
"id": "Extension:human-specifiednotesandotherdocumentation",
"path": "Extension",
"short": "Human-specified notes and other documentation",
"definition": "Each comment is a time-stamped entry of arbitrary length that is not editable except by anyone in the author group.",
"min": 0,
"max": "*",
"base": {
"path": "Extension",
"min": 0,
"max": "*"
},
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "children().count() > id.count()",
"xpath": "@value|f:*|h:div"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])"
}
],
"isModifier": false
},
{
"id": "Extension:human-specifiednotesandotherdocumentation.id",
"path": "Extension.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "*"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Extension:human-specifiednotesandotherdocumentation.extension",
"path": "Extension.extension",
"slicing": {
"id": "59",
"discriminator": [
"url"
],
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "Extension:human-specifiednotesandotherdocumentation.extension:content",
"path": "Extension.extension",
"name": "content",
"short": "Remarks or other text",
"definition": "Comments created about the value set.",
"min": 1,
"max": "1",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": false
},
{
"id": "Extension:human-specifiednotesandotherdocumentation.extension:content.id",
"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). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "*"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Extension:human-specifiednotesandotherdocumentation.extension:content.extension:extension",
"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"
}
]
},
{
"id": "Extension:human-specifiednotesandotherdocumentation.extension:content.url",
"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 SHALL be a URI for the Structure Definition defining the extension.",
"min": 1,
"max": "1",
"base": {
"path": "Extension.url",
"min": 1,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"fixedUri": "content",
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Extension:human-specifiednotesandotherdocumentation.extension:content.valueString",
"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"
}
]
},
{
"id": "Extension:human-specifiednotesandotherdocumentation.extension:timestamp",
"path": "Extension.extension",
"name": "timestamp",
"short": "When the comment was created",
"definition": "Time the comment was recorded.",
"min": 1,
"max": "1",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": false
},
{
"id": "Extension:human-specifiednotesandotherdocumentation.extension:timestamp.id",
"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). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "*"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Extension:human-specifiednotesandotherdocumentation.extension:timestamp.extension:extension",
"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"
}
]
},
{
"id": "Extension:human-specifiednotesandotherdocumentation.extension:timestamp.url",
"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 SHALL be a URI for the Structure Definition defining the extension.",
"min": 1,
"max": "1",
"base": {
"path": "Extension.url",
"min": 1,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"fixedUri": "timestamp",
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Extension:human-specifiednotesandotherdocumentation.extension:timestamp.valueInstant",
"path": "Extension.extension.valueInstant",
"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": "instant"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Extension:human-specifiednotesandotherdocumentation.url",
"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 SHALL be a URI for the Structure Definition defining the extension.",
"min": 1,
"max": "1",
"base": {
"path": "Extension.url",
"min": 1,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"fixedUri": "http://hl7.org/fhir/StructureDefinition/valueset-comment",
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Extension:human-specifiednotesandotherdocumentation.value[x]",
"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": "base64Binary"
},
{
"code": "boolean"
},
{
"code": "code"
},
{
"code": "date"
},
{
"code": "dateTime"
},
{
"code": "decimal"
},
{
"code": "id"
},
{
"code": "instant"
},
{
"code": "integer"
},
{
"code": "markdown"
},
{
"code": "oid"
},
{
"code": "positiveInt"
},
{
"code": "string"
},
{
"code": "time"
},
{
"code": "unsignedInt"
},
{
"code": "uri"
},
{
"code": "Address"
},
{
"code": "Age"
},
{
"code": "Annotation"
},
{
"code": "Attachment"
},
{
"code": "CodeableConcept"
},
{
"code": "Coding"
},
{
"code": "ContactPoint"
},
{
"code": "Count"
},
{
"code": "Distance"
},
{
"code": "Duration"
},
{
"code": "HumanName"
},
{
"code": "Identifier"
},
{
"code": "Money"
},
{
"code": "Period"
},
{
"code": "Quantity"
},
{
"code": "Range"
},
{
"code": "Ratio"
},
{
"code": "Reference"
},
{
"code": "SampledData"
},
{
"code": "Signature"
},
{
"code": "Timing"
},
{
"code": "Meta"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
}
]
},
"differential": {
"element": [
{
"id": "Extension:human-specifiednotesandotherdocumentation",
"path": "Extension",
"short": "Human-specified notes and other documentation",
"definition": "Each comment is a time-stamped entry of arbitrary length that is not editable except by anyone in the author group.",
"min": 0,
"max": "*",
"isModifier": false
},
{
"id": "Extension:human-specifiednotesandotherdocumentation.extension:content",
"path": "Extension.extension",
"name": "content",
"short": "Remarks or other text",
"definition": "Comments created about the value set.",
"min": 1,
"max": "1",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
},
{
"id": "Extension:human-specifiednotesandotherdocumentation.extension:content.extension:extension",
"path": "Extension.extension.extension",
"name": "extension",
"max": "0"
},
{
"id": "Extension:human-specifiednotesandotherdocumentation.extension:content.url",
"path": "Extension.extension.url",
"type": [
{
"code": "uri"
}
],
"fixedUri": "content"
},
{
"id": "Extension:human-specifiednotesandotherdocumentation.extension:content.value[x]",
"path": "Extension.extension.value[x]",
"min": 1,
"type": [
{
"code": "string"
}
]
},
{
"id": "Extension:human-specifiednotesandotherdocumentation.extension:timestamp",
"path": "Extension.extension",
"name": "timestamp",
"short": "When the comment was created",
"definition": "Time the comment was recorded.",
"min": 1,
"max": "1",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
},
{
"id": "Extension:human-specifiednotesandotherdocumentation.extension:timestamp.extension:extension",
"path": "Extension.extension.extension",
"name": "extension",
"max": "0"
},
{
"id": "Extension:human-specifiednotesandotherdocumentation.extension:timestamp.url",
"path": "Extension.extension.url",
"type": [
{
"code": "uri"
}
],
"fixedUri": "timestamp"
},
{
"id": "Extension:human-specifiednotesandotherdocumentation.extension:timestamp.value[x]",
"path": "Extension.extension.value[x]",
"min": 1,
"type": [
{
"code": "instant"
}
]
},
{
"id": "Extension:human-specifiednotesandotherdocumentation.url",
"path": "Extension.url",
"type": [
{
"code": "uri"
}
],
"fixedUri": "http://hl7.org/fhir/StructureDefinition/valueset-comment"
},
{
"id": "Extension:human-specifiednotesandotherdocumentation.value[x]",
"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.