Release 4 5 Preview #1

This page is part of the FHIR Specification (v4.0.1: R4 - Mixed Normative and STU ) in it's permanent home (it will always be available at this URL). (v4.2.0: R5 Preview #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: Item

Orders and Observations Work Group   Maturity Level : 1 Informative Use Context : Any

URL for this extension: 


http://hl7.org/fhir/StructureDefinition/servicerequest-geneticsItem

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

The specific diagnostic investigations that are requested as part of this request. Sometimes, there can only be one item per request, but in most contexts, more than one investigation can be requested.

Context of Use: Use on Element ID DiagnosticReport

Extension Content

Summary

Name Flags Card. Type Description & Constraints doco
. . Item 0..* Extension URL = http://hl7.org/fhir/StructureDefinition/servicerequest-geneticsItem
Item: The specific diagnostic investigations that are requested as part of this request. Sometimes, there can only be one item per request, but in most contexts, more than one investigation can be requested.


Use on Element ID DiagnosticReport
. . . code 1..1 CodeableConcept Code to indicate the item (test, panel or sequence variant) being ordered.

. . . geneticsObservation 0..1 Reference ( Observation ) Indicate the genetic variant ordered to be tested.

. . . specimen 0..1 Reference ( Specimen ) If the item is related to a specific specimen.


doco Documentation for this format

Full Structure

Name Flags Card. Type Description & Constraints doco
. . extension 0..* Extension URL = http://hl7.org/fhir/StructureDefinition/servicerequest-geneticsItem
Item: The specific diagnostic investigations that are requested as part of this request. Sometimes, there can only be one item per request, but in most contexts, more than one investigation can be requested.


Use on Element ID DiagnosticReport
. . . extension I 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
. . . extension:code I 1..1 Extension Code to indicate the item (test, panel or sequence variant) being ordered
. . . . id 0..1 string Unique id for inter-element referencing
.... extension I 0..0
. . . . url 1..1 uri "code"
. . . . value[x] I 1..1 CodeableConcept Value of extension
. . . extension:geneticsObservation I 0..1 Extension Indicate the genetic variant ordered to be tested
. . . . id 0..1 string Unique id for inter-element referencing
. . . . extension I 0..0
. . . . url 1..1 uri "geneticsObservation"
. . . . value[x] I 1..1 Reference ( Observation ) Value of extension
. . . . id 0..1 string Unique id for inter-element referencing
.... extension I 0..0
. . . . url 1..1 uri "specimen"
. . . . value[x] I 1..1 Reference ( Specimen ) Value of extension
. . . extension:status I 0..1 Extension proposed | draft | planned | requested | received | accepted | in-progress | review | completed | cancelled | suspended | rejected | failed
. . . . id 0..1 string Unique id for inter-element referencing
. . . . extension I 0..0
. . . . url 1..1 uri "status"
. . . . value[x] I 1..1 code Value of extension
. . . url 1..1 uri "http://hl7.org/fhir/StructureDefinition/servicerequest-geneticsItem"
. . . value[x] I 0 .. 0
. . . . valueBase64Binary base64Binary
. . . . valueBoolean boolean
. . . . valueCanonical canonical () (Any)
. . . . valueCode code
. . . . valueDate date
. . . . valueDateTime dateTime
. . . . valueDecimal decimal
. . . . valueId id
. . . . valueInstant instant
. . . . valueInteger integer
. . . . valueMarkdown valueInteger64 markdown integer64
. . . . valueOid valueMarkdown oid markdown
. . . . valuePositiveInt valueOid positiveInt oid
. . . . valueString valuePositiveInt string positiveInt
. . . . valueTime valueString time string
. . . . valueUnsignedInt valueTime unsignedInt time
. . . . valueUri valueUnsignedInt uri unsignedInt
. . . . valueUrl valueUri url uri
. . . . valueUuid valueUrl uuid url
. . . valueAddress . valueUuid Address uuid
. . . . valueAge valueAddress Age Address
. . . . valueAnnotation valueAge Annotation Age
. . . . valueAttachment valueAnnotation Attachment Annotation
. . . . valueCodeableConcept valueAttachment CodeableConcept Attachment
. . . . valueCoding valueCodeableConcept Coding CodeableConcept
. . . . valueContactPoint valueCoding ContactPoint Coding
. . . . valueCount valueContactPoint Count ContactPoint
. . . . valueDistance valueCount Distance Count
. . . . valueDuration valueDistance Duration Distance
. . . . valueHumanName valueDuration HumanName Duration
. . . . valueIdentifier valueHumanName Identifier HumanName
. . . . valueMoney valueIdentifier Money Identifier
. . . . valuePeriod valueMoney Period Money
. . . . valueQuantity valuePeriod Quantity Period
. . . . valueRange valueQuantity Range Quantity
. . . . valueRatio valueRange Ratio Range
. . . valueReference . valueRatio Reference Ratio ()
. . . valueSampledData . valueReference SampledData Reference (Any)
. . . . valueSignature valueSampledData Signature SampledData
. . . . valueTiming valueSignature Timing Signature
. . . . valueContactDetail valueTiming ContactDetail Timing
. . . . valueContributor valueContactDetail Contributor ContactDetail
. . . . valueDataRequirement valueContributor DataRequirement Contributor
. . . . valueExpression valueDataRequirement Expression DataRequirement
. . . . valueParameterDefinition valueExpression ParameterDefinition Expression
. . . . valueRelatedArtifact valueParameterDefinition RelatedArtifact ParameterDefinition
. . . . valueTriggerDefinition valueRelatedArtifact TriggerDefinition RelatedArtifact
. . . . valueUsageContext valueTriggerDefinition UsageContext TriggerDefinition
. . . . valueDosage valueUsageContext Dosage UsageContext
. . . . valueMeta valueDosage Dosage
.... valueMeta Meta

