R6 Ballot (2nd Draft)

Publish-box (todo)

14.8.12.2 StructureDefinition: EBMRecommendation

Clinical Decision Support icon Work Group  Maturity Level: 0 Trial Use Use Context: Any

The canonical URL for this profile is: 

http://hl7.org/fhir/StructureDefinition/ebmrecommendation

Represents justification for a recommendation

This profile was published on Tue, Jan 11, 2022 00:00+0800 as a draft by HL7.

14.8.12.2.1 Formal Views of Profile Content

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

This structure is derived from ArtifactAssessment.

Summary

Mandatory: 1 element
Must-Support: 1 element
Prohibited: 2 elements

This indicates the differences between this profile and the base ArtifactAssessment structure.

Name iconFlags iconCard. iconType iconDescription & Constraints icondoco icon
.. ArtifactAssessment 1..1 ArtifactAssessment Adds metadata-supported comments, classifiers or ratings related to a Resource
... citeAs[x] 0..1 Reference(Citation), markdown How to cite the recommendation
... artifact[x] S 1..1 The artifact assessed, commented upon or rated
.... artifactReference Reference(PlanDefinition | ActivityDefinition)
.... artifactCanonical canonical(Any)
.... artifactUri uri
... workflowStatus 0..0
... disposition 0..0

doco Documentation for this format icon

This provides the consolidated view (aka snapshot) of the profile after applying the changes in this profile to the base ArtifactAssessment structure.

Name iconFlags iconCard. iconType iconDescription & Constraints icondoco icon
.. ArtifactAssessment 1..1 ArtifactAssessment Adds metadata-supported comments, classifiers or ratings related to a Resource
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: All Languages (required): IETF language tag for a human language

Additional BindingsPurpose
Common Languages Starter Set
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Additional identifier for the artifact assessment
... title Σ 0..1 string A short title for the assessment for use in displaying and selecting
... citeAs[x] 0..1 How to cite the recommendation
.... citeAsReference Reference(Citation)
.... citeAsMarkdown markdown
... date Σ 0..1 dateTime Date last changed
... copyright 0..1 markdown Use and/or publishing restrictions
... approvalDate 0..1 date When the artifact assessment was approved by publisher
... lastReviewDate Σ 0..1 date When the artifact assessment was last reviewed by the publisher
... artifact[x] SΣ 1..1 The artifact assessed, commented upon or rated
.... artifactReference Reference(PlanDefinition | ActivityDefinition)
.... artifactCanonical canonical(Any)
.... artifactUri uri
... content 0..* BackboneElement Comment, classifier, or rating content
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... informationType 0..1 code comment | classifier | rating | container | response | change-request
Binding: Artifact Assessment Information Type (required)
.... summary 0..1 markdown Brief summary of the content
.... type 0..1 CodeableConcept What type of content
Binding: Evidence Certainty Type (example)
.... classifier 0..* CodeableConcept Rating, classifier, or assessment
Binding: Evidence Certainty Rating (example)
.... quantity 0..1 Quantity Quantitative rating
.... author 0..1 Reference(Patient | Practitioner | PractitionerRole | Organization | Device) Who authored the content
.... path 0..* uri What the comment is directed to
.... relatedArtifact 0..* RelatedArtifact Additional information
.... freeToShare 0..1 boolean Acceptable to publicly share the resource content
.... component 0..* See content (ArtifactAssessment) Contained content

doco Documentation for this format icon
<!-- EBMRecommendation -->doco

