Release 4B Ballot #1

This page is part of the FHIR Specification (v4.1.0: Release 4B Ballot #1). 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

Extension: References

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

URL for this extension:

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

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

Additional bibliographic reference information about genetics, medications, clinical trials, etc. associated with knowledge-based information on genetics/genetic condition.

Context of Use: Use on Element ID DiagnosticReport

Extension Content

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. References0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/DiagnosticReport-geneticsReferences
References: Additional bibliographic reference information about genetics, medications, clinical trials, etc. associated with knowledge-based information on genetics/genetic condition.


Use on Element ID DiagnosticReport
... description0..1stringConcise description of the genetic reference.

... reference0..*uriAn absolute URI to express where to find the link.

... type0..1CodeableConceptA code that classifies the type of genetic reference link.


doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/DiagnosticReport-geneticsReferences
References: Additional bibliographic reference information about genetics, medications, clinical trials, etc. associated with knowledge-based information on genetics/genetic condition.


Use on Element ID DiagnosticReport
... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... extension:description 0..1ExtensionReference description
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"description"
.... value[x] 1..1stringValue of extension
... extension:reference 0..*ExtensionReference URI
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"reference"
.... value[x] 1..1uriValue of extension
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"type"
.... value[x] 1..1CodeableConceptValue of extension
Binding: DiagnosticAttachmentType (example): Codes based on Snomed for diagnostic genetic reference types

... url 1..1uri"http://hl7.org/fhir/StructureDefinition/DiagnosticReport-geneticsReferences"
... 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
.... valueCodingCoding
.... valueContactPointContactPoint
.... valueCountCount
.... valueDistanceDistance
.... valueDurationDuration
.... valueHumanNameHumanName
.... valueIdentifierIdentifier
.... valueMoneyMoney
.... valuePeriodPeriod
.... valueQuantityQuantity
.... valueRangeRange
.... valueRatioRatio
.... valueReferenceReference(Any)
.... valueSampledDataSampledData
.... valueSignatureSignature
.... valueTimingTiming
.... valueContactDetailContactDetail
.... valueContributorContributor
.... valueDataRequirementDataRequirement
.... valueExpressionExpression
.... valueParameterDefinitionParameterDefinition
.... valueRelatedArtifactRelatedArtifact
.... valueTriggerDefinitionTriggerDefinition
.... valueUsageContextUsageContext
.... valueDosageDosage
.... valueMetaMeta

doco Documentation for this format

XML Template

<!-- References -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/DiagnosticReport-geneticsReferences" >
 <-- extension sliced by value:url  in the specified orderOpen-->
 <extension url="description"> ?? 0..1 Extension  <!-- ?? 0..1 Reference description -->
  <valueString value="[string]"/><!-- ?? 1..1 Value of extension -->
 </extension>
 <extension url="reference"> ?? 0..* Extension  <!-- ?? 0..* Reference URI -->
  <valueUri value="[uri]"/><!-- ?? 1..1 Value of extension -->
 </extension>
 <extension url="type"> ?? 0..1 Extension  <!-- ?? 0..1 Reference type -->
  <valueCodeableConcept><!-- ?? 1..1 CodeableConcept Value of extension --></valueCodeableConcept>
 </extension>
</extension>

JSON Template

{ // References
    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // Reference description // C?
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "description", // R! 
        "valueString" : "<string>" // C? R! Value of extension
      },
      { // Reference URI // C?
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "reference", // R! 
        "valueUri" : "<uri>" // C? R! Value of extension
      },
      { // Reference type // C?
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "type", // R! 
        "valueCodeableConcept" : { CodeableConcept } // C? R! Value of extension
      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/DiagnosticReport-geneticsReferences", // R! 
// value[x]: Value of extension. One of these 50:
  }

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. References0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/DiagnosticReport-geneticsReferences
References: Additional bibliographic reference information about genetics, medications, clinical trials, etc. associated with knowledge-based information on genetics/genetic condition.


Use on Element ID DiagnosticReport
... description0..1stringConcise description of the genetic reference.

... reference0..*uriAn absolute URI to express where to find the link.

... type0..1CodeableConceptA code that classifies the type of genetic reference link.


doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/DiagnosticReport-geneticsReferences
References: Additional bibliographic reference information about genetics, medications, clinical trials, etc. associated with knowledge-based information on genetics/genetic condition.


Use on Element ID DiagnosticReport
... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... extension:description 0..1ExtensionReference description
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"description"
.... value[x] 1..1stringValue of extension
... extension:reference 0..*ExtensionReference URI
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"reference"
.... value[x] 1..1uriValue of extension
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"type"
.... value[x] 1..1CodeableConceptValue of extension
Binding: DiagnosticAttachmentType (example): Codes based on Snomed for diagnostic genetic reference types

... url 1..1uri"http://hl7.org/fhir/StructureDefinition/DiagnosticReport-geneticsReferences"
... 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
.... valueCodingCoding
.... valueContactPointContactPoint
.... valueCountCount
.... valueDistanceDistance
.... valueDurationDuration
.... valueHumanNameHumanName
.... valueIdentifierIdentifier
.... valueMoneyMoney
.... valuePeriodPeriod
.... valueQuantityQuantity
.... valueRangeRange
.... valueRatioRatio
.... valueReferenceReference(Any)
.... valueSampledDataSampledData
.... valueSignatureSignature
.... valueTimingTiming
.... valueContactDetailContactDetail
.... valueContributorContributor
.... valueDataRequirementDataRequirement
.... valueExpressionExpression
.... valueParameterDefinitionParameterDefinition
.... valueRelatedArtifactRelatedArtifact
.... valueTriggerDefinitionTriggerDefinition
.... valueUsageContextUsageContext
.... valueDosageDosage
.... valueMetaMeta

doco Documentation for this format

XML Template

<!-- References -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/DiagnosticReport-geneticsReferences" >
 <-- extension sliced by value:url  in the specified orderOpen-->
 <extension url="description"> ?? 0..1 Extension  <!-- ?? 0..1 Reference description -->
  <valueString value="[string]"/><!-- ?? 1..1 Value of extension -->
 </extension>
 <extension url="reference"> ?? 0..* Extension  <!-- ?? 0..* Reference URI -->
  <valueUri value="[uri]"/><!-- ?? 1..1 Value of extension -->
 </extension>
 <extension url="type"> ?? 0..1 Extension  <!-- ?? 0..1 Reference type -->
  <valueCodeableConcept><!-- ?? 1..1 CodeableConcept Value of extension --></valueCodeableConcept>
 </extension>
</extension>

JSON Template

{ // References
    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // Reference description // C?
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "description", // R! 
        "valueString" : "<string>" // C? R! Value of extension
      },
      { // Reference URI // C?
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "reference", // R! 
        "valueUri" : "<uri>" // C? R! Value of extension
      },
      { // Reference type // C?
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "type", // R! 
        "valueCodeableConcept" : { CodeableConcept } // C? R! Value of extension
      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/DiagnosticReport-geneticsReferences", // R! 
// value[x]: Value of extension. One of these 50:
  }

 

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.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)