doco Documentation for this format

XML Template 

<!-- Item -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/servicerequest-geneticsItem" >
 <-- extension sliced by value:url  in the specified orderOpen-->
 <extension url="code"> ?? 1..1 Extension  <!-- ?? 1..1 Code to indicate the item (test, panel or sequence variant) being ordered -->
  <

  <valueCodeableConcept><!-- ?? 1..1 CodeableConcept 

      Value of extension --></valueCodeableConcept>
 </extension>
 <extension url="geneticsObservation"> ?? 0..1 Extension  <!-- ?? 0..1 Indicate the genetic variant ordered to be tested -->
  <</valueReference>

  <valueReference><!-- ?? 1..1 Reference(Observation) Value of extension --></valueReference>

 </extension>
 <extension url="specimen"> ?? 0..1 Extension  <!-- ?? 0..1 If this item relates to specific specimens -->
  <</valueReference>

  <valueReference><!-- ?? 1..1 Reference(Specimen) Value of extension --></valueReference>

 </extension>
 <extension url="status"> ?? 0..1 Extension  <!-- ?? 0..1 proposed | draft | planned | requested | received | accepted | in-progress | review | completed | cancelled | suspended | rejected | failed -->
  <

  <valueCode value="[code]"/><!-- ?? 1..1 Value of extension -->

 </extension>
</extension>

JSON Template 

{ // Item
    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // Code to indicate the item (test, panel or sequence variant) being ordered // C? R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "code", // R! 
        "

        "valueCodeableConcept" : { CodeableConcept } // C? R! Value of extension

      },
      { // Indicate the genetic variant ordered to be tested // C?
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "geneticsObservation", // R! 
        "

        "valueReference" : { Reference(Observation) } // C? R! Value of extension

      },
      { // If this item relates to specific specimens // C?
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "specimen", // R! 
        "

        "valueReference" : { Reference(Specimen) } // C? R! Value of extension

      },
      { // proposed | draft | planned | requested | received | accepted | in-progress | review | completed | cancelled | suspended | rejected | failed // C?
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "status", // R! 
        "

        "valueCode" : "<code>" // C? R! Value of extension

      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/servicerequest-geneticsItem", // R! 


// value[x]: Value of extension. One of these 51:
  }

