StructureDefinition: EBMRecommendation

Release 5 Draft Ballot

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

14.8.11.2 StructureDefinition: EBMRecommendation

Clinical Decision Support

Work Group

Maturity Level: 0

Trial Use

Use Context: Any

The official 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+0000 as a draft by HL7.

14.8.11.2.1 Formal Views of Profile Content

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

Text Summary
Differential Table
Snapshot Table
XML Template
JSON Template
All

This structure is derived from ArtifactAssessment.

Summary

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

This structure is derived from ArtifactAssessment.

Name	Flags	Card.	Type	Description & Constraints
ArtifactAssessment		1..1	ArtifactAssessment	Adds metadata-supported comments, classifiers or ratings related to a Resource
citeAs		0..1	Reference(Citation), markdown	How to cite the recommendation
artifact	S	1..1		The artifact assessed, commented upon or rated
artifact			Reference(PlanDefinition \| ActivityDefinition)
artifact			canonical(Any)
artifact			uri
workflowStatus		0..0
disposition		0..0
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
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: Common Languages (preferred) Max Binding: All Languages: IETF language tag
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
Slices for citeAs[x]		0..1		How to cite the recommendation Slice: Unordered, Open by type:$this
citeAsReference			Reference(Citation)
citeAsMarkdown			markdown
date	Σ	0..1	dateTime	Date last changed
copyright		0..1	markdown	Use and/or publishing restrictions
approvalDate		0..1	dateTime	When the artifact assessment was approved by publisher
lastReviewDate	Σ	0..1	dateTime	When the artifact assessment was last reviewed
Slices for artifact[x]	SΣ	1..1		The artifact assessed, commented upon or rated Slice: Unordered, Open by type:$this
artifactReference			Reference(PlanDefinition \| ActivityDefinition)
artifactCanonical			canonical(Any)
artifactUri			uri
content		0..*	BackboneElement	Comment, classifier, or rating content
id		0..1	id	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: EvidenceCertaintyType (example)
classifier		0..*	CodeableConcept	Rating, classifier, or assessment Binding: EvidenceCertaintyRating (example)
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
Documentation for this format

<!-- EBMRecommendation -->

<ArtifactAssessment xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <id value="[id]"/><!-- 0..1 Logical id of this artifact -->
 <meta><!--  0..1 Meta Metadata about the resource --></meta>
 <implicitRules value="[uri]"/><!--  0..1 A set of rules under which this content was created -->
 <language value="[code]"/><!--  0..1 Language of the resource content   -->
 <text><!--  0..1 Narrative 
     Text summary of the resource, for human interpretation --></text>
 <contained><!-- 0..* Resource 
     Contained, inline Resources --></contained>
 <modifierExtension><!--  0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
 <identifier><!--  0..* Identifier 
     Additional identifier for the artifact assessment --></identifier>
 <-- citeAs[x] sliced by type:$this  in the specified orderOpen-->
 <date value="[dateTime]"/><!--  0..1 Date last changed -->
 <copyright value="[markdown]"/><!--  0..1 Use and/or publishing restrictions -->
 <approvalDate value="[dateTime]"/><!--  0..1 When the artifact assessment was approved by publisher -->
 <lastReviewDate value="[dateTime]"/><!--  0..1 When the artifact assessment was last reviewed -->
 <-- artifact[x] sliced by type:$this  in the specified orderOpen-->
 <content>  0..* BackboneElement  <!--  0..* Comment, classifier, or rating content -->
  <modifierExtension><!--  0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <informationType value="[code]"/><!--  0..1 comment | classifier | rating | container | response | change-request    -->
  <summary value="[markdown]"/><!--  0..1 Brief summary of the content -->
  <type><!--  0..1 CodeableConcept What type of content   --></type>
  <classifier><!--  0..* CodeableConcept Rating, classifier, or assessment   --></classifier>
  <author><!--  0..1 Reference(Patient) 
      Who authored the content --></author>
  <path value="[uri]"/><!--  0..* What the comment is directed to -->
  <relatedArtifact><!--  0..* RelatedArtifact 
      Additional information --></relatedArtifact>
  <freeToShare value="[boolean]"/><!--  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]"/><!--  0..0 submitted | triaged | waiting-for-input | resolved-no-change | resolved-change-required | deferred | duplicate | applied | published    -->
 <disposition value="[code]"/><!--  0..0 unresolved | not-persuasive | persuasive | persuasive-with-modification | not-persuasive-with-modification    -->
</ArtifactAssessment>

