PackagesCanonicalsLogsProblems
    Packages
    hl7.fhir.r5.examples@5.0.0-ballot
    http://hl7.org/fhir/StructureDefinition/EvidenceVariable
description: The EvidenceVariable resource describes an element that knowledge (Evidence) is about.
package_name: hl7.fhir.r5.examples
derivation: specialization
name: EvidenceVariable
type: EvidenceVariable
elements:
  description: {isModifier: false, short: Natural language description of the evidence variable, type: markdown, mustSupport: false, isSummary: true, index: 12}
  category:
    isModifier: false
    short: A grouping for ordinal or polychotomous variables
    type: BackboneElement
    mustSupport: false
    array: true
    isSummary: false
    index: 64
    elements:
      name: {isModifier: false, short: Description of the grouping, type: string, mustSupport: false, isSummary: false, index: 65}
      value:
        isModifier: false
        short: Definition of the grouping
        mustSupport: false
        choices: [valueCodeableConcept, valueQuantity, valueRange]
        isSummary: false
        index: 67
      valueCodeableConcept: {isModifier: false, short: Definition of the grouping, type: CodeableConcept, mustSupport: false, choiceOf: value, isSummary: false, index: 68}
      valueQuantity: {isModifier: false, short: Definition of the grouping, type: Quantity, mustSupport: false, choiceOf: value, isSummary: false, index: 69}
      valueRange: {isModifier: false, short: Definition of the grouping, type: Range, mustSupport: false, choiceOf: value, isSummary: false, index: 70}
  date: {isModifier: false, short: Date last changed, type: dateTime, mustSupport: false, isSummary: true, index: 9}
  endorser: {isModifier: false, short: Who endorsed the content, type: ContactDetail, mustSupport: false, array: true, isSummary: false, index: 22}
  publisher: {isModifier: false, short: Name of the publisher/steward (organization or individual), type: string, mustSupport: false, isSummary: true, index: 10}
  approvalDate: {isModifier: false, short: When the resource was approved by publisher, type: date, mustSupport: false, isSummary: false, index: 16}
  name: {isModifier: false, short: Name for this evidence variable (computer friendly), type: string, mustSupport: false, isSummary: true, index: 3}
  useContext: {isModifier: false, short: The context that the content is intended to support, type: UsageContext, mustSupport: false, array: true, isSummary: true, index: 14}
  copyright: {isModifier: false, short: Use and/or publishing restrictions, type: markdown, mustSupport: false, isSummary: false, index: 15}
  experimental: {isModifier: false, short: 'For testing purposes, not real usage', type: boolean, mustSupport: false, meaningWhenMissing: 'If absent, this resource is treated as though it is not experimental.', isSummary: false, index: 8}
  title: {isModifier: false, short: Name for this evidence variable (human friendly), type: string, mustSupport: false, isSummary: true, index: 4}
  note: {isModifier: false, short: Used for footnotes or explanatory notes, type: Annotation, mustSupport: false, array: true, isSummary: false, index: 13}
  author: {isModifier: false, short: Who authored the content, type: ContactDetail, mustSupport: false, array: true, isSummary: false, index: 19}
  characteristic:
    constraint:
      evv-1: {human: 'In a characteristic, at most one of these seven elements shall be used: definitionReference or definitionCanonical or definitionCodeableConcept or definitionExpression or definitionId or definitionByTypeAndValue or definitionByCombination', source: 'http://hl7.org/fhir/StructureDefinition/EvidenceVariable', severity: error, expression: (definitionReference.count() + definitionCanonical.count() + definitionCodeableConcept.count() + definitionExpression.count() + definitionId.count() + definitionByTypeAndValue.count() + definitionByCombination.count())  < 2}
    isModifier: false
    short: A defining factor of the EvidenceVariable
    index: 25
    type: BackboneElement
    mustSupport: false
    array: true
    elements:
      description: {isModifier: false, short: Natural language description of the characteristic, type: string, mustSupport: false, isSummary: false, index: 27}
      exclude: {isModifier: false, short: Whether the characteristic is an inclusion criterion or exclusion criterion, type: boolean, mustSupport: false, meaningWhenMissing: 'False', isSummary: false, index: 29}
      definitionByCombination:
        isModifier: false
        short: Used to specify how two or more characteristics are combined
        type: BackboneElement
        mustSupport: false
        isSummary: false
        index: 48
        elements:
          code:
            isModifier: false
            short: all-of | any-of | at-least | at-most | statistical | net-effect | dataset
            type: code
            mustSupport: false
            binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/characteristic-combination|5.0.0-ballot'}
            isSummary: false
            index: 49
          threshold: {isModifier: false, short: Provides the value of "n" when "at-least" or "at-most" codes are used, type: positiveInt, mustSupport: false, isSummary: false, index: 50}
          characteristic:
            elementReference: ['http://hl7.org/fhir/StructureDefinition/EvidenceVariable', elements, characteristic]
            min: 1
            isModifier: false
            short: A defining factor of the characteristic
            index: 51
            mustSupport: false
            array: true
            isSummary: false
        required: [characteristic, code]
      linkId: {isModifier: false, short: Label for internal linking, type: id, mustSupport: false, isSummary: false, index: 26}
      definitionExpression: {isModifier: false, short: Defines the characteristic (without using type and value) by a Expression, type: Expression, mustSupport: false, isSummary: true, index: 33}
      definitionByTypeAndValue:
        isModifier: false
        short: Defines the characteristic using type and value
        type: BackboneElement
        mustSupport: false
        isSummary: true
        index: 35
        elements:
          valueReference: {isModifier: false, short: Defines the characteristic when coupled with characteristic.type, type: Reference, mustSupport: false, choiceOf: value, isSummary: true, index: 45}
          offset:
            isModifier: false
            short: Reference point for valueQuantity
            type: CodeableConcept
            mustSupport: false
            binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/characteristic-offset'}
            isSummary: false
            index: 47
          method:
            isModifier: false
            short: Method for how the characteristic value was determined
            type: CodeableConcept
            mustSupport: false
            array: true
            binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/definition-method'}
            isSummary: false
            index: 37
          valueQuantity: {isModifier: false, short: Defines the characteristic when coupled with characteristic.type, type: Quantity, mustSupport: false, choiceOf: value, isSummary: true, index: 43}
          value:
            isModifier: false
            short: Defines the characteristic when coupled with characteristic.type
            mustSupport: false
            choices: [valueCodeableConcept, valueBoolean, valueQuantity, valueRange, valueReference, valueId]
            isSummary: true
            index: 40
          valueBoolean: {isModifier: false, short: Defines the characteristic when coupled with characteristic.type, type: boolean, mustSupport: false, choiceOf: value, isSummary: true, index: 42}
          type:
            isModifier: false
            short: Expresses the type of characteristic
            type: CodeableConcept
            mustSupport: false
            binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/usage-context-type'}
            isSummary: true
            index: 36
          valueCodeableConcept: {isModifier: false, short: Defines the characteristic when coupled with characteristic.type, type: CodeableConcept, mustSupport: false, choiceOf: value, isSummary: true, index: 41}
          device:
            isModifier: false
            short: Device used for determining characteristic
            refers: ['http://hl7.org/fhir/StructureDefinition/Device', 'http://hl7.org/fhir/StructureDefinition/DeviceMetric']
            type: Reference
            mustSupport: false
            isSummary: false
            index: 38
          valueRange: {isModifier: false, short: Defines the characteristic when coupled with characteristic.type, type: Range, mustSupport: false, choiceOf: value, isSummary: true, index: 44}
          valueId: {isModifier: false, short: Defines the characteristic when coupled with characteristic.type, type: id, mustSupport: false, choiceOf: value, isSummary: true, index: 46}
        required: [valueReference, valueRange, value, valueBoolean, type, valueCodeableConcept, valueId, valueQuantity]
      definitionCanonical: {isModifier: false, short: Defines the characteristic (without using type and value) by a Canonical, type: canonical, mustSupport: false, isSummary: true, index: 31}
      definitionReference:
        isModifier: false
        short: Defines the characteristic (without using type and value) by a Reference
        refers: ['http://hl7.org/fhir/StructureDefinition/Evidence', 'http://hl7.org/fhir/StructureDefinition/EvidenceVariable', 'http://hl7.org/fhir/StructureDefinition/Group']
        type: Reference
        mustSupport: false
        isSummary: true
        index: 30
      definitionId: {isModifier: false, short: Defines the characteristic (without using type and value) by a id, type: id, mustSupport: false, isSummary: true, index: 34}
      note: {isModifier: false, short: Used for footnotes or explanatory notes, type: Annotation, mustSupport: false, array: true, isSummary: false, index: 28}
      definitionCodeableConcept: {isModifier: false, short: Defines the characteristic (without using type and value) by a CodeableConcept, type: CodeableConcept, mustSupport: false, isSummary: true, index: 32}
      timeFromEvent:
        isModifier: false
        short: Observation time from study specified event
        type: BackboneElement
        mustSupport: false
        array: true
        isSummary: false
        index: 52
        elements:
          eventReference: {isModifier: false, short: The event used as a base point (reference point) in time, type: Reference, mustSupport: false, choiceOf: event, isSummary: false, index: 58}
          description: {isModifier: false, short: Human readable description, type: string, mustSupport: false, isSummary: false, index: 53}
          eventCodeableConcept: {isModifier: false, short: The event used as a base point (reference point) in time, type: CodeableConcept, mustSupport: false, choiceOf: event, isSummary: false, index: 57}
          note: {isModifier: false, short: Used for footnotes or explanatory notes, type: Annotation, mustSupport: false, array: true, isSummary: false, index: 54}
          eventId: {isModifier: false, short: The event used as a base point (reference point) in time, type: id, mustSupport: false, choiceOf: event, isSummary: false, index: 60}
          eventDateTime: {isModifier: false, short: The event used as a base point (reference point) in time, type: dateTime, mustSupport: false, choiceOf: event, isSummary: false, index: 59}
          event:
            isModifier: false
            short: The event used as a base point (reference point) in time
            mustSupport: false
            choices: [eventCodeableConcept, eventReference, eventDateTime, eventId]
            isSummary: false
            index: 56
          quantity: {isModifier: false, short: Used to express the observation at a defined amount of time after the study start, type: Quantity, mustSupport: false, isSummary: false, index: 61}
          range: {isModifier: false, short: Used to express the observation within a period after the study start, type: Range, mustSupport: false, isSummary: false, index: 62}
    isSummary: true
  handling:
    isModifier: false
    short: continuous | dichotomous | ordinal | polychotomous
    type: code
    mustSupport: false
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/variable-handling|5.0.0-ballot'}
    isSummary: false
    index: 63
  status:
    isModifier: true
    short: draft | active | retired | unknown
    index: 7
    type: code
    mustSupport: false
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/publication-status|5.0.0-ballot'}
    isModifierReason: This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration
    isSummary: true
  subtitle: {isModifier: false, short: Subordinate title of the EvidenceVariable, type: string, mustSupport: false, isSummary: false, index: 6}
  url:
    constraint:
      cnl-1: {human: 'URL should not contain | or # - these characters make processing canonical references problematic', source: 'http://hl7.org/fhir/StructureDefinition/EvidenceVariable', severity: warning, expression: 'url.matches(''([^|#])*'')'}
    isModifier: false
    short: Canonical identifier for this evidence variable, represented as a URI (globally unique)
    type: uri
    mustSupport: false
    isSummary: true
    index: 0
  identifier: {isModifier: false, short: Additional identifier for the evidence variable, type: Identifier, mustSupport: false, array: true, isSummary: true, index: 1}
  lastReviewDate: {isModifier: false, short: When the resource was last reviewed, type: date, mustSupport: false, isSummary: false, index: 17}
  editor: {isModifier: false, short: Who edited the content, type: ContactDetail, mustSupport: false, array: true, isSummary: false, index: 20}
  reviewer: {isModifier: false, short: Who reviewed the content, type: ContactDetail, mustSupport: false, array: true, isSummary: false, index: 21}
  shortTitle: {isModifier: false, short: Title for use in informal contexts, type: string, mustSupport: false, isSummary: true, index: 5}
  version: {isModifier: false, short: Business version of the evidence variable, type: string, mustSupport: false, isSummary: true, index: 2}
  relatedArtifact: {isModifier: false, short: 'Additional documentation, citations, etc.', type: RelatedArtifact, mustSupport: false, array: true, isSummary: false, index: 23}
  actual: {isModifier: false, short: Actual or conceptual, type: boolean, mustSupport: false, isSummary: false, index: 24}
  contact: {isModifier: false, short: Contact details for the publisher, type: ContactDetail, mustSupport: false, array: true, isSummary: true, index: 11}
  effectivePeriod: {isModifier: false, short: When the resource is expected to be used, type: Period, mustSupport: false, isSummary: false, index: 18}
package_version: 5.0.0-ballot
class: resource
kind: resource
url: http://hl7.org/fhir/StructureDefinition/EvidenceVariable
base: http://hl7.org/fhir/StructureDefinition/DomainResource
version: 5.0.0-ballot
required: [status]