Release 4

11.27.0 ProdCharacteristic

Pharmacy Work GroupMaturity Level: 3Standards Status: Trial Use
This type is still undergoing development and review by the appropriate Workgroups. At this time, is considered only as a draft design not suitable for production implementation

The ProdCharacteristic structure defines TODO.

Note: the ProdCharacteristic structure allows modifier extensions.

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. ProdCharacteristicΣDElementThe marketing status describes the date when a medicinal product is actually put on the market or the date as of which it is no longer available
Elements defined in Ancestors: id, extension, modifierExtension
... heightΣ0..1QuantityWhere applicable, the height can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used
... widthΣ0..1QuantityWhere applicable, the width can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used
... depthΣ0..1QuantityWhere applicable, the depth can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used
... nominalVolumeΣ0..1QuantityWhere applicable, the nominal volume can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used
... externalDiameterΣ0..1QuantityWhere applicable, the external diameter can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used
... shapeΣ0..1stringWhere applicable, the shape can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used
... colorΣ0..*stringWhere applicable, the color can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used
... imprintΣ0..*stringWhere applicable, the imprint can be specified as text
... imageΣ0..*AttachmentWhere applicable, the image can be provided The format of the image attachment shall be specified by regional implementations
... scoringΣ0..1CodeableConceptWhere applicable, the scoring can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used

doco Documentation for this format

UML Diagram (Legend)

ProdCharacteristicWhere applicable, the height can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be usedheight : Quantity [0..1]Where applicable, the width can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be usedwidth : Quantity [0..1]Where applicable, the depth can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be useddepth : Quantity [0..1]Where applicable, the weight can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be usedweight : Quantity [0..1]Where applicable, the nominal volume can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be usednominalVolume : Quantity [0..1]Where applicable, the external diameter can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be usedexternalDiameter : Quantity [0..1]Where applicable, the shape can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be usedshape : string [0..1]Where applicable, the color can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be usedcolor : string [0..*]Where applicable, the imprint can be specified as textimprint : string [0..*]Where applicable, the image can be provided The format of the image attachment shall be specified by regional implementationsimage : Attachment [0..*]Where applicable, the scoring can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be usedscoring : CodeableConcept [0..1]BackboneTypeMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)modifierExtension : Extension [0..*]

XML Template

<ProdCharacteristic xmlns="http://hl7.org/fhir">
 <!-- from Element: extension -->
 <height><!-- 0..1 Quantity Where applicable, the height can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used --></height>
 <width><!-- 0..1 Quantity Where applicable, the width can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used --></width>
 <depth><!-- 0..1 Quantity Where applicable, the depth can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used --></depth>
 <weight><!-- 0..1 Quantity Where applicable, the weight can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used --></weight>
 <nominalVolume><!-- 0..1 Quantity Where applicable, the nominal volume can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used --></nominalVolume>
 <externalDiameter><!-- 0..1 Quantity Where applicable, the external diameter can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used --></externalDiameter>
 <shape value="[string]"/><!-- 0..1 Where applicable, the shape can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used -->
 <color value="[string]"/><!-- 0..* Where applicable, the color can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used -->
 <imprint value="[string]"/><!-- 0..* Where applicable, the imprint can be specified as text -->
 <image><!-- 0..* Attachment Where applicable, the image can be provided The format of the image attachment shall be specified by regional implementations --></image>
 <scoring><!-- 0..1 CodeableConcept Where applicable, the scoring can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used --></scoring>
</ProdCharacteristic>

JSON Template

{doco
  // from Element: extension
  "height" : { Quantity }, // Where applicable, the height can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used
  "width" : { Quantity }, // Where applicable, the width can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used
  "depth" : { Quantity }, // Where applicable, the depth can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used
  "weight" : { Quantity }, // Where applicable, the weight can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used
  "nominalVolume" : { Quantity }, // Where applicable, the nominal volume can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used
  "externalDiameter" : { Quantity }, // Where applicable, the external diameter can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used
  "shape" : "<string>", // Where applicable, the shape can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used
  "color" : ["<string>"], // Where applicable, the color can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used
  "imprint" : ["<string>"], // Where applicable, the imprint can be specified as text
  "image" : [{ Attachment }], // Where applicable, the image can be provided The format of the image attachment shall be specified by regional implementations
  "scoring" : { CodeableConcept } // Where applicable, the scoring can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .

[
 # from Element: Element.extension
  fhir:ProdCharacteristic.height [ Quantity ]; # 0..1 Where applicable, the height can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used
  fhir:ProdCharacteristic.width [ Quantity ]; # 0..1 Where applicable, the width can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used
  fhir:ProdCharacteristic.depth [ Quantity ]; # 0..1 Where applicable, the depth can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used
  fhir:ProdCharacteristic.weight [ Quantity ]; # 0..1 Where applicable, the weight can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used
  fhir:ProdCharacteristic.nominalVolume [ Quantity ]; # 0..1 Where applicable, the nominal volume can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used
  fhir:ProdCharacteristic.externalDiameter [ Quantity ]; # 0..1 Where applicable, the external diameter can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used
  fhir:ProdCharacteristic.shape [ string ]; # 0..1 Where applicable, the shape can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used
  fhir:ProdCharacteristic.color [ string ], ... ; # 0..* Where applicable, the color can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used
  fhir:ProdCharacteristic.imprint [ string ], ... ; # 0..* Where applicable, the imprint can be specified as text
  fhir:ProdCharacteristic.image [ Attachment ], ... ; # 0..* Where applicable, the image can be provided The format of the image attachment shall be specified by regional implementations
  fhir:ProdCharacteristic.scoring [ CodeableConcept ]; # 0..1 Where applicable, the scoring can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used
]

Changes since Release 3

ProdCharacteristic
  • No Changes

See the Full Difference for further information

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. ProdCharacteristicΣDElementThe marketing status describes the date when a medicinal product is actually put on the market or the date as of which it is no longer available
Elements defined in Ancestors: id, extension, modifierExtension
... heightΣ0..1QuantityWhere applicable, the height can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used
... widthΣ0..1QuantityWhere applicable, the width can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used
... depthΣ0..1QuantityWhere applicable, the depth can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used
... nominalVolumeΣ0..1QuantityWhere applicable, the nominal volume can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used
... externalDiameterΣ0..1QuantityWhere applicable, the external diameter can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used
... shapeΣ0..1stringWhere applicable, the shape can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used
... colorΣ0..*stringWhere applicable, the color can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used
... imprintΣ0..*stringWhere applicable, the imprint can be specified as text
... imageΣ0..*AttachmentWhere applicable, the image can be provided The format of the image attachment shall be specified by regional implementations
... scoringΣ0..1CodeableConceptWhere applicable, the scoring can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used

doco Documentation for this format

UML Diagram (Legend)

ProdCharacteristicWhere applicable, the height can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be usedheight : Quantity [0..1]Where applicable, the width can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be usedwidth : Quantity [0..1]Where applicable, the depth can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be useddepth : Quantity [0..1]Where applicable, the weight can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be usedweight : Quantity [0..1]Where applicable, the nominal volume can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be usednominalVolume : Quantity [0..1]Where applicable, the external diameter can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be usedexternalDiameter : Quantity [0..1]Where applicable, the shape can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be usedshape : string [0..1]Where applicable, the color can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be usedcolor : string [0..*]Where applicable, the imprint can be specified as textimprint : string [0..*]Where applicable, the image can be provided The format of the image attachment shall be specified by regional implementationsimage : Attachment [0..*]Where applicable, the scoring can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be usedscoring : CodeableConcept [0..1]BackboneTypeMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)modifierExtension : Extension [0..*]

