Consolidated CDA Release 2.2, published by Health Level Seven. This is not an authorized publication; it is the continuous build for version 2.2). This version is based on the current content of https://github.com/HL7/CDA-ccda-2.2/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org/fhir/cda/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.4.23 | Version: 2.2 | |||
Active as of 2022-05-13 | Computable Name: MedicationInformation | |||
Other Identifiers: : 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 CDAR2.ManufacturedProduct
Summary
Mandatory: 6 elements
Slices
This structure defines the following Slices:
This structure is derived from CDAR2.ManufacturedProduct
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ManufacturedProduct | 1..1 | CDAR2.ManufacturedProduct | ||
classCode | 1..1 | code | ||
Slices for templateId | 0..* | II | Slice: Unordered, Open by value:root, value:extension | |
templateId:primary | 1..1 | II | ||
root | 1..1 | string | Required Pattern: 2.16.840.1.113883.10.20.22.4.23 | |
extension | 1..1 | string | Required Pattern: 2014-06-09 | |
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 | Binding: Clinical Substance (example) | |
manufacturerOrganization | 0..1 | Organization | ||
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ManufacturedProduct | 1..1 | CDAR2.ManufacturedProduct | ||
classCode | 1..1 | code | Binding: RoleClassManufacturedProduct (required) Fixed Value: MANU | |
Slices for templateId | 0..* | II | Slice: Unordered, Open by value:root, value:extension | |
templateId:primary | 1..1 | II | ||
nullFlavor | 0..1 | code | Binding: NullFlavor (required) | |
assigningAuthorityName | 0..1 | string | ||
displayable | 0..1 | boolean | ||
root | 1..1 | string | Required Pattern: 2.16.840.1.113883.10.20.22.4.23 | |
extension | 1..1 | string | Required Pattern: 2014-06-09 | |
id | 0..* | II | ||
sdtcIdentifiedBy | 0..* | IdentifiedBy | XML: identifiedBy (urn:hl7-org:sdtc) | |
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). | |
classCode | 1..1 | code | Binding: EntityClassManufacturedMaterial (required) Fixed Value: MMAT | |
determinerCode | 1..1 | code | Binding: EntityDeterminerDetermined (required) Fixed Value: KIND | |
nullFlavor | 0..1 | code | Binding: NullFlavor (required) | |
templateId | 0..* | II | ||
code | 1..1 | CE | Binding: Medication Clinical Drug (required) | |
nullFlavor | 0..1 | code | Binding: NullFlavor (required) | |
code | 0..1 | string | ||
codeSystem | 0..1 | string | ||
codeSystemName | 0..1 | string | ||
codeSystemVersion | 0..1 | string | ||
displayName | 0..1 | string | ||
sdtcValueSet | 0..1 | string | XML: valueSet (urn:hl7-org:sdtc) | |
sdtcValueSetVersion | 0..1 | string | XML: valueSetVersion (urn:hl7-org:sdtc) | |
originalText | 0..1 | ED | ||
translation | 0..* | CD | Binding: Clinical Substance (example) | |
name | 0..1 | EN | ||
lotNumberText | 0..1 | ED | ||
manufacturerOrganization | 0..1 | Organization | ||
Documentation for this format |
This structure is derived from CDAR2.ManufacturedProduct
Summary
Mandatory: 6 elements
Slices
This structure defines the following Slices:
Differential View
This structure is derived from CDAR2.ManufacturedProduct
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ManufacturedProduct | 1..1 | CDAR2.ManufacturedProduct | ||
classCode | 1..1 | code | ||
Slices for templateId | 0..* | II | Slice: Unordered, Open by value:root, value:extension | |
templateId:primary | 1..1 | II | ||
root | 1..1 | string | Required Pattern: 2.16.840.1.113883.10.20.22.4.23 | |
extension | 1..1 | string | Required Pattern: 2014-06-09 | |
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 | Binding: Clinical Substance (example) | |
manufacturerOrganization | 0..1 | Organization | ||
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ManufacturedProduct | 1..1 | CDAR2.ManufacturedProduct | ||
classCode | 1..1 | code | Binding: RoleClassManufacturedProduct (required) Fixed Value: MANU | |
Slices for templateId | 0..* | II | Slice: Unordered, Open by value:root, value:extension | |
templateId:primary | 1..1 | II | ||
nullFlavor | 0..1 | code | Binding: NullFlavor (required) | |
assigningAuthorityName | 0..1 | string | ||
displayable | 0..1 | boolean | ||
root | 1..1 | string | Required Pattern: 2.16.840.1.113883.10.20.22.4.23 | |
extension | 1..1 | string | Required Pattern: 2014-06-09 | |
id | 0..* | II | ||
sdtcIdentifiedBy | 0..* | IdentifiedBy | XML: identifiedBy (urn:hl7-org:sdtc) | |
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). | |
classCode | 1..1 | code | Binding: EntityClassManufacturedMaterial (required) Fixed Value: MMAT | |
determinerCode | 1..1 | code | Binding: EntityDeterminerDetermined (required) Fixed Value: KIND | |
nullFlavor | 0..1 | code | Binding: NullFlavor (required) | |
templateId | 0..* | II | ||
code | 1..1 | CE | Binding: Medication Clinical Drug (required) | |
nullFlavor | 0..1 | code | Binding: NullFlavor (required) | |
code | 0..1 | string | ||
codeSystem | 0..1 | string | ||
codeSystemName | 0..1 | string | ||
codeSystemVersion | 0..1 | string | ||
displayName | 0..1 | string | ||
sdtcValueSet | 0..1 | string | XML: valueSet (urn:hl7-org:sdtc) | |
sdtcValueSetVersion | 0..1 | string | XML: valueSetVersion (urn:hl7-org:sdtc) | |
originalText | 0..1 | ED | ||
translation | 0..* | CD | Binding: Clinical Substance (example) | |
name | 0..1 | EN | ||
lotNumberText | 0..1 | ED | ||
manufacturerOrganization | 0..1 | Organization | ||
Documentation for this format |
Other representations of profile: CSV, Excel, Schematron
Path | Conformance | ValueSet / Code |
ManufacturedProduct.classCode | required | Fixed Value: MANU |
ManufacturedProduct.templateId:primary.nullFlavor | required | NullFlavor |
ManufacturedProduct.manufacturedMaterial.classCode | required | Fixed Value: MMAT |
ManufacturedProduct.manufacturedMaterial.determinerCode | required | Fixed Value: KIND |
ManufacturedProduct.manufacturedMaterial.nullFlavor | required | NullFlavor |
ManufacturedProduct.manufacturedMaterial.code | required | Medication Clinical Drug |
ManufacturedProduct.manufacturedMaterial.code.nullFlavor | required | NullFlavor |
ManufacturedProduct.manufacturedMaterial.code.translation | example | Clinical Substance |