Summary

Name Flags Card. Type Description & Constraints doco
. . Item 0..* Extension URL = http://hl7.org/fhir/StructureDefinition/servicerequest-geneticsItem
Item: The specific diagnostic investigations that are requested as part of this request. Sometimes, there can only be one item per request, but in most contexts, more than one investigation can be requested.


Use on Element ID DiagnosticReport
. . . code 1..1 CodeableConcept Code to indicate the item (test, panel or sequence variant) being ordered.

. . . geneticsObservation 0..1 Reference ( Observation ) Indicate the genetic variant ordered to be tested.

. . . specimen 0..1 Reference ( Specimen ) If the item is related to a specific specimen.


doco Documentation for this format

Full Structure

Name Flags Card. Type Description & Constraints doco
. . extension 0..* Extension URL = http://hl7.org/fhir/StructureDefinition/servicerequest-geneticsItem
Item: The specific diagnostic investigations that are requested as part of this request. Sometimes, there can only be one item per request, but in most contexts, more than one investigation can be requested.


Use on Element ID DiagnosticReport
. . . extension I 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
. . . extension:code I 1..1 Extension Code to indicate the item (test, panel or sequence variant) being ordered
. . . . id 0..1 string Unique id for inter-element referencing
.... extension I 0..0
. . . . url 1..1 uri "code"
. . . . value[x] I 1..1 CodeableConcept Value of extension
. . . extension:geneticsObservation I 0..1 Extension Indicate the genetic variant ordered to be tested
. . . . id 0..1 string Unique id for inter-element referencing
. . . . extension I 0..0
. . . . url 1..1 uri "geneticsObservation"
. . . . value[x] I 1..1 Reference ( Observation ) Value of extension
. . . . id 0..1 string Unique id for inter-element referencing
.... extension I 0..0
. . . . url 1..1 uri "specimen"
. . . . value[x] I 1..1 Reference ( Specimen ) Value of extension
. . . extension:status I 0..1 Extension proposed | draft | planned | requested | received | accepted | in-progress | review | completed | cancelled | suspended | rejected | failed
. . . . id 0..1 string Unique id for inter-element referencing
. . . . extension I 0..0
. . . . url 1..1 uri "status"
. . . . value[x] I 1..1 code Value of extension
. . . url 1..1 uri "http://hl7.org/fhir/StructureDefinition/servicerequest-geneticsItem"
. . . value[x] I 0 .. 0
. . . . valueBase64Binary base64Binary
. . . . valueBoolean boolean
. . . . valueCanonical canonical () (Any)
. . . . valueCode code
. . . . valueDate date
. . . . valueDateTime dateTime
. . . . valueDecimal decimal
. . . . valueId id
. . . . valueInstant instant
. . . . valueInteger integer
. . . . valueMarkdown valueInteger64 markdown integer64
. . . . valueOid valueMarkdown oid markdown
. . . . valuePositiveInt valueOid positiveInt oid
. . . . valueString valuePositiveInt string positiveInt
. . . . valueTime valueString time string
. . . . valueUnsignedInt valueTime unsignedInt time
. . . . valueUri valueUnsignedInt uri unsignedInt
. . . . valueUrl valueUri url uri
. . . . valueUuid valueUrl uuid url
. . . valueAddress . valueUuid Address uuid
. . . . valueAge valueAddress Age Address
. . . . valueAnnotation valueAge Annotation Age
. . . . valueAttachment valueAnnotation Attachment Annotation
. . . . valueCodeableConcept valueAttachment CodeableConcept Attachment
. . . . valueCoding valueCodeableConcept Coding CodeableConcept
. . . . valueContactPoint valueCoding ContactPoint Coding
. . . . valueCount valueContactPoint Count ContactPoint
. . . . valueDistance valueCount Distance Count
. . . . valueDuration valueDistance Duration Distance
. . . . valueHumanName valueDuration HumanName Duration
. . . . valueIdentifier valueHumanName Identifier HumanName
. . . . valueMoney valueIdentifier Money Identifier
. . . . valuePeriod valueMoney Period Money
. . . . valueQuantity valuePeriod Quantity Period
. . . . valueRange valueQuantity Range Quantity
. . . . valueRatio valueRange Ratio Range
. . . valueReference . valueRatio Reference Ratio ()
. . . valueSampledData . valueReference SampledData Reference (Any)
. . . . valueSignature valueSampledData Signature SampledData
. . . . valueTiming valueSignature Timing Signature
. . . . valueContactDetail valueTiming ContactDetail Timing
. . . . valueContributor valueContactDetail Contributor ContactDetail
. . . . valueDataRequirement valueContributor DataRequirement Contributor
. . . . valueExpression valueDataRequirement Expression DataRequirement
. . . . valueParameterDefinition valueExpression ParameterDefinition Expression
. . . . valueRelatedArtifact valueParameterDefinition RelatedArtifact ParameterDefinition
. . . . valueTriggerDefinition valueRelatedArtifact TriggerDefinition RelatedArtifact
. . . . valueUsageContext valueTriggerDefinition UsageContext TriggerDefinition
. . . . valueDosage valueUsageContext Dosage UsageContext
. . . . valueMeta valueDosage Dosage
.... valueMeta Meta

