FHIR Extensions Pack
5.1.0 - 5.1.0 (April 2024) International flag

This page is part of the FHIR Core Extensions Registry (v5.1.0: Release 5.1) based on FHIR (HL7® FHIR® Standard) v5.0.0. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Extension: Artifact Comment

Official URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment Version: 5.1.0
Standards status: Trial-use Maturity Level: 3 Responsible: HL7 International / Clinical Decision Support Computable Name: ArtifactComment
Other Identifiers: OID:2.16.840.1.113883.4.642.5.1753

A comment containing additional documentation, a review comment, usage guidance, or other relevant information from a particular user.

Context of Use

This extension may be used on the following element(s):

  • Element ID Resource

Usage info

Usage:

Changes since version 1.0.0:

  • The resource metadata has changed (title, status, publisher)
  • The data elements list has changed

    • Formal Views of Extension Content

    Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

    This structure is derived from Extension

    Summary

    Complex Extension: A comment containing additional documentation, a review comment, usage guidance, or other relevant information from a particular user.

    • type: code: Indicates whether the comment is providing additional documentation, a review comment that requires resolution, or providing usage guidance to an artifact consumer.
    • text: markdown: The text content of the comment.
    • target: uri: A URI that points to what the comment is about, such as a line of text in the CQL, or a specific element in a resource.
    • reference: uri: Provides additional supporting information relevant to the comment.
    • user: string: Specifies the user or organization that authored the comment.
    • authoredOn: dateTime: Specifies the date and time the comment was authored.

    Maturity: 3

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..* Extension Additional documentation, review, or usage guidance
    ... Slices for extension Content/Rules for all slices
    .... extension:type 1..1 Extension documentation | review | guidance
    ..... extension 0..0
    ..... url 1..1 uri "type"
    ..... value[x] 1..1 code Value of extension
    Binding: ArtifactCommentType (required)
    .... extension:text 1..1 Extension The comment
    ..... extension 0..0
    ..... url 1..1 uri "text"
    ..... value[x] 1..1 markdown Value of extension
    .... extension:target 0..* Extension What the comment is directed to
    ..... extension 0..0
    ..... url 1..1 uri "target"
    ..... value[x] 1..1 uri Value of extension
    .... extension:reference 0..* Extension Supporting reference for the comment
    ..... extension 0..0
    ..... url 1..1 uri "reference"
    ..... value[x] 1..1 uri Value of extension
    .... extension:user 0..1 Extension Who commented
    ..... extension 0..0
    ..... url 1..1 uri "user"
    ..... value[x] 1..1 string Value of extension
    .... extension:authoredOn 0..1 Extension Date and time the comment was made
    ..... extension 0..0
    ..... url 1..1 uri "authoredOn"
    ..... value[x] 1..1 dateTime Value of extension
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/cqf-artifactComment"
    ... value[x] 0..0

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..* Extension Additional documentation, review, or usage guidance
    ... id 0..1 id Unique id for inter-element referencing
    ... Slices for extension 2..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    .... extension:type 1..1 Extension documentation | review | guidance
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "type"
    ..... value[x] 1..1 code Value of extension
    Binding: ArtifactCommentType (required)
    .... extension:text 1..1 Extension The comment
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "text"
    ..... value[x] 1..1 markdown Value of extension
    .... extension:target 0..* Extension What the comment is directed to
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "target"
    ..... value[x] 1..1 uri Value of extension
    .... extension:reference 0..* Extension Supporting reference for the comment
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "reference"
    ..... value[x] 1..1 uri Value of extension
    .... extension:user 0..1 Extension Who commented
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "user"
    ..... value[x] 1..1 string Value of extension
    .... extension:authoredOn 0..1 Extension Date and time the comment was made
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "authoredOn"
    ..... value[x] 1..1 dateTime Value of extension
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/cqf-artifactComment"

    doco Documentation for this format

    This structure is derived from Extension

    Summary

    Complex Extension: A comment containing additional documentation, a review comment, usage guidance, or other relevant information from a particular user.

    • type: code: Indicates whether the comment is providing additional documentation, a review comment that requires resolution, or providing usage guidance to an artifact consumer.
    • text: markdown: The text content of the comment.
    • target: uri: A URI that points to what the comment is about, such as a line of text in the CQL, or a specific element in a resource.
    • reference: uri: Provides additional supporting information relevant to the comment.
    • user: string: Specifies the user or organization that authored the comment.
    • authoredOn: dateTime: Specifies the date and time the comment was authored.

    Maturity: 3

    Differential View

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..* Extension Additional documentation, review, or usage guidance
    ... Slices for extension Content/Rules for all slices
    .... extension:type 1..1 Extension documentation | review | guidance
    ..... extension 0..0
    ..... url 1..1 uri "type"
    ..... value[x] 1..1 code Value of extension
    Binding: ArtifactCommentType (required)
    .... extension:text 1..1 Extension The comment
    ..... extension 0..0
    ..... url 1..1 uri "text"
    ..... value[x] 1..1 markdown Value of extension
    .... extension:target 0..* Extension What the comment is directed to
    ..... extension 0..0
    ..... url 1..1 uri "target"
    ..... value[x] 1..1 uri Value of extension
    .... extension:reference 0..* Extension Supporting reference for the comment
    ..... extension 0..0
    ..... url 1..1 uri "reference"
    ..... value[x] 1..1 uri Value of extension
    .... extension:user 0..1 Extension Who commented
    ..... extension 0..0
    ..... url 1..1 uri "user"
    ..... value[x] 1..1 string Value of extension
    .... extension:authoredOn 0..1 Extension Date and time the comment was made
    ..... extension 0..0
    ..... url 1..1 uri "authoredOn"
    ..... value[x] 1..1 dateTime Value of extension
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/cqf-artifactComment"
    ... value[x] 0..0

    doco Documentation for this format

    Snapshot View

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..* Extension Additional documentation, review, or usage guidance
    ... id 0..1 id Unique id for inter-element referencing
    ... Slices for extension 2..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    .... extension:type 1..1 Extension documentation | review | guidance
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "type"
    ..... value[x] 1..1 code Value of extension
    Binding: ArtifactCommentType (required)
    .... extension:text 1..1 Extension The comment
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "text"
    ..... value[x] 1..1 markdown Value of extension
    .... extension:target 0..* Extension What the comment is directed to
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "target"
    ..... value[x] 1..1 uri Value of extension
    .... extension:reference 0..* Extension Supporting reference for the comment
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "reference"
    ..... value[x] 1..1 uri Value of extension
    .... extension:user 0..1 Extension Who commented
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "user"
    ..... value[x] 1..1 string Value of extension
    .... extension:authoredOn 0..1 Extension Date and time the comment was made
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "authoredOn"
    ..... value[x] 1..1 dateTime Value of extension
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/cqf-artifactComment"

    doco Documentation for this format

     

    Other representations of profile: CSV, Excel, Schematron

    Terminology Bindings

    PathConformanceValueSetURI
    Extension.extension:type.value[x]requiredArtifactCommentType (a valid code from Artifact comment type codesystem)
    http://hl7.org/fhir/ValueSet/artifact-comment-type
    from this IG

    Constraints

    IdGradePath(s)DetailsRequirements
    ele-1error**ALL** elementsAll FHIR elements must have a @value or children
    : hasValue() or (children().count() > id.count())
    ext-1error**ALL** extensionsMust have either extensions or value[x], not both
    : extension.exists() != value.exists()

    Search Parameters for this Extension

    (none found)