Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: R5 Ballot - see ballot notes). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Extension: artifactComment

FHIR Infrastructure Work Group

Maturity Level: 1

Informative

Use Context: Any

Summary

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

Version: 5.0.0-ballot

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

Summary

Name	Card.	Type	Description & Constraints
artifactComment	0..*	Extension	URL = 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
type	1..1	code	documentation \| review \| guidance Binding: Artifact comment type (required)
text	1..1	markdown	The comment
target	0..*	uri	What the comment is directed to
reference	0..*	uri	Supporting reference for the comment
user	0..1	string	Who commented
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..*	Extension	URL = 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..*	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: Artifact comment type (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
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/cqf-artifactComment"
value[x]	0..0
Documentation for this format

XML Template

<!-- artifactComment -->

<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

Name	Card.	Type	Description & Constraints
artifactComment	0..*	Extension	URL = 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
type	1..1	code	documentation \| review \| guidance Binding: Artifact comment type (required)
text	1..1	markdown	The comment
target	0..*	uri	What the comment is directed to
reference	0..*	uri	Supporting reference for the comment
user	0..1	string	Who commented
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..*	Extension	URL = 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..*	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: Artifact comment type (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
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/cqf-artifactComment"
value[x]	0..0
Documentation for this format

XML Template

<!-- artifactComment -->

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

Search

No Search Extensions defined for this resource

Examples of this extension

No examples found.