FHIR CI-Build

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

Summary

Defining URL:http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
Version:5.0.0-cibuild
Name:artifactComment
Title:null
Modifier:This extension is not a modifier extension
Status:draft
Definition:A comment containing additional documentation, a review comment, usage guidance, or other relevant information from a particular user.
Committee:FHIR Infrastructure Work Group

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..1codedocumentation | review | guidance

Binding: Artifact comment type (required)
... text1..1markdownThe comment

... target0..*uriWhat the comment is directed to

... user0..1stringWho commented


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..1idUnique id for inter-element referencing
.... 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..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"text"
.... value[x] 1..1markdownValue of extension
.... id 0..1idUnique 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..1idUnique 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..1idUnique id for inter-element referencing
.... 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

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"> I 1..1 Extension  <!-- I 1..1 documentation | review | guidance -->
  <valueCode value="[code]"/><!-- I 1..1 Value of extension -->
 </extension>
 <extension url="text"> I 1..1 Extension  <!-- I 1..1 The comment -->
  <valueMarkdown value="[markdown]"/><!-- I 1..1 Value of extension -->
 </extension>
 <extension url="target"> I 0..* Extension  <!-- I 0..* What the comment is directed to -->
  <valueUri value="[uri]"/><!-- I 1..1 Value of extension -->
 </extension>
 <extension url="reference"> I 0..* Extension  <!-- I 0..* Supporting reference for the comment -->
  <valueUri value="[uri]"/><!-- I 1..1 Value of extension -->
 </extension>
 <extension url="user"> I 0..1 Extension  <!-- I 0..1 Who commented -->
  <valueString value="[string]"/><!-- I 1..1 Value of extension -->
 </extension>
</extension>

JSON Template

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

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..1codedocumentation | review | guidance

Binding: Artifact comment type (required)
... text1..1markdownThe comment

... target0..*uriWhat the comment is directed to

... user0..1stringWho commented


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..1idUnique id for inter-element referencing
.... 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..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"text"
.... value[x] 1..1markdownValue of extension
.... id 0..1idUnique 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..1idUnique 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..1idUnique id for inter-element referencing
.... 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

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"> I 1..1 Extension  <!-- I 1..1 documentation | review | guidance -->
  <valueCode value="[code]"/><!-- I 1..1 Value of extension -->
 </extension>
 <extension url="text"> I 1..1 Extension  <!-- I 1..1 The comment -->
  <valueMarkdown value="[markdown]"/><!-- I 1..1 Value of extension -->
 </extension>
 <extension url="target"> I 0..* Extension  <!-- I 0..* What the comment is directed to -->
  <valueUri value="[uri]"/><!-- I 1..1 Value of extension -->
 </extension>
 <extension url="reference"> I 0..* Extension  <!-- I 0..* Supporting reference for the comment -->
  <valueUri value="[uri]"/><!-- I 1..1 Value of extension -->
 </extension>
 <extension url="user"> I 0..1 Extension  <!-- I 0..1 Who commented -->
  <valueString value="[string]"/><!-- I 1..1 Value of extension -->
 </extension>
</extension>

JSON Template

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

 

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: )
  • 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)

Search

No Search Extensions defined for this resource

Examples of this extension

No examples found.