Release 4B

This page is part of the FHIR Specification (v4.3.0: R4B - STU). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R4B R4 R3

Extension: Analysis

Orders and Observations Work Group Maturity Level: 1InformativeUse Context: Any

URL for this extension:

http://hl7.org/fhir/StructureDefinition/DiagnosticReport-geneticsAnalysis

Status: draft. Extension maintained by: Health Level Seven International (Clinical Genomics)

Knowledge-based comments on the effect of the sequence on patient's condition/medication reaction.

Context of Use: Use on Element ID DiagnosticReport

Extension Content

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. Analysis0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/DiagnosticReport-geneticsAnalysis
Analysis: Knowledge-based comments on the effect of the sequence on patient's condition/medication reaction.


Use on Element ID DiagnosticReport
... type1..1CodeableConceptType of the analysis. E.g. for a drug, what is being analyzed - efficacy, reaction, the drug's effect on the user's metabolism, etc.

... interpretation0..1CodeableConceptInterpretation of the sequence's effect on the patient's condition or reaction to a medication.


doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/DiagnosticReport-geneticsAnalysis
Analysis: Knowledge-based comments on the effect of the sequence on patient's condition/medication reaction.


Use on Element ID DiagnosticReport
... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... extension:type 1..1ExtensionAnalysis type
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"type"
.... value[x] 1..1CodeableConceptValue of extension
... extension:interpretation 0..1ExtensionAnalysis interpretation
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"interpretation"
.... value[x] 1..1CodeableConceptValue of extension
... value[x] 0..0
.... valueBase64Binarybase64Binary
.... valueBooleanboolean
.... valueCanonicalcanonical(Any)
.... valueCodecode
.... valueDatedate
.... valueDateTimedateTime
.... valueDecimaldecimal
.... valueIdid
.... valueInstantinstant
.... valueIntegerinteger
.... valueMarkdownmarkdown
.... valueOidoid
.... valuePositiveIntpositiveInt
.... valueStringstring
.... valueTimetime
.... valueUnsignedIntunsignedInt
.... valueUriuri
.... valueUrlurl
.... valueUuiduuid
.... valueAddressAddress
.... valueAgeAge
.... valueAnnotationAnnotation
.... valueAttachmentAttachment
.... valueCodeableConceptCodeableConcept
.... valueCodeableReferenceCodeableReference
.... valueCodingCoding
.... valueContactPointContactPoint
.... valueCountCount
.... valueDistanceDistance
.... valueDurationDuration
.... valueHumanNameHumanName
.... valueIdentifierIdentifier
.... valueMoneyMoney
.... valuePeriodPeriod
.... valueQuantityQuantity
.... valueRangeRange
.... valueRatioRatio
.... valueRatioRangeRatioRange
.... valueReferenceReference(Any)
.... valueSampledDataSampledData
.... valueSignatureSignature
.... valueTimingTiming
.... valueContactDetailContactDetail
.... valueContributorContributor
.... valueDataRequirementDataRequirement
.... valueExpressionExpression
.... valueParameterDefinitionParameterDefinition
.... valueRelatedArtifactRelatedArtifact
.... valueTriggerDefinitionTriggerDefinition
.... valueUsageContextUsageContext
.... valueDosageDosage

doco Documentation for this format

XML Template

<!-- Analysis -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/DiagnosticReport-geneticsAnalysis" >
 <-- extension sliced by value:url  in the specified orderOpen-->
 <extension url="type"> ?? 1..1 Extension  <!-- ?? 1..1 Analysis type -->
  <valueCodeableConcept><!-- ?? 1..1 CodeableConcept 
      Value of extension --></valueCodeableConcept>
 </extension>
 <extension url="interpretation"> ?? 0..1 Extension  <!-- ?? 0..1 Analysis interpretation -->
  <valueCodeableConcept><!-- ?? 1..1 CodeableConcept 
      Value of extension --></valueCodeableConcept>
 </extension>
</extension>

JSON Template

{ // Analysis
    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // Analysis type // C? R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "type", // R! 
        "valueCodeableConcept" : { CodeableConcept } // C? R! Value of extension
      },
      { // Analysis interpretation // C?
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "interpretation", // R! 
        "valueCodeableConcept" : { CodeableConcept } // C? R! Value of extension
      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/DiagnosticReport-geneticsAnalysis", // R! 
// value[x]: Value of extension. One of these 51:
  }

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. Analysis0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/DiagnosticReport-geneticsAnalysis
Analysis: Knowledge-based comments on the effect of the sequence on patient's condition/medication reaction.


