Release 5 Preview #3

14.10 Resource EvidenceReport - Content

Clinical Decision Support Work GroupMaturity Level: 0 Trial UseSecurity Category: Business Compartments: Not linked to any defined compartments

The EvidenceReport Resource is a specialized container for a collection of resources and codable concepts, adapted to support compositions of Evidence, EvidenceVariable, and Citation resources and related concepts.

An evidence report is a structured presentation of any combination of evidence and related concepts. Evidence reports may bundle knowledge related to a single study or citation, and may bundle knowledge spanning multiple related studies or citations. Publishing such reports are extensively used by researchers, scholars, and evaluators to advance scientific knowledge, to decide whether more research is needed, to inform policy, to determine whether the literature has reached consensus, to inform clinical decision support, to substantiate the decisions being recommended, and for many other uses.

The subject of the report defines its scope and can be expressed with one or more subject.characteristic elements (for structured definitions) or one or more subject.note elements (for human-readable expressions). Specifying a research question by the population, exposure, comparator, and outcome (PICO) could be expressed with four characteristics.

Evidence reports may be dynamic, changing as new evidence accrues. The relatesTo element supports coding the relationships between EvidenceReport Resources.

The content of the EvidenceReport Resource is contained in any number of sections that can each contain any number of sections. Each section can have its focus defined using a codeable concept or reference to another resource. Each section can have designated authors that can be distinct from authors for the EvidenceReport Resource.

The content in a section can be of different forms and can include text (which itself can be uniquely represented human-expressed content and/or machine-generated from other content), entryClassifier (to express codeable concepts), entryReference (to express other FHIR resources), entryReason (to represent empty sections as content), and section elements.

The EvidenceReport Resource is used for structured bundles and is not expected to replace simple lists or bundles where List and Bundle Resources can be used.

The EvidenceReport Resource is similar to a Composition Resource but the EvidenceReport is better suited for communicating reports about research and data analysis not specific to individual persons while the Composition Resource is better suited for healthcare related reports specific to individual persons as the subject.

The EvidenceReport Resource is used for data exchange for concepts beyond identification, location and contributor attribution. Where data exchange is limited to such things a Citation Resource may be used. An EvidenceReport Resource may reference a Citation Resource to itself in the citeAs element.

This resource is referenced by itself.

This resource does not implement any patterns.

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. EvidenceReport TUMetadataResourceA EvidenceReport
+ Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension, url, identifier, version, name, title, status, experimental, date, publisher, contact, description, useContext, jurisdiction, purpose, copyright, approvalDate, lastReviewDate, effectivePeriod
... url Σ0..1uriCanonical identifier for this EvidenceReport, represented as a globally unique URI
... status ?!Σ1..1codedraft | active | retired | unknown
PublicationStatus (Required)
... useContext Σ0..*UsageContextThe context that the content is intended to support
... relatedIdentifier Σ0..*IdentifierMay include trial registry identifiers
... citeAs 0..1Reference(Citation)Citation for this report
... type 0..1CodeableConceptKind of report
EvidenceReportType (Extensible)
... note 0..*AnnotationUsed for footnotes and annotations
... relatedArtifact 0..*RelatedArtifactLink, description or reference to artifact associated with the report
... subject Σ1..1BackboneElementFocus of the report
.... characteristic 0..*BackboneElementCharacteristic
..... code 1..1CodeableConceptCharacteristic code
FocusCharacteristicCode (Extensible)
..... value[x] 1..1Characteristic value
...... valueReferenceReference(Any)
...... valueCodeableConceptCodeableConcept
...... valueBooleanboolean
...... valueQuantityQuantity
...... valueRangeRange
..... exclude 0..1booleanIs used to express not the characteristic
..... period 0..1PeriodTimeframe for the characteristic
.... note 0..*AnnotationFootnotes and/or explanatory notes
... publisher Σ0..1stringName of the publisher (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... author Σ0..*ContactDetailWho authored the content
... editor 0..*ContactDetailWho edited the content
... reviewer 0..*ContactDetailWho reviewed the content
... endorser Σ0..*ContactDetailWho endorsed the content
... relatesTo 0..*BackboneElementRelationships to other compositions/documents
.... code 1..1codereplaces | amends | appends | transforms
ReportRelationshipType (Required)
.... target[x] 1..1Target of the relationship
..... targetIdentifierIdentifier
..... targetReferenceReference(EvidenceReport)
... section 0..*BackboneElementComposition is broken into sections
.... title 0..1stringLabel for section (e.g. for ToC)
.... focus 0..1CodeableConceptClassification of section (recommended)
ReportSectionType (Extensible)
.... focusReference 0..1Reference(Any)Classification of section by Resource
.... author 0..*Reference(Person | Device | Group | Organization)Who and/or what authored the section
.... text 0..1NarrativeText summary of the section, for human interpretation
.... mode 0..1codeworking | snapshot | changes
ListMode (Required)
.... orderedBy 0..1CodeableConceptOrder of section entries
List Order Codes (Preferred)
.... entryClassifier 0..*CodeableConceptExtensible classifiers
EvidenceClassifier (Extensible)
.... entryReference 0..*Reference(Any)A reference to data that supports this section
.... emptyReason 0..1CodeableConceptWhy the section is empty
List Empty Reasons (Preferred)
.... section 0..*see sectionNested Section

doco Documentation for this format

UML Diagram (Legend)

EvidenceReport (MetadataResource)An absolute URI that is used to identify this EvidenceReport when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this summary is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the summary is stored on different serversurl : uri [0..1]The status of this summary. Enables tracking the life-cycle of the content (this element modifies the meaning of other elements)status : code [1..1] « The lifecycle status of an artifact. (Strength=Required)PublicationStatus! »The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate evidence report instancesuseContext : UsageContext [0..*]A formal identifier that is used to identify this EvidenceReport when it is represented in other formats, or referenced in a specification, model, design or an instanceidentifier : Identifier [0..*]A formal identifier that is used to identify things closely related to this EvidenceReportrelatedIdentifier : Identifier [0..*]Citation Resource or display of suggested citation for this reportciteAs : Reference [0..1] « Citation »Specifies the kind of report, such as grouping of classifiers, search results, or human-compiled expressiontype : CodeableConcept [0..1] « The kind of report, such as grouping of classifiers, search results, or human-compiled expression. (Strength=Extensible)EvidenceReportType+ »Used for footnotes and annotationsnote : Annotation [0..*]Link, description or reference to artifact associated with the reportrelatedArtifact : RelatedArtifact [0..*]The name of the organization or individual that published the evidence reportpublisher : string [0..1]Contact details to assist a user in finding and communicating with the publishercontact : ContactDetail [0..*]An individiual, organization, or device primarily involved in the creation and maintenance of the contentauthor : ContactDetail [0..*]An individiual, organization, or device primarily responsible for internal coherence of the contenteditor : ContactDetail [0..*]An individiual, organization, or device primarily responsible for review of some aspect of the contentreviewer : ContactDetail [0..*]An individiual, organization, or device responsible for officially endorsing the content for use in some settingendorser : ContactDetail [0..*]SubjectUsed for general notes and annotations not coded elsewherenote : Annotation [0..*]CharacteristicCharacteristic codecode : CodeableConcept [1..1] « Evidence focus characteristic code. (Strength=Extensible)FocusCharacteristicCode+ »Characteristic valuevalue[x] : DataType [1..1] « Reference(Any)|CodeableConcept|boolean| Quantity|Range »Is used to express not the characteristicexclude : boolean [0..1]Timeframe for the characteristicperiod : Period [0..1]RelatesToThe type of relationship that this composition has with anther composition or documentcode : code [1..1] « The type of relationship between reports. (Strength=Required)ReportRelationshipType! »The target composition/document of this relationshiptarget[x] : DataType [1..1] « Identifier|Reference(EvidenceReport) »SectionThe label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contentstitle : string [0..1]A code identifying the kind of content contained within the section. This should be consistent with the section titlefocus : CodeableConcept [0..1] « Evidence Report Section Type. (Strength=Extensible)ReportSectionType+ »A definitional Resource identifying the kind of content contained within the section. This should be consistent with the section titlefocusReference : Reference [0..1] « Any »Identifies who is responsible for the information in this section, not necessarily who typed it inauthor : Reference [0..*] « Person|Device|Group|Organization »A human-readable narrative that contains the attested content of the section, used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is peferred to contain sufficient detail to make it acceptable for a human to just read the narrativetext : Narrative [0..1]How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deletedmode : code [0..1] « The processing mode that applies to this section. (Strength=Required)ListMode! »Specifies the order applied to the items in the section entriesorderedBy : CodeableConcept [0..1] « What order applies to the items in the entry. (Strength=Preferred)ListOrderCodes? »Specifies any type of classification of the evidence reportentryClassifier : CodeableConcept [0..*] « Commonly used classifiers for evidence sets. (Strength=Extensible)EvidenceClassifier+ »A reference to the actual resource from which the narrative in the section is derivedentryReference : Reference [0..*] « Any »If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reasonemptyReason : CodeableConcept [0..1] « If a section is empty, why it is empty. (Strength=Preferred)ListEmptyReasons? »Characteristiccharacteristic[0..*]Specifies the subject or focus of the report. Answers "What is this report about?"subject[1..1]Relationships that this composition has with other compositions or documents that already existrelatesTo[0..*]A nested sub-section within this sectionsection[0..*]The root of the sections that make up the compositionsection[0..*]

XML Template

<EvidenceReport xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <url value="[uri]"/><!-- 0..1 Canonical identifier for this EvidenceReport, represented as a globally unique URI -->
 <status value="[code]"/><!-- 1..1 draft | active | retired | unknown -->
 <useContext><!-- 0..* UsageContext The context that the content is intended to support --></useContext>
 <identifier><!-- 0..* Identifier May include DOI, PMID, PMCID, etc. --></identifier>
 <relatedIdentifier><!-- 0..* Identifier May include trial registry identifiers --></relatedIdentifier>
 <citeAs><!-- 0..1 Reference(Citation) Citation for this report --></citeAs>
 <type><!-- 0..1 CodeableConcept Kind of report --></type>
 <note><!-- 0..* Annotation Used for footnotes and annotations --></note>
 <relatedArtifact><!-- 0..* RelatedArtifact Link, description or reference to artifact associated with the report --></relatedArtifact>
 <subject>  <!-- 1..1 Focus of the report -->
  <characteristic>  <!-- 0..* Characteristic -->
   <code><!-- 1..1 CodeableConcept Characteristic code --></code>
   <value[x]><!-- 1..1 Reference(Any)|CodeableConcept|boolean|Quantity|Range Characteristic value --></value[x]>
   <exclude value="[boolean]"/><!-- 0..1 Is used to express not the characteristic -->
   <period><!-- 0..1 Period Timeframe for the characteristic --></period>
  </characteristic>
  <note><!-- 0..* Annotation Footnotes and/or explanatory notes --></note>
 </subject>
 <publisher value="[string]"/><!-- 0..1 Name of the publisher (organization or individual) -->
 <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact>
 <author><!-- 0..* ContactDetail Who authored the content --></author>
 <editor><!-- 0..* ContactDetail Who edited the content --></editor>
 <reviewer><!-- 0..* ContactDetail Who reviewed the content --></reviewer>
 <endorser><!-- 0..* ContactDetail Who endorsed the content --></endorser>
 <relatesTo>  <!-- 0..* Relationships to other compositions/documents -->
  <code value="[code]"/><!-- 1..1 replaces | amends | appends | transforms -->
  <target[x]><!-- 1..1 Identifier|Reference(EvidenceReport) Target of the relationship --></target[x]>
 </relatesTo>
 <section>  <!-- 0..* Composition is broken into sections -->
  <title value="[string]"/><!-- 0..1 Label for section (e.g. for ToC) -->
  <focus><!-- 0..1 CodeableConcept Classification of section (recommended) --></focus>
  <focusReference><!-- 0..1 Reference(Any) Classification of section by Resource --></focusReference>
  <author><!-- 0..* Reference(Device|Group|Organization|Person) Who and/or what authored the section --></author>
  <text><!-- 0..1 Narrative Text summary of the section, for human interpretation --></text>
  <mode value="[code]"/><!-- 0..1 working | snapshot | changes -->
  <orderedBy><!-- 0..1 CodeableConcept Order of section entries --></orderedBy>
  <entryClassifier><!-- 0..* CodeableConcept Extensible classifiers --></entryClassifier>
  <entryReference><!-- 0..* Reference(Any) A reference to data that supports this section --></entryReference>
  <emptyReason><!-- 0..1 CodeableConcept Why the section is empty --></emptyReason>
  <section><!-- 0..* Content as for EvidenceReport.section Nested Section --></section>
 </section>
</EvidenceReport>

JSON Template

{doco
  "resourceType" : "EvidenceReport",
  // from Resource: id, meta, implicitRules, and language
  "url" : "<uri>", // Canonical identifier for this EvidenceReport, represented as a globally unique URI
  "status" : "<code>", // R!  draft | active | retired | unknown
  "useContext" : [{ UsageContext }], // The context that the content is intended to support
  "identifier" : [{ Identifier }], // May include DOI, PMID, PMCID, etc.
  "relatedIdentifier" : [{ Identifier }], // May include trial registry identifiers
  "citeAs" : { Reference(Citation) }, // Citation for this report
  "type" : { CodeableConcept }, // Kind of report
  "note" : [{ Annotation }], // Used for footnotes and annotations
  "relatedArtifact" : [{ RelatedArtifact }], // Link, description or reference to artifact associated with the report
  "subject" : { // R!  Focus of the report
    "characteristic" : [{ // Characteristic
      "code" : { CodeableConcept }, // R!  Characteristic code
      // value[x]: Characteristic value. One of these 5:
      "valueReference" : { Reference(Any) },
      "valueCodeableConcept" : { CodeableConcept },
      "valueBoolean" : <boolean>,
      "valueQuantity" : { Quantity },
      "valueRange" : { Range },
      "exclude" : <boolean>, // Is used to express not the characteristic
      "period" : { Period } // Timeframe for the characteristic
    }],
    "note" : [{ Annotation }] // Footnotes and/or explanatory notes
  },
  "publisher" : "<string>", // Name of the publisher (organization or individual)
  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "author" : [{ ContactDetail }], // Who authored the content
  "editor" : [{ ContactDetail }], // Who edited the content
  "reviewer" : [{ ContactDetail }], // Who reviewed the content
  "endorser" : [{ ContactDetail }], // Who endorsed the content
  "relatesTo" : [{ // Relationships to other compositions/documents
    "code" : "<code>", // R!  replaces | amends | appends | transforms
    // target[x]: Target of the relationship. One of these 2:
    "targetIdentifier" : { Identifier }
    "targetReference" : { Reference(EvidenceReport) }
  }],
  "section" : [{ // Composition is broken into sections
    "title" : "<string>", // Label for section (e.g. for ToC)
    "focus" : { CodeableConcept }, // Classification of section (recommended)
    "focusReference" : { Reference(Any) }, // Classification of section by Resource
    "author" : [{ Reference(Device|Group|Organization|Person) }], // Who and/or what authored the section
    "text" : { Narrative }, // Text summary of the section, for human interpretation
    "mode" : "<code>", // working | snapshot | changes
    "orderedBy" : { CodeableConcept }, // Order of section entries
    "entryClassifier" : [{ CodeableConcept }], // Extensible classifiers
    "entryReference" : [{ Reference(Any) }], // A reference to data that supports this section
    "emptyReason" : { CodeableConcept }, // Why the section is empty
    "section" : [{ Content as for EvidenceReport.section }] // Nested Section
  }]
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:EvidenceReport;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  fhir:EvidenceReport.url [ uri ]; # 0..1 Canonical identifier for this EvidenceReport, represented as a globally unique URI
  fhir:EvidenceReport.status [ code ]; # 1..1 draft | active | retired | unknown
  fhir:EvidenceReport.useContext [ UsageContext ], ... ; # 0..* The context that the content is intended to support
  fhir:EvidenceReport.identifier [ Identifier ], ... ; # 0..* May include DOI, PMID, PMCID, etc.
  fhir:EvidenceReport.relatedIdentifier [ Identifier ], ... ; # 0..* May include trial registry identifiers
  fhir:EvidenceReport.citeAs [ Reference(Citation) ]; # 0..1 Citation for this report
  fhir:EvidenceReport.type [ CodeableConcept ]; # 0..1 Kind of report
  fhir:EvidenceReport.note [ Annotation ], ... ; # 0..* Used for footnotes and annotations
  fhir:EvidenceReport.relatedArtifact [ RelatedArtifact ], ... ; # 0..* Link, description or reference to artifact associated with the report
  fhir:EvidenceReport.subject [ # 1..1 Focus of the report
    fhir:EvidenceReport.subject.characteristic [ # 0..* Characteristic
      fhir:EvidenceReport.subject.characteristic.code [ CodeableConcept ]; # 1..1 Characteristic code
      # EvidenceReport.subject.characteristic.value[x] : 1..1 Characteristic value. One of these 5
        fhir:EvidenceReport.subject.characteristic.valueReference [ Reference(Any) ]
        fhir:EvidenceReport.subject.characteristic.valueCodeableConcept [ CodeableConcept ]
        fhir:EvidenceReport.subject.characteristic.valueBoolean [ boolean ]
        fhir:EvidenceReport.subject.characteristic.valueQuantity [ Quantity ]
        fhir:EvidenceReport.subject.characteristic.valueRange [ Range ]
      fhir:EvidenceReport.subject.characteristic.exclude [ boolean ]; # 0..1 Is used to express not the characteristic
      fhir:EvidenceReport.subject.characteristic.period [ Period ]; # 0..1 Timeframe for the characteristic
    ], ...;
    fhir:EvidenceReport.subject.note [ Annotation ], ... ; # 0..* Footnotes and/or explanatory notes
  ];
  fhir:EvidenceReport.publisher [ string ]; # 0..1 Name of the publisher (organization or individual)
  fhir:EvidenceReport.contact [ ContactDetail ], ... ; # 0..* Contact details for the publisher
  fhir:EvidenceReport.author [ ContactDetail ], ... ; # 0..* Who authored the content
  fhir:EvidenceReport.editor [ ContactDetail ], ... ; # 0..* Who edited the content
  fhir:EvidenceReport.reviewer [ ContactDetail ], ... ; # 0..* Who reviewed the content
  fhir:EvidenceReport.endorser [ ContactDetail ], ... ; # 0..* Who endorsed the content
  fhir:EvidenceReport.relatesTo [ # 0..* Relationships to other compositions/documents
    fhir:EvidenceReport.relatesTo.code [ code ]; # 1..1 replaces | amends | appends | transforms
    # EvidenceReport.relatesTo.target[x] : 1..1 Target of the relationship. One of these 2
      fhir:EvidenceReport.relatesTo.targetIdentifier [ Identifier ]
      fhir:EvidenceReport.relatesTo.targetReference [ Reference(EvidenceReport) ]
  ], ...;
  fhir:EvidenceReport.section [ # 0..* Composition is broken into sections
    fhir:EvidenceReport.section.title [ string ]; # 0..1 Label for section (e.g. for ToC)
    fhir:EvidenceReport.section.focus [ CodeableConcept ]; # 0..1 Classification of section (recommended)
    fhir:EvidenceReport.section.focusReference [ Reference(Any) ]; # 0..1 Classification of section by Resource
    fhir:EvidenceReport.section.author [ Reference(Device|Group|Organization|Person) ], ... ; # 0..* Who and/or what authored the section
    fhir:EvidenceReport.section.text [ Narrative ]; # 0..1 Text summary of the section, for human interpretation
    fhir:EvidenceReport.section.mode [ code ]; # 0..1 working | snapshot | changes
    fhir:EvidenceReport.section.orderedBy [ CodeableConcept ]; # 0..1 Order of section entries
    fhir:EvidenceReport.section.entryClassifier [ CodeableConcept ], ... ; # 0..* Extensible classifiers
    fhir:EvidenceReport.section.entryReference [ Reference(Any) ], ... ; # 0..* A reference to data that supports this section
    fhir:EvidenceReport.section.emptyReason [ CodeableConcept ]; # 0..1 Why the section is empty
    fhir:EvidenceReport.section.section [ See EvidenceReport.section ], ... ; # 0..* Nested Section
  ], ...;
]

Changes since R3

This resource did not exist in Release 2

This analysis is available as XML or JSON.

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. EvidenceReport TUMetadataResourceA EvidenceReport
+ Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension, url, identifier, version, name, title, status, experimental, date, publisher, contact, description, useContext, jurisdiction, purpose, copyright, approvalDate, lastReviewDate, effectivePeriod
... url Σ0..1uriCanonical identifier for this EvidenceReport, represented as a globally unique URI
... status ?!Σ1..1codedraft | active | retired | unknown
PublicationStatus (Required)
... useContext Σ0..*UsageContextThe context that the content is intended to support
... relatedIdentifier Σ0..*IdentifierMay include trial registry identifiers
... citeAs 0..1Reference(Citation)Citation for this report
... type 0..1CodeableConceptKind of report
EvidenceReportType (Extensible)
... note 0..*AnnotationUsed for footnotes and annotations
... relatedArtifact 0..*RelatedArtifactLink, description or reference to artifact associated with the report
... subject Σ1..1BackboneElementFocus of the report
.... characteristic 0..*BackboneElementCharacteristic
..... code 1..1CodeableConceptCharacteristic code
FocusCharacteristicCode (Extensible)
..... value[x] 1..1Characteristic value
...... valueReferenceReference(Any)
...... valueCodeableConceptCodeableConcept
...... valueBooleanboolean
...... valueQuantityQuantity
...... valueRangeRange
..... exclude 0..1booleanIs used to express not the characteristic
..... period 0..1PeriodTimeframe for the characteristic
.... note 0..*AnnotationFootnotes and/or explanatory notes
... publisher Σ0..1stringName of the publisher (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... author Σ0..*ContactDetailWho authored the content
... editor 0..*ContactDetailWho edited the content
... reviewer 0..*ContactDetailWho reviewed the content
... endorser Σ0..*ContactDetailWho endorsed the content
... relatesTo 0..*BackboneElementRelationships to other compositions/documents
.... code 1..1codereplaces | amends | appends | transforms
ReportRelationshipType (Required)
.... target[x] 1..1Target of the relationship
..... targetIdentifierIdentifier
..... targetReferenceReference(EvidenceReport)
... section 0..*BackboneElementComposition is broken into sections
.... title 0..1stringLabel for section (e.g. for ToC)
.... focus 0..1CodeableConceptClassification of section (recommended)
ReportSectionType (Extensible)
.... focusReference 0..1Reference(Any)Classification of section by Resource
.... author 0..*Reference(Person | Device | Group | Organization)Who and/or what authored the section
.... text 0..1NarrativeText summary of the section, for human interpretation
.... mode 0..1codeworking | snapshot | changes
ListMode (Required)
.... orderedBy 0..1CodeableConceptOrder of section entries
List Order Codes (Preferred)
.... entryClassifier 0..*CodeableConceptExtensible classifiers
EvidenceClassifier (Extensible)
.... entryReference 0..*Reference(Any)A reference to data that supports this section
.... emptyReason 0..1CodeableConceptWhy the section is empty
List Empty Reasons (Preferred)
.... section 0..*see sectionNested Section

doco Documentation for this format

UML Diagram (Legend)

EvidenceReport (MetadataResource)An absolute URI that is used to identify this EvidenceReport when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this summary is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the summary is stored on different serversurl : uri [0..1]The status of this summary. Enables tracking the life-cycle of the content (this element modifies the meaning of other elements)status : code [1..1] « The lifecycle status of an artifact. (Strength=Required)PublicationStatus! »The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate evidence report instancesuseContext : UsageContext [0..*]A formal identifier that is used to identify this EvidenceReport when it is represented in other formats, or referenced in a specification, model, design or an instanceidentifier : Identifier [0..*]A formal identifier that is used to identify things closely related to this EvidenceReportrelatedIdentifier : Identifier [0..*]Citation Resource or display of suggested citation for this reportciteAs : Reference [0..1] « Citation »Specifies the kind of report, such as grouping of classifiers, search results, or human-compiled expressiontype : CodeableConcept [0..1] « The kind of report, such as grouping of classifiers, search results, or human-compiled expression. (Strength=Extensible)EvidenceReportType+ »Used for footnotes and annotationsnote : Annotation [0..*]Link, description or reference to artifact associated with the reportrelatedArtifact : RelatedArtifact [0..*]The name of the organization or individual that published the evidence reportpublisher : string [0..1]Contact details to assist a user in finding and communicating with the publishercontact : ContactDetail [0..*]An individiual, organization, or device primarily involved in the creation and maintenance of the contentauthor : ContactDetail [0..*]An individiual, organization, or device primarily responsible for internal coherence of the contenteditor : ContactDetail [0..*]An individiual, organization, or device primarily responsible for review of some aspect of the contentreviewer : ContactDetail [0..*]An individiual, organization, or device responsible for officially endorsing the content for use in some settingendorser : ContactDetail [0..*]SubjectUsed for general notes and annotations not coded elsewherenote : Annotation [0..*]CharacteristicCharacteristic codecode : CodeableConcept [1..1] « Evidence focus characteristic code. (Strength=Extensible)FocusCharacteristicCode+ »Characteristic valuevalue[x] : DataType [1..1] « Reference(Any)|CodeableConcept|boolean| Quantity|Range »Is used to express not the characteristicexclude : boolean [0..1]Timeframe for the characteristicperiod : Period [0..1]RelatesToThe type of relationship that this composition has with anther composition or documentcode : code [1..1] « The type of relationship between reports. (Strength=Required)ReportRelationshipType! »The target composition/document of this relationshiptarget[x] : DataType [1..1] « Identifier|Reference(EvidenceReport) »SectionThe label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contentstitle : string [0..1]A code identifying the kind of content contained within the section. This should be consistent with the section titlefocus : CodeableConcept [0..1] « Evidence Report Section Type. (Strength=Extensible)ReportSectionType+ »A definitional Resource identifying the kind of content contained within the section. This should be consistent with the section titlefocusReference : Reference [0..1] « Any »Identifies who is responsible for the information in this section, not necessarily who typed it inauthor : Reference [0..*] « Person|Device|Group|Organization »A human-readable narrative that contains the attested content of the section, used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is peferred to contain sufficient detail to make it acceptable for a human to just read the narrativetext : Narrative [0..1]How the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deletedmode : code [0..1] « The processing mode that applies to this section. (Strength=Required)ListMode! »Specifies the order applied to the items in the section entriesorderedBy : CodeableConcept [0..1] « What order applies to the items in the entry. (Strength=Preferred)ListOrderCodes? »Specifies any type of classification of the evidence reportentryClassifier : CodeableConcept [0..*] « Commonly used classifiers for evidence sets. (Strength=Extensible)EvidenceClassifier+ »A reference to the actual resource from which the narrative in the section is derivedentryReference : Reference [0..*] « Any »If the section is empty, why the list is empty. An empty section typically has some text explaining the empty reasonemptyReason : CodeableConcept [0..1] « If a section is empty, why it is empty. (Strength=Preferred)ListEmptyReasons? »Characteristiccharacteristic[0..*]Specifies the subject or focus of the report. Answers "What is this report about?"subject[1..1]Relationships that this composition has with other compositions or documents that already existrelatesTo[0..*]A nested sub-section within this sectionsection[0..*]The root of the sections that make up the compositionsection[0..*]

XML Template

<EvidenceReport xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <url value="[uri]"/><!-- 0..1 Canonical identifier for this EvidenceReport, represented as a globally unique URI -->
 <status value="[code]"/><!-- 1..1 draft | active | retired | unknown -->
 <useContext><!-- 0..* UsageContext The context that the content is intended to support --></useContext>
 <identifier><!-- 0..* Identifier May include DOI, PMID, PMCID, etc. --></identifier>
 <relatedIdentifier><!-- 0..* Identifier May include trial registry identifiers --></relatedIdentifier>
 <citeAs><!-- 0..1 Reference(Citation) Citation for this report --></citeAs>
 <type><!-- 0..1 CodeableConcept Kind of report --></type>
 <note><!-- 0..* Annotation Used for footnotes and annotations --></note>
 <relatedArtifact><!-- 0..* RelatedArtifact Link, description or reference to artifact associated with the report --></relatedArtifact>
 <subject>  <!-- 1..1 Focus of the report -->
  <characteristic>  <!-- 0..* Characteristic -->
   <code><!-- 1..1 CodeableConcept Characteristic code --></code>
   <value[x]><!-- 1..1 Reference(Any)|CodeableConcept|boolean|Quantity|Range Characteristic value --></value[x]>
   <exclude value="[boolean]"/><!-- 0..1 Is used to express not the characteristic -->
   <period><!-- 0..1 Period Timeframe for the characteristic --></period>
  </characteristic>
  <note><!-- 0..* Annotation Footnotes and/or explanatory notes --></note>
 </subject>
 <publisher value="[string]"/><!-- 0..1 Name of the publisher (organization or individual) -->
 <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact>
 <author><!-- 0..* ContactDetail Who authored the content --></author>
 <editor><!-- 0..* ContactDetail Who edited the content --></editor>
 <reviewer><!-- 0..* ContactDetail Who reviewed the content --></reviewer>
 <endorser><!-- 0..* ContactDetail Who endorsed the content --></endorser>
 <relatesTo>  <!-- 0..* Relationships to other compositions/documents -->
  <code value="[code]"/><!-- 1..1 replaces | amends | appends | transforms -->
  <target[x]><!-- 1..1 Identifier|Reference(EvidenceReport) Target of the relationship --></target[x]>
 </relatesTo>
 <section>  <!-- 0..* Composition is broken into sections -->
  <title value="[string]"/><!-- 0..1 Label for section (e.g. for ToC) -->
  <focus><!-- 0..1 CodeableConcept Classification of section (recommended) --></focus>
  <focusReference><!-- 0..1 Reference(Any) Classification of section by Resource --></focusReference>
  <author><!-- 0..* Reference(Device|Group|Organization|Person) Who and/or what authored the section --></author>
  <text><!-- 0..1 Narrative Text summary of the section, for human interpretation --></text>
  <mode value="[code]"/><!-- 0..1 working | snapshot | changes -->
  <orderedBy><!-- 0..1 CodeableConcept Order of section entries --></orderedBy>
  <entryClassifier><!-- 0..* CodeableConcept Extensible classifiers --></entryClassifier>
  <entryReference><!-- 0..* Reference(Any) A reference to data that supports this section --></entryReference>
  <emptyReason><!-- 0..1 CodeableConcept Why the section is empty --></emptyReason>
  <section><!-- 0..* Content as for EvidenceReport.section Nested Section --></section>
 </section>
</EvidenceReport>

JSON Template

{doco
  "resourceType" : "EvidenceReport",
  // from Resource: id, meta, implicitRules, and language
  "url" : "<uri>", // Canonical identifier for this EvidenceReport, represented as a globally unique URI
  "status" : "<code>", // R!  draft | active | retired | unknown
  "useContext" : [{ UsageContext }], // The context that the content is intended to support
  "identifier" : [{ Identifier }], // May include DOI, PMID, PMCID, etc.
  "relatedIdentifier" : [{ Identifier }], // May include trial registry identifiers
  "citeAs" : { Reference(Citation) }, // Citation for this report
  "type" : { CodeableConcept }, // Kind of report
  "note" : [{ Annotation }], // Used for footnotes and annotations
  "relatedArtifact" : [{ RelatedArtifact }], // Link, description or reference to artifact associated with the report
  "subject" : { // R!  Focus of the report
    "characteristic" : [{ // Characteristic
      "code" : { CodeableConcept }, // R!  Characteristic code
      // value[x]: Characteristic value. One of these 5:
      "valueReference" : { Reference(Any) },
      "valueCodeableConcept" : { CodeableConcept },
      "valueBoolean" : <boolean>,
      "valueQuantity" : { Quantity },
      "valueRange" : { Range },
      "exclude" : <boolean>, // Is used to express not the characteristic
      "period" : { Period } // Timeframe for the characteristic
    }],
    "note" : [{ Annotation }] // Footnotes and/or explanatory notes
  },
  "publisher" : "<string>", // Name of the publisher (organization or individual)
  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "author" : [{ ContactDetail }], // Who authored the content
  "editor" : [{ ContactDetail }], // Who edited the content
  "reviewer" : [{ ContactDetail }], // Who reviewed the content
  "endorser" : [{ ContactDetail }], // Who endorsed the content
  "relatesTo" : [{ // Relationships to other compositions/documents
    "code" : "<code>", // R!  replaces | amends | appends | transforms
    // target[x]: Target of the relationship. One of these 2:
    "targetIdentifier" : { Identifier }
    "targetReference" : { Reference(EvidenceReport) }
  }],
  "section" : [{ // Composition is broken into sections
    "title" : "<string>", // Label for section (e.g. for ToC)
    "focus" : { CodeableConcept }, // Classification of section (recommended)
    "focusReference" : { Reference(Any) }, // Classification of section by Resource
    "author" : [{ Reference(Device|Group|Organization|Person) }], // Who and/or what authored the section
    "text" : { Narrative }, // Text summary of the section, for human interpretation
    "mode" : "<code>", // working | snapshot | changes
    "orderedBy" : { CodeableConcept }, // Order of section entries
    "entryClassifier" : [{ CodeableConcept }], // Extensible classifiers
    "entryReference" : [{ Reference(Any) }], // A reference to data that supports this section
    "emptyReason" : { CodeableConcept }, // Why the section is empty
    "section" : [{ Content as for EvidenceReport.section }] // Nested Section
  }]
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:EvidenceReport;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  fhir:EvidenceReport.url [ uri ]; # 0..1 Canonical identifier for this EvidenceReport, represented as a globally unique URI
  fhir:EvidenceReport.status [ code ]; # 1..1 draft | active | retired | unknown
  fhir:EvidenceReport.useContext [ UsageContext ], ... ; # 0..* The context that the content is intended to support
  fhir:EvidenceReport.identifier [ Identifier ], ... ; # 0..* May include DOI, PMID, PMCID, etc.
  fhir:EvidenceReport.relatedIdentifier [ Identifier ], ... ; # 0..* May include trial registry identifiers
  fhir:EvidenceReport.citeAs [ Reference(Citation) ]; # 0..1 Citation for this report
  fhir:EvidenceReport.type [ CodeableConcept ]; # 0..1 Kind of report
  fhir:EvidenceReport.note [ Annotation ], ... ; # 0..* Used for footnotes and annotations
  fhir:EvidenceReport.relatedArtifact [ RelatedArtifact ], ... ; # 0..* Link, description or reference to artifact associated with the report
  fhir:EvidenceReport.subject [ # 1..1 Focus of the report
    fhir:EvidenceReport.subject.characteristic [ # 0..* Characteristic
      fhir:EvidenceReport.subject.characteristic.code [ CodeableConcept ]; # 1..1 Characteristic code
      # EvidenceReport.subject.characteristic.value[x] : 1..1 Characteristic value. One of these 5
        fhir:EvidenceReport.subject.characteristic.valueReference [ Reference(Any) ]
        fhir:EvidenceReport.subject.characteristic.valueCodeableConcept [ CodeableConcept ]
        fhir:EvidenceReport.subject.characteristic.valueBoolean [ boolean ]
        fhir:EvidenceReport.subject.characteristic.valueQuantity [ Quantity ]
        fhir:EvidenceReport.subject.characteristic.valueRange [ Range ]
      fhir:EvidenceReport.subject.characteristic.exclude [ boolean ]; # 0..1 Is used to express not the characteristic
      fhir:EvidenceReport.subject.characteristic.period [ Period ]; # 0..1 Timeframe for the characteristic
    ], ...;
    fhir:EvidenceReport.subject.note [ Annotation ], ... ; # 0..* Footnotes and/or explanatory notes
  ];
  fhir:EvidenceReport.publisher [ string ]; # 0..1 Name of the publisher (organization or individual)
  fhir:EvidenceReport.contact [ ContactDetail ], ... ; # 0..* Contact details for the publisher
  fhir:EvidenceReport.author [ ContactDetail ], ... ; # 0..* Who authored the content
  fhir:EvidenceReport.editor [ ContactDetail ], ... ; # 0..* Who edited the content
  fhir:EvidenceReport.reviewer [ ContactDetail ], ... ; # 0..* Who reviewed the content
  fhir:EvidenceReport.endorser [ ContactDetail ], ... ; # 0..* Who endorsed the content
  fhir:EvidenceReport.relatesTo [ # 0..* Relationships to other compositions/documents
    fhir:EvidenceReport.relatesTo.code [ code ]; # 1..1 replaces | amends | appends | transforms
    # EvidenceReport.relatesTo.target[x] : 1..1 Target of the relationship. One of these 2
      fhir:EvidenceReport.relatesTo.targetIdentifier [ Identifier ]
      fhir:EvidenceReport.relatesTo.targetReference [ Reference(EvidenceReport) ]
  ], ...;
  fhir:EvidenceReport.section [ # 0..* Composition is broken into sections
    fhir:EvidenceReport.section.title [ string ]; # 0..1 Label for section (e.g. for ToC)
    fhir:EvidenceReport.section.focus [ CodeableConcept ]; # 0..1 Classification of section (recommended)
    fhir:EvidenceReport.section.focusReference [ Reference(Any) ]; # 0..1 Classification of section by Resource
    fhir:EvidenceReport.section.author [ Reference(Device|Group|Organization|Person) ], ... ; # 0..* Who and/or what authored the section
    fhir:EvidenceReport.section.text [ Narrative ]; # 0..1 Text summary of the section, for human interpretation
    fhir:EvidenceReport.section.mode [ code ]; # 0..1 working | snapshot | changes
    fhir:EvidenceReport.section.orderedBy [ CodeableConcept ]; # 0..1 Order of section entries
    fhir:EvidenceReport.section.entryClassifier [ CodeableConcept ], ... ; # 0..* Extensible classifiers
    fhir:EvidenceReport.section.entryReference [ Reference(Any) ], ... ; # 0..* A reference to data that supports this section
    fhir:EvidenceReport.section.emptyReason [ CodeableConcept ]; # 0..1 Why the section is empty
    fhir:EvidenceReport.section.section [ See EvidenceReport.section ], ... ; # 0..* Nested Section
  ], ...;
]

Changes since Release 3

This resource did not exist in Release 2

This analysis is available as XML or JSON.

 

See the Profiles & Extensions and the alternate definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) , the spreadsheet version & the dependency analysis a

PathDefinitionTypeReference
EvidenceReport.status The lifecycle status of an artifact.RequiredPublicationStatus
EvidenceReport.type The kind of report, such as grouping of classifiers, search results, or human-compiled expression.ExtensibleEvidenceReportType
EvidenceReport.subject.characteristic.code Evidence focus characteristic code.ExtensibleFocusCharacteristicCode
EvidenceReport.relatesTo.code The type of relationship between reports.RequiredReportRelationshipType
EvidenceReport.section.focus Evidence Report Section Type.ExtensibleReportSectionType
EvidenceReport.section.mode The processing mode that applies to this section.RequiredListMode
EvidenceReport.section.orderedBy What order applies to the items in the entry.PreferredListOrderCodes
EvidenceReport.section.entryClassifier Commonly used classifiers for evidence sets.ExtensibleEvidenceClassifier
EvidenceReport.section.emptyReason If a section is empty, why it is empty.PreferredListEmptyReasons

idLevelLocationDescriptionExpression
cnl-0Warning (base)Name should be usable as an identifier for the module by machine processing applications such as code generationname.matches('[A-Z]([A-Za-z0-9_]){0,254}')

Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

NameTypeDescriptionExpressionIn Common
contexttokenA use context assigned to the evidence report(EvidenceReport.useContext.value as CodeableConcept)
context-quantityquantityA quantity- or range-valued use context assigned to the evidence report(EvidenceReport.useContext.value as Quantity) | (EvidenceReport.useContext.value as Range)
context-typetokenA type of use context assigned to the evidence reportEvidenceReport.useContext.code
context-type-quantitycompositeA use context type and quantity- or range-based value assigned to the evidence reportOn EvidenceReport.useContext:
  context-type: code
  context-quantity: value.as(Quantity) | value.as(Range)
context-type-valuecompositeA use context type and value assigned to the evidence reportOn EvidenceReport.useContext:
  context-type: code
  context: value.as(CodeableConcept)
identifiertokenExternal identifier for the evidence reportEvidenceReport.identifier
publisher NstringName of the publisher of the evidence reportEvidenceReport.publisher
status NtokenThe current status of the evidence reportEvidenceReport.status
url NuriThe uri that identifies the evidence reportEvidenceReport.url