R4 Draft for Comment

This page is part of the FHIR Specification (v3.2.0: R4 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: Item

Orders and Observations Work Group Maturity Level: 1InformativeUse 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: DiagnosticReport

usage info: insert a list of places where this extension is used

Extension Content

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = 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: DiagnosticReport
... code1..1CodeableConceptCode to indicate the item (test, panel or sequence variant) being ordered.
... geneticsObservation0..1Reference(Observation)Indicate the genetic variant ordered to be tested.
... specimen0..1Reference(Specimen)If the item is related to a specific specimen.
... status0..1codeThe status of this individual item within the order.

doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = 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: DiagnosticReport
... extension 1..1ExtensionCode to indicate the item (test, panel or sequence variant) being ordered
.... url 1..1uri"code"
.... valueCodeableConcept 0..1CodeableConceptValue of extension
... extension 0..1ExtensionIndicate the genetic variant ordered to be tested
.... url 1..1uri"geneticsObservation"
.... valueReference 0..1Reference(Observation)Value of extension
... extension 0..1ExtensionIf this item relates to specific specimens
.... url 1..1uri"specimen"
.... valueReference 0..1Reference(Specimen)Value of extension
... extension 0..1Extensionproposed | draft | planned | requested | received | accepted | in-progress | review | completed | cancelled | suspended | rejected | failed
.... url 1..1uri"status"
.... valueCode 0..1codeValue of extension
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/servicerequest-geneticsItem"
... value[x] 0..0

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><!-- 0..1 CodeableConcept 
      Value of extension --></valueCodeableConcept>
 </extension>
 <extension url="geneticsObservation"> 0..1 Extension  <!-- 0..1 Indicate the genetic variant ordered to be tested -->
  <valueReference><!-- 0..1 Reference(Observation) 
      Value of extension --></valueReference>
 </extension>
 <extension url="specimen"> 0..1 Extension  <!-- 0..1 If this item relates to specific specimens -->
  <valueReference><!-- 0..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]"/><!-- 0..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 // R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "code", // R! 
        "valueCodeableConcept" : { CodeableConcept } //Value of extension
      },
      { // Indicate the genetic variant ordered to be tested //
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "geneticsObservation", // R! 
        "valueReference" : { Reference(Observation) } //Value of extension
      },
      { // If this item relates to specific specimens //
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "specimen", // R! 
        "valueReference" : { Reference(Specimen) } //Value of extension
      },
      { // proposed | draft | planned | requested | received | accepted | in-progress | review | completed | cancelled | suspended | rejected | failed //
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "status", // R! 
        "valueCode" : "<code>" //Value of extension
      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/servicerequest-geneticsItem", // R! 
// value[x]: Value of extension. One of these 46:
  }

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = 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: DiagnosticReport
... code1..1CodeableConceptCode to indicate the item (test, panel or sequence variant) being ordered.
... geneticsObservation0..1Reference(Observation)Indicate the genetic variant ordered to be tested.
... specimen0..1Reference(Specimen)If the item is related to a specific specimen.
... status0..1codeThe status of this individual item within the order.

doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = 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: DiagnosticReport
... extension 1..1ExtensionCode to indicate the item (test, panel or sequence variant) being ordered
.... url 1..1uri"code"
.... valueCodeableConcept 0..1CodeableConceptValue of extension
... extension 0..1ExtensionIndicate the genetic variant ordered to be tested
.... url 1..1uri"geneticsObservation"
.... valueReference 0..1Reference(Observation)Value of extension
... extension 0..1ExtensionIf this item relates to specific specimens
.... url 1..1uri"specimen"
.... valueReference 0..1Reference(Specimen)Value of extension
... extension 0..1Extensionproposed | draft | planned | requested | received | accepted | in-progress | review | completed | cancelled | suspended | rejected | failed
.... url 1..1uri"status"
.... valueCode 0..1codeValue of extension
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/servicerequest-geneticsItem"
... value[x] 0..0

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><!-- 0..1 CodeableConcept 
      Value of extension --></valueCodeableConcept>
 </extension>
 <extension url="geneticsObservation"> 0..1 Extension  <!-- 0..1 Indicate the genetic variant ordered to be tested -->
  <valueReference><!-- 0..1 Reference(Observation) 
      Value of extension --></valueReference>
 </extension>
 <extension url="specimen"> 0..1 Extension  <!-- 0..1 If this item relates to specific specimens -->
  <valueReference><!-- 0..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]"/><!-- 0..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 // R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "code", // R! 
        "valueCodeableConcept" : { CodeableConcept } //Value of extension
      },
      { // Indicate the genetic variant ordered to be tested //
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "geneticsObservation", // R! 
        "valueReference" : { Reference(Observation) } //Value of extension
      },
      { // If this item relates to specific specimens //
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "specimen", // R! 
        "valueReference" : { Reference(Specimen) } //Value of extension
      },
      { // proposed | draft | planned | requested | received | accepted | in-progress | review | completed | cancelled | suspended | rejected | failed //
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "status", // R! 
        "valueCode" : "<code>" //Value of extension
      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/servicerequest-geneticsItem", // R! 
// value[x]: Value of extension. One of these 46:
  }

 

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')]))