This
page
is
part
of
the
FHIR
Specification
(v5.0.0:
R5
-
STU
v6.0.0-ballot1:
Release
6
Ballot
(1st
Draft)
(see
Ballot
Notes
).
This
is
the
The
current
published
version
in
it's
permanent
home
(it
will
always
be
available
at
this
URL).
is
5.0.0
.
For
a
full
list
of
available
versions,
see
the
Directory
of
published
versions
Clinical
Decision
Support
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+1100 as a draft by HL7.
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 | Flags | Card. | Type |
Description
&
Constraints
|
|---|---|---|---|---|
|
1..1 | ArtifactAssessment | Adds metadata-supported comments, classifiers or ratings related to a Resource | |
|
0..1 | Reference ( Citation ) , markdown | How to cite the recommendation | |
|
S | 1..1 | The artifact assessed, commented upon or rated | |
|
Reference ( PlanDefinition | ActivityDefinition ) | |||
|
canonical (Any) | |||
|
uri | |||
|
0 .. 0 | |||
|
0 .. 0 | |||
Documentation
for
this
format
|
||||
This provides the consolidated view (aka snapshot) of the profile after applying the changes in this profile to the base ArtifactAssessment structure.
| Name | Flags | Card. | Type |
Description
&
Constraints
|
||||
|---|---|---|---|---|---|---|---|---|
|
1..1 | ArtifactAssessment |
Adds
metadata-supported
comments,
classifiers
or
ratings
related
to
a
Resource
|
|||||
|
Σ | 0..1 | id | Logical id of this artifact | ||||
|
Σ | 0..1 | Meta | Metadata about the resource | ||||
|
?! Σ | 0..1 | uri | A set of rules under which this content was created | ||||
|
0..1 | code |
Language
of
the
resource
content
Binding: All Languages ( required ): IETF language tag for a human language
|
|||||
|
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
|
0..* | Resource |
Contained,
inline
Resources
|
|||||
|
0..* | Extension |
Additional
content
defined
by
implementations
|
|||||
|
?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
|
||||
|
Σ | 0..* | Identifier |
Additional
identifier
for
the
artifact
assessment
|
||||
|
Σ | 0..1 | string | A short title for the assessment for use in displaying and selecting | ||||
|
|
How
to
cite
the
recommendation
|
||||||
|
Reference ( Citation ) | |||||||
|
markdown | |||||||
|
Σ | 0..1 | dateTime | Date last changed | ||||
|
0..1 | markdown | Use and/or publishing restrictions | |||||
|
0..1 | date | When the artifact assessment was approved by publisher | |||||
|
Σ | 0..1 | date | When the artifact assessment was last reviewed by the publisher | ||||
|
S Σ |
|
The
artifact
assessed,
commented
upon
or
rated
|
|||||
|
Reference ( PlanDefinition | ActivityDefinition ) | |||||||
|
canonical (Any) | |||||||
|
uri | |||||||
|
0..* | BackboneElement |
Comment,
classifier,
or
rating
content
|
|||||
|
0..1 | string | Unique id for inter-element referencing | |||||
|
0..* | Extension |
Additional
content
defined
by
implementations
|
|||||
|
?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
||||
|
0..1 | code |
comment
|
classifier
|
rating
|
container
|
response
|
change-request
Binding: Artifact Assessment Information Type ( required ) |
|||||
|
0..1 | markdown | Brief summary of the content | |||||
|
0..1 | CodeableConcept |
What
type
of
content
Binding: Evidence Certainty Type ( example ) |
|||||
|
0..* | CodeableConcept |
Rating,
classifier,
or
assessment
Binding: Evidence Certainty Rating ( example ) |
|||||
|
0..1 | Quantity | Quantitative rating | |||||
|
0..1 | Reference ( Patient | Practitioner | PractitionerRole | Organization | Device ) | Who authored the content | |||||
|
0..* | uri |
What
the
comment
is
directed
to
|
|||||
|
0..* | RelatedArtifact |
Additional
information
|
|||||
|
0..1 | boolean | Acceptable to publicly share the resource content | |||||
|
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><!-- 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> <Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension> Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">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 --> <Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension> Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">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
"Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">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 .
Differential View
This indicates the differences between this profile and the base ArtifactAssessment structure.
| Name | Flags | Card. | Type |
Description
&
Constraints
|
|---|---|---|---|---|
|
1..1 | ArtifactAssessment | Adds metadata-supported comments, classifiers or ratings related to a Resource | |
|
0..1 | Reference ( Citation ) , markdown | How to cite the recommendation | |
|
S | 1..1 | The artifact assessed, commented upon or rated | |
|
Reference ( PlanDefinition | ActivityDefinition ) | |||
|
canonical (Any) | |||
|
uri | |||
|
0 .. 0 | |||
|
0 .. 0 | |||
Documentation
for
this
format
|
||||
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 | Flags | Card. | Type |
Description
&
Constraints
|
||||
|---|---|---|---|---|---|---|---|---|
|
1..1 | ArtifactAssessment |
Adds
metadata-supported
comments,
classifiers
or
ratings
related
to
a
Resource
|
|||||
|
Σ | 0..1 | id | Logical id of this artifact | ||||
|
Σ | 0..1 | Meta | Metadata about the resource | ||||
|
?! Σ | 0..1 | uri | A set of rules under which this content was created | ||||
|
0..1 | code |
Language
of
the
resource
content
Binding: All Languages ( required ): IETF language tag for a human language
|
|||||
|
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
|
0..* | Resource |
Contained,
inline
Resources
|
|||||
|
0..* | Extension |
Additional
content
defined
by
implementations
|
|||||
|
?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
|
||||
|
Σ | 0..* | Identifier |
Additional
identifier
for
the
artifact
assessment
|
||||
|
Σ | 0..1 | string | A short title for the assessment for use in displaying and selecting | ||||
|
|
How
to
cite
the
recommendation
|
||||||
|
Reference ( Citation ) | |||||||
|
markdown | |||||||
|
Σ | 0..1 | dateTime | Date last changed | ||||
|
0..1 | markdown | Use and/or publishing restrictions | |||||
|
0..1 | date | When the artifact assessment was approved by publisher | |||||
|
Σ | 0..1 | date | When the artifact assessment was last reviewed by the publisher | ||||
|
S Σ |
|
The
artifact
assessed,
commented
upon
or
rated
|
|||||
|
Reference ( PlanDefinition | ActivityDefinition ) | |||||||
|
canonical (Any) | |||||||
|
uri | |||||||
|
0..* | BackboneElement |
Comment,
classifier,
or
rating
content
|
|||||
|
0..1 | string | Unique id for inter-element referencing | |||||
|
0..* | Extension |
Additional
content
defined
by
implementations
|
|||||
|
?! Σ | 0..* | Extension |
Extensions
that
cannot
be
ignored
even
if
unrecognized
|
||||
|
0..1 | code |
comment
|
classifier
|
rating
|
container
|
response
|
change-request
Binding: Artifact Assessment Information Type ( required ) |
|||||
|
0..1 | markdown | Brief summary of the content | |||||
|
0..1 | CodeableConcept |
What
type
of
content
Binding: Evidence Certainty Type ( example ) |
|||||
|
0..* | CodeableConcept |
Rating,
classifier,
or
assessment
Binding: Evidence Certainty Rating ( example ) |
|||||
|
0..1 | Quantity | Quantitative rating | |||||
|
0..1 | Reference ( Patient | Practitioner | PractitionerRole | Organization | Device ) | Who authored the content | |||||
|
0..* | uri |
What
the
comment
is
directed
to
|
|||||
|
0..* | RelatedArtifact |
Additional
information
|
|||||
|
0..1 | boolean | Acceptable to publicly share the resource content | |||||
|
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><!-- 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> <Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension> Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">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 --> <Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension> Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">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
"Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">
Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">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
| 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 |