Release 5 Preview #3
MedicationsThis 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 
. Page versions: R4B R4
| Pharmacy Work Group | Maturity Level: 3 | Standards 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
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  ProdCharacteristic | ΣD | Element | The 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..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 |
| 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 |
| 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 |
| 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 |
| 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 |
| 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 |
 shape | Σ | 0..1 | 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 | Σ | 0..* | 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 | Σ | 0..* | string | 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 |
 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 |
| Documentation for this format | ||||
UML Diagram (Legend)
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
{
// 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 |
|
See the Full Difference for further information
Structure
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ProdCharacteristic | ΣD | Element | The 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..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 |
| 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 |
| 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 |
| 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 |
| 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 |
| 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 |
| shape | Σ | 0..1 | 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 | Σ | 0..* | 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 | Σ | 0..* | string | 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 |
| 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 |
| Documentation for this format | ||||
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
{
// 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 |
|
See the Full Difference for further information
Constraints
ProdCharacteristic is used in the following places: DeviceDefinition
FHIR ®© HL7.org 2011+. FHIR R5 Preview #3 hl7.fhir.core#4.5.0 generated on Thu, Aug 20, 2020 17:46+1000.
Links: Search |
Version History |
Table of Contents |
QA Page |
Compare to R4 |
|
Propose a change