This page is part of the FHIR Specification (v3.3.0: R4 Ballot 2). 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
Modeling and Methodology Work Group | Maturity Level: N/A | Ballot Status: Informative |
StructureDefinition for ProdCharacteristic
{ "resourceType": "StructureDefinition", "id": "ProdCharacteristic", "meta": { "lastUpdated": "2018-04-03T12:05:46.262+10:00" }, "text": { "status": "generated", "div": "<div>!-- Snipped for Brevity --></div>" }, "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-ballot-status", "valueString": "Draft" } ], "url": "http://hl7.org/fhir/StructureDefinition/ProdCharacteristic", "name": "ProdCharacteristic", "status": "draft", "date": "2018-04-03T12:05:46+10:00", "publisher": "HL7 FHIR Standard", "contact": [ { "telecom": [ { "system": "url", "value": "http://hl7.org/fhir" } ] } ], "description": "Base StructureDefinition for ProdCharacteristic Type: 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.", "fhirVersion": "3.3.0", "mapping": [ { "identity": "rim", "uri": "http://hl7.org/v3", "name": "RIM Mapping" } ], "kind": "complex-type", "abstract": false, "type": "ProdCharacteristic", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/BackboneElement", "derivation": "specialization", "snapshot": { "element": [ { "id": "ProdCharacteristic", "path": "ProdCharacteristic", "short": "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", "definition": "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.", "min": 0, "max": "*", "base": { "path": "ProdCharacteristic", "min": 0, "max": "*" }, "isModifier": false, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "ProdCharacteristic.id", "path": "ProdCharacteristic.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "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": [ { "code": "string" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "ProdCharacteristic.extension", "path": "ProdCharacteristic.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional 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.", "comment": "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.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "ProdCharacteristic.modifierExtension", "path": "ProdCharacteristic.modifierExtension", "short": "Extensions that cannot be ignored", "definition": "May 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. 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.", "comment": "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.", "alias": [ "extensions", "user content", "modifiers" ], "min": 0, "max": "*", "base": { "path": "BackboneElement.modifierExtension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "isModifier": true, "isModifierReason": "modifierExtension is reserved for use where modifier extensions must be used", "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "id": "ProdCharacteristic.height", "path": "ProdCharacteristic.height", "short": "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", "definition": "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.", "min": 0, "max": "1", "base": { "path": "ProdCharacteristic.height", "min": 0, "max": "1" }, "type": [ { "code": "Quantity" } ], "isModifier": false, "isSummary": true }, { "id": "ProdCharacteristic.width", "path": "ProdCharacteristic.width", "short": "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", "definition": "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.", "min": 0, "max": "1", "base": { "path": "ProdCharacteristic.width", "min": 0, "max": "1" }, "type": [ { "code": "Quantity" } ], "isModifier": false, "isSummary": true }, { "id": "ProdCharacteristic.depth", "path": "ProdCharacteristic.depth", "short": "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", "definition": "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.", "min": 0, "max": "1", "base": { "path": "ProdCharacteristic.depth", "min": 0, "max": "1" }, "type": [ { "code": "Quantity" } ], "isModifier": false, "isSummary": true }, { "id": "ProdCharacteristic.weight", "path": "ProdCharacteristic.weight", "short": "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", "definition": "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.", "min": 0, "max": "1", "base": { "path": "ProdCharacteristic.weight", "min": 0, "max": "1" }, "type": [ { "code": "Quantity" } ], "isModifier": false, "isSummary": true }, { "id": "ProdCharacteristic.nominalVolume", "path": "ProdCharacteristic.nominalVolume", "short": "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", "definition": "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.", "min": 0, "max": "1", "base": { "path": "ProdCharacteristic.nominalVolume", "min": 0, "max": "1" }, "type": [ { "code": "Quantity" } ], "isModifier": false, "isSummary": true }, { "id": "ProdCharacteristic.externalDiameter", "path": "ProdCharacteristic.externalDiameter", "short": "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", "definition": "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.", "min": 0, "max": "1", "base": { "path": "ProdCharacteristic.externalDiameter", "min": 0, "max": "1" }, "type": [ { "code": "Quantity" } ], "isModifier": false, "isSummary": true }, { "id": "ProdCharacteristic.shape", "path": "ProdCharacteristic.shape", "short": "Where applicable, the shape can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used", "definition": "Where applicable, the shape can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used.", "min": 0, "max": "1", "base": { "path": "ProdCharacteristic.shape", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "isModifier": false, "isSummary": true }, { "id": "ProdCharacteristic.color", "path": "ProdCharacteristic.color", "short": "Where applicable, the color can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used", "definition": "Where applicable, the color can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used.", "min": 0, "max": "*", "base": { "path": "ProdCharacteristic.color", "min": 0, "max": "*" }, "type": [ { "code": "string" } ], "isModifier": false, "isSummary": true }, { "id": "ProdCharacteristic.imprint", "path": "ProdCharacteristic.imprint", "short": "Where applicable, the imprint can be specified as text", "definition": "Where applicable, the imprint can be specified as text.", "min": 0, "max": "*", "base": { "path": "ProdCharacteristic.imprint", "min": 0, "max": "*" }, "type": [ { "code": "string" } ], "isModifier": false, "isSummary": true }, { "id": "ProdCharacteristic.image", "path": "ProdCharacteristic.image", "short": "Where applicable, the image can be provided The format of the image attachment shall be specified by regional implementations", "definition": "Where applicable, the image can be provided The format of the image attachment shall be specified by regional implementations.", "min": 0, "max": "*", "base": { "path": "ProdCharacteristic.image", "min": 0, "max": "*" }, "type": [ { "code": "Attachment" } ], "isModifier": false, "isSummary": true }, { "id": "ProdCharacteristic.scoring", "path": "ProdCharacteristic.scoring", "short": "Where applicable, the scoring can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used", "definition": "Where applicable, the scoring can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used.", "min": 0, "max": "1", "base": { "path": "ProdCharacteristic.scoring", "min": 0, "max": "1" }, "type": [ { "code": "CodeableConcept" } ], "isModifier": false, "isSummary": true } ] }, "differential": { "element": [ { "id": "ProdCharacteristic", "path": "ProdCharacteristic", "short": "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", "definition": "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.", "min": 0, "max": "*" }, { "id": "ProdCharacteristic.height", "path": "ProdCharacteristic.height", "short": "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", "definition": "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.", "min": 0, "max": "1", "type": [ { "code": "Quantity" } ], "isSummary": true }, { "id": "ProdCharacteristic.width", "path": "ProdCharacteristic.width", "short": "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", "definition": "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.", "min": 0, "max": "1", "type": [ { "code": "Quantity" } ], "isSummary": true }, { "id": "ProdCharacteristic.depth", "path": "ProdCharacteristic.depth", "short": "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", "definition": "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.", "min": 0, "max": "1", "type": [ { "code": "Quantity" } ], "isSummary": true }, { "id": "ProdCharacteristic.weight", "path": "ProdCharacteristic.weight", "short": "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", "definition": "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.", "min": 0, "max": "1", "type": [ { "code": "Quantity" } ], "isSummary": true }, { "id": "ProdCharacteristic.nominalVolume", "path": "ProdCharacteristic.nominalVolume", "short": "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", "definition": "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.", "min": 0, "max": "1", "type": [ { "code": "Quantity" } ], "isSummary": true }, { "id": "ProdCharacteristic.externalDiameter", "path": "ProdCharacteristic.externalDiameter", "short": "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", "definition": "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.", "min": 0, "max": "1", "type": [ { "code": "Quantity" } ], "isSummary": true }, { "id": "ProdCharacteristic.shape", "path": "ProdCharacteristic.shape", "short": "Where applicable, the shape can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used", "definition": "Where applicable, the shape can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "isSummary": true }, { "id": "ProdCharacteristic.color", "path": "ProdCharacteristic.color", "short": "Where applicable, the color can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used", "definition": "Where applicable, the color can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used.", "min": 0, "max": "*", "type": [ { "code": "string" } ], "isSummary": true }, { "id": "ProdCharacteristic.imprint", "path": "ProdCharacteristic.imprint", "short": "Where applicable, the imprint can be specified as text", "definition": "Where applicable, the imprint can be specified as text.", "min": 0, "max": "*", "type": [ { "code": "string" } ], "isSummary": true }, { "id": "ProdCharacteristic.image", "path": "ProdCharacteristic.image", "short": "Where applicable, the image can be provided The format of the image attachment shall be specified by regional implementations", "definition": "Where applicable, the image can be provided The format of the image attachment shall be specified by regional implementations.", "min": 0, "max": "*", "type": [ { "code": "Attachment" } ], "isSummary": true }, { "id": "ProdCharacteristic.scoring", "path": "ProdCharacteristic.scoring", "short": "Where applicable, the scoring can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used", "definition": "Where applicable, the scoring can be specified An appropriate controlled vocabulary shall be used The term and the term identifier shall be used.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "isSummary": true } ] } }
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.