Consolidated CDA Release 2.1 StructureDefinition Publication
2.1 - CI Build

Consolidated CDA Release 2.1 StructureDefinition Publication, published by Health Level Seven. This is not an authorized publication; it is the continuous build for version 2.1). This version is based on the current content of https://github.com/HL7/CDA-ccda-2.1-sd/ and changes regularly. See the Directory of published versions

## Logical Model: MedicationInformation - Detailed Descriptions

Draft as of 2023-09-29

Definitions for the MedicationInformation logical model.

- Differential Elements Table
- Key Elements Table
- Snapshot Elements Table

Guidance on how to interpret the contents of this table can be found here

0. ManufacturedProduct
XML Format | In the XML format, this property has the namespace `urn:hl7-org:v3`.
2. ManufacturedProduct.classCode
Comments | SHALL contain exactly one [1..1] @classCode="MANU" (CodeSystem: HL7RoleClass urn:oid:2.16.840.1.113883.5.110 STATIC) (CONF:1098-7408).
Control | 1..?
4. ManufacturedProduct.templateId
Control | 1..?
Slicing | This element introduces a set of slices on `ManufacturedProduct.templateId`. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: value @ root value @ extension
6. ManufacturedProduct.templateId:primary
Slice Name | primary
Comments | SHALL contain exactly one [1..1] templateId (CONF:1098-7409) such that it
Control | 1..1
8. ManufacturedProduct.templateId:primary.root
Comments | SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.23" (CONF:1098-10506).
Control | 1..?
Pattern Value | 2.16.840.1.113883.10.20.22.4.23
10. ManufacturedProduct.templateId:primary.extension
Comments | SHALL contain exactly one [1..1] @extension="2014-06-09" (CONF:1098-32579).
Control | 1..?
Pattern Value | 2014-06-09
12. ManufacturedProduct.id
Comments | MAY contain zero or more [0..*] id (CONF:1098-7410).
14. ManufacturedProduct.manufacturedMaterial
Short | A medication should be recorded as a pre-coordinated ingredient + strength + dose form (e.g., “metoprolol 25mg tablet”, “amoxicillin 400mg/5mL suspension”) where possible. This includes RxNorm codes whose Term Type is SCD (semantic clinical drug), SBD (semantic brand drug), GPCK (generic pack), BPCK (brand pack).
Comments | SHALL contain exactly one [1..1] manufacturedMaterial (CONF:1098-7411).
Control | 1..?
16. ManufacturedProduct.manufacturedMaterial.code
Comments | This manufacturedMaterial SHALL contain exactly one [1..1] code, which SHALL be selected from ValueSet Medication Clinical Drug urn:oid:2.16.840.1.113762.1.4.1010.4 DYNAMIC (CONF:1098-7412).
Control | 1..?
Binding | The codes SHALL be taken from Medication Clinical Drug
18. ManufacturedProduct.manufacturedMaterial.code.translation
Comments | This code MAY contain zero or more [0..*] translation, which MAY be selected from ValueSet Clinical Substance urn:oid:2.16.840.1.113762.1.4.1010.2 DYNAMIC (CONF:1098-31884).
Binding | For example codes, see Clinical Substance
20. ManufacturedProduct.manufacturerOrganization
Comments | MAY contain zero or one [0..1] manufacturerOrganization (CONF:1098-7416).

Guidance on how to interpret the contents of this table can be found here

0. ManufacturedProduct
Definition | Base definition for all types defined in FHIR type system.
Short | Base for all types and resources
Control | 10..1*
Is Modifier | false
XML Format | In the XML format, this property has the namespace `urn:hl7-org:v3`.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2. ManufacturedProduct.classCode
Comments | SHALL contain exactly one [1..1] @classCode="MANU" (CodeSystem: HL7RoleClass urn:oid:2.16.840.1.113883.5.110 STATIC) (CONF:1098-7408).
Control | 1..1
Binding | The codes SHALL be taken from RoleClassManufacturedProduct
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | MANU
4. ManufacturedProduct.templateId
Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
Slicing | This element introduces a set of slices on `ManufacturedProduct.templateId`. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: value @ root value @ extension
6. ManufacturedProduct.templateId:primary
Slice Name | primary
Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question
Comments | SHALL contain exactly one [1..1] templateId (CONF:1098-7409) such that it
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
8. ManufacturedProduct.templateId:primary.root
Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.
Comments | SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.23" (CONF:1098-10506).
Control | 1..1
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Root
Pattern Value | 2.16.840.1.113883.10.20.22.4.23
10. ManufacturedProduct.templateId:primary.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
Comments | SHALL contain exactly one [1..1] @extension="2014-06-09" (CONF:1098-32579).
Control | 1..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Extension
Pattern Value | 2014-06-09
12. ManufacturedProduct.id
Comments | MAY contain zero or more [0..*] id (CONF:1098-7410).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
14. ManufacturedProduct.manufacturedMaterial
Short | A medication should be recorded as a pre-coordinated ingredient + strength + dose form (e.g., “metoprolol 25mg tablet”, “amoxicillin 400mg/5mL suspension”) where possible. This includes RxNorm codes whose Term Type is SCD (semantic clinical drug), SBD (semantic brand drug), GPCK (generic pack), BPCK (brand pack).
Comments | SHALL contain exactly one [1..1] manufacturedMaterial (CONF:1098-7411).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Material
16. ManufacturedProduct.manufacturedMaterial.code
Comments | This manufacturedMaterial SHALL contain exactly one [1..1] code, which SHALL be selected from ValueSet Medication Clinical Drug urn:oid:2.16.840.1.113762.1.4.1010.4 DYNAMIC (CONF:1098-7412).
Control | 1..1
Binding | The codes SHALL be taken from Medication Clinical Drug
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
18. ManufacturedProduct.manufacturedMaterial.code.qualifier
Definition | Specifies additional codes that increase the specificity of the the primary code.
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/CR
Label | Qualifier
20. ManufacturedProduct.manufacturedMaterial.code.translation
Definition | A set of other concept descriptors that translate this concept descriptor into other code systems.
Comments | This code MAY contain zero or more [0..*] translation, which MAY be selected from ValueSet Clinical Substance urn:oid:2.16.840.1.113762.1.4.1010.2 DYNAMIC (CONF:1098-31884).
Control | 0..*
Binding | For example codes, see Clinical Substance
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD
XML Format | The type of this property is determined using the `xsi:type`attribute.
Label | Translation
22. ManufacturedProduct.manufacturerOrganization
Comments | MAY contain zero or one [0..1] manufacturerOrganization (CONF:1098-7416).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization

Guidance on how to interpret the contents of this table can be found here

