Release 4 R5 Final QA

This page is part of the FHIR Specification (v4.0.1: R4 (v5.0.0-draft-final: Final QA Preview for R5 - Mixed Normative and STU see ballot notes ) in it's permanent home (it will always be available at this URL). ). The current version which supercedes this version is 5.0.0 . For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B

14.8.11.2 StructureDefinition: EBMRecommendation

Clinical Decision Support icon Work Group   Maturity Level : N/A 0 Standards Status : Informative Trial Use Compartments Use Context : Device , Patient , Practitioner 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.

14.8.11.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 Flags Card. Type Description & Constraints doco
.. 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

doco Documentation for this format icon

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

ShEx statement
Name Flags Card. Type Description & Constraints doco
.. 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
... 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
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 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
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 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


# How the Quantity should be understood and represented.
fhirvs:quantity-comparator ["<" "<=" ">=" ">"]

<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>
 <# A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.
fhirvs:all-types ["Address" "Age" "Annotation" "Attachment" "BackboneElement" "CodeableConcept" "Coding" "ContactDetail" "ContactPoint" "Contributor" "Count" "DataRequirement" "Distance" "Dosage" "Duration" "Element" "ElementDefinition" "Expression" "Extension" "HumanName" "Identifier" "MarketingStatus" "Meta" "Money" "MoneyQuantity" "Narrative" "ParameterDefinition" "Period" "Population" "ProdCharacteristic" "ProductShelfLife" "Quantity" "Range" "Ratio" "Reference" "RelatedArtifact" "SampledData" "Signature" "SimpleQuantity" "SubstanceAmount" "Timing" "TriggerDefinition" "UsageContext" "base64Binary" "boolean" "canonical" "code" "date" "dateTime" "decimal" "id" "instant" "integer" "markdown" "oid" "positiveInt" "string" "time" "unsignedInt" "uri" "url" "uuid" "xhtml" "Account" "ActivityDefinition" "AdverseEvent" "AllergyIntolerance" "Appointment" "AppointmentResponse" "AuditEvent" "Basic" "Binary" "BiologicallyDerivedProduct" "BodyStructure" "Bundle" "CapabilityStatement" "CarePlan" "CareTeam" "CatalogEntry" "ChargeItem" "ChargeItemDefinition" "Claim" "ClaimResponse" "ClinicalImpression" "CodeSystem" "Communication" "CommunicationRequest" "CompartmentDefinition" "Composition" "ConceptMap" "Condition" "Consent" "Contract" "Coverage" "CoverageEligibilityRequest" "CoverageEligibilityResponse" "DetectedIssue" "Device" "DeviceDefinition" "DeviceMetric" "DeviceRequest" "DeviceUseStatement" "DiagnosticReport" "DocumentManifest" "DocumentReference" "DomainResource" "EffectEvidenceSynthesis" "Encounter" "Endpoint" "EnrollmentRequest" "EnrollmentResponse" "EpisodeOfCare" "EventDefinition" "Evidence" "EvidenceVariable" "ExampleScenario" "ExplanationOfBenefit" "FamilyMemberHistory" "Flag" "Goal" "GraphDefinition" "Group" "GuidanceResponse" "HealthcareService" "ImagingStudy" "Immunization" "ImmunizationEvaluation" "ImmunizationRecommendation" "ImplementationGuide" "InsurancePlan" "Invoice" "Library" "Linkage" "List" "Location" "Measure" "MeasureReport" "Media" "Medication" "MedicationAdministration" "MedicationDispense" "MedicationKnowledge" "MedicationRequest" "MedicationStatement" "MedicinalProduct" "MedicinalProductAuthorization" "MedicinalProductContraindication" "MedicinalProductIndication" "MedicinalProductIngredient" "MedicinalProductInteraction" "MedicinalProductManufactured" "MedicinalProductPackaged" "MedicinalProductPharmaceutical" "MedicinalProductUndesirableEffect" "MessageDefinition" "MessageHeader" "MolecularSequence" "NamingSystem" "NutritionOrder" "Observation" "ObservationDefinition" "OperationDefinition" "OperationOutcome" "Organization" "OrganizationAffiliation" "Parameters" "Patient" "PaymentNotice" "PaymentReconciliation" "Person" "PlanDefinition" "Practitioner" "PractitionerRole" "Procedure" "Provenance" "Questionnaire" "QuestionnaireResponse" "RelatedPerson" "RequestGroup" "ResearchDefinition" "ResearchElementDefinition" "ResearchStudy" "ResearchSubject" "Resource" "RiskAssessment" "RiskEvidenceSynthesis" "Schedule" "SearchParameter" "ServiceRequest" "Slot" "Specimen" "SpecimenDefinition" "StructureDefinition" "StructureMap" "Subscription" "Substance" "SubstanceNucleicAcid" "SubstancePolymer" "SubstanceProtein" "SubstanceReferenceInformation" "SubstanceSourceMaterial" "SubstanceSpecification" "SupplyDelivery" "SupplyRequest" "Task" "TerminologyCapabilities" "TestReport" "TestScript" "ValueSet" "VerificationResult" "VisionPrescription" "Type" "Any"]

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] sliced by type:$this  in the specified orderOpen-->

 <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] sliced by type:$this  in the specified orderOpen-->

 <content> I 0..* BackboneElement  <!-- I 0..* Comment, classifier, or rating content -->
  <# A unit of time (units from UCUM).
fhirvs:units-of-time ["s" "min" "h" "d" "wk" "mo" "a"]

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   -->
 <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">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
    "citeAsReference" : [ //  sliced by type:$this  in the specified order, Open ]
    "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
    "artifactReference" : [ //  sliced by type:$this  in the specified order, Open ]
    "content" : [{ BackboneElement }] // IComment, classifier, or rating content
  }

Usage note: every effort has been made 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 Flags Card. Type Description & Constraints doco
.. ArtifactAssessment 1..1 ArtifactAssessment Adds metadata-supported comments, classifiers or ratings related to ensure 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

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 Flags Card. Type Description & Constraints doco
.. 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
... 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 ShEx files are correct artifact assessment
... title Σ 0..1 string A short title for the assessment for use in displaying and useful, but they are not a normative part selecting
... 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 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
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 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 specification. 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] sliced by type:$this  in the specified orderOpen-->

 <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] sliced by type:$this  in the specified orderOpen-->

 <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   -->
 <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
    "citeAsReference" : [ //  sliced by type:$this  in the specified order, Open ]
    "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
    "artifactReference" : [ //  sliced by type:$this  in the specified order, Open ]
    "content" : [{ BackboneElement }] // IComment, classifier, or rating content
  }

 

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

14.8.11.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
. .