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
Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/MedicationInformation | Version: 2.1 | |||
Draft as of 2023-09-29 | 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 CDAR2.ManufacturedProduct
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ManufacturedProduct | CDAR2.ManufacturedProduct | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @classCode, templateId, id, sdtcIdentifiedBy, manufacturedLabeledDrug, manufacturedMaterial, manufacturerOrganization | ||
classCode | 1..1 | cs | ||
Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
templateId:primary | 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 | |
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 |
Path | Conformance | ValueSet |
ManufacturedProduct.manufacturedMaterial.code | required | Medication Clinical Drug |
ManufacturedProduct.manufacturedMaterial.code.translation | example | Clinical Substance |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ManufacturedProduct | 1..1 | CDAR2.ManufacturedProduct | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @classCode, templateId, id, sdtcIdentifiedBy, manufacturedLabeledDrug, manufacturedMaterial, manufacturerOrganization Base for all types and resources | |
@classCode | 1..1 | cs | Binding: RoleClassManufacturedProduct (required) Fixed Value: MANU | |
Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
templateId:primary | 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 | |
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 |
Path | Conformance | ValueSet / Code |
ManufacturedProduct.classCode | required | Fixed Value: MANU |
ManufacturedProduct.manufacturedMaterial.code | required | Medication Clinical Drug |
ManufacturedProduct.manufacturedMaterial.code.translation | example | Clinical Substance |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ManufacturedProduct | 1..1 | CDAR2.ManufacturedProduct | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @classCode, templateId, id, sdtcIdentifiedBy, manufacturedLabeledDrug, manufacturedMaterial, manufacturerOrganization Base for all types and resources | |
@classCode | 1..1 | cs | Binding: RoleClassManufacturedProduct (required) Fixed Value: MANU | |
Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
templateId:primary | 1..1 | II | ||
@nullFlavor | 0..1 | cs | Binding: NullFlavor (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 | |
id | 0..* | II | ||
sdtcIdentifiedBy | 0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc 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 | 0..1 | cs | Binding: EntityClassManufacturedMaterial (required) Fixed Value: MMAT | |
@determinerCode | 0..1 | cs | Binding: EntityDeterminerDetermined (required) Fixed Value: KIND | |
@nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
templateId | 0..* | II | ||
code | 1..1 | CE | Binding: Medication Clinical Drug (required) | |
@nullFlavor | 0..1 | cs | Binding: NullFlavor (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 | Binding: Clinical Substance (example) | |
name | 0..1 | EN | ||
lotNumberText | 0..1 | ST | ||
manufacturerOrganization | 0..1 | Organization | ||
Documentation for this format |
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 |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
This structure is derived from CDAR2.ManufacturedProduct
Summary
Mandatory: 7 elements
Slices
This structure defines the following Slices:
Differential View
This structure is derived from CDAR2.ManufacturedProduct
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ManufacturedProduct | CDAR2.ManufacturedProduct | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @classCode, templateId, id, sdtcIdentifiedBy, manufacturedLabeledDrug, manufacturedMaterial, manufacturerOrganization | ||
classCode | 1..1 | cs | ||
Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
templateId:primary | 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 | |
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 |
Path | Conformance | ValueSet |
ManufacturedProduct.manufacturedMaterial.code | required | Medication Clinical Drug |
ManufacturedProduct.manufacturedMaterial.code.translation | example | Clinical Substance |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ManufacturedProduct | 1..1 | CDAR2.ManufacturedProduct | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @classCode, templateId, id, sdtcIdentifiedBy, manufacturedLabeledDrug, manufacturedMaterial, manufacturerOrganization Base for all types and resources | |
@classCode | 1..1 | cs | Binding: RoleClassManufacturedProduct (required) Fixed Value: MANU | |
Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
templateId:primary | 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 | |
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 |
Path | Conformance | ValueSet / Code |
ManufacturedProduct.classCode | required | Fixed Value: MANU |
ManufacturedProduct.manufacturedMaterial.code | required | Medication Clinical Drug |
ManufacturedProduct.manufacturedMaterial.code.translation | example | Clinical Substance |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ManufacturedProduct | 1..1 | CDAR2.ManufacturedProduct | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @classCode, templateId, id, sdtcIdentifiedBy, manufacturedLabeledDrug, manufacturedMaterial, manufacturerOrganization Base for all types and resources | |
@classCode | 1..1 | cs | Binding: RoleClassManufacturedProduct (required) Fixed Value: MANU | |
Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
templateId:primary | 1..1 | II | ||
@nullFlavor | 0..1 | cs | Binding: NullFlavor (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 | |
id | 0..* | II | ||
sdtcIdentifiedBy | 0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc 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 | 0..1 | cs | Binding: EntityClassManufacturedMaterial (required) Fixed Value: MMAT | |
@determinerCode | 0..1 | cs | Binding: EntityDeterminerDetermined (required) Fixed Value: KIND | |
@nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
templateId | 0..* | II | ||
code | 1..1 | CE | Binding: Medication Clinical Drug (required) | |
@nullFlavor | 0..1 | cs | Binding: NullFlavor (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 | Binding: Clinical Substance (example) | |
name | 0..1 | EN | ||
lotNumberText | 0..1 | ST | ||
manufacturerOrganization | 0..1 | Organization | ||
Documentation for this format |
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 |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
This structure is derived from CDAR2.ManufacturedProduct
Summary
Mandatory: 7 elements
Slices
This structure defines the following Slices: