Consolidated CDA (C-CDA), published by Health Level Seven. This guide is not an authorized publication; it is the continuous build for version 4.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/CDA-ccda/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/MedicationInformation | Version: 4.0.0-ballot | |||
Draft as of 2024-11-21 | Computable Name: MedicationInformation | |||
Other Identifiers: urn:ietf:rfc:3986#Uniform Resource Identifier (URI)#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 and the interval of administration. Thus, a patient consuming a single "metoprolol 25mg tablet" per administration will have a doseQuantity of "1", whereas a patient consuming "metoprolol Oral Product" (RxCUI 1163523) will have a dose of "25 mg".
Usage:
Description of Template, 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 Instance 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 | URI |
ManufacturedProduct.manufacturedMaterial.code | required | MedicationClinicalDrug http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1010.4 | |
ManufacturedProduct.manufacturedMaterial.code.translation | preferred | ClinicalSubstance http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1010.2 |
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 Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) product-choice: manufacturedLabeledDrug and manufacturedMaterial are mutually exclusive (one must be present) |
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 | URI |
ManufacturedProduct.classCode | required | Fixed Value: MANUhttp://terminology.hl7.org/ValueSet/v3-RoleClassManufacturedProduct | |
ManufacturedProduct.manufacturedMaterial.code | required | MedicationClinicalDrug http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1010.4 | |
ManufacturedProduct.manufacturedMaterial.code.translation | preferred | ClinicalSubstance http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1010.2 |
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 Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) product-choice: manufacturedLabeledDrug and manufacturedMaterial are mutually exclusive (one must be present) |
@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 | URI |
ManufacturedProduct.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
ManufacturedProduct.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
ManufacturedProduct.templateId:med-information.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
ManufacturedProduct.classCode | required | Fixed Value: MANUhttp://terminology.hl7.org/ValueSet/v3-RoleClassManufacturedProduct | |
ManufacturedProduct.manufacturedMaterial.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
ManufacturedProduct.manufacturedMaterial.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
ManufacturedProduct.manufacturedMaterial.classCode | required | Fixed Value: MMAThttp://terminology.hl7.org/ValueSet/v3-EntityClassManufacturedMaterial | |
ManufacturedProduct.manufacturedMaterial.determinerCode | required | Fixed Value: KINDhttp://terminology.hl7.org/ValueSet/v3-EntityDeterminerDetermined | |
ManufacturedProduct.manufacturedMaterial.code | required | MedicationClinicalDrug http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1010.4 | |
ManufacturedProduct.manufacturedMaterial.code.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
ManufacturedProduct.manufacturedMaterial.code.translation | preferred | ClinicalSubstance http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1010.2 |
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 Instance 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 | URI |
ManufacturedProduct.manufacturedMaterial.code | required | MedicationClinicalDrug http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1010.4 | |
ManufacturedProduct.manufacturedMaterial.code.translation | preferred | ClinicalSubstance http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1010.2 |
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 Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) product-choice: manufacturedLabeledDrug and manufacturedMaterial are mutually exclusive (one must be present) |
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 | URI |
ManufacturedProduct.classCode | required | Fixed Value: MANUhttp://terminology.hl7.org/ValueSet/v3-RoleClassManufacturedProduct | |
ManufacturedProduct.manufacturedMaterial.code | required | MedicationClinicalDrug http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1010.4 | |
ManufacturedProduct.manufacturedMaterial.code.translation | preferred | ClinicalSubstance http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1010.2 |
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 Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) product-choice: manufacturedLabeledDrug and manufacturedMaterial are mutually exclusive (one must be present) |
@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 | URI |
ManufacturedProduct.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
ManufacturedProduct.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
ManufacturedProduct.templateId:med-information.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
ManufacturedProduct.classCode | required | Fixed Value: MANUhttp://terminology.hl7.org/ValueSet/v3-RoleClassManufacturedProduct | |
ManufacturedProduct.manufacturedMaterial.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
ManufacturedProduct.manufacturedMaterial.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
ManufacturedProduct.manufacturedMaterial.classCode | required | Fixed Value: MMAThttp://terminology.hl7.org/ValueSet/v3-EntityClassManufacturedMaterial | |
ManufacturedProduct.manufacturedMaterial.determinerCode | required | Fixed Value: KINDhttp://terminology.hl7.org/ValueSet/v3-EntityDeterminerDetermined | |
ManufacturedProduct.manufacturedMaterial.code | required | MedicationClinicalDrug http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1010.4 | |
ManufacturedProduct.manufacturedMaterial.code.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
ManufacturedProduct.manufacturedMaterial.code.translation | preferred | ClinicalSubstance http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1010.2 |
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: