Release 5 Draft Ballot

This page is part of the FHIR Specification (v4.6.0: R5 Draft Ballot). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Extension: quantityRemaining

Pharmacy Work Group

Maturity Level: 1

Informative

Use Context: Any

URL for this extension:

http://hl7.org/fhir/StructureDefinition/medicationdispense-quantityRemaining

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

The quanity left to be dispensed after a dispensing event.

Context of Use: Use on Element ID MedicationDispense

Summary

Name	Flags	Card.	Type	Description & Constraints
quantityRemaining		0..1	SimpleQuantity	URL = http://hl7.org/fhir/StructureDefinition/medicationdispense-quantityRemaining quantityRemaining: The quanity left to be dispensed after a dispensing event. Use on Element ID MedicationDispense
Documentation for this format

Full Structure

Name	Flags	Card.	Type	Description & Constraints
extension		0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/medicationdispense-quantityRemaining quantityRemaining: The quanity left to be dispensed after a dispensing event. Use on Element ID MedicationDispense
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/medicationdispense-quantityRemaining"
value[x]	I	1..1	SimpleQuantity	A fixed quantity (no comparator)
Documentation for this format

XML Template

<!-- quantityRemaining -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/medicationdispense-quantityRemaining" >
  <!-- from Element: extension -->
 <valueQuantity><!--  1..1 Quantity A fixed quantity (no comparator) --></valueQuantity>
</extension>

JSON Template

{ // quantityRemaining
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
    "url" : "http://hl7.org/fhir/StructureDefinition/medicationdispense-quantityRemaining", // R! 
    "valueQuantity" : { Quantity(SimpleQuantity) } // C? R! A fixed quantity (no comparator)
  }

Summary

Name	Flags	Card.	Type	Description & Constraints
quantityRemaining		0..1	SimpleQuantity	URL = http://hl7.org/fhir/StructureDefinition/medicationdispense-quantityRemaining quantityRemaining: The quanity left to be dispensed after a dispensing event. Use on Element ID MedicationDispense
Documentation for this format

Full Structure

Name	Flags	Card.	Type	Description & Constraints
extension		0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/medicationdispense-quantityRemaining quantityRemaining: The quanity left to be dispensed after a dispensing event. Use on Element ID MedicationDispense
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/medicationdispense-quantityRemaining"
value[x]	I	1..1	SimpleQuantity	A fixed quantity (no comparator)
Documentation for this format

XML Template

<!-- quantityRemaining -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/medicationdispense-quantityRemaining" >
  <!-- from Element: extension -->
 <valueQuantity><!--  1..1 Quantity A fixed quantity (no comparator) --></valueQuantity>
</extension>

JSON Template

{ // quantityRemaining
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
    "url" : "http://hl7.org/fhir/StructureDefinition/medicationdispense-quantityRemaining", // R! 
    "valueQuantity" : { Quantity(SimpleQuantity) } // C? R! A fixed quantity (no comparator)
  }

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)
qty-3: On Extension.value[x]: If a code for the unit is present, the system SHALL also be present (xpath on Extension.value[x]: not(exists(f:code)) or exists(f:system))
sqty-1: On Extension.value[x]: The comparator is not used on a SimpleQuantity (xpath on Extension.value[x]: not(exists(f:comparator)))