Release 5 Draft Ballot

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions

Extension: artifactComment

FHIR Infrastructure Work Group Maturity Level: 1InformativeUse Context: Any

URL for this extension:

http://hl7.org/fhir/StructureDefinition/cqf-artifactComment

Status: draft. Extension maintained by: Health Level Seven, Inc. - CDS WG

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

Context of Use: Use on Element ID Element

Extension Content

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. artifactComment0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
artifactComment: A comment containing additional documentation, a review comment, usage guidance, or other relevant information from a particular user.


Use on Element ID Element
... type1..1codeIndicates whether the comment is providing additional documentation, a review comment that requires resolution, or providing usage guidance to an artifact consumer.

... text1..1markdownThe text content of the comment.

... target0..*uriA 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.

... user0..1stringSpecifies the user or organization that authored the comment.


doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
artifactComment: A comment containing additional documentation, a review comment, usage guidance, or other relevant information from a particular user.


Use on Element ID Element
... Slices for extension 0..*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
.... Slices for extension 0..0
.... url 1..1uri"type"
.... value[x] 1..1codeValue of extension
Binding: Artifact comment type (required)
... extension:text 1..1ExtensionThe comment
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..0
.... url 1..1uri"text"
.... value[x] 1..1markdownValue of extension
.... id 0..1stringUnique id for inter-element referencing
.... Slices for 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
.... Slices for 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
.... Slices for extension 0..0
.... url 1..1uri"user"
.... value[x] 1..1stringValue of extension
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/cqf-artifactComment"
... value[x] 0..0
.... valueBase64Binarybase64Binary
.... valueBooleanboolean
.... valueCanonicalcanonical(Any)
.... valueCodecode
.... valueDatedate
.... valueDateTimedateTime
.... valueDecimaldecimal
.... valueIdid
.... valueInstantinstant
.... valueIntegerinteger
.... valueInteger64integer64
.... valueMarkdownmarkdown
.... valueOidoid
.... valuePositiveIntpositiveInt
.... valueStringstring
.... valueTimetime
.... valueUnsignedIntunsignedInt
.... valueUriuri
.... valueUrlurl
.... valueUuiduuid
.... valueAddressAddress
.... valueAgeAge
.... valueAnnotationAnnotation
.... valueAttachmentAttachment
.... valueCodeableConceptCodeableConcept
.... valueCodingCoding
.... valueContactPointContactPoint
.... valueCountCount
.... valueDistanceDistance
.... valueDurationDuration
.... valueHumanNameHumanName
.... valueIdentifierIdentifier
.... valueMoneyMoney
.... valuePeriodPeriod
.... valueQuantityQuantity
.... valueRangeRange
.... valueRatioRatio
.... valueReferenceReference(Any)
.... valueSampledDataSampledData
.... valueSignatureSignature
.... valueTimingTiming
.... valueContactDetailContactDetail
.... valueContributorContributor
.... valueDataRequirementDataRequirement
.... valueExpressionExpression
.... valueParameterDefinitionParameterDefinition
.... valueRelatedArtifactRelatedArtifact
.... valueTriggerDefinitionTriggerDefinition
.... valueUsageContextUsageContext
.... valueDosageDosage
.... valueMetaMeta

doco Documentation for this format

XML Template

<!-- artifactComment -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/cqf-artifactComment" >
 <-- extension sliced by value:url  in the specified orderOpen-->
 <extension url="type"> ?? 1..1 Extension  <!-- ?? 1..1 documentation | review | guidance -->
  <valueCode value="[code]"/><!-- ?? 1..1 Value of extension -->
 </extension>
 <extension url="text"> ?? 1..1 Extension  <!-- ?? 1..1 The comment -->
  <valueMarkdown value="[markdown]"/><!-- ?? 1..1 Value of extension -->
 </extension>
 <extension url="target"> ?? 0..* Extension  <!-- ?? 0..* What the comment is directed to -->
  <valueUri value="[uri]"/><!-- ?? 1..1 Value of extension -->
 </extension>
 <extension url="reference"> ?? 0..* Extension  <!-- ?? 0..* Supporting reference for the comment -->
  <valueUri value="[uri]"/><!-- ?? 1..1 Value of extension -->
 </extension>
 <extension url="user"> ?? 0..1 Extension  <!-- ?? 0..1 Who commented -->
  <valueString value="[string]"/><!-- ?? 1..1 Value of extension -->
 </extension>
</extension>

JSON Template

{ // artifactComment
    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // documentation | review | guidance // C? R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "type", // R! 
        "valueCode" : "<code>" // C? R! Value of extension
      },
      { // The comment // C? R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "text", // R! 
        "valueMarkdown" : "<markdown>" // C? R! Value of extension
      },
      { // What the comment is directed to // C?
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "target", // R! 
        "valueUri" : "<uri>" // C? R! Value of extension
      },
      { // Supporting reference for the comment // C?
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "reference", // R! 
        "valueUri" : "<uri>" // C? R! Value of extension
      },
      { // Who commented // C?
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "user", // R! 
        "valueString" : "<string>" // C? R! Value of extension
      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/cqf-artifactComment", // R! 
// value[x]: Value of extension. One of these 51:
  }

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. artifactComment0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
artifactComment: A comment containing additional documentation, a review comment, usage guidance, or other relevant information from a particular user.


Use on Element ID Element
... type1..1codeIndicates whether the comment is providing additional documentation, a review comment that requires resolution, or providing usage guidance to an artifact consumer.

... text1..1markdownThe text content of the comment.

... target0..*uriA 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.

... user0..1stringSpecifies the user or organization that authored the comment.


doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
artifactComment: A comment containing additional documentation, a review comment, usage guidance, or other relevant information from a particular user.


Use on Element ID Element
... Slices for extension 0..*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
.... Slices for extension 0..0
.... url 1..1uri"type"
.... value[x] 1..1codeValue of extension
Binding: Artifact comment type (required)
... extension:text 1..1ExtensionThe comment
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..0
.... url 1..1uri"text"
.... value[x] 1..1markdownValue of extension
.... id 0..1stringUnique id for inter-element referencing
.... Slices for 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
.... Slices for 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
.... Slices for extension 0..0
.... url 1..1uri"user"
.... value[x] 1..1stringValue of extension
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/cqf-artifactComment"
... value[x] 0..0
.... valueBase64Binarybase64Binary
.... valueBooleanboolean
.... valueCanonicalcanonical(Any)
.... valueCodecode
.... valueDatedate
.... valueDateTimedateTime
.... valueDecimaldecimal
.... valueIdid
.... valueInstantinstant
.... valueIntegerinteger
.... valueInteger64integer64
.... valueMarkdownmarkdown
.... valueOidoid
.... valuePositiveIntpositiveInt
.... valueStringstring
.... valueTimetime
.... valueUnsignedIntunsignedInt
.... valueUriuri
.... valueUrlurl
.... valueUuiduuid
.... valueAddressAddress
.... valueAgeAge
.... valueAnnotationAnnotation
.... valueAttachmentAttachment
.... valueCodeableConceptCodeableConcept
.... valueCodingCoding
.... valueContactPointContactPoint
.... valueCountCount
.... valueDistanceDistance
.... valueDurationDuration
.... valueHumanNameHumanName
.... valueIdentifierIdentifier
.... valueMoneyMoney
.... valuePeriodPeriod
.... valueQuantityQuantity
.... valueRangeRange
.... valueRatioRatio
.... valueReferenceReference(Any)
.... valueSampledDataSampledData
.... valueSignatureSignature
.... valueTimingTiming
.... valueContactDetailContactDetail
.... valueContributorContributor
.... valueDataRequirementDataRequirement
.... valueExpressionExpression
.... valueParameterDefinitionParameterDefinition
.... valueRelatedArtifactRelatedArtifact
.... valueTriggerDefinitionTriggerDefinition
.... valueUsageContextUsageContext
.... valueDosageDosage
.... valueMetaMeta

doco Documentation for this format

XML Template

<!-- artifactComment -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/cqf-artifactComment" >
 <-- extension sliced by value:url  in the specified orderOpen-->
 <extension url="type"> ?? 1..1 Extension  <!-- ?? 1..1 documentation | review | guidance -->
  <valueCode value="[code]"/><!-- ?? 1..1 Value of extension -->
 </extension>
 <extension url="text"> ?? 1..1 Extension  <!-- ?? 1..1 The comment -->
  <valueMarkdown value="[markdown]"/><!-- ?? 1..1 Value of extension -->
 </extension>
 <extension url="target"> ?? 0..* Extension  <!-- ?? 0..* What the comment is directed to -->
  <valueUri value="[uri]"/><!-- ?? 1..1 Value of extension -->
 </extension>
 <extension url="reference"> ?? 0..* Extension  <!-- ?? 0..* Supporting reference for the comment -->
  <valueUri value="[uri]"/><!-- ?? 1..1 Value of extension -->
 </extension>
 <extension url="user"> ?? 0..1 Extension  <!-- ?? 0..1 Who commented -->
  <valueString value="[string]"/><!-- ?? 1..1 Value of extension -->
 </extension>
</extension>

JSON Template

{ // artifactComment
    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // documentation | review | guidance // C? R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "type", // R! 
        "valueCode" : "<code>" // C? R! Value of extension
      },
      { // The comment // C? R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "text", // R! 
        "valueMarkdown" : "<markdown>" // C? R! Value of extension
      },
      { // What the comment is directed to // C?
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "target", // R! 
        "valueUri" : "<uri>" // C? R! Value of extension
      },
      { // Supporting reference for the comment // C?
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "reference", // R! 
        "valueUri" : "<uri>" // C? R! Value of extension
      },
      { // Who commented // C?
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "user", // R! 
        "valueString" : "<string>" // C? R! Value of extension
      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/cqf-artifactComment", // R! 
// value[x]: Value of extension. One of these 51:
  }

 

Constraints

  • ele-1: All FHIR elements must have a @value or children (xpath: @value|f:*|h:div)
  • ext-1: Must have either extensions or value[x], not both (xpath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]))
  • ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: @value|f:*|h:div)
  • ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
  • ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: @value|f:*|h:div)
  • ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
  • ele-1: On Extension.extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension.extension: @value|f:*|h:div)
  • ext-1: On Extension.extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
  • ele-1: On Extension.extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.extension.value[x]: @value|f:*|h:div)
  • ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: @value|f:*|h:div)
  • ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
  • ele-1: On Extension.extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension.extension: @value|f:*|h:div)
  • ext-1: On Extension.extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
  • ele-1: On Extension.extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.extension.value[x]: @value|f:*|h:div)
  • ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: @value|f:*|h:div)
  • ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
  • ele-1: On Extension.extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension.extension: @value|f:*|h:div)
  • ext-1: On Extension.extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
  • ele-1: On Extension.extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.extension.value[x]: @value|f:*|h:div)
  • ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: @value|f:*|h:div)
  • ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
  • ele-1: On Extension.extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension.extension: @value|f:*|h:div)
  • ext-1: On Extension.extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
  • ele-1: On Extension.extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.extension.value[x]: @value|f:*|h:div)
  • ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: @value|f:*|h:div)
  • ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
  • ele-1: On Extension.extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension.extension: @value|f:*|h:div)
  • ext-1: On Extension.extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
  • ele-1: On Extension.extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.extension.value[x]: @value|f:*|h:div)
  • ele-1: On Extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.value[x]: @value|f:*|h:div)