Release 5 Preview #1

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: reagent

Orders and Observations Work Group

Maturity Level: 1

Informative

Use Context: Any

URL for this extension:

http://hl7.org/fhir/StructureDefinition/observation-reagent

Status: draft. Extension maintained by: Health Level Seven, Inc. - OO WG

Reference to reagents used to generate this observation. This is intended for this for in-lab transactions between instruments and Laboratory Information Systems (LIS).

Comment:

Note this extension may be superseded by elements in planned instrumentation management resource elements.

Context of Use: Use on Element ID Observation

Summary

Name	Flags	Card.	Type	Description & Constraints
reagent		0..*	Reference(Substance)	URL = http://hl7.org/fhir/StructureDefinition/observation-reagent reagent: Reference to reagents used to generate this observation. This is intended for this for in-lab transactions between instruments and Laboratory Information Systems (LIS). Use on Element ID Observation
Documentation for this format

Full Structure

Name	Flags	Card.	Type	Description & Constraints
extension		0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/observation-reagent reagent: Reference to reagents used to generate this observation. This is intended for this for in-lab transactions between instruments and Laboratory Information Systems (LIS). Use on Element ID Observation
extension	I	0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/observation-reagent"
value[x]	I	1..1	Reference(Substance)	Value of extension
Documentation for this format

XML Template

<!-- reagent -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/observation-reagent" >
  <!-- from Element: extension -->
 <valueReference><!--  1..1 Reference(Substance) Value of extension --></valueReference>
</extension>

JSON Template

{ // reagent
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
    "url" : "http://hl7.org/fhir/StructureDefinition/observation-reagent", // R! 
    "valueReference" : { Reference(Substance) } // C? R! Value of extension
  }

Summary

Name	Flags	Card.	Type	Description & Constraints
reagent		0..*	Reference(Substance)	URL = http://hl7.org/fhir/StructureDefinition/observation-reagent reagent: Reference to reagents used to generate this observation. This is intended for this for in-lab transactions between instruments and Laboratory Information Systems (LIS). Use on Element ID Observation
Documentation for this format

Full Structure

Name	Flags	Card.	Type	Description & Constraints
extension		0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/observation-reagent reagent: Reference to reagents used to generate this observation. This is intended for this for in-lab transactions between instruments and Laboratory Information Systems (LIS). Use on Element ID Observation
extension	I	0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/observation-reagent"
value[x]	I	1..1	Reference(Substance)	Value of extension
Documentation for this format

XML Template

<!-- reagent -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/observation-reagent" >
  <!-- from Element: extension -->
 <valueReference><!--  1..1 Reference(Substance) Value of extension --></valueReference>
</extension>

JSON Template

{ // reagent
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
    "url" : "http://hl7.org/fhir/StructureDefinition/observation-reagent", // R! 
    "valueReference" : { Reference(Substance) } // C? R! Value of extension
  }

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.value[x]: All FHIR elements must have a @value or children (xpath on Extension.value[x]: @value|f:*|h:div)