Release 5 Preview #2

This page is part of the FHIR Specification (v4.4.0: R5 Preview #2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

14.10 Resource EvidenceFocus - Content

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

EvidenceFocus.

14.10.1 Scope and Usage

14.10.2 References

No resources refer to this resource directly.

This resource does not implement any patterns.

14.10.3 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. EvidenceFocus TUMetadataResourceAn EvidenceFocus
+ 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 EvidenceFocus, represented as a globally unique URI
... identifier Σ0..*IdentifierUnique to the EvidenceFocus Resource
... version Σ0..1stringBusiness version of this summary
... status ?!Σ1..1codedraft | active | retired | unknown
PublicationStatus (Required)
... useContext Σ0..*UsageContextUse context
... date Σ0..1dateTimeDate created
... note 0..*AnnotationFootnotes and/or explanatory notes
... copyright 0..1markdownCopyright
... citeAs Σ0..1Reference(Citation)Citation for this EvidenceFocus resource
... characteristic 0..*BackboneElementCharacteristic
.... code Σ1..1CodeableConceptCharacteristic code
EvidenceFocusCharacteristicCode (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
... relatedArtifact 0..*RelatedArtifactAdditional documentation

doco Documentation for this format

UML Diagram (Legend)

EvidenceFocus (MetadataResource)An absolute URI that is used to identify this EvidenceFocus 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]A formal identifier that is used to identify this summary when it is represented in other formats, or referenced in a specification, model, design or an instanceidentifier : Identifier [0..*]The identifier that is used to identify this version of the summary when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the summary author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequenceversion : string [0..1]A natural language name identifying the evidence focus. This name should be usable as an identifier for the module by machine processing applications such as code generationname : string [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 focus instancesuseContext : UsageContext [0..*]The date (and optionally time) when the evidence focus was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the evidence focus changesdate : dateTime [0..1]Used for general notes and annotations not coded elsewherenote : Annotation [0..*]A copyright statement relating to the evidence focus and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the evidence focuscopyright : markdown [0..1]Citation for this EvidenceFocus resourceciteAs : Reference [0..1] « Citation »Additional documentationrelatedArtifact : RelatedArtifact [0..*]CharacteristicCharacteristic codecode : CodeableConcept [1..1] « Evidence focus characteristic code. (Strength=Extensible)EvidenceFocusCharacteristicCo...+ »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]Characteristiccharacteristic[0..*]

XML Template

<EvidenceFocus xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <url value="[uri]"/><!-- 0..1 Canonical identifier for this EvidenceFocus, represented as a globally unique URI -->
 <identifier><!-- 0..* Identifier Unique to the EvidenceFocus Resource --></identifier>
 <version value="[string]"/><!-- 0..1 Business version of this summary -->
 <name value="[string]"/><!-- ?? 0..1 Name -->
 <status value="[code]"/><!-- 1..1 draft | active | retired | unknown -->
 <useContext><!-- 0..* UsageContext Use context --></useContext>
 <date value="[dateTime]"/><!-- 0..1 Date created -->
 <note><!-- 0..* Annotation Footnotes and/or explanatory notes --></note>
 <copyright value="[markdown]"/><!-- 0..1 Copyright -->
 <citeAs><!-- 0..1 Reference(Citation) Citation for this EvidenceFocus resource --></citeAs>
 <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>
 <relatedArtifact><!-- 0..* RelatedArtifact Additional documentation --></relatedArtifact>
</EvidenceFocus>

Turtle Template

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


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

  # from Resource: .id, .meta, .implicitRules, and .language
  fhir:EvidenceFocus.url [ uri ]; # 0..1 Canonical identifier for this EvidenceFocus, represented as a globally unique URI
  fhir:EvidenceFocus.identifier [ Identifier ], ... ; # 0..* Unique to the EvidenceFocus Resource
  fhir:EvidenceFocus.version [ string ]; # 0..1 Business version of this summary
  fhir:EvidenceFocus.name [ string ]; # 0..1 Name
  fhir:EvidenceFocus.status [ code ]; # 1..1 draft | active | retired | unknown
  fhir:EvidenceFocus.useContext [ UsageContext ], ... ; # 0..* Use context
  fhir:EvidenceFocus.date [ dateTime ]; # 0..1 Date created
  fhir:EvidenceFocus.note [ Annotation ], ... ; # 0..* Footnotes and/or explanatory notes
  fhir:EvidenceFocus.copyright [ markdown ]; # 0..1 Copyright
  fhir:EvidenceFocus.citeAs [ Reference(Citation) ]; # 0..1 Citation for this EvidenceFocus resource
  fhir:EvidenceFocus.characteristic [ # 0..* Characteristic
    fhir:EvidenceFocus.characteristic.code [ CodeableConcept ]; # 1..1 Characteristic code
    # EvidenceFocus.characteristic.value[x] : 1..1 Characteristic value. One of these 5
      fhir:EvidenceFocus.characteristic.valueReference [ Reference(Any) ]
      fhir:EvidenceFocus.characteristic.valueCodeableConcept [ CodeableConcept ]
      fhir:EvidenceFocus.characteristic.valueBoolean [ boolean ]
      fhir:EvidenceFocus.characteristic.valueQuantity [ Quantity ]
      fhir:EvidenceFocus.characteristic.valueRange [ Range ]
    fhir:EvidenceFocus.characteristic.exclude [ boolean ]; # 0..1 Is used to express not the characteristic
    fhir:EvidenceFocus.characteristic.period [ Period ]; # 0..1 Timeframe for the characteristic
  ], ...;
  fhir:EvidenceFocus.relatedArtifact [ RelatedArtifact ], ... ; # 0..* Additional documentation
]

