Consolidated CDA Release 2.2
2.2 - CI Build United States of America flag

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

Resource Profile: Medication Information

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:

Formal Views of Profile Content

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:

  • The element ManufacturedProduct.templateId is sliced based on the values of value:root, value:extension

This structure is derived from CDAR2.ManufacturedProduct

NameFlagsCard.TypeDescription & Constraintsdoco
.. ManufacturedProduct 1..1CDAR2.ManufacturedProduct
... classCode 1..1code
... Slices for templateId 0..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.4.23
..... extension 1..1stringRequired Pattern: 2014-06-09
... id 0..*II
.... code 1..1CEBinding: Medication Clinical Drug (required)
..... translation 0..*CDBinding: Clinical Substance (example)
... manufacturerOrganization 0..1Organization

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. ManufacturedProduct 1..1CDAR2.ManufacturedProduct
... classCode 1..1codeBinding: RoleClassManufacturedProduct (required)
Fixed Value: MANU
... Slices for templateId 0..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... nullFlavor 0..1codeBinding: NullFlavor (required)
..... assigningAuthorityName 0..1string
..... displayable 0..1boolean
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.4.23
..... extension 1..1stringRequired Pattern: 2014-06-09
... id 0..*II
... manufacturedLabeledDrug 0..1LabeledDrug
... manufacturedMaterial 1..1MaterialA 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..1codeBinding: EntityClassManufacturedMaterial (required)
Fixed Value: MMAT
.... determinerCode 1..1codeBinding: EntityDeterminerDetermined (required)
Fixed Value: KIND
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... templateId 0..*II
.... code 1..1CEBinding: Medication Clinical Drug (required)
..... nullFlavor 0..1codeBinding: NullFlavor (required)
..... code 0..1string
..... codeSystem 0..1string
..... codeSystemName 0..1string
..... codeSystemVersion 0..1string
..... displayName 0..1string
..... sdtcValueSet 0..1stringXML: valueSet (urn:hl7-org:sdtc)
..... sdtcValueSetVersion 0..1stringXML: valueSetVersion (urn:hl7-org:sdtc)
..... originalText 0..1ED
..... translation 0..*CDBinding: Clinical Substance (example)
.... name 0..1EN
.... lotNumberText 0..1ED
... manufacturerOrganization 0..1Organization

doco Documentation for this format

This structure is derived from CDAR2.ManufacturedProduct

Summary

Mandatory: 6 elements

Slices

This structure defines the following Slices:

  • The element ManufacturedProduct.templateId is sliced based on the values of value:root, value:extension

Differential View

This structure is derived from CDAR2.ManufacturedProduct

NameFlagsCard.TypeDescription & Constraintsdoco
.. ManufacturedProduct 1..1CDAR2.ManufacturedProduct
... classCode 1..1code
... Slices for templateId 0..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.4.23
..... extension 1..1stringRequired Pattern: 2014-06-09
... id 0..*II
.... code 1..1CEBinding: Medication Clinical Drug (required)
..... translation 0..*CDBinding: Clinical Substance (example)
... manufacturerOrganization 0..1Organization

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ManufacturedProduct 1..1CDAR2.ManufacturedProduct
... classCode 1..1codeBinding: RoleClassManufacturedProduct (required)
Fixed Value: MANU
... Slices for templateId 0..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:primary 1..1II
..... nullFlavor 0..1codeBinding: NullFlavor (required)
..... assigningAuthorityName 0..1string
..... displayable 0..1boolean
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.4.23
..... extension 1..1stringRequired Pattern: 2014-06-09
... id 0..*II
... manufacturedLabeledDrug 0..1LabeledDrug
... manufacturedMaterial 1..1MaterialA 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..1codeBinding: EntityClassManufacturedMaterial (required)
Fixed Value: MMAT
.... determinerCode 1..1codeBinding: EntityDeterminerDetermined (required)
Fixed Value: KIND
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... templateId 0..*II
.... code 1..1CEBinding: Medication Clinical Drug (required)
..... nullFlavor 0..1codeBinding: NullFlavor (required)
..... code 0..1string
..... codeSystem 0..1string
..... codeSystemName 0..1string
..... codeSystemVersion 0..1string
..... displayName 0..1string
..... sdtcValueSet 0..1stringXML: valueSet (urn:hl7-org:sdtc)
..... sdtcValueSetVersion 0..1stringXML: valueSetVersion (urn:hl7-org:sdtc)
..... originalText 0..1ED
..... translation 0..*CDBinding: Clinical Substance (example)
.... name 0..1EN
.... lotNumberText 0..1ED
... manufacturerOrganization 0..1Organization

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet / Code
ManufacturedProduct.classCoderequiredFixed Value: MANU
ManufacturedProduct.templateId:primary.nullFlavorrequiredNullFlavor
ManufacturedProduct.manufacturedMaterial.classCoderequiredFixed Value: MMAT
ManufacturedProduct.manufacturedMaterial.determinerCoderequiredFixed Value: KIND
ManufacturedProduct.manufacturedMaterial.nullFlavorrequiredNullFlavor
ManufacturedProduct.manufacturedMaterial.coderequiredMedication Clinical Drug
ManufacturedProduct.manufacturedMaterial.code.nullFlavorrequiredNullFlavor
ManufacturedProduct.manufacturedMaterial.code.translationexampleClinical Substance