Canonical Resource Management Infrastructure Implementation Guide
1.0.0-ballot - Ballot International flag

This page is part of the Canonical Resource Management Infrastructure Implementation Guide (v1.0.0-ballot: STU1 Ballot 1) based on FHIR R4. . 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: 1.0.0-ballot
Standards status: Trial-use Maturity Level: 3 Computable Name: ArtifactComment

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:

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..*ExtensionAdditional documentation, review, or usage guidance
... extension:type 1..1Extensiondocumentation | review | guidance
.... extension 0..0
.... url 1..1uri"type"
.... value[x] 1..1codeValue of extension
Binding: ArtifactCommentType (required)
... extension:text 1..1ExtensionThe comment
.... extension 0..0
.... url 1..1uri"text"
.... value[x] 1..1markdownValue of extension
... extension:target 0..*ExtensionWhat the comment is directed to
.... extension 0..0
.... url 1..1uri"target"
.... value[x] 1..1uriValue of extension
.... extension 0..0
.... url 1..1uri"reference"
.... value[x] 1..1uriValue of extension
... extension:user 0..1ExtensionWho commented
.... extension 0..0
.... url 1..1uri"user"
.... value[x] 1..1stringValue of extension
... extension:authoredOn 0..1ExtensionDate and time the comment was made
.... extension 0..0
.... url 1..1uri"authoredOn"
.... value[x] 1..1dateTimeValue of extension
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/cqf-artifactComment"
... value[x] 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionAdditional documentation, review, or usage guidance
... id 0..1stringUnique id for inter-element referencing
... Slices for extension 2..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... extension:type 1..1Extensiondocumentation | review | guidance
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"type"
.... value[x] 1..1codeValue of extension
Binding: ArtifactCommentType (required)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"text"
.... value[x] 1..1markdownValue of extension
... extension:target 0..*ExtensionWhat the comment is directed to
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"target"
.... value[x] 1..1uriValue of extension
... extension:reference 0..*ExtensionSupporting reference for the comment
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"reference"
.... value[x] 1..1uriValue of extension
... extension:user 0..1ExtensionWho commented
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"user"
.... value[x] 1..1stringValue of extension
... extension:authoredOn 0..1ExtensionDate and time the comment was made
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"authoredOn"
.... value[x] 1..1dateTimeValue of extension
... url 1..1uri"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..*ExtensionAdditional documentation, review, or usage guidance
... extension:type 1..1Extensiondocumentation | review | guidance
.... extension 0..0
.... url 1..1uri"type"
.... value[x] 1..1codeValue of extension
Binding: ArtifactCommentType (required)
... extension:text 1..1ExtensionThe comment
.... extension 0..0
.... url 1..1uri"text"
.... value[x] 1..1markdownValue of extension
... extension:target 0..*ExtensionWhat the comment is directed to
.... extension 0..0
.... url 1..1uri"target"
.... value[x] 1..1uriValue of extension
.... extension 0..0
.... url 1..1uri"reference"
.... value[x] 1..1uriValue of extension
... extension:user 0..1ExtensionWho commented
.... extension 0..0
.... url 1..1uri"user"
.... value[x] 1..1stringValue of extension
... extension:authoredOn 0..1ExtensionDate and time the comment was made
.... extension 0..0
.... url 1..1uri"authoredOn"
.... value[x] 1..1dateTimeValue of extension
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/cqf-artifactComment"
... value[x] 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionAdditional documentation, review, or usage guidance
... id 0..1stringUnique id for inter-element referencing
... Slices for extension 2..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... extension:type 1..1Extensiondocumentation | review | guidance
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"type"
.... value[x] 1..1codeValue of extension
Binding: ArtifactCommentType (required)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"text"
.... value[x] 1..1markdownValue of extension
... extension:target 0..*ExtensionWhat the comment is directed to
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"target"
.... value[x] 1..1uriValue of extension
... extension:reference 0..*ExtensionSupporting reference for the comment
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"reference"
.... value[x] 1..1uriValue of extension
... extension:user 0..1ExtensionWho commented
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"user"
.... value[x] 1..1stringValue of extension
... extension:authoredOn 0..1ExtensionDate and time the comment was made
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"authoredOn"
.... value[x] 1..1dateTimeValue of extension
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/cqf-artifactComment"

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
Extension.extension:type.value[x]requiredArtifactCommentType

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()