ForecastedDoseVolumeExtension

The FHIR extension is for Forecast Dose Volume purposes.

id0..1string
extensionC0..0Extension
url1..1uriFixed Value
id0..1string
extensionC0..*Extension
valueΣ0..1decimal
comparatorΣ ?!0..0codeBinding
unitΣ0..1string
systemΣ C0..0uri
codeΣ0..0code
Extension
ShortOptional Extensions Element
Definition

Optional Extension Element - found in all resources.

Cardinality0..1
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Extension.id
ShortUnique 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.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Extension.extension
ShortAdditional content defined by implementations
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Cardinality0..0
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Extension.url
Shortidentifies the meaning of the extension
Definition

Source of the definition for the extension code - a logical name or a URL.

Cardinality1..1
Typeuri
Comments

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.

Fixed Value
https://ehealth.bc.ca/fhir/StructureDefinition/bcy-ids-forecast-dose-volume
Mappings
  • rim: N/A
Extension.value[x]
ShortValue of extension
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Cardinality0..1
TypeQuantity
ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
Extension.value[x].id
ShortUnique 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.

Cardinality0..1
Typestring
Mappings
  • rim: n/a
Extension.value[x].extension
ShortAdditional content defined by implementations
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Cardinality0..*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
Extension.value[x].value
ShortNumerical value (with implicit precision)
Definition

The value of the measured amount. The value includes an implicit precision in the presentation of the value.

Cardinality0..1
Typedecimal
SummaryTrue
Requirements

Precision is handled implicitly in almost all cases of measurement.

Comments

The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: SN.2 / CQ - N/A
  • rim: PQ.value, CO.value, MO.value, IVL.high or IVL.low depending on the value
Extension.value[x].comparator
Short< | <= | >= | > - how to understand the value
Definition

How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.

Cardinality0..0
Typecode
Binding

How the Quantity should be understood and represented.

QuantityComparator (required)

ModifierTrue
SummaryTrue
Requirements

Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Meaning when missing

If there is no comparator, then there is no modification of the value

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: SN.1 / CQ.1
  • rim: IVL properties
Extension.value[x].unit
ShortUnit representation
Definition

A human-readable form of the unit.

Cardinality0..1
Typestring
SummaryTrue
Requirements

There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: (see OBX.6 etc.) / CQ.2
  • rim: PQ.unit
Extension.value[x].system
ShortSystem that defines coded unit form
Definition

The identification of the system that provides the coded form of the unit.

Cardinality0..0
Typeuri
SummaryTrue
Requirements

Need to know the system that defines the coded form of the unit.

Comments

see http://en.wikipedia.org/wiki/Uniform_resource_identifier

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1, qty-3
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: (see OBX.6 etc.) / CQ.2
  • rim: CO.codeSystem, PQ.translation.codeSystem
Extension.value[x].code
ShortCoded form of the unit
Definition

A computer processable form of the unit in some unit representation system.

Cardinality0..0
Typecode
SummaryTrue
Requirements

Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.

Comments

The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.

ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1
Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: (see OBX.6 etc.) / CQ.2
  • rim: PQ.code, MO.currency, PQ.translation.code
<StructureDefinition xmlns="http://hl7.org/fhir">
<url value="https://ehealth.bc.ca/fhir/StructureDefinition/bcy-ids-forecast-dose-volume" />
<name value="ForecastedDoseVolumeExtension" />
<status value="draft" />
<fhirVersion value="4.0.1" />
<kind value="complex-type" />
<abstract value="false" />
<type value="element" />
<expression value="ImmunizationRecommendation.recommendation" />
</context>
<type value="Extension" />
<baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" />
<derivation value="constraint" />
<element id="Extension">
<path value="Extension" />
<max value="1" />
</element>
<element id="Extension.extension">
<path value="Extension.extension" />
<max value="0" />
</element>
<element id="Extension.url">
<path value="Extension.url" />
<fixedUri value="https://ehealth.bc.ca/fhir/StructureDefinition/bcy-ids-forecast-dose-volume" />
</element>
<element id="Extension.value[x]">
<path value="Extension.value[x]" />
<code value="Quantity" />
</type>
</element>
<element id="Extension.value[x].comparator">
<path value="Extension.value[x].comparator" />
<max value="0" />
</element>
<element id="Extension.value[x].system">
<path value="Extension.value[x].system" />
<max value="0" />
</element>
<element id="Extension.value[x].code">
<path value="Extension.value[x].code" />
<max value="0" />
</element>
</differential>
</StructureDefinition>
{
"resourceType": "StructureDefinition",
"url": "https://ehealth.bc.ca/fhir/StructureDefinition/bcy-ids-forecast-dose-volume",
"name": "ForecastedDoseVolumeExtension",
"status": "draft",
"fhirVersion": "4.0.1",
"kind": "complex-type",
"abstract": false,
"context": [
{
"type": "element",
"expression": "ImmunizationRecommendation.recommendation"
}
],
"type": "Extension",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension",
"derivation": "constraint",
"element": [
{
"id": "Extension",
"path": "Extension",
"max": "1"
},
{
"id": "Extension.extension",
"path": "Extension.extension",
"max": "0"
},
{
"id": "Extension.url",
"path": "Extension.url",
"fixedUri": "https://ehealth.bc.ca/fhir/StructureDefinition/bcy-ids-forecast-dose-volume"
},
{
"id": "Extension.value[x]",
"path": "Extension.value[x]",
"type": [
{
"code": "Quantity"
}
]
},
{
"id": "Extension.value[x].comparator",
"path": "Extension.value[x].comparator",
"max": "0"
},
{
"id": "Extension.value[x].system",
"path": "Extension.value[x].system",
"max": "0"
},
{
"id": "Extension.value[x].code",
"path": "Extension.value[x].code",
"max": "0"
}
]
}
}