This page is part of the FHIR Specification (v1.0.2: DSTU 2). 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
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="valueset-comment"/> <url value="http://hl7.org/fhir/StructureDefinition/valueset-comment"/> <name value="Human-specified notes and other documentation"/> <status value="draft"/> <publisher value="HL7"/> <date value="2015-10-24T07:41:03+11:00"/> <description value="Each comment is a time-stamped entry of arbitrary length that is not editable except by anyone in the author group."/> <fhirVersion value="1.0.2"/> <kind value="datatype"/> <constrainedType value="Extension"/> <abstract value="false"/> <contextType value="resource"/> <context value="ValueSet"/> <base value="http://hl7.org/fhir/StructureDefinition/Extension"/> <snapshot> <element> <path value="Extension"/> <short value="Human-specified notes and other documentation"/> <definition value="Each comment is a time-stamped entry of arbitrary length that is not editable except by anyone in the author group."/> <min value="0"/> <max value="*"/> <base> <path value="Extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <isModifier value="false"/> </element> <element> <path value="Extension.id"/> <representation value="xmlAttr"/> <short value="xml:id (or equivalent in JSON)"/> <definition value="unique id for the element within a resource (for internal references)."/> <min value="0"/> <max value="1"/> <base> <path value="Extension.id"/> <min value="0"/> <max value="1"/> </base> <type> <code value="id"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="Extension.extension"/> <slicing> <discriminator value="url"/> <ordered value="false"/> <rules value="open"/> </slicing> <short value="Additional Content defined by implementations"/> <definition value="May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension."/> <comments value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone."/> <alias value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <base> <path value="Extension.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="Extension.extension"/> <name value="content"/> <short value="Remarks or other text"/> <definition value="Comments created about the value set."/> <min value="1"/> <max value="1"/> <base> <path value="Extension.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <isModifier value="false"/> </element> <element> <path value="Extension.extension.id"/> <representation value="xmlAttr"/> <short value="xml:id (or equivalent in JSON)"/> <definition value="unique id for the element within a resource (for internal references)."/> <min value="0"/> <max value="1"/> <base> <path value="Extension.id"/> <min value="0"/> <max value="1"/> </base> <type> <code value="id"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="Extension.extension.extension"/> <name value="extension"/> <short value="Extension"/> <definition value="An Extension"/> <min value="0"/> <max value="0"/> <base> <path value="Extension.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> </element> <element> <path value="Extension.extension.url"/> <representation value="xmlAttr"/> <short value="identifies the meaning of the extension"/> <definition value="Source of the definition for the extension code - a logical name or a URL."/> <comments value="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 value="1"/> <max value="1"/> <base> <path value="Extension.url"/> <min value="1"/> <max value="1"/> </base> <type> <code value="uri"/> </type> <fixedUri value="content"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element> <path value="Extension.extension.valueString"/> <short value="Value of extension"/> <definition value="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 value="1"/> <max value="1"/> <base> <path value="Extension.value[x]"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element> <path value="Extension.extension"/> <name value="timestamp"/> <short value="When the comment was created"/> <definition value="Time the comment was recorded."/> <min value="1"/> <max value="1"/> <base> <path value="Extension.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <isModifier value="false"/> </element> <element> <path value="Extension.extension.id"/> <representation value="xmlAttr"/> <short value="xml:id (or equivalent in JSON)"/> <definition value="unique id for the element within a resource (for internal references)."/> <min value="0"/> <max value="1"/> <base> <path value="Extension.id"/> <min value="0"/> <max value="1"/> </base> <type> <code value="id"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="Extension.extension.extension"/> <name value="extension"/> <short value="Extension"/> <definition value="An Extension"/> <min value="0"/> <max value="0"/> <base> <path value="Extension.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> </element> <element> <path value="Extension.extension.url"/> <representation value="xmlAttr"/> <short value="identifies the meaning of the extension"/> <definition value="Source of the definition for the extension code - a logical name or a URL."/> <comments value="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 value="1"/> <max value="1"/> <base> <path value="Extension.url"/> <min value="1"/> <max value="1"/> </base> <type> <code value="uri"/> </type> <fixedUri value="timestamp"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element> <path value="Extension.extension.valueInstant"/> <short value="Value of extension"/> <definition value="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 value="1"/> <max value="1"/> <base> <path value="Extension.value[x]"/> <min value="0"/> <max value="1"/> </base> <type> <code value="instant"/> </type> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element> <path value="Extension.url"/> <representation value="xmlAttr"/> <short value="identifies the meaning of the extension"/> <definition value="Source of the definition for the extension code - a logical name or a URL."/> <comments value="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 value="1"/> <max value="1"/> <base> <path value="Extension.url"/> <min value="1"/> <max value="1"/> </base> <type> <code value="uri"/> </type> <fixedUri value="http://hl7.org/fhir/StructureDefinition/valueset-comment"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element> <path value="Extension.value[x]"/> <short value="Value of extension"/> <definition value="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 value="0"/> <max value="0"/> <base> <path value="Extension.value[x]"/> <min value="0"/> <max value="1"/> </base> <type> <code value="boolean"/> </type> <type> <code value="integer"/> </type> <type> <code value="decimal"/> </type> <type> <code value="base64Binary"/> </type> <type> <code value="instant"/> </type> <type> <code value="string"/> </type> <type> <code value="uri"/> </type> <type> <code value="date"/> </type> <type> <code value="dateTime"/> </type> <type> <code value="time"/> </type> <type> <code value="code"/> </type> <type> <code value="oid"/> </type> <type> <code value="id"/> </type> <type> <code value="unsignedInt"/> </type> <type> <code value="positiveInt"/> </type> <type> <code value="markdown"/> </type> <type> <code value="Annotation"/> </type> <type> <code value="Attachment"/> </type> <type> <code value="Identifier"/> </type> <type> <code value="CodeableConcept"/> </type> <type> <code value="Coding"/> </type> <type> <code value="Quantity"/> </type> <type> <code value="Range"/> </type> <type> <code value="Period"/> </type> <type> <code value="Ratio"/> </type> <type> <code value="SampledData"/> </type> <type> <code value="Signature"/> </type> <type> <code value="HumanName"/> </type> <type> <code value="Address"/> </type> <type> <code value="ContactPoint"/> </type> <type> <code value="Timing"/> </type> <type> <code value="Reference"/> </type> <type> <code value="Meta"/> </type> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> </snapshot> <differential> <element> <path value="Extension"/> <short value="Human-specified notes and other documentation"/> <definition value="Each comment is a time-stamped entry of arbitrary length that is not editable except by anyone in the author group."/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </element> <element> <path value="Extension.extension"/> <name value="content"/> <short value="Remarks or other text"/> <definition value="Comments created about the value set."/> <min value="1"/> <max value="1"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </element> <element> <path value="Extension.extension.extension"/> <name value="extension"/> <max value="0"/> </element> <element> <path value="Extension.extension.url"/> <type> <code value="uri"/> </type> <fixedUri value="content"/> </element> <element> <path value="Extension.extension.value[x]"/> <min value="1"/> <type> <code value="string"/> </type> </element> <element> <path value="Extension.extension"/> <name value="timestamp"/> <short value="When the comment was created"/> <definition value="Time the comment was recorded."/> <min value="1"/> <max value="1"/> <type> <code value="Extension"/> </type> <isModifier value="false"/> </element> <element> <path value="Extension.extension.extension"/> <name value="extension"/> <max value="0"/> </element> <element> <path value="Extension.extension.url"/> <type> <code value="uri"/> </type> <fixedUri value="timestamp"/> </element> <element> <path value="Extension.extension.value[x]"/> <min value="1"/> <type> <code value="instant"/> </type> </element> <element> <path value="Extension.url"/> <type> <code value="uri"/> </type> <fixedUri value="http://hl7.org/fhir/StructureDefinition/valueset-comment"/> </element> <element> <path value="Extension.value[x]"/> <min value="0"/> <max value="0"/> </element> </differential> </StructureDefinition>
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.