{ // EBMRecommendation
  // from Element: extension
    "meta" : { Meta }, // C?Metadata about the resource
    "implicitRules" : "<uri>", // C?A set of rules under which this content was created
    "language" : "<code>", // C?Language of the resource content
    "text" : { Narrative }, // C?Text summary of the resource, for human interpretation
    "contained" : [{ Resource }], //Contained, inline Resources
    "modifierExtension" : [{ Extension }], // C?Extensions that cannot be ignored
    "identifier" : [{ Identifier }], // C?Additional identifier for the artifact assessment
    "citeAsReference" : [ //  sliced by type:$this  in the specified order, Open ]
    "date" : "<dateTime>", // C?Date last changed
    "copyright" : "<markdown>", // C?Use and/or publishing restrictions
    "approvalDate" : "<dateTime>", // C?When the artifact assessment was approved by publisher
    "lastReviewDate" : "<dateTime>", // C?When the artifact assessment was last reviewed
    "artifactReference" : [ //  sliced by type:$this  in the specified order, Open ]
    "content" : [{ BackboneElement }] // C?Comment, classifier, or rating content
  }

This structure is derived from ArtifactAssessment.

Summary

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

Differential View

This structure is derived from ArtifactAssessment.

Name	Flags	Card.	Type	Description & Constraints
ArtifactAssessment		1..1	ArtifactAssessment	Adds metadata-supported comments, classifiers or ratings related to a Resource
citeAs		0..1	Reference(Citation), markdown	How to cite the recommendation
artifact	S	1..1		The artifact assessed, commented upon or rated
artifact			Reference(PlanDefinition \| ActivityDefinition)
artifact			canonical(Any)
artifact			uri
workflowStatus		0..0
disposition		0..0
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
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: Common Languages (preferred) Max Binding: All Languages: IETF language tag
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
Slices for citeAs[x]		0..1		How to cite the recommendation Slice: Unordered, Open by type:$this
citeAsReference			Reference(Citation)
citeAsMarkdown			markdown
date	Σ	0..1	dateTime	Date last changed
copyright		0..1	markdown	Use and/or publishing restrictions
approvalDate		0..1	dateTime	When the artifact assessment was approved by publisher
lastReviewDate	Σ	0..1	dateTime	When the artifact assessment was last reviewed
Slices for artifact[x]	SΣ	1..1		The artifact assessed, commented upon or rated Slice: Unordered, Open by type:$this
artifactReference			Reference(PlanDefinition \| ActivityDefinition)
artifactCanonical			canonical(Any)
artifactUri			uri
content		0..*	BackboneElement	Comment, classifier, or rating content
id		0..1	id	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: EvidenceCertaintyType (example)
classifier		0..*	CodeableConcept	Rating, classifier, or assessment Binding: EvidenceCertaintyRating (example)
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
Documentation for this format

XML Template

<!-- EBMRecommendation -->

<ArtifactAssessment xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <id value="[id]"/><!-- 0..1 Logical id of this artifact -->
 <meta><!--  0..1 Meta Metadata about the resource --></meta>
 <implicitRules value="[uri]"/><!--  0..1 A set of rules under which this content was created -->
 <language value="[code]"/><!--  0..1 Language of the resource content   -->
 <text><!--  0..1 Narrative 
     Text summary of the resource, for human interpretation --></text>
 <contained><!-- 0..* Resource 
     Contained, inline Resources --></contained>
 <modifierExtension><!--  0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
 <identifier><!--  0..* Identifier 
     Additional identifier for the artifact assessment --></identifier>
 <-- citeAs[x] sliced by type:$this  in the specified orderOpen-->
 <date value="[dateTime]"/><!--  0..1 Date last changed -->
 <copyright value="[markdown]"/><!--  0..1 Use and/or publishing restrictions -->
 <approvalDate value="[dateTime]"/><!--  0..1 When the artifact assessment was approved by publisher -->
 <lastReviewDate value="[dateTime]"/><!--  0..1 When the artifact assessment was last reviewed -->
 <-- artifact[x] sliced by type:$this  in the specified orderOpen-->
 <content>  0..* BackboneElement  <!--  0..* Comment, classifier, or rating content -->
  <modifierExtension><!--  0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <informationType value="[code]"/><!--  0..1 comment | classifier | rating | container | response | change-request    -->
  <summary value="[markdown]"/><!--  0..1 Brief summary of the content -->
  <type><!--  0..1 CodeableConcept What type of content   --></type>
  <classifier><!--  0..* CodeableConcept Rating, classifier, or assessment   --></classifier>
  <author><!--  0..1 Reference(Patient) 
      Who authored the content --></author>
  <path value="[uri]"/><!--  0..* What the comment is directed to -->
  <relatedArtifact><!--  0..* RelatedArtifact 
      Additional information --></relatedArtifact>
  <freeToShare value="[boolean]"/><!--  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]"/><!--  0..0 submitted | triaged | waiting-for-input | resolved-no-change | resolved-change-required | deferred | duplicate | applied | published    -->
 <disposition value="[code]"/><!--  0..0 unresolved | not-persuasive | persuasive | persuasive-with-modification | not-persuasive-with-modification    -->
</ArtifactAssessment>

JSON Template

{ // EBMRecommendation
  // from Element: extension
    "meta" : { Meta }, // C?Metadata about the resource
    "implicitRules" : "<uri>", // C?A set of rules under which this content was created
    "language" : "<code>", // C?Language of the resource content
    "text" : { Narrative }, // C?Text summary of the resource, for human interpretation
    "contained" : [{ Resource }], //Contained, inline Resources
    "modifierExtension" : [{ Extension }], // C?Extensions that cannot be ignored
    "identifier" : [{ Identifier }], // C?Additional identifier for the artifact assessment
    "citeAsReference" : [ //  sliced by type:$this  in the specified order, Open ]
    "date" : "<dateTime>", // C?Date last changed
    "copyright" : "<markdown>", // C?Use and/or publishing restrictions
    "approvalDate" : "<dateTime>", // C?When the artifact assessment was approved by publisher
    "lastReviewDate" : "<dateTime>", // C?When the artifact assessment was last reviewed
    "artifactReference" : [ //  sliced by type:$this  in the specified order, Open ]
    "content" : [{ BackboneElement }] // C?Comment, classifier, or rating content
  }

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

14.8.11.2.2 Terminology Bindings

Path	Name	Conformance	ValueSet
ArtifactAssessment.language	Common Languages	preferred	Common Languages
ArtifactAssessment.content.informationType	Artifact Assessment Information Type	required	Artifact Assessment Information Type
ArtifactAssessment.content.type	EvidenceCertaintyType	example	EvidenceCertaintyType
ArtifactAssessment.content.classifier	EvidenceCertaintyRating	example	EvidenceCertaintyRating

.