<ArtifactAssessment xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <id value="[id]"/><!-- 0..1 Logical id of this artifact -->
 <meta><!-- I 0..1 Meta Metadata about the resource --></meta>
 <implicitRules value="[uri]"/><!-- I 0..1 A set of rules under which this content was created -->
 <language value="[code]"/><!-- I 0..1 Language of the resource content   -->
 <text><!-- I 0..1 Narrative 
     Text summary of the resource, for human interpretation --></text>
 <contained><!-- 0..* Resource 
     Contained, inline Resources --></contained>
 <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
 <identifier><!-- I 0..* Identifier 
     Additional identifier for the artifact assessment --></identifier>
 <title value="[string]"/><!-- I 0..1 A short title for the assessment for use in displaying and selecting -->
 <citeAs[x]><!-- I 0..1 Reference(Citation)|markdown 
     How to cite the recommendation --></citeAs[x]>
 <date value="[dateTime]"/><!-- I 0..1 Date last changed -->
 <copyright value="[markdown]"/><!-- I 0..1 Use and/or publishing restrictions -->
 <approvalDate value="[date]"/><!-- I 0..1 When the artifact assessment was approved by publisher -->
 <lastReviewDate value="[date]"/><!-- I 0..1 When the artifact assessment was last reviewed by the publisher -->
 <artifact[x]><!-- I 1..1 Reference(PlanDefinition)|canonical|uri 
     The artifact assessed, commented upon or rated --></artifact[x]>
 <content> I 0..* BackboneElement  <!-- I 0..* Comment, classifier, or rating content -->
  <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <informationType value="[code]"/><!-- I 0..1 comment | classifier | rating | container | response | change-request   -->
  <summary value="[markdown]"/><!-- I 0..1 Brief summary of the content -->
  <type><!-- I 0..1 CodeableConcept What type of content   --></type>
  <classifier><!-- I 0..* CodeableConcept Rating, classifier, or assessment   --></classifier>
  <quantity><!-- I 0..1 Quantity 
      Quantitative rating --></quantity>
  <author><!-- I 0..1 Reference(Patient) 
      Who authored the content --></author>
  <path value="[uri]"/><!-- I 0..* What the comment is directed to -->
  <relatedArtifact><!-- I 0..* RelatedArtifact 
      Additional information --></relatedArtifact>
  <freeToShare value="[boolean]"/><!-- I 0..1 Acceptable to publicly share the resource content -->
  <component><!-- See http://hl7.org/fhir/StructureDefinition/ArtifactAssessment#ArtifactAssessment.content  Contained content --></component>
 </content>
 <workflowStatus value="[code]"/><!-- I 0..0 submitted | triaged | waiting-for-input | resolved-no-change | resolved-change-required | deferred | duplicate | applied | published | entered-in-error   -->
 <disposition value="[code]"/><!-- I 0..0 unresolved | not-persuasive | persuasive | persuasive-with-modification | not-persuasive-with-modification   -->
</ArtifactAssessment>

{ // EBMRecommendation
  // from Element: extension
    "meta" : { Meta }, // IMetadata about the resource
    "implicitRules" : "<uri>", // IA set of rules under which this content was created
    "language" : "<code>", // ILanguage of the resource content
    "text" : { Narrative }, // IText summary of the resource, for human interpretation
    "contained" : [{ Resource }], //Contained, inline Resources
    "modifierExtension" : [{ Extension }], // IExtensions that cannot be ignored
    "identifier" : [{ Identifier }], // IAdditional identifier for the artifact assessment
    "title" : "<string>", // IA short title for the assessment for use in displaying and selecting
  // value[x]: How to cite the recommendation. One of these 2:
    "citeAsReference" : { Reference(Citation) }, // IHow to cite the recommendation
    "citeAsMarkdown" : "<markdown>", // IHow to cite the recommendation
    "date" : "<dateTime>", // IDate last changed
    "copyright" : "<markdown>", // IUse and/or publishing restrictions
    "approvalDate" : "<date>", // IWhen the artifact assessment was approved by publisher
    "lastReviewDate" : "<date>", // IWhen the artifact assessment was last reviewed by the publisher
  // value[x]: The artifact assessed, commented upon or rated. One of these 3:
    "artifactReference" : { Reference(PlanDefinition) }, // I R! The artifact assessed, commented upon or rated
    "artifactCanonical" : "<canonical>", // I R! The artifact assessed, commented upon or rated
    "artifactUri" : "<uri>", // I R! The artifact assessed, commented upon or rated
    "content" : [{ BackboneElement }] // IComment, classifier, or rating content
  }

This structure is derived from ArtifactAssessment.

Summary

Mandatory: 1 element
Must-Support: 1 element
Prohibited: 2 elements

Differential View

This indicates the differences between this profile and the base ArtifactAssessment structure.

Name iconFlags iconCard. iconType iconDescription & Constraints icondoco icon
.. ArtifactAssessment 1..1 ArtifactAssessment Adds metadata-supported comments, classifiers or ratings related to a Resource
... citeAs[x] 0..1 Reference(Citation), markdown How to cite the recommendation
... artifact[x] S 1..1 The artifact assessed, commented upon or rated
.... artifactReference Reference(PlanDefinition | ActivityDefinition)
.... artifactCanonical canonical(Any)
.... artifactUri uri
... workflowStatus 0..0
... disposition 0..0

doco Documentation for this format icon

Snapshot View

This provides the consolidated view (aka snapshot) of the profile after applying the changes in this profile to the base ArtifactAssessment structure.

Name iconFlags iconCard. iconType iconDescription & Constraints icondoco icon
.. ArtifactAssessment 1..1 ArtifactAssessment Adds metadata-supported comments, classifiers or ratings related to a Resource
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: All Languages (required): IETF language tag for a human language

Additional BindingsPurpose
Common Languages Starter Set
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Additional identifier for the artifact assessment
... title Σ 0..1 string A short title for the assessment for use in displaying and selecting
... citeAs[x] 0..1 How to cite the recommendation
.... citeAsReference Reference(Citation)
.... citeAsMarkdown markdown
... date Σ 0..1 dateTime Date last changed
... copyright 0..1 markdown Use and/or publishing restrictions
... approvalDate 0..1 date When the artifact assessment was approved by publisher
... lastReviewDate Σ 0..1 date When the artifact assessment was last reviewed by the publisher
... artifact[x] SΣ 1..1 The artifact assessed, commented upon or rated
.... artifactReference Reference(PlanDefinition | ActivityDefinition)
.... artifactCanonical canonical(Any)
.... artifactUri uri
... content 0..* BackboneElement Comment, classifier, or rating content
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... informationType 0..1 code comment | classifier | rating | container | response | change-request
Binding: Artifact Assessment Information Type (required)
.... summary 0..1 markdown Brief summary of the content
.... type 0..1 CodeableConcept What type of content
Binding: Evidence Certainty Type (example)
.... classifier 0..* CodeableConcept Rating, classifier, or assessment
Binding: Evidence Certainty Rating (example)
.... quantity 0..1 Quantity Quantitative rating
.... author 0..1 Reference(Patient | Practitioner | PractitionerRole | Organization | Device) Who authored the content
.... path 0..* uri What the comment is directed to
.... relatedArtifact 0..* RelatedArtifact Additional information
.... freeToShare 0..1 boolean Acceptable to publicly share the resource content
.... component 0..* See content (ArtifactAssessment) Contained content

doco Documentation for this format icon

XML Template

<!-- EBMRecommendation -->doco

