Consolidated CDA
3.0.0-ballot - ballot
Consolidated CDA
3.0.0-ballot - ballot
This page is part of the CCDA: Consolidated CDA Release (v3.0.0-ballot: CCDA 3.0 Ballot 1) based on FHIR (HL7® FHIR® Standard) v5.0.0. . For a full list of available versions, see the Directory of published versions
| Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/MedicationInformation | Version: 3.0.0-ballot | |||
| Draft as of 2023-12-21 | Computable Name: MedicationInformation | |||
| Other Identifiers: id: urn:hl7ii:2.16.840.1.113883.10.20.22.4.23:2014-06-09 | ||||
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).
The dose (doseQuantity) represents how many of the consumables are to be administered at each administration event. As a result, the dose is always relative to the consumable. Thus, a patient consuming a single “metoprolol 25mg tablet” per administration will have a doseQuantity of “1”, whereas a patient consuming “metoprolol” will have a dose of “25 mg”.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from ManufacturedProduct
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  ManufacturedProduct | ManufacturedProduct | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, id, sdtcIdentifiedBy, manufacturedLabeledDrug, manufacturedMaterial, manufacturerOrganization Instances of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) | ||
  Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
   templateId:med-information | 1..1 | II | ||
  @root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.23 | |
  @extension | 1..1 | st | Required Pattern: 2014-06-09 | |
 @classCode | 1..1 | cs | ||
| id | 0..* | II | ||
| manufacturedMaterial | 1..1 | Material | 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). | |
 code | 1..1 | CE | Binding: Medication Clinical Drug (required) | |
 translation | 0..* | CD | Translations may also be sent with NDC codes (Codesystem urn:oid:2.16.840.1.113883.6.69). Binding: Clinical Substance (preferred) | |
| manufacturerOrganization | 0..1 | Organization | ||
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| ManufacturedProduct.manufacturedMaterial.code | required | MedicationClinicalDrug |
| ManufacturedProduct.manufacturedMaterial.code.translation | preferred | ClinicalSubstance |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ManufacturedProduct | C | 1..1 | ManufacturedProduct | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, id, sdtcIdentifiedBy, manufacturedLabeledDrug, manufacturedMaterial, manufacturerOrganization Base for all types and resources Instances of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) |
| Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:med-information | 1..1 | II | ||
 @root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.23 | |
| @extension | 1..1 | st | Required Pattern: 2014-06-09 | |
| @classCode | 1..1 | cs | Binding: RoleClassManufacturedProduct (required) Fixed Value: MANU | |
 id | 0..* | II | ||
| manufacturedMaterial | 1..1 | Material | 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). | |
| code | 1..1 | CE | Binding: Medication Clinical Drug (required) | |
| translation | 0..* | CD | Translations may also be sent with NDC codes (Codesystem urn:oid:2.16.840.1.113883.6.69). Binding: Clinical Substance (preferred) | |
| manufacturerOrganization | 0..1 | Organization | ||
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| ManufacturedProduct.classCode | required | Fixed Value: MANU |
| ManufacturedProduct.manufacturedMaterial.code | required | MedicationClinicalDrug |
| ManufacturedProduct.manufacturedMaterial.code.translation | preferred | ClinicalSubstance |
| Id | Grade | Path(s) | Details | Requirements |
| product-choice | error | ManufacturedProduct | manufacturedLabeledDrug and manufacturedMaterial are mutually exclusive (one must be present) : (manufacturedLabeledDrug | manufacturedMaterial).count() = 1 |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ManufacturedProduct | C | 1..1 | ManufacturedProduct | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, id, sdtcIdentifiedBy, manufacturedLabeledDrug, manufacturedMaterial, manufacturerOrganization Base for all types and resources Instances of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) |
| @nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode | 0..* | CS | ||
| typeId | 0..1 | II | ||
| @nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName | 0..1 | st | ||
| @displayable | 0..1 | bl | ||
| @root | 1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension | 1..1 | st | ||
| Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:med-information | 1..1 | II | ||
| @nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName | 0..1 | st | ||
| @displayable | 0..1 | bl | ||
| @root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.23 | |
| @extension | 1..1 | st | Required Pattern: 2014-06-09 | |
| @classCode | 1..1 | cs | Binding: RoleClassManufacturedProduct (required) Fixed Value: MANU | |
| id | 0..* | II | ||
| sdtcIdentifiedBy | 0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |
 (Choice of one) | 1..1 | |||
 manufacturedLabeledDrug | 0..1 | LabeledDrug | ||