XML Template

<ProdCharacteristic xmlns="http://hl7.org/fhir">
 <!-- from Element: extension -->
 <height><!-- 0..1 Quantity Where applicable, the height can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used --></height>
 <width><!-- 0..1 Quantity Where applicable, the width can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used --></width>
 <depth><!-- 0..1 Quantity Where applicable, the depth can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used --></depth>
 <weight><!-- 0..1 Quantity Where applicable, the weight can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used --></weight>
 <nominalVolume><!-- 0..1 Quantity Where applicable, the nominal volume can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used --></nominalVolume>
 <externalDiameter><!-- 0..1 Quantity Where applicable, the external diameter can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used --></externalDiameter>
 <shape value="[string]"/><!-- 0..1 Where applicable, the shape can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used -->
 <color value="[string]"/><!-- 0..* Where applicable, the color can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used -->
 <imprint value="[string]"/><!-- 0..* Where applicable, the imprint can be specified as text -->
 <image><!-- 0..* Attachment Where applicable, the image can be provided The format of the image attachment shall be specified by regional implementations --></image>
 <scoring><!-- 0..1 CodeableConcept Where applicable, the scoring can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used --></scoring>
</ProdCharacteristic>

JSON Template

{doco
  // from Element: extension
  "height" : { Quantity }, // Where applicable, the height can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used
  "width" : { Quantity }, // Where applicable, the width can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used
  "depth" : { Quantity }, // Where applicable, the depth can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used
  "weight" : { Quantity }, // Where applicable, the weight can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used
  "nominalVolume" : { Quantity }, // Where applicable, the nominal volume can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used
  "externalDiameter" : { Quantity }, // Where applicable, the external diameter can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used
  "shape" : "<string>", // Where applicable, the shape can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used
  "color" : ["<string>"], // Where applicable, the color can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used
  "imprint" : ["<string>"], // Where applicable, the imprint can be specified as text
  "image" : [{ Attachment }], // Where applicable, the image can be provided The format of the image attachment shall be specified by regional implementations
  "scoring" : { CodeableConcept } // Where applicable, the scoring can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .

[
 # from Element: Element.extension
  fhir:ProdCharacteristic.height [ Quantity ]; # 0..1 Where applicable, the height can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used
  fhir:ProdCharacteristic.width [ Quantity ]; # 0..1 Where applicable, the width can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used
  fhir:ProdCharacteristic.depth [ Quantity ]; # 0..1 Where applicable, the depth can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used
  fhir:ProdCharacteristic.weight [ Quantity ]; # 0..1 Where applicable, the weight can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used
  fhir:ProdCharacteristic.nominalVolume [ Quantity ]; # 0..1 Where applicable, the nominal volume can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used
  fhir:ProdCharacteristic.externalDiameter [ Quantity ]; # 0..1 Where applicable, the external diameter can be specified using a numerical value and its unit of measurement The unit of measurement shall be specified in accordance with ISO 11240 and the resulting terminology The symbol and the symbol identifier shall be used
  fhir:ProdCharacteristic.shape [ string ]; # 0..1 Where applicable, the shape can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used
  fhir:ProdCharacteristic.color [ string ], ... ; # 0..* Where applicable, the color can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used
  fhir:ProdCharacteristic.imprint [ string ], ... ; # 0..* Where applicable, the imprint can be specified as text
  fhir:ProdCharacteristic.image [ Attachment ], ... ; # 0..* Where applicable, the image can be provided The format of the image attachment shall be specified by regional implementations
  fhir:ProdCharacteristic.scoring [ CodeableConcept ]; # 0..1 Where applicable, the scoring can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used
]

Changes since Release 3

ProdCharacteristic
  • No Changes

See the Full Difference for further information

Constraints

ProdCharacteristic is used in the following places: DeviceDefinition