doco Documentation for this format

XML Template 

<!-- Item -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/servicerequest-geneticsItem" >
 <-- extension sliced by value:url  in the specified orderOpen-->
 <extension url="code"> ?? 1..1 Extension  <!-- ?? 1..1 Code to indicate the item (test, panel or sequence variant) being ordered -->
  <

  <valueCodeableConcept><!-- ?? 1..1 CodeableConcept 

      Value of extension --></valueCodeableConcept>
 </extension>
 <extension url="geneticsObservation"> ?? 0..1 Extension  <!-- ?? 0..1 Indicate the genetic variant ordered to be tested -->
  <</valueReference>

  <valueReference><!-- ?? 1..1 Reference(Observation) Value of extension --></valueReference>

 </extension>
 <extension url="specimen"> ?? 0..1 Extension  <!-- ?? 0..1 If this item relates to specific specimens -->
  <</valueReference>

  <valueReference><!-- ?? 1..1 Reference(Specimen) Value of extension --></valueReference>

 </extension>
 <extension url="status"> ?? 0..1 Extension  <!-- ?? 0..1 proposed | draft | planned | requested | received | accepted | in-progress | review | completed | cancelled | suspended | rejected | failed -->
  <

  <valueCode value="[code]"/><!-- ?? 1..1 Value of extension -->

 </extension>
</extension>

JSON Template 

{ // Item
    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // Code to indicate the item (test, panel or sequence variant) being ordered // C? R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "code", // R! 
        "

        "valueCodeableConcept" : { CodeableConcept } // C? R! Value of extension

      },
      { // Indicate the genetic variant ordered to be tested // C?
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "geneticsObservation", // R! 
        "

        "valueReference" : { Reference(Observation) } // C? R! Value of extension

      },
      { // If this item relates to specific specimens // C?
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "specimen", // R! 
        "

        "valueReference" : { Reference(Specimen) } // C? R! Value of extension

      },
      { // proposed | draft | planned | requested | received | accepted | in-progress | review | completed | cancelled | suspended | rejected | failed // C?
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "status", // R! 
        "

        "valueCode" : "<code>" // C? R! Value of extension

      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/servicerequest-geneticsItem", // R! 


// value[x]: Value of extension. One of these 51:
  }

 

Constraints

  • ele-1 : All FHIR elements must have a @value or children (xpath: @value|f:*|h:div )
  • 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.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 )