Use on Element ID DiagnosticReport
... type1..1CodeableConceptType of the analysis. E.g. for a drug, what is being analyzed - efficacy, reaction, the drug's effect on the user's metabolism, etc.

... interpretation0..1CodeableConceptInterpretation of the sequence's effect on the patient's condition or reaction to a medication.


doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/DiagnosticReport-geneticsAnalysis
Analysis: Knowledge-based comments on the effect of the sequence on patient's condition/medication reaction.


Use on Element ID DiagnosticReport
... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... extension:type 1..1ExtensionAnalysis type
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"type"
.... value[x] 1..1CodeableConceptValue of extension
... extension:interpretation 0..1ExtensionAnalysis interpretation
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"interpretation"
.... value[x] 1..1CodeableConceptValue of extension
... value[x] 0..0
.... valueBase64Binarybase64Binary
.... valueBooleanboolean
.... valueCanonicalcanonical(Any)
.... valueCodecode
.... valueDatedate
.... valueDateTimedateTime
.... valueDecimaldecimal
.... valueIdid
.... valueInstantinstant
.... valueIntegerinteger
.... valueMarkdownmarkdown
.... valueOidoid
.... valuePositiveIntpositiveInt
.... valueStringstring
.... valueTimetime
.... valueUnsignedIntunsignedInt
.... valueUriuri
.... valueUrlurl
.... valueUuiduuid
.... valueAddressAddress
.... valueAgeAge
.... valueAnnotationAnnotation
.... valueAttachmentAttachment
.... valueCodeableConceptCodeableConcept
.... valueCodeableReferenceCodeableReference
.... valueCodingCoding
.... valueContactPointContactPoint
.... valueCountCount
.... valueDistanceDistance
.... valueDurationDuration
.... valueHumanNameHumanName
.... valueIdentifierIdentifier
.... valueMoneyMoney
.... valuePeriodPeriod
.... valueQuantityQuantity
.... valueRangeRange
.... valueRatioRatio
.... valueRatioRangeRatioRange
.... valueReferenceReference(Any)
.... valueSampledDataSampledData
.... valueSignatureSignature
.... valueTimingTiming
.... valueContactDetailContactDetail
.... valueContributorContributor
.... valueDataRequirementDataRequirement
.... valueExpressionExpression
.... valueParameterDefinitionParameterDefinition
.... valueRelatedArtifactRelatedArtifact
.... valueTriggerDefinitionTriggerDefinition
.... valueUsageContextUsageContext
.... valueDosageDosage

doco Documentation for this format

XML Template

<!-- Analysis -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/DiagnosticReport-geneticsAnalysis" >
 <-- extension sliced by value:url  in the specified orderOpen-->
 <extension url="type"> ?? 1..1 Extension  <!-- ?? 1..1 Analysis type -->
  <valueCodeableConcept><!-- ?? 1..1 CodeableConcept 
      Value of extension --></valueCodeableConcept>
 </extension>
 <extension url="interpretation"> ?? 0..1 Extension  <!-- ?? 0..1 Analysis interpretation -->
  <valueCodeableConcept><!-- ?? 1..1 CodeableConcept 
      Value of extension --></valueCodeableConcept>
 </extension>
</extension>

JSON Template

{ // Analysis
    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // Analysis type // C? R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "type", // R! 
        "valueCodeableConcept" : { CodeableConcept } // C? R! Value of extension
      },
      { // Analysis interpretation // C?
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "interpretation", // R! 
        "valueCodeableConcept" : { CodeableConcept } // C? R! Value of extension
      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/DiagnosticReport-geneticsAnalysis", // R! 
// value[x]: Value of extension. One of these 51:
  }

 

Constraints

  • ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (xpath: @value|f:*|h:div|self::f:Parameters)
  • ext-1: Must have either extensions or value[x], not both (xpath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]))
  • ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: @value|f:*|h:div)
  • ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
  • ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: @value|f:*|h:div)
  • ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
  • ele-1: On Extension.extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension.extension: @value|f:*|h:div)
  • ext-1: On Extension.extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
  • ele-1: On Extension.extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.extension.value[x]: @value|f:*|h:div)
  • ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: @value|f:*|h:div)
  • ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
  • ele-1: On Extension.extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension.extension: @value|f:*|h:div)
  • ext-1: On Extension.extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
  • ele-1: On Extension.extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.extension.value[x]: @value|f:*|h:div)
  • ele-1: On Extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.value[x]: @value|f:*|h:div)