SPL Mapping FHIR R5 Implementation Guide, published by HL7 International / Biomedical Research and Regulation. This guide is not an authorized publication; it is the continuous build for version 0.2.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-spl/ and changes regularly. See the Directory of published versions
Page standards status: Trial-use | Maturity Level: 1 |
Definitions for the SubmittedMedicationLogicalModel logical model.
Guidance on how to interpret the contents of this table can be found here
0. SubmittedMedication | |
Definition | Details about the Medication that is submitted to the FDA. |
Short | Submitted Medication Logical Model |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
2. SubmittedMedication.ndcCode | |
Definition | The NDC Code that uniquely identifies this medication. |
Short | NDC Code |
Control | 0..1 |
Type | CodeableConcept |
4. SubmittedMedication.proprietaryName | |
Definition | The name of the Medication as used in medication labeling or in a catalog. |
Short | Proprietary Name |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
6. SubmittedMedication.proprietaryNameSuffix | |
Definition | An optional suffix that is part of the proprietary name. |
Short | Proprietary Name Suffix |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
8. SubmittedMedication.nonProprietaryName | |
Definition | An optional name of the medication that is used to refer to this medication. |
Short | Non-Proprietary Name |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
10. SubmittedMedication.form | |
Definition | A code that indicates the dose form of the medication. |
Short | Medication Form |
Control | 0..1 |
Type | CodeableConcept |
12. SubmittedMedication.sourceMedicationCode | |
Definition | An NDC code that indicates a medication that is the source of this medication. |
Short | Source Medication |
Control | 0..1 |
Type | CodeableConcept |
14. SubmittedMedication.MedicationIdentifier | |
Definition | Additional identifiers that are customer facing and can be used to refer to this medication. |
Short | Additional Identifiers |
Control | 0..* |
Type | Identifier |
16. SubmittedMedication.deaSchedule | |
Definition | A code that indicates the specific DEA schedule that this medication belongs to. |
Short | DEA Schedule Code |
Control | 0..1 |
Type | CodeableConcept |
18. SubmittedMedication.route | |
Definition | A code that indicates the route by which the medication is administered. |
Short | Route of Administration |
Control | 0..* |
Type | CodeableConcept |
20. SubmittedMedication.ingredient | |
Definition | Ingredient information for this medication. |
Short | Medication Ingredients |
Control | 0..* |
Type | BackboneElement |
22. SubmittedMedication.ingredient.type | |
Definition | A code that indicates the role the ingredient has in this medication, eg. active, flavouring, base, etc. |
Short | Ingredient Type |
Control | 1..1 |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
24. SubmittedMedication.ingredient.unii | |
Definition | The UNII that identifies the ingredient substance. |
Short | Ingredient Code |
Control | 1..1 |
Type | CodeableConcept |
26. SubmittedMedication.ingredient.name | |
Definition | The name of the ingredient. |
Short | Ingredient Name |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
28. SubmittedMedication.ingredient.strength | |
Definition | How much of the ingredient is present in the medication. |
Short | Ingredient Strength |
Control | 0..1 |
Type | Ratio |
30. SubmittedMedication.ingredient.activeMoiety | |
Definition | The active moeity that corresponds to this ingredient. |
Short | Ingredient Active Moiety |
Control | 1..2 |
Type | BackboneElement |
32. SubmittedMedication.ingredient.activeMoiety.unii | |
Definition | The UNII that identifies the ingredient's active moiety. |
Short | Active Moiety Code |
Control | 1..1 |
Type | CodeableConcept |
34. SubmittedMedication.ingredient.activeMoiety.name | |
Definition | The name of the ingredient's active moiety. |
Short | Active Moiety Name |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
36. SubmittedMedication.ingredient.strengthReference | |
Definition | An ingredient that is used as the reference for the strength. |
Short | Reference Ingredient for Strength |
Control | 0..1 |
Type | BackboneElement |
38. SubmittedMedication.ingredient.strengthReference.unii | |
Definition | The UNII that identifies the reference ingredient. |
Short | Reference Ingredient Code |
Control | 1..1 |
Type | CodeableConcept |
40. SubmittedMedication.ingredient.strengthReference.name | |
Definition | The name of the reference ingredient. |
Short | Reference Ingredient Name |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
42. SubmittedMedication.packaging | |
Definition | Information about the various packaging of the medication. |
Short | Medication Packaging |
Control | 0..1 |
Type | BackboneElement |
44. SubmittedMedication.packaging.quantity | |
Definition | Amount of medication in the package. |
Short | Amount of medication in the package. |
Control | 1..1 |
Type | Quantity |
46. SubmittedMedication.packaging.type | |
Definition | The type of the packaging. |
Short | Packaging Type |
Control | 1..1 |
Type | CodeableConcept |
48. SubmittedMedication.packaging.code | |
Definition | The NDC package code that corresponds to this packaging. |
Short | Packaging Identifier |
Control | 0..1 |
Type | CodeableConcept |
50. SubmittedMedication.packaging.sample | |
Definition | Indicates whether the package is a drug sample. |
Short | Drug Sample Flag |
Control | 1..1 |
Type | boolean |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
52. SubmittedMedication.packaging.combinationMedicationType | |
Definition | Indicates the type of combination medication, if applicable. |
Short | Combination Medication Type |
Control | 0..1 |
Type | CodeableConcept |
54. SubmittedMedication.packaging.marketingStatusPeriod | |
Definition | The start and end date of when this package is on the market. |
Short | Marketing Status Period |
Control | 0..1 |
Type | Period |
56. SubmittedMedication.packaging.characteristic | |
Definition | Properties that provide extra information about the packaging. |
Short | Packaging Characteristics |
Control | 0..* |
Type | Seettp://hl7.org/fhir/us/spl/StructureDefinition/SubmittedMedicationLogicalModel#SubmittedMedication.characteristic |
58. SubmittedMedication.packaging.packaging | |
Definition | Packaging that contains this package. |
Short | Outer Packaging |
Control | 0..1 |
Type | Seettp://hl7.org/fhir/us/spl/StructureDefinition/SubmittedMedicationLogicalModel#SubmittedMedication.packaging |
60. SubmittedMedication.part | |
Definition | Information about parts of the medication. |
Short | Medication Part |
Control | 0..* |
Type | BackboneElement |
62. SubmittedMedication.part.quantity | |
Definition | Amount of parts in the medication. |
Short | Part Quantity |
Control | 1..1 |
Type | Quantity |
64. SubmittedMedication.part.Medication | |
Definition | Medication information for this part. |
Short | Part Medication |
Control | 1..1 |
Type | Reference(Submitted Medication Logical Model) |
66. SubmittedMedication.part.marketing | |
Definition | Marketing Information about this part. |
Short | Part Marketing |
Control | 0..1 |
Type | Seettp://hl7.org/fhir/us/spl/StructureDefinition/SubmittedMedicationLogicalModel#SubmittedMedication.marketing |
68. SubmittedMedication.marketing | |
Definition | Information about the marketing category and an associated application. |
Short | Marketing Application Information |
Control | 0..1 |
Type | BackboneElement |
70. SubmittedMedication.marketing.number | |
Definition | The application number for this medication. |
Short | Markting Application Number |
Control | 0..1 |
Type | Identifier |
72. SubmittedMedication.marketing.category | |
Definition | The marketing category for this medication. |
Short | Marketing Category |
Control | 0..1 |
Type | CodeableConcept |
74. SubmittedMedication.marketing.approvalDate | |
Definition | The approval date of the marketing applicaiton. |
Short | Marketing Approval Date |
Control | 0..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
76. SubmittedMedication.marketingStatusPeriod | |
Definition | The start and end date of when the medication is on the market. |
Short | Marketing Status Period |
Control | 1..1 |
Type | Period |
78. SubmittedMedication.characteristic | |
Definition | Properties that provide extra information about the medication. |
Short | Medication Characteristics |
Control | 0..* |
Type | BackboneElement |
80. SubmittedMedication.characteristic.type | |
Definition | A code that identifies the characteristic. |
Short | Characteristic Type |
Control | 1..1 |
Type | CodeableConcept |
82. SubmittedMedication.characteristic.value[x] | |
Definition | The value of the characteristic. |
Short | Characteristic Value |
Control | 1..1 |
Type | Choice of: Quantity, integer, Range, CodeableConcept, string, base64Binary, boolean |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Guidance on how to interpret the contents of this table can be found here
0. SubmittedMedication | |
Definition | Details about the Medication that is submitted to the FDA. Base definition for all elements in a resource. |
Short | Submitted Medication Logical ModelBase for all elements |
Control | 0..* |
Is Modifier | false |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
2. SubmittedMedication.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | Unique id for inter-element referencing |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
4. SubmittedMedication.extension | |
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 managable, 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. |
Short | Additional content defined by implementations |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | 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()) |
Slicing | This element introduces a set of slices on SubmittedMedication.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
6. SubmittedMedication.ndcCode | |
Definition | The NDC Code that uniquely identifies this medication. |
Short | NDC Code |
Control | 0..1 |
Type | CodeableConcept |
8. SubmittedMedication.proprietaryName | |
Definition | The name of the Medication as used in medication labeling or in a catalog. |
Short | Proprietary Name |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
10. SubmittedMedication.proprietaryNameSuffix | |
Definition | An optional suffix that is part of the proprietary name. |
Short | Proprietary Name Suffix |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
12. SubmittedMedication.nonProprietaryName | |
Definition | An optional name of the medication that is used to refer to this medication. |
Short | Non-Proprietary Name |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
14. SubmittedMedication.form | |
Definition | A code that indicates the dose form of the medication. |
Short | Medication Form |
Control | 0..1 |
Type | CodeableConcept |
16. SubmittedMedication.sourceMedicationCode | |
Definition | An NDC code that indicates a medication that is the source of this medication. |
Short | Source Medication |
Control | 0..1 |
Type | CodeableConcept |
18. SubmittedMedication.MedicationIdentifier | |
Definition | Additional identifiers that are customer facing and can be used to refer to this medication. |
Short | Additional Identifiers |
Control | 0..* |
Type | Identifier |
20. SubmittedMedication.deaSchedule | |
Definition | A code that indicates the specific DEA schedule that this medication belongs to. |
Short | DEA Schedule Code |
Control | 0..1 |
Type | CodeableConcept |
22. SubmittedMedication.route | |
Definition | A code that indicates the route by which the medication is administered. |
Short | Route of Administration |
Control | 0..* |
Type | CodeableConcept |
24. SubmittedMedication.ingredient | |
Definition | Ingredient information for this medication. |
Short | Medication Ingredients |
Control | 0..* |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
26. SubmittedMedication.ingredient.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | Unique id for inter-element referencing |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | idstring |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
28. SubmittedMedication.ingredient.extension | |
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 managable, 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. |
Short | Additional content defined by implementations |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | 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()) |
Slicing | This element introduces a set of slices on SubmittedMedication.ingredient.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
30. SubmittedMedication.ingredient.modifierExtension | |
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 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 managable, 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). |
Short | Extensions that cannot be ignored even if unrecognized |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | 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()) |
32. SubmittedMedication.ingredient.type | |
Definition | A code that indicates the role the ingredient has in this medication, eg. active, flavouring, base, etc. |
Short | Ingredient Type |
Control | 1..1 |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
34. SubmittedMedication.ingredient.unii | |
Definition | The UNII that identifies the ingredient substance. |
Short | Ingredient Code |
Control | 1..1 |
Type | CodeableConcept |
36. SubmittedMedication.ingredient.name | |
Definition | The name of the ingredient. |
Short | Ingredient Name |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
38. SubmittedMedication.ingredient.strength | |
Definition | How much of the ingredient is present in the medication. |
Short | Ingredient Strength |
Control | 0..1 |
Type | Ratio |
40. SubmittedMedication.ingredient.activeMoiety | |
Definition | The active moeity that corresponds to this ingredient. |
Short | Ingredient Active Moiety |
Control | 1..2 |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
42. SubmittedMedication.ingredient.activeMoiety.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | Unique id for inter-element referencing |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | idstring |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
44. SubmittedMedication.ingredient.activeMoiety.extension | |
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 managable, 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. |
Short | Additional content defined by implementations |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | 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()) |
Slicing | This element introduces a set of slices on SubmittedMedication.ingredient.activeMoiety.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
46. SubmittedMedication.ingredient.activeMoiety.modifierExtension | |
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 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 managable, 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). |
Short | Extensions that cannot be ignored even if unrecognized |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | 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()) |
48. SubmittedMedication.ingredient.activeMoiety.unii | |
Definition | The UNII that identifies the ingredient's active moiety. |
Short | Active Moiety Code |
Control | 1..1 |
Type | CodeableConcept |
50. SubmittedMedication.ingredient.activeMoiety.name | |
Definition | The name of the ingredient's active moiety. |
Short | Active Moiety Name |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
52. SubmittedMedication.ingredient.strengthReference | |
Definition | An ingredient that is used as the reference for the strength. |
Short | Reference Ingredient for Strength |
Control | 0..1 |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
54. SubmittedMedication.ingredient.strengthReference.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | Unique id for inter-element referencing |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | idstring |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
56. SubmittedMedication.ingredient.strengthReference.extension | |
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 managable, 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. |
Short | Additional content defined by implementations |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | 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()) |
Slicing | This element introduces a set of slices on SubmittedMedication.ingredient.strengthReference.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
58. SubmittedMedication.ingredient.strengthReference.modifierExtension | |
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 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 managable, 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). |
Short | Extensions that cannot be ignored even if unrecognized |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | 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()) |
60. SubmittedMedication.ingredient.strengthReference.unii | |
Definition | The UNII that identifies the reference ingredient. |
Short | Reference Ingredient Code |
Control | 1..1 |
Type | CodeableConcept |
62. SubmittedMedication.ingredient.strengthReference.name | |
Definition | The name of the reference ingredient. |
Short | Reference Ingredient Name |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
64. SubmittedMedication.packaging | |
Definition | Information about the various packaging of the medication. |
Short | Medication Packaging |
Control | 0..1 |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
66. SubmittedMedication.packaging.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | Unique id for inter-element referencing |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | idstring |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
68. SubmittedMedication.packaging.extension | |
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 managable, 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. |
Short | Additional content defined by implementations |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | 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()) |
Slicing | This element introduces a set of slices on SubmittedMedication.packaging.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
70. SubmittedMedication.packaging.modifierExtension | |
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 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 managable, 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). |
Short | Extensions that cannot be ignored even if unrecognized |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | 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()) |
72. SubmittedMedication.packaging.quantity | |
Definition | Amount of medication in the package. |
Short | Amount of medication in the package. |
Control | 1..1 |
Type | Quantity |
74. SubmittedMedication.packaging.type | |
Definition | The type of the packaging. |
Short | Packaging Type |
Control | 1..1 |
Type | CodeableConcept |
76. SubmittedMedication.packaging.code | |
Definition | The NDC package code that corresponds to this packaging. |
Short | Packaging Identifier |
Control | 0..1 |
Type | CodeableConcept |
78. SubmittedMedication.packaging.sample | |
Definition | Indicates whether the package is a drug sample. |
Short | Drug Sample Flag |
Control | 1..1 |
Type | boolean |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
80. SubmittedMedication.packaging.combinationMedicationType | |
Definition | Indicates the type of combination medication, if applicable. |
Short | Combination Medication Type |
Control | 0..1 |
Type | CodeableConcept |
82. SubmittedMedication.packaging.marketingStatusPeriod | |
Definition | The start and end date of when this package is on the market. |
Short | Marketing Status Period |
Control | 0..1 |
Type | Period |
84. SubmittedMedication.packaging.characteristic | |
Definition | Properties that provide extra information about the packaging. |
Short | Packaging Characteristics |
Control | 0..* |
Type | Seettp://hl7.org/fhir/us/spl/StructureDefinition/SubmittedMedicationLogicalModel#SubmittedMedication.characteristic |
86. SubmittedMedication.packaging.packaging | |
Definition | Packaging that contains this package. |
Short | Outer Packaging |
Control | 0..1 |
Type | Seettp://hl7.org/fhir/us/spl/StructureDefinition/SubmittedMedicationLogicalModel#SubmittedMedication.packaging |
88. SubmittedMedication.part | |
Definition | Information about parts of the medication. |
Short | Medication Part |
Control | 0..* |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
90. SubmittedMedication.part.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | Unique id for inter-element referencing |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | idstring |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
92. SubmittedMedication.part.extension | |
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 managable, 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. |
Short | Additional content defined by implementations |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | 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()) |
Slicing | This element introduces a set of slices on SubmittedMedication.part.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
94. SubmittedMedication.part.modifierExtension | |
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 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 managable, 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). |
Short | Extensions that cannot be ignored even if unrecognized |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | 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()) |
96. SubmittedMedication.part.quantity | |
Definition | Amount of parts in the medication. |
Short | Part Quantity |
Control | 1..1 |
Type | Quantity |
98. SubmittedMedication.part.Medication | |
Definition | Medication information for this part. |
Short | Part Medication |
Control | 1..1 |
Type | Reference(Submitted Medication Logical Model) |
100. SubmittedMedication.part.marketing | |
Definition | Marketing Information about this part. |
Short | Part Marketing |
Control | 0..1 |
Type | Seettp://hl7.org/fhir/us/spl/StructureDefinition/SubmittedMedicationLogicalModel#SubmittedMedication.marketing |
102. SubmittedMedication.marketing | |
Definition | Information about the marketing category and an associated application. |
Short | Marketing Application Information |
Control | 0..1 |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
104. SubmittedMedication.marketing.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | Unique id for inter-element referencing |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | idstring |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
106. SubmittedMedication.marketing.extension | |
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 managable, 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. |
Short | Additional content defined by implementations |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | 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()) |
Slicing | This element introduces a set of slices on SubmittedMedication.marketing.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
108. SubmittedMedication.marketing.modifierExtension | |
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 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 managable, 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). |
Short | Extensions that cannot be ignored even if unrecognized |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | 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()) |
110. SubmittedMedication.marketing.number | |
Definition | The application number for this medication. |
Short | Markting Application Number |
Control | 0..1 |
Type | Identifier |
112. SubmittedMedication.marketing.category | |
Definition | The marketing category for this medication. |
Short | Marketing Category |
Control | 0..1 |
Type | CodeableConcept |
114. SubmittedMedication.marketing.approvalDate | |
Definition | The approval date of the marketing applicaiton. |
Short | Marketing Approval Date |
Control | 0..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
116. SubmittedMedication.marketingStatusPeriod | |
Definition | The start and end date of when the medication is on the market. |
Short | Marketing Status Period |
Control | 1..1 |
Type | Period |
118. SubmittedMedication.characteristic | |
Definition | Properties that provide extra information about the medication. |
Short | Medication Characteristics |
Control | 0..* |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
120. SubmittedMedication.characteristic.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | Unique id for inter-element referencing |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | idstring |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
122. SubmittedMedication.characteristic.extension | |
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 managable, 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. |
Short | Additional content defined by implementations |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | 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()) |
Slicing | This element introduces a set of slices on SubmittedMedication.characteristic.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
124. SubmittedMedication.characteristic.modifierExtension | |
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 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 managable, 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). |
Short | Extensions that cannot be ignored even if unrecognized |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | 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()) |
126. SubmittedMedication.characteristic.type | |
Definition | A code that identifies the characteristic. |
Short | Characteristic Type |
Control | 1..1 |
Type | CodeableConcept |
128. SubmittedMedication.characteristic.value[x] | |
Definition | The value of the characteristic. |
Short | Characteristic Value |
Control | 1..1 |
Type | Choice of: Quantity, integer, Range, CodeableConcept, string, base64Binary, boolean |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Guidance on how to interpret the contents of this table can be found here
0. SubmittedMedication | |
Definition | Details about the Medication that is submitted to the FDA. |
Short | Submitted Medication Logical Model |
Control | 0..* |
Is Modifier | false |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
2. SubmittedMedication.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | Unique id for inter-element referencing |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | string |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
4. SubmittedMedication.extension | |
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 managable, 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. |
Short | Additional content defined by implementations |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | 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() ) |
Slicing | This element introduces a set of slices on SubmittedMedication.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
6. SubmittedMedication.ndcCode | |
Definition | The NDC Code that uniquely identifies this medication. |
Short | NDC Code |
Control | 0..1 |
Type | CodeableConcept |
8. SubmittedMedication.proprietaryName | |
Definition | The name of the Medication as used in medication labeling or in a catalog. |
Short | Proprietary Name |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
10. SubmittedMedication.proprietaryNameSuffix | |
Definition | An optional suffix that is part of the proprietary name. |
Short | Proprietary Name Suffix |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
12. SubmittedMedication.nonProprietaryName | |
Definition | An optional name of the medication that is used to refer to this medication. |
Short | Non-Proprietary Name |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
14. SubmittedMedication.form | |
Definition | A code that indicates the dose form of the medication. |
Short | Medication Form |
Control | 0..1 |
Type | CodeableConcept |
16. SubmittedMedication.sourceMedicationCode | |
Definition | An NDC code that indicates a medication that is the source of this medication. |
Short | Source Medication |
Control | 0..1 |
Type | CodeableConcept |
18. SubmittedMedication.MedicationIdentifier | |
Definition | Additional identifiers that are customer facing and can be used to refer to this medication. |
Short | Additional Identifiers |
Control | 0..* |
Type | Identifier |
20. SubmittedMedication.deaSchedule | |
Definition | A code that indicates the specific DEA schedule that this medication belongs to. |
Short | DEA Schedule Code |
Control | 0..1 |
Type | CodeableConcept |
22. SubmittedMedication.route | |
Definition | A code that indicates the route by which the medication is administered. |
Short | Route of Administration |
Control | 0..* |
Type | CodeableConcept |
24. SubmittedMedication.ingredient | |
Definition | Ingredient information for this medication. |
Short | Medication Ingredients |
Control | 0..* |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
26. SubmittedMedication.ingredient.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | Unique id for inter-element referencing |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | id |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
28. SubmittedMedication.ingredient.extension | |
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 managable, 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. |
Short | Additional content defined by implementations |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | 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() ) |
Slicing | This element introduces a set of slices on SubmittedMedication.ingredient.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
30. SubmittedMedication.ingredient.modifierExtension | |
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 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 managable, 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). |
Short | Extensions that cannot be ignored even if unrecognized |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | 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() ) |
32. SubmittedMedication.ingredient.type | |
Definition | A code that indicates the role the ingredient has in this medication, eg. active, flavouring, base, etc. |
Short | Ingredient Type |
Control | 1..1 |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
34. SubmittedMedication.ingredient.unii | |
Definition | The UNII that identifies the ingredient substance. |
Short | Ingredient Code |
Control | 1..1 |
Type | CodeableConcept |
36. SubmittedMedication.ingredient.name | |
Definition | The name of the ingredient. |
Short | Ingredient Name |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
38. SubmittedMedication.ingredient.strength | |
Definition | How much of the ingredient is present in the medication. |
Short | Ingredient Strength |
Control | 0..1 |
Type | Ratio |
40. SubmittedMedication.ingredient.activeMoiety | |
Definition | The active moeity that corresponds to this ingredient. |
Short | Ingredient Active Moiety |
Control | 1..2 |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
42. SubmittedMedication.ingredient.activeMoiety.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | Unique id for inter-element referencing |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | id |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
44. SubmittedMedication.ingredient.activeMoiety.extension | |
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 managable, 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. |
Short | Additional content defined by implementations |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | 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() ) |
Slicing | This element introduces a set of slices on SubmittedMedication.ingredient.activeMoiety.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
46. SubmittedMedication.ingredient.activeMoiety.modifierExtension | |
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 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 managable, 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). |
Short | Extensions that cannot be ignored even if unrecognized |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | 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() ) |
48. SubmittedMedication.ingredient.activeMoiety.unii | |
Definition | The UNII that identifies the ingredient's active moiety. |
Short | Active Moiety Code |
Control | 1..1 |
Type | CodeableConcept |
50. SubmittedMedication.ingredient.activeMoiety.name | |
Definition | The name of the ingredient's active moiety. |
Short | Active Moiety Name |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
52. SubmittedMedication.ingredient.strengthReference | |
Definition | An ingredient that is used as the reference for the strength. |
Short | Reference Ingredient for Strength |
Control | 0..1 |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
54. SubmittedMedication.ingredient.strengthReference.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | Unique id for inter-element referencing |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | id |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
56. SubmittedMedication.ingredient.strengthReference.extension | |
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 managable, 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. |
Short | Additional content defined by implementations |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | 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() ) |
Slicing | This element introduces a set of slices on SubmittedMedication.ingredient.strengthReference.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
58. SubmittedMedication.ingredient.strengthReference.modifierExtension | |
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 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 managable, 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). |
Short | Extensions that cannot be ignored even if unrecognized |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | 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() ) |
60. SubmittedMedication.ingredient.strengthReference.unii | |
Definition | The UNII that identifies the reference ingredient. |
Short | Reference Ingredient Code |
Control | 1..1 |
Type | CodeableConcept |
62. SubmittedMedication.ingredient.strengthReference.name | |
Definition | The name of the reference ingredient. |
Short | Reference Ingredient Name |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
64. SubmittedMedication.packaging | |
Definition | Information about the various packaging of the medication. |
Short | Medication Packaging |
Control | 0..1 |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
66. SubmittedMedication.packaging.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | Unique id for inter-element referencing |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | id |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
68. SubmittedMedication.packaging.extension | |
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 managable, 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. |
Short | Additional content defined by implementations |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | 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() ) |
Slicing | This element introduces a set of slices on SubmittedMedication.packaging.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
70. SubmittedMedication.packaging.modifierExtension | |
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 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 managable, 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). |
Short | Extensions that cannot be ignored even if unrecognized |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | 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() ) |
72. SubmittedMedication.packaging.quantity | |
Definition | Amount of medication in the package. |
Short | Amount of medication in the package. |
Control | 1..1 |
Type | Quantity |
74. SubmittedMedication.packaging.type | |
Definition | The type of the packaging. |
Short | Packaging Type |
Control | 1..1 |
Type | CodeableConcept |
76. SubmittedMedication.packaging.code | |
Definition | The NDC package code that corresponds to this packaging. |
Short | Packaging Identifier |
Control | 0..1 |
Type | CodeableConcept |
78. SubmittedMedication.packaging.sample | |
Definition | Indicates whether the package is a drug sample. |
Short | Drug Sample Flag |
Control | 1..1 |
Type | boolean |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
80. SubmittedMedication.packaging.combinationMedicationType | |
Definition | Indicates the type of combination medication, if applicable. |
Short | Combination Medication Type |
Control | 0..1 |
Type | CodeableConcept |
82. SubmittedMedication.packaging.marketingStatusPeriod | |
Definition | The start and end date of when this package is on the market. |
Short | Marketing Status Period |
Control | 0..1 |
Type | Period |
84. SubmittedMedication.packaging.characteristic | |
Definition | Properties that provide extra information about the packaging. |
Short | Packaging Characteristics |
Control | 0..* |
Type | Seettp://hl7.org/fhir/us/spl/StructureDefinition/SubmittedMedicationLogicalModel#SubmittedMedication.characteristic |
86. SubmittedMedication.packaging.packaging | |
Definition | Packaging that contains this package. |
Short | Outer Packaging |
Control | 0..1 |
Type | Seettp://hl7.org/fhir/us/spl/StructureDefinition/SubmittedMedicationLogicalModel#SubmittedMedication.packaging |
88. SubmittedMedication.part | |
Definition | Information about parts of the medication. |
Short | Medication Part |
Control | 0..* |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
90. SubmittedMedication.part.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | Unique id for inter-element referencing |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | id |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
92. SubmittedMedication.part.extension | |
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 managable, 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. |
Short | Additional content defined by implementations |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | 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() ) |
Slicing | This element introduces a set of slices on SubmittedMedication.part.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
94. SubmittedMedication.part.modifierExtension | |
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 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 managable, 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). |
Short | Extensions that cannot be ignored even if unrecognized |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | 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() ) |
96. SubmittedMedication.part.quantity | |
Definition | Amount of parts in the medication. |
Short | Part Quantity |
Control | 1..1 |
Type | Quantity |
98. SubmittedMedication.part.Medication | |
Definition | Medication information for this part. |
Short | Part Medication |
Control | 1..1 |
Type | Reference(Submitted Medication Logical Model) |
100. SubmittedMedication.part.marketing | |
Definition | Marketing Information about this part. |
Short | Part Marketing |
Control | 0..1 |
Type | Seettp://hl7.org/fhir/us/spl/StructureDefinition/SubmittedMedicationLogicalModel#SubmittedMedication.marketing |
102. SubmittedMedication.marketing | |
Definition | Information about the marketing category and an associated application. |
Short | Marketing Application Information |
Control | 0..1 |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
104. SubmittedMedication.marketing.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | Unique id for inter-element referencing |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | id |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
106. SubmittedMedication.marketing.extension | |
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 managable, 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. |
Short | Additional content defined by implementations |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | 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() ) |
Slicing | This element introduces a set of slices on SubmittedMedication.marketing.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
108. SubmittedMedication.marketing.modifierExtension | |
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 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 managable, 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). |
Short | Extensions that cannot be ignored even if unrecognized |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | 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() ) |
110. SubmittedMedication.marketing.number | |
Definition | The application number for this medication. |
Short | Markting Application Number |
Control | 0..1 |
Type | Identifier |
112. SubmittedMedication.marketing.category | |
Definition | The marketing category for this medication. |
Short | Marketing Category |
Control | 0..1 |
Type | CodeableConcept |
114. SubmittedMedication.marketing.approvalDate | |
Definition | The approval date of the marketing applicaiton. |
Short | Marketing Approval Date |
Control | 0..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
116. SubmittedMedication.marketingStatusPeriod | |
Definition | The start and end date of when the medication is on the market. |
Short | Marketing Status Period |
Control | 1..1 |
Type | Period |
118. SubmittedMedication.characteristic | |
Definition | Properties that provide extra information about the medication. |
Short | Medication Characteristics |
Control | 0..* |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
120. SubmittedMedication.characteristic.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Short | Unique id for inter-element referencing |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | id |
Is Modifier | false |
XML Format | In the XML format, this property is represented as an attribute. |
Summary | false |
122. SubmittedMedication.characteristic.extension | |
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 managable, 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. |
Short | Additional content defined by implementations |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | false |
Summary | false |
Alternate Names | extensions, user content |
Invariants | 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() ) |
Slicing | This element introduces a set of slices on SubmittedMedication.characteristic.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
124. SubmittedMedication.characteristic.modifierExtension | |
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 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 managable, 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). |
Short | Extensions that cannot be ignored even if unrecognized |
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. |
Control | 0..* |
Type | Extension |
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
Summary | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content, modifiers |
Invariants | 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() ) |
126. SubmittedMedication.characteristic.type | |
Definition | A code that identifies the characteristic. |
Short | Characteristic Type |
Control | 1..1 |
Type | CodeableConcept |
128. SubmittedMedication.characteristic.value[x] | |
Definition | The value of the characteristic. |
Short | Characteristic Value |
Control | 1..1 |
Type | Choice of: Quantity, integer, Range, CodeableConcept, string, base64Binary, boolean |
[x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |