This page is part of the FHIR Specification (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

Summary

Name	Card.	Type	Description & Constraints
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.
status	0..1	code	The status of this individual item within the order.
Documentation for this format

Full Structure

Name	Flags	Card.	Type	Description & Constraints
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
extension:specimen	I	0..1	Extension	If this item relates to specific specimens
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
valueInteger64			integer64
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueUrl			url
valueUuid			uuid
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueContactDetail			ContactDetail
valueContributor			Contributor
valueDataRequirement			DataRequirement
valueExpression			Expression
valueParameterDefinition			ParameterDefinition
valueRelatedArtifact			RelatedArtifact
valueTriggerDefinition			TriggerDefinition
valueUsageContext			UsageContext
valueDosage			Dosage
valueMeta			Meta
Documentation for this format

XML Template

<!-- Item -->

<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><!--  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><!--  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	Card.	Type	Description & Constraints
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.
status	0..1	code	The status of this individual item within the order.
Documentation for this format

Full Structure

Name	Flags	Card.	Type	Description & Constraints
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
extension:specimen	I	0..1	Extension	If this item relates to specific specimens
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
valueInteger64			integer64
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueUrl			url
valueUuid			uuid
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueContactDetail			ContactDetail
valueContributor			Contributor
valueDataRequirement			DataRequirement
valueExpression			Expression
valueParameterDefinition			ParameterDefinition
valueRelatedArtifact			RelatedArtifact
valueTriggerDefinition			TriggerDefinition
valueUsageContext			UsageContext
valueDosage			Dosage
valueMeta			Meta
Documentation for this format

XML Template

<!-- Item -->

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