<ArtifactAssessment xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <id value="[id]"/><!-- 0..1 Logical id of this artifact -->
 <meta><!-- I 0..1 Meta Metadata about the resource --></meta>
 <implicitRules value="[uri]"/><!-- I 0..1 A set of rules under which this content was created -->
 <language value="[code]"/><!-- I 0..1 Language of the resource content   -->
 <text><!-- I 0..1 Narrative 
     Text summary of the resource, for human interpretation --></text>
 <contained><!-- 0..* Resource 
     Contained, inline Resources --></contained>
 <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
 <identifier><!-- I 0..* Identifier 
     Additional identifier for the artifact assessment --></identifier>
 <title value="[string]"/><!-- I 0..1 A short title for the assessment for use in displaying and selecting -->
 <citeAs[x]><!-- I 0..1 Reference(Citation)|markdown 
     How to cite the recommendation --></citeAs[x]>
 <date value="[dateTime]"/><!-- I 0..1 Date last changed -->
 <copyright value="[markdown]"/><!-- I 0..1 Use and/or publishing restrictions -->
 <approvalDate value="[date]"/><!-- I 0..1 When the artifact assessment was approved by publisher -->
 <lastReviewDate value="[date]"/><!-- I 0..1 When the artifact assessment was last reviewed by the publisher -->
 <artifact[x]><!-- I 1..1 Reference(PlanDefinition)|canonical|uri 
     The artifact assessed, commented upon or rated --></artifact[x]>
 <content> I 0..* BackboneElement  <!-- I 0..* Comment, classifier, or rating content -->
  <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <informationType value="[code]"/><!-- I 0..1 comment | classifier | rating | container | response | change-request   -->
  <summary value="[markdown]"/><!-- I 0..1 Brief summary of the content -->
  <type><!-- I 0..1 CodeableConcept What type of content   --></type>
  <classifier><!-- I 0..* CodeableConcept Rating, classifier, or assessment   --></classifier>
  <quantity><!-- I 0..1 Quantity 
      Quantitative rating --></quantity>
  <author><!-- I 0..1 Reference(Patient) 
      Who authored the content --></author>
  <path value="[uri]"/><!-- I 0..* What the comment is directed to -->
  <relatedArtifact><!-- I 0..* RelatedArtifact 
      Additional information --></relatedArtifact>
  <freeToShare value="[boolean]"/><!-- I 0..1 Acceptable to publicly share the resource content -->
  <component><!-- See http://hl7.org/fhir/StructureDefinition/ArtifactAssessment#ArtifactAssessment.content  Contained content --></component>
 </content>
 <workflowStatus value="[code]"/><!-- I 0..0 submitted | triaged | waiting-for-input | resolved-no-change | resolved-change-required | deferred | duplicate | applied | published | entered-in-error   -->
 <disposition value="[code]"/><!-- I 0..0 unresolved | not-persuasive | persuasive | persuasive-with-modification | not-persuasive-with-modification   -->
</ArtifactAssessment>

JSON Template

{ // EBMRecommendation
  // from Element: extension
    "meta" : { Meta }, // IMetadata about the resource
    "implicitRules" : "<uri>", // IA set of rules under which this content was created
    "language" : "<code>", // ILanguage of the resource content
    "text" : { Narrative }, // IText summary of the resource, for human interpretation
    "contained" : [{ Resource }], //Contained, inline Resources
    "modifierExtension" : [{ Extension }], // IExtensions that cannot be ignored
    "identifier" : [{ Identifier }], // IAdditional identifier for the artifact assessment
    "title" : "<string>", // IA short title for the assessment for use in displaying and selecting
  // value[x]: How to cite the recommendation. One of these 2:
    "citeAsReference" : { Reference(Citation) }, // IHow to cite the recommendation
    "citeAsMarkdown" : "<markdown>", // IHow to cite the recommendation
    "date" : "<dateTime>", // IDate last changed
    "copyright" : "<markdown>", // IUse and/or publishing restrictions
    "approvalDate" : "<date>", // IWhen the artifact assessment was approved by publisher
    "lastReviewDate" : "<date>", // IWhen the artifact assessment was last reviewed by the publisher
  // value[x]: The artifact assessed, commented upon or rated. One of these 3:
    "artifactReference" : { Reference(PlanDefinition) }, // I R! The artifact assessed, commented upon or rated
    "artifactCanonical" : "<canonical>", // I R! The artifact assessed, commented upon or rated
    "artifactUri" : "<uri>", // I R! The artifact assessed, commented upon or rated
    "content" : [{ BackboneElement }] // IComment, classifier, or rating content
  }

 

Alternate definitions: Master Definition (XML, JSON), Schematron

14.8.12.2.2 Terminology Bindings

Path Name Conformance ValueSet
ArtifactAssessment.language All Languages required All Languages
ArtifactAssessment.content.informationType Artifact Assessment Information Type required Artifact Assessment Information Type
ArtifactAssessment.content.type Evidence Certainty Type example Evidence Certainty Type
ArtifactAssessment.content.classifier Evidence Certainty Rating example Evidence Certainty Rating
. .