0. ManufacturedProduct
Definition | Base definition for all types defined in FHIR type system.
Short | Base for all types and resources
Control | 1..1
Is Modifier | false
XML Format | In the XML format, this property has the namespace `urn:hl7-org:v3`.
Invariants | ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
2. ManufacturedProduct.classCode
Comments | SHALL contain exactly one [1..1] @classCode="MANU" (CodeSystem: HL7RoleClass urn:oid:2.16.840.1.113883.5.110 STATIC) (CONF:1098-7408).
Control | 1..1
Binding | The codes SHALL be taken from RoleClassManufacturedProduct
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | MANU
4. ManufacturedProduct.templateId
Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
Slicing | This element introduces a set of slices on `ManufacturedProduct.templateId`. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: value @ root value @ extension
6. ManufacturedProduct.templateId:primary
Slice Name | primary
Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question
Comments | SHALL contain exactly one [1..1] templateId (CONF:1098-7409) such that it
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
8. ManufacturedProduct.templateId:primary.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
10. ManufacturedProduct.templateId:primary.assigningAuthorityName
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Assigning Authority Name
12. ManufacturedProduct.templateId:primary.displayable
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
Control | 0..1
Type | boolean(bl: Boolean)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Displayable
14. ManufacturedProduct.templateId:primary.root
Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.
Comments | SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.23" (CONF:1098-10506).
Control | 1..1
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Root
Pattern Value | 2.16.840.1.113883.10.20.22.4.23
16. ManufacturedProduct.templateId:primary.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
Comments | SHALL contain exactly one [1..1] @extension="2014-06-09" (CONF:1098-32579).
Control | 1..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Extension
Pattern Value | 2014-06-09
18. ManufacturedProduct.id
Comments | MAY contain zero or more [0..*] id (CONF:1098-7410).
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
20. ManufacturedProduct.sdtcIdentifiedBy
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`identifiedBy`.
22. ManufacturedProduct.manufacturedLabeledDrug
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/LabeledDrug
24. ManufacturedProduct.manufacturedMaterial
Short | A medication should be recorded as a pre-coordinated ingredient + strength + dose form (e.g., “metoprolol 25mg tablet”, “amoxicillin 400mg/5mL suspension”) where possible. This includes RxNorm codes whose Term Type is SCD (semantic clinical drug), SBD (semantic brand drug), GPCK (generic pack), BPCK (brand pack).
Comments | SHALL contain exactly one [1..1] manufacturedMaterial (CONF:1098-7411).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Material
26. ManufacturedProduct.manufacturedMaterial.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassManufacturedMaterial
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | MMAT
28. ManufacturedProduct.manufacturedMaterial.determinerCode
Control | 0..1
Binding | The codes SHALL be taken from EntityDeterminerDetermined
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | KIND
30. ManufacturedProduct.manufacturedMaterial.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
32. ManufacturedProduct.manufacturedMaterial.templateId
Definition | When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
34. ManufacturedProduct.manufacturedMaterial.code
Comments | This manufacturedMaterial SHALL contain exactly one [1..1] code, which SHALL be selected from ValueSet Medication Clinical Drug urn:oid:2.16.840.1.113762.1.4.1010.4 DYNAMIC (CONF:1098-7412).
Control | 1..1
Binding | The codes SHALL be taken from Medication Clinical Drug
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
36. ManufacturedProduct.manufacturedMaterial.code.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..1
Binding | The codes SHALL be taken from NullFlavor
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Exceptional Value Detail
38. ManufacturedProduct.manufacturedMaterial.code.code
Definition | The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache.
Control | 0..1
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code
40. ManufacturedProduct.manufacturedMaterial.code.codeSystem
Definition | Specifies the code system that defines the code.
Control | 0..1
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System
42. ManufacturedProduct.manufacturedMaterial.code.codeSystemName
Definition | The common name of the coding system.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System Name
44. ManufacturedProduct.manufacturedMaterial.code.codeSystemVersion
Definition | If applicable, a version descriptor defined specifically for the given code system.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Code System Version
46. ManufacturedProduct.manufacturedMaterial.code.displayName
Definition | A name or title for the code, under which the sending system shows the code value to its users.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Label | Display Name
48. ManufacturedProduct.manufacturedMaterial.code.sdtcValueSet
Definition | The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.
Control | 0..1
Type | string(oid: ISO Object Identifier)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`valueSet`.
50. ManufacturedProduct.manufacturedMaterial.code.sdtcValueSetVersion
Definition | The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept.
Control | 0..1
Type | string(st: Character String)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`valueSetVersion`.
52. ManufacturedProduct.manufacturedMaterial.code.originalText
Definition | The text or phrase used as the basis for the coding.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED
Label | Original Text
54. ManufacturedProduct.manufacturedMaterial.code.qualifier
Definition | Specifies additional codes that increase the specificity of the the primary code.
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/CR
Label | Qualifier
56. ManufacturedProduct.manufacturedMaterial.code.translation
Definition | A set of other concept descriptors that translate this concept descriptor into other code systems.
Comments | This code MAY contain zero or more [0..*] translation, which MAY be selected from ValueSet Clinical Substance urn:oid:2.16.840.1.113762.1.4.1010.2 DYNAMIC (CONF:1098-31884).
Control | 0..*
Binding | For example codes, see Clinical Substance
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD
XML Format | The type of this property is determined using the `xsi:type`attribute.
Label | Translation
58. ManufacturedProduct.manufacturedMaterial.name
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/EN
60. ManufacturedProduct.manufacturedMaterial.lotNumberText
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ST
62. ManufacturedProduct.manufacturerOrganization
Comments | MAY contain zero or one [0..1] manufacturerOrganization (CONF:1098-7416).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization