This page is part of the FHIR Specification (v4.5.0: R5 Preview #3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions
Pharmacy Work Group | Maturity Level: N/A | Standards Status: Informative |
Raw JSON (canonical form + also see JSON Format Specification)
quantityRemaining
{ "resourceType" : "StructureDefinition", "id" : "medicationdispense-quantityRemaining", "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg", "valueCode" : "phx" }, { "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm", "valueInteger" : 1 }], "url" : "http://hl7.org/fhir/StructureDefinition/medicationdispense-quantityRemaining", "version" : "4.5.0", "name" : "quantityRemaining", "title" : "quantityRemaining", "status" : "draft", "date" : "2019-03-23", "publisher" : "Health Level Seven, Inc. - FHIR WG", "contact" : [{ "telecom" : [{ "system" : "url", "value" : "HL7" }] }], "description" : "The quanity left to be dispensed after a dispensing event.", "fhirVersion" : "4.5.0", "mapping" : [{ "identity" : "rim", "uri" : "http://hl7.org/v3", "name" : "RIM Mapping" }], "kind" : "complex-type", "abstract" : false, "context" : [{ "type" : "element", "expression" : "MedicationDispense" }], "type" : "Extension", "baseDefinition" : "http://hl7.org/fhir/StructureDefinition/Extension", "derivation" : "constraint", "snapshot" : { "element" : [{ "id" : "Extension", "path" : "Extension", "short" : "Quanity of medication left to be dispensed after a dispensing event", "definition" : "The quanity left to be dispensed after a dispensing event.", "min" : 0, "max" : "1", "base" : { "path" : "Extension", "min" : 0, "max" : "*" }, "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }, { "key" : "ext-1", "severity" : "error", "human" : "Must have either extensions or value[x], not both", "expression" : "extension.exists() != value.exists()", "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])", "source" : "http://hl7.org/fhir/StructureDefinition/Extension" }], "isModifier" : false }, { "id" : "Extension.id", "path" : "Extension.id", "representation" : ["xmlAttr"], "short" : "Unique id for inter-element referencing", "definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min" : 0, "max" : "1", "base" : { "path" : "Element.id", "min" : 0, "max" : "1" }, "type" : [{ "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUri" : "string" }], "code" : "http://hl7.org/fhirpath/System.String" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "rim", "map" : "n/a" }] }, { "id" : "Extension.extension", "path" : "Extension.extension", "slicing" : { "discriminator" : [{ "type" : "value", "path" : "url" }], "description" : "Extensions are always sliced by (at least) url", "rules" : "open" }, "short" : "Extension", "definition" : "An Extension", "min" : 0, "max" : "0", "base" : { "path" : "Element.extension", "min" : 0, "max" : "*" }, "type" : [{ "code" : "Extension" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }, { "key" : "ext-1", "severity" : "error", "human" : "Must have either extensions or value[x], not both", "expression" : "extension.exists() != value.exists()", "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source" : "http://hl7.org/fhir/StructureDefinition/Extension" }], "isModifier" : false, "isSummary" : false }, { "id" : "Extension.url", "path" : "Extension.url", "representation" : ["xmlAttr"], "short" : "identifies the meaning of the extension", "definition" : "Source of the definition for the extension code - a logical name or a URL.", "comment" : "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.", "min" : 1, "max" : "1", "base" : { "path" : "Extension.url", "min" : 1, "max" : "1" }, "type" : [{ "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUri" : "uri" }], "code" : "http://hl7.org/fhirpath/System.String" }], "fixedUri" : "http://hl7.org/fhir/StructureDefinition/medicationdispense-quantityRemaining", "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "rim", "map" : "N/A" }] }, { "id" : "Extension.value[x]", "path" : "Extension.value[x]", "short" : "A fixed quantity (no comparator)", "definition" : "The comparator is not used on a SimpleQuantity", "comment" : "The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.", "min" : 1, "max" : "1", "base" : { "path" : "Extension.value[x]", "min" : 0, "max" : "1" }, "type" : [{ "code" : "Quantity", "profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"] }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }, { "key" : "qty-3", "severity" : "error", "human" : "If a code for the unit is present, the system SHALL also be present", "expression" : "code.empty() or system.exists()", "xpath" : "not(exists(f:code)) or exists(f:system)", "source" : "http://hl7.org/fhir/StructureDefinition/Quantity" }, { "key" : "sqty-1", "severity" : "error", "human" : "The comparator is not used on a SimpleQuantity", "expression" : "comparator.empty()", "xpath" : "not(exists(f:comparator))", "source" : "http://hl7.org/fhir/StructureDefinition/Extension" }], "isModifier" : false, "mapping" : [{ "identity" : "rim", "map" : "n/a" }, { "identity" : "v2", "map" : "SN (see also Range) or CQ" }, { "identity" : "rim", "map" : "PQ, IVL<PQ>, MO, CO, depending on the values" }] }] }, "differential" : { "element" : [{ "id" : "Extension", "path" : "Extension", "short" : "Quanity of medication left to be dispensed after a dispensing event", "definition" : "The quanity left to be dispensed after a dispensing event.", "min" : 0, "max" : "1" }, { "id" : "Extension.extension", "path" : "Extension.extension", "max" : "0" }, { "id" : "Extension.url", "path" : "Extension.url", "fixedUri" : "http://hl7.org/fhir/StructureDefinition/medicationdispense-quantityRemaining" }, { "id" : "Extension.value[x]", "path" : "Extension.value[x]", "min" : 1, "type" : [{ "code" : "Quantity", "profile" : ["http://hl7.org/fhir/StructureDefinition/SimpleQuantity"] }] }] } }
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.