PackagesCanonicalsLogsProblems
    Packages
    hl7.fhir.r6.examples@6.0.0-ballot4
    http://hl7.org/fhir/StructureDefinition/Observation
description: Measurements and simple assertions made about a patient, device or other subject.
package_name: hl7.fhir.r6.examples
derivation: specialization
name: Observation
type: Observation
elements:
  category:
    isModifier: false
    short: Classification of  type of observation
    type: CodeableConcept
    mustSupport: false
    array: true
    binding: {strength: preferred, valueSet: 'http://hl7.org/fhir/ValueSet/observation-category'}
    isSummary: false
    index: 8
  referenceRange:
    constraint:
      obs-3: {human: Must have at least a low or a high or text, source: 'http://hl7.org/fhir/StructureDefinition/Observation', severity: error, expression: low.exists() or high.exists() or text.exists()}
    isModifier: false
    short: Provides guide for interpretation
    index: 45
    type: BackboneElement
    mustSupport: false
    array: true
    elements:
      low:
        constraint:
          obs-13: {human: 'If low.comparator exists, it must be ''>='' or ''>''.', source: 'http://hl7.org/fhir/StructureDefinition/Observation', severity: error, expression: comparator.exists() implies (comparator = '>=' or comparator = '>')}
        isModifier: false
        short: Low Range, if relevant
        type: Quantity
        mustSupport: false
        isSummary: false
        index: 46
      high:
        constraint:
          obs-14: {human: 'If high.comparator exists, it must be ''<='' or ''<''.', source: 'http://hl7.org/fhir/StructureDefinition/Observation', severity: error, expression: comparator.exists() implies (comparator = '<=' or comparator = '<')}
        isModifier: false
        short: High Range, if relevant
        type: Quantity
        mustSupport: false
        isSummary: false
        index: 47
      normalValue:
        isModifier: false
        short: Normal value, if relevant
        type: CodeableConcept
        mustSupport: false
        binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/observation-referencerange-normalvalue'}
        isSummary: false
        index: 48
      type:
        isModifier: false
        short: Reference range qualifier
        type: CodeableConcept
        mustSupport: false
        binding: {strength: preferred, valueSet: 'http://hl7.org/fhir/ValueSet/referencerange-meaning'}
        isSummary: false
        index: 49
      appliesTo:
        isModifier: false
        short: Reference range population
        type: CodeableConcept
        mustSupport: false
        array: true
        binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/referencerange-appliesto'}
        isSummary: false
        index: 50
      age: {isModifier: false, short: 'Applicable age range, if relevant', type: Range, mustSupport: false, isSummary: false, index: 51}
      text: {isModifier: false, short: Text based reference range in an observation, type: markdown, mustSupport: false, isSummary: false, index: 52}
    isSummary: false
  hasMember:
    isModifier: false
    short: Related resource that belongs to the Observation group
    refers: ['http://hl7.org/fhir/StructureDefinition/Observation', 'http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse']
    type: Reference
    mustSupport: false
    array: true
    isSummary: true
    index: 53
  derivedFrom:
    isModifier: false
    short: Related resource from which the observation is made
    refers: ['http://hl7.org/fhir/StructureDefinition/DocumentReference', 'http://hl7.org/fhir/StructureDefinition/ImagingSelection', 'http://hl7.org/fhir/StructureDefinition/ImagingStudy', 'http://hl7.org/fhir/StructureDefinition/Observation', 'http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse']
    type: Reference
    mustSupport: false
    array: true
    isSummary: true
    index: 54
  interpretation:
    isModifier: false
    short: High, low, normal, etc
    type: CodeableConcept
    mustSupport: false
    array: true
    binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/observation-interpretation'}
    isSummary: false
    index: 37
  encounter:
    isModifier: false
    short: Healthcare event during which this observation is made. If you need to place the observation within one or more episodes of care, use the workflow-episodeOfCare extension
    refers: ['http://hl7.org/fhir/StructureDefinition/Encounter']
    type: Reference
    mustSupport: false
    isSummary: true
    index: 13
  method:
    isModifier: false
    short: How it was done
    type: CodeableConcept
    mustSupport: false
    binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/observation-methods'}
    isSummary: false
    index: 42
  valueTime: {isModifier: false, short: Actual result, type: time, mustSupport: false, choiceOf: value, isSummary: true, index: 32}
  specimen:
    constraint:
      obs-9: {human: 'If Observation.specimen is a reference to Group, the group can only have specimens', source: 'http://hl7.org/fhir/StructureDefinition/Observation', severity: error, expression: (reference.resolve().exists() and reference.resolve() is Group) implies reference.resolve().member.entity.resolve().all($this is Specimen)}
    isModifier: false
    short: Specimen used for this observation
    refers: ['http://hl7.org/fhir/StructureDefinition/Group', 'http://hl7.org/fhir/StructureDefinition/Specimen']
    type: Reference
    mustSupport: false
    isSummary: false
    index: 43
  valueQuantity: {isModifier: false, short: Actual result, type: Quantity, mustSupport: false, choiceOf: value, isSummary: true, index: 24}
  value:
    isModifier: false
    short: Actual result
    mustSupport: false
    choices: [valueQuantity, valueCodeableConcept, valueString, valueBoolean, valueInteger, valueRange, valueRatio, valueSampledData, valueTime, valueDateTime, valuePeriod, valueAttachment]
    isSummary: true
    index: 23
  valueString: {isModifier: false, short: Actual result, type: string, mustSupport: false, choiceOf: value, isSummary: true, index: 26}
  valueRatio: {isModifier: false, short: Actual result, type: Ratio, mustSupport: false, choiceOf: value, isSummary: true, index: 30}
  valueBoolean: {isModifier: false, short: Actual result, type: boolean, mustSupport: false, choiceOf: value, isSummary: true, index: 27}
  valueDateTime: {isModifier: false, short: Actual result, type: dateTime, mustSupport: false, choiceOf: value, isSummary: true, index: 33}
  component:
    isModifier: false
    short: Component results
    index: 55
    type: BackboneElement
    mustSupport: false
    array: true
    elements:
      referenceRange:
        elementReference: ['http://hl7.org/fhir/StructureDefinition/Observation', elements, referenceRange]
        isModifier: false
        short: Provides guide for interpretation of component result value
        mustSupport: false
        array: true
        isSummary: false
        index: 73
      interpretation:
        isModifier: false
        short: High, low, normal, etc
        type: CodeableConcept
        mustSupport: false
        array: true
        binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/observation-interpretation'}
        isSummary: false
        index: 72
      valueTime: {isModifier: false, short: Actual component result, type: time, mustSupport: false, choiceOf: value, isSummary: true, index: 67}
      valueQuantity: {isModifier: false, short: Actual component result, type: Quantity, mustSupport: false, choiceOf: value, isSummary: true, index: 59}
      value:
        isModifier: false
        short: Actual component result
        mustSupport: false
        choices: [valueQuantity, valueCodeableConcept, valueString, valueBoolean, valueInteger, valueRange, valueRatio, valueSampledData, valueTime, valueDateTime, valuePeriod, valueAttachment]
        isSummary: true
        index: 58
      valueString: {isModifier: false, short: Actual component result, type: string, mustSupport: false, choiceOf: value, isSummary: true, index: 61}
      valueRatio: {isModifier: false, short: Actual component result, type: Ratio, mustSupport: false, choiceOf: value, isSummary: true, index: 65}
      valueBoolean: {isModifier: false, short: Actual component result, type: boolean, mustSupport: false, choiceOf: value, isSummary: true, index: 62}
      valueDateTime: {isModifier: false, short: Actual component result, type: dateTime, mustSupport: false, choiceOf: value, isSummary: true, index: 68}
      valueSampledData: {isModifier: false, short: Actual component result, type: SampledData, mustSupport: false, choiceOf: value, isSummary: true, index: 66}
      code:
        isModifier: false
        short: Type of component observation (code / type)
        type: CodeableConcept
        mustSupport: false
        binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/observation-codes-observationorboth'}
        isSummary: true
        index: 56
      valueCodeableConcept: {isModifier: false, short: Actual component result, type: CodeableConcept, mustSupport: false, choiceOf: value, isSummary: true, index: 60}
      valuePeriod: {isModifier: false, short: Actual component result, type: Period, mustSupport: false, choiceOf: value, isSummary: true, index: 69}
      valueRange: {isModifier: false, short: Actual component result, type: Range, mustSupport: false, choiceOf: value, isSummary: true, index: 64}
      valueInteger: {isModifier: false, short: Actual component result, type: integer, mustSupport: false, choiceOf: value, isSummary: true, index: 63}
      valueAttachment: {isModifier: false, short: Actual component result, type: Attachment, mustSupport: false, choiceOf: value, isSummary: true, index: 70}
      dataAbsentReason:
        isModifier: false
        short: Why the component result value is missing
        type: CodeableConcept
        mustSupport: false
        binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/data-absent-reason'}
        isSummary: false
        index: 71
    required: [code]
    isSummary: true
  note: {isModifier: false, short: Comments about the observation, type: Annotation, mustSupport: false, array: true, isSummary: false, index: 39}
  valueSampledData: {isModifier: false, short: Actual result, type: SampledData, mustSupport: false, choiceOf: value, isSummary: true, index: 31}
  effectiveDateTime: {isModifier: false, short: Clinically relevant time/time-period for observation, type: dateTime, mustSupport: false, choiceOf: effective, isSummary: true, index: 16}
  status:
    isModifier: true
    short: registered | specimen-in-process | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | unknown | cannot-be-obtained
    index: 7
    type: code
    mustSupport: false
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/observation-status|6.0.0-ballot4'}
    isModifierReason: This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
    isSummary: true
  effective:
    isModifier: false
    short: Clinically relevant time/time-period for observation
    mustSupport: false
    choices: [effectiveDateTime, effectivePeriod, effectiveTiming, effectiveInstant]
    isSummary: true
    index: 15
  code:
    isModifier: false
    short: Type of observation (code / type)
    type: CodeableConcept
    mustSupport: false
    binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/observation-codes-observationorboth'}
    isSummary: true
    index: 9
  identifier: {isModifier: false, short: Business Identifier for observation, type: Identifier, mustSupport: false, array: true, isSummary: true, index: 0}
  effectiveTiming: {isModifier: false, short: Clinically relevant time/time-period for observation, type: Timing, mustSupport: false, choiceOf: effective, isSummary: true, index: 18}
  interpretationContext:
    isModifier: false
    short: Context for understanding the observation
    type: CodeableReference
    mustSupport: false
    array: true
    binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/observation-interpretation-context'}
    isSummary: false
    index: 38
  valueCodeableConcept: {isModifier: false, short: Actual result, type: CodeableConcept, mustSupport: false, choiceOf: value, isSummary: true, index: 25}
  bodySite:
    isModifier: false
    short: 'DEPRECATED: Observed body part'
    type: CodeableConcept
    mustSupport: false
    binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/body-site'}
    isSummary: false
    index: 40
  focus:
    isModifier: true
    short: What the observation is about, when it is not about the subject of record
    index: 11
    refers: ['http://hl7.org/fhir/StructureDefinition/Resource']
    type: Reference
    mustSupport: false
    array: true
    isModifierReason: This element is labeled as a modifier because it changes who is the target of the observation. See the use cases in the definition.
    isSummary: true
  issued: {isModifier: false, short: Date/Time this version was made available, type: instant, mustSupport: false, isSummary: true, index: 20}
  valuePeriod: {isModifier: false, short: Actual result, type: Period, mustSupport: false, choiceOf: value, isSummary: true, index: 34}
  device:
    isModifier: false
    short: A reference to the device that generates the measurements or the device settings for the device
    refers: ['http://hl7.org/fhir/StructureDefinition/Device', 'http://hl7.org/fhir/StructureDefinition/DeviceMetric']
    type: Reference
    mustSupport: false
    isSummary: false
    index: 44
  effectiveInstant: {isModifier: false, short: Clinically relevant time/time-period for observation, type: instant, mustSupport: false, choiceOf: effective, isSummary: true, index: 19}
  basedOn:
    isModifier: false
    short: Fulfills plan, proposal or order
    refers: ['http://hl7.org/fhir/StructureDefinition/CarePlan', 'http://hl7.org/fhir/StructureDefinition/DeviceRequest', 'http://hl7.org/fhir/StructureDefinition/MedicationRequest', 'http://hl7.org/fhir/StructureDefinition/NutritionOrder', 'http://hl7.org/fhir/StructureDefinition/ServiceRequest']
    type: Reference
    mustSupport: false
    array: true
    isSummary: true
    index: 1
  valueRange: {isModifier: false, short: Actual result, type: Range, mustSupport: false, choiceOf: value, isSummary: true, index: 29}
  partOf:
    isModifier: false
    short: Part of referenced event
    refers: ['http://hl7.org/fhir/StructureDefinition/ImagingStudy', 'http://hl7.org/fhir/StructureDefinition/Immunization', 'http://hl7.org/fhir/StructureDefinition/MedicationAdministration', 'http://hl7.org/fhir/StructureDefinition/MedicationDispense', 'http://hl7.org/fhir/StructureDefinition/MedicationStatement', 'http://hl7.org/fhir/StructureDefinition/Procedure']
    type: Reference
    mustSupport: false
    array: true
    isSummary: true
    index: 6
  bodyStructure:
    isModifier: false
    short: Observed body structure
    type: CodeableReference
    mustSupport: false
    binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/body-site'}
    isSummary: false
    index: 41
  valueInteger: {isModifier: false, short: Actual result, type: integer, mustSupport: false, choiceOf: value, isSummary: true, index: 28}
  valueAttachment: {isModifier: false, short: Actual result, type: Attachment, mustSupport: false, choiceOf: value, isSummary: true, index: 35}
  triggeredBy:
    isModifier: false
    short: Triggering observation(s)
    index: 2
    type: BackboneElement
    mustSupport: false
    array: true
    elements:
      observation:
        isModifier: false
        short: Triggering observation
        refers: ['http://hl7.org/fhir/StructureDefinition/Observation']
        type: Reference
        mustSupport: false
        isSummary: true
        index: 3
      type:
        isModifier: false
        short: reflex | repeat | re-run
        type: code
        mustSupport: false
        binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/observation-triggeredbytype|6.0.0-ballot4'}
        isSummary: true
        index: 4
      reason: {isModifier: false, short: Reason that the observation was triggered, type: string, mustSupport: false, isSummary: false, index: 5}
    required: [type, observation]
    isSummary: false
  subject:
    isModifier: false
    short: Who and/or what the observation is about
    refers: ['http://hl7.org/fhir/StructureDefinition/BiologicallyDerivedProduct', 'http://hl7.org/fhir/StructureDefinition/Device', 'http://hl7.org/fhir/StructureDefinition/Group', 'http://hl7.org/fhir/StructureDefinition/Location', 'http://hl7.org/fhir/StructureDefinition/Medication', 'http://hl7.org/fhir/StructureDefinition/NutritionProduct', 'http://hl7.org/fhir/StructureDefinition/Organization', 'http://hl7.org/fhir/StructureDefinition/Patient', 'http://hl7.org/fhir/StructureDefinition/Practitioner', 'http://hl7.org/fhir/StructureDefinition/Procedure', 'http://hl7.org/fhir/StructureDefinition/Substance']
    type: Reference
    mustSupport: false
    isSummary: true
    index: 10
  performer:
    isModifier: false
    short: Who is responsible for the observation
    refers: ['http://hl7.org/fhir/StructureDefinition/CareTeam', 'http://hl7.org/fhir/StructureDefinition/Group', 'http://hl7.org/fhir/StructureDefinition/HealthcareService', 'http://hl7.org/fhir/StructureDefinition/Organization', 'http://hl7.org/fhir/StructureDefinition/Patient', 'http://hl7.org/fhir/StructureDefinition/Practitioner', 'http://hl7.org/fhir/StructureDefinition/PractitionerRole', 'http://hl7.org/fhir/StructureDefinition/RelatedPerson']
    type: Reference
    mustSupport: false
    array: true
    isSummary: true
    index: 21
  dataAbsentReason:
    isModifier: false
    short: Why the result value is missing
    type: CodeableConcept
    mustSupport: false
    binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/data-absent-reason'}
    isSummary: false
    index: 36
  organizer: {isModifier: false, short: This observation organizes/groups a set of sub-observations, type: boolean, mustSupport: false, isSummary: true, index: 12}
  effectivePeriod: {isModifier: false, short: Clinically relevant time/time-period for observation, type: Period, mustSupport: false, choiceOf: effective, isSummary: true, index: 17}
package_version: 6.0.0-ballot4
class: resource
kind: resource
url: http://hl7.org/fhir/StructureDefinition/Observation
base: http://hl7.org/fhir/StructureDefinition/DomainResource
version: 6.0.0-ballot4
required: [status, code]