| manufacturedMaterial | 1..1 | Material | 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). | |
| @nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode | 0..* | CS | ||
| typeId | 0..1 | II | ||
| @nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName | 0..1 | st | ||
| @displayable | 0..1 | bl | ||
| @root | 1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension | 1..1 | st | ||
| templateId | 0..* | II | ||
| @classCode | 0..1 | cs | Binding: EntityClassManufacturedMaterial (required) Fixed Value: MMAT | |
| @determinerCode | 0..1 | cs | Binding: EntityDeterminerDetermined (required) Fixed Value: KIND | |
| code | 1..1 | CE | Binding: Medication Clinical Drug (required) | |
| @nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
| @code | 0..1 | cs | ||
| @codeSystem | 0..1 | oid, uuid, ruid | ||
| @codeSystemName | 0..1 | st | ||
| @codeSystemVersion | 0..1 | st | ||
| @displayName | 0..1 | st | ||
| @sdtcValueSet | 0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
| @sdtcValueSetVersion | 0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
| originalText | 0..1 | ED | ||
| translation | 0..* | CD | Translations may also be sent with NDC codes (Codesystem urn:oid:2.16.840.1.113883.6.69). Binding: Clinical Substance (preferred) | |
| name | 0..1 | EN | ||
| lotNumberText | 0..1 | ST | ||
| manufacturerOrganization | 0..1 | Organization | ||
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| ManufacturedProduct.nullFlavor | required | CDANullFlavor |
| ManufacturedProduct.typeId.nullFlavor | required | CDANullFlavor |
| ManufacturedProduct.templateId:med-information.nullFlavor | required | CDANullFlavor |
| ManufacturedProduct.classCode | required | Fixed Value: MANU |
| ManufacturedProduct.manufacturedMaterial.nullFlavor | required | CDANullFlavor |
| ManufacturedProduct.manufacturedMaterial.typeId.nullFlavor | required | CDANullFlavor |
| ManufacturedProduct.manufacturedMaterial.classCode | required | Fixed Value: MMAT |
| ManufacturedProduct.manufacturedMaterial.determinerCode | required | Fixed Value: KIND |
| ManufacturedProduct.manufacturedMaterial.code | required | MedicationClinicalDrug |
| ManufacturedProduct.manufacturedMaterial.code.nullFlavor | required | CDANullFlavor |
| ManufacturedProduct.manufacturedMaterial.code.translation | preferred | ClinicalSubstance |
| Id | Grade | Path(s) | Details | Requirements |
| product-choice | error | ManufacturedProduct | manufacturedLabeledDrug and manufacturedMaterial are mutually exclusive (one must be present) : (manufacturedLabeledDrug | manufacturedMaterial).count() = 1 |
This structure is derived from ManufacturedProduct
Summary
Mandatory: 7 elements
Slices
This structure defines the following Slices:
Differential View
This structure is derived from ManufacturedProduct
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ManufacturedProduct | ManufacturedProduct | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, id, sdtcIdentifiedBy, manufacturedLabeledDrug, manufacturedMaterial, manufacturerOrganization Instances of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) | ||
| Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:med-information | 1..1 | II | ||
| @root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.23 | |
| @extension | 1..1 | st | Required Pattern: 2014-06-09 | |
| @classCode | 1..1 | cs | ||
| id | 0..* | II | ||
| manufacturedMaterial | 1..1 | Material | 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). | |
| code | 1..1 | CE | Binding: Medication Clinical Drug (required) | |
| translation | 0..* | CD | Translations may also be sent with NDC codes (Codesystem urn:oid:2.16.840.1.113883.6.69). Binding: Clinical Substance (preferred) | |
| manufacturerOrganization | 0..1 | Organization | ||
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| ManufacturedProduct.manufacturedMaterial.code | required | MedicationClinicalDrug |
| ManufacturedProduct.manufacturedMaterial.code.translation | preferred | ClinicalSubstance |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ManufacturedProduct | C | 1..1 | ManufacturedProduct | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, id, sdtcIdentifiedBy, manufacturedLabeledDrug, manufacturedMaterial, manufacturerOrganization Base for all types and resources Instances of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) |
| Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:med-information | 1..1 | II | ||
| @root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.23 | |
| @extension | 1..1 | st | Required Pattern: 2014-06-09 | |
| @classCode | 1..1 | cs | Binding: RoleClassManufacturedProduct (required) Fixed Value: MANU | |
| id | 0..* | II | ||
| manufacturedMaterial | 1..1 | Material | 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). | |
| code | 1..1 | CE | Binding: Medication Clinical Drug (required) | |
| translation | 0..* | CD | Translations may also be sent with NDC codes (Codesystem urn:oid:2.16.840.1.113883.6.69). Binding: Clinical Substance (preferred) | |
| manufacturerOrganization | 0..1 | Organization | ||
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| ManufacturedProduct.classCode | required | Fixed Value: MANU |
| ManufacturedProduct.manufacturedMaterial.code | required | MedicationClinicalDrug |
| ManufacturedProduct.manufacturedMaterial.code.translation | preferred | ClinicalSubstance |
| Id | Grade | Path(s) | Details | Requirements |
| product-choice | error | ManufacturedProduct | manufacturedLabeledDrug and manufacturedMaterial are mutually exclusive (one must be present) : (manufacturedLabeledDrug | manufacturedMaterial).count() = 1 |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ManufacturedProduct | C | 1..1 | ManufacturedProduct | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, id, sdtcIdentifiedBy, manufacturedLabeledDrug, manufacturedMaterial, manufacturerOrganization Base for all types and resources Instances of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) |
| @nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode | 0..* | CS | ||
| typeId | 0..1 | II | ||
| @nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName | 0..1 | st | ||
| @displayable | 0..1 | bl | ||
| @root | 1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension | 1..1 | st | ||
| Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:med-information | 1..1 | II | ||
| @nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName | 0..1 | st | ||
| @displayable | 0..1 | bl | ||
| @root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.23 | |
| @extension | 1..1 | st | Required Pattern: 2014-06-09 | |
| @classCode | 1..1 | cs | Binding: RoleClassManufacturedProduct (required) Fixed Value: MANU | |
| id | 0..* | II | ||
| sdtcIdentifiedBy | 0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |
| (Choice of one) | 1..1 | |||
| manufacturedLabeledDrug | 0..1 | LabeledDrug | ||
| manufacturedMaterial | 1..1 | Material | 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). | |
| @nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode | 0..* | CS | ||
| typeId | 0..1 | II | ||
| @nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName | 0..1 | st | ||
| @displayable | 0..1 | bl | ||
| @root | 1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension | 1..1 | st | ||
| templateId | 0..* | II | ||
| @classCode | 0..1 | cs | Binding: EntityClassManufacturedMaterial (required) Fixed Value: MMAT | |
| @determinerCode | 0..1 | cs | Binding: EntityDeterminerDetermined (required) Fixed Value: KIND | |
| code | 1..1 | CE | Binding: Medication Clinical Drug (required) | |
| @nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
| @code | 0..1 | cs | ||
| @codeSystem | 0..1 | oid, uuid, ruid | ||
| @codeSystemName | 0..1 | st | ||
| @codeSystemVersion | 0..1 | st | ||
| @displayName | 0..1 | st | ||
| @sdtcValueSet | 0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
| @sdtcValueSetVersion | 0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
| originalText | 0..1 | ED | ||
| translation | 0..* | CD | Translations may also be sent with NDC codes (Codesystem urn:oid:2.16.840.1.113883.6.69). Binding: Clinical Substance (preferred) | |
| name | 0..1 | EN | ||
| lotNumberText | 0..1 | ST | ||
| manufacturerOrganization | 0..1 | Organization | ||
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| ManufacturedProduct.nullFlavor | required | CDANullFlavor |
| ManufacturedProduct.typeId.nullFlavor | required | CDANullFlavor |
| ManufacturedProduct.templateId:med-information.nullFlavor | required | CDANullFlavor |
| ManufacturedProduct.classCode | required | Fixed Value: MANU |
| ManufacturedProduct.manufacturedMaterial.nullFlavor | required | CDANullFlavor |
| ManufacturedProduct.manufacturedMaterial.typeId.nullFlavor | required | CDANullFlavor |
| ManufacturedProduct.manufacturedMaterial.classCode | required | Fixed Value: MMAT |
| ManufacturedProduct.manufacturedMaterial.determinerCode | required | Fixed Value: KIND |
| ManufacturedProduct.manufacturedMaterial.code | required | MedicationClinicalDrug |
| ManufacturedProduct.manufacturedMaterial.code.nullFlavor | required | CDANullFlavor |
| ManufacturedProduct.manufacturedMaterial.code.translation | preferred | ClinicalSubstance |
| Id | Grade | Path(s) | Details | Requirements |
| product-choice | error | ManufacturedProduct | manufacturedLabeledDrug and manufacturedMaterial are mutually exclusive (one must be present) : (manufacturedLabeledDrug | manufacturedMaterial).count() = 1 |
This structure is derived from ManufacturedProduct
Summary
Mandatory: 7 elements
Slices
This structure defines the following Slices:
IG © 2019+ Health Level Seven. Package hl7.cda.us.ccda#3.0.0-ballot based on FHIR 5.0.0. Generated 2023-12-21
Links: Table of Contents |
QA Report
| Version History 
|
|
Propose a change