Changes since R3

This resource did not exist in Release 2

This analysis is available as XML or JSON.

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. EvidenceFocus TUMetadataResourceAn EvidenceFocus
+ 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 EvidenceFocus, represented as a globally unique URI
... identifier Σ0..*IdentifierUnique to the EvidenceFocus Resource
... version Σ0..1stringBusiness version of this summary
... status ?!Σ1..1codedraft | active | retired | unknown
PublicationStatus (Required)
... useContext Σ0..*UsageContextUse context
... date Σ0..1dateTimeDate created
... note 0..*AnnotationFootnotes and/or explanatory notes
... copyright 0..1markdownCopyright
... citeAs Σ0..1Reference(Citation)Citation for this EvidenceFocus resource
... characteristic 0..*BackboneElementCharacteristic
.... code Σ1..1CodeableConceptCharacteristic code
EvidenceFocusCharacteristicCode (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
... relatedArtifact 0..*RelatedArtifactAdditional documentation

doco Documentation for this format

UML Diagram (Legend)

EvidenceFocus (MetadataResource)An absolute URI that is used to identify this EvidenceFocus 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]A formal identifier that is used to identify this summary when it is represented in other formats, or referenced in a specification, model, design or an instanceidentifier : Identifier [0..*]The identifier that is used to identify this version of the summary when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the summary author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequenceversion : string [0..1]A natural language name identifying the evidence focus. This name should be usable as an identifier for the module by machine processing applications such as code generationname : string [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 focus instancesuseContext : UsageContext [0..*]The date (and optionally time) when the evidence focus was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the evidence focus changesdate : dateTime [0..1]Used for general notes and annotations not coded elsewherenote : Annotation [0..*]A copyright statement relating to the evidence focus and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the evidence focuscopyright : markdown [0..1]Citation for this EvidenceFocus resourceciteAs : Reference [0..1] « Citation »Additional documentationrelatedArtifact : RelatedArtifact [0..*]CharacteristicCharacteristic codecode : CodeableConcept [1..1] « Evidence focus characteristic code. (Strength=Extensible)EvidenceFocusCharacteristicCo...+ »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]Characteristiccharacteristic[0..*]

XML Template

<EvidenceFocus xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <url value="[uri]"/><!-- 0..1 Canonical identifier for this EvidenceFocus, represented as a globally unique URI -->
 <identifier><!-- 0..* Identifier Unique to the EvidenceFocus Resource --></identifier>
 <version value="[string]"/><!-- 0..1 Business version of this summary -->
 <name value="[string]"/><!-- ?? 0..1 Name -->
 <status value="[code]"/><!-- 1..1 draft | active | retired | unknown -->
 <useContext><!-- 0..* UsageContext Use context --></useContext>
 <date value="[dateTime]"/><!-- 0..1 Date created -->
 <note><!-- 0..* Annotation Footnotes and/or explanatory notes --></note>
 <copyright value="[markdown]"/><!-- 0..1 Copyright -->
 <citeAs><!-- 0..1 Reference(Citation) Citation for this EvidenceFocus resource --></citeAs>
 <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>
 <relatedArtifact><!-- 0..* RelatedArtifact Additional documentation --></relatedArtifact>
</EvidenceFocus>

Turtle Template

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


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

  # from Resource: .id, .meta, .implicitRules, and .language
  fhir:EvidenceFocus.url [ uri ]; # 0..1 Canonical identifier for this EvidenceFocus, represented as a globally unique URI
  fhir:EvidenceFocus.identifier [ Identifier ], ... ; # 0..* Unique to the EvidenceFocus Resource
  fhir:EvidenceFocus.version [ string ]; # 0..1 Business version of this summary
  fhir:EvidenceFocus.name [ string ]; # 0..1 Name
  fhir:EvidenceFocus.status [ code ]; # 1..1 draft | active | retired | unknown
  fhir:EvidenceFocus.useContext [ UsageContext ], ... ; # 0..* Use context
  fhir:EvidenceFocus.date [ dateTime ]; # 0..1 Date created
  fhir:EvidenceFocus.note [ Annotation ], ... ; # 0..* Footnotes and/or explanatory notes
  fhir:EvidenceFocus.copyright [ markdown ]; # 0..1 Copyright
  fhir:EvidenceFocus.citeAs [ Reference(Citation) ]; # 0..1 Citation for this EvidenceFocus resource
  fhir:EvidenceFocus.characteristic [ # 0..* Characteristic
    fhir:EvidenceFocus.characteristic.code [ CodeableConcept ]; # 1..1 Characteristic code
    # EvidenceFocus.characteristic.value[x] : 1..1 Characteristic value. One of these 5
      fhir:EvidenceFocus.characteristic.valueReference [ Reference(Any) ]
      fhir:EvidenceFocus.characteristic.valueCodeableConcept [ CodeableConcept ]
      fhir:EvidenceFocus.characteristic.valueBoolean [ boolean ]
      fhir:EvidenceFocus.characteristic.valueQuantity [ Quantity ]
      fhir:EvidenceFocus.characteristic.valueRange [ Range ]
    fhir:EvidenceFocus.characteristic.exclude [ boolean ]; # 0..1 Is used to express not the characteristic
    fhir:EvidenceFocus.characteristic.period [ Period ]; # 0..1 Timeframe for the characteristic
  ], ...;
  fhir:EvidenceFocus.relatedArtifact [ RelatedArtifact ], ... ; # 0..* Additional documentation
]

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

14.10.3.1 Terminology Bindings

PathDefinitionTypeReference
EvidenceFocus.status The lifecycle status of an artifact.RequiredPublicationStatus
EvidenceFocus.characteristic.code Evidence focus characteristic code.ExtensibleEvidenceFocusCharacteristicCode

14.10.3.2 Constraints

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}')

14.10.4 Search Parameters

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 focus(EvidenceFocus.useContext.value as CodeableConcept)
context-quantityquantityA quantity- or range-valued use context assigned to the evidence focus(EvidenceFocus.useContext.value as Quantity) | (EvidenceFocus.useContext.value as Range)
context-typetokenA type of use context assigned to the evidence focusEvidenceFocus.useContext.code
context-type-quantitycompositeA use context type and quantity- or range-based value assigned to the evidence focusOn EvidenceFocus.useContext:
  context-type: code
  context-quantity: value.as(Quantity) | value.as(Range)
context-type-valuecompositeA use context type and value assigned to the evidence focusOn EvidenceFocus.useContext:
  context-type: code
  context: value.as(CodeableConcept)
date NdateThe evidence focus publication dateEvidenceFocus.date
identifiertokenExternal identifier for the evidence focusEvidenceFocus.identifier
name NstringComputationally friendly name of the evidence focusEvidenceFocus.name
status NtokenThe current status of the evidence focusEvidenceFocus.status
url NuriThe uri that identifies the evidence focusEvidenceFocus.url
version NtokenThe business version of the evidence focusEvidenceFocus.version