Consolidated CDA (C-CDA)
4.0.0-ballot - STU4
Consolidated CDA (C-CDA)
4.0.0-ballot - STU4
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/ImmunizationMedicationInformation | Version: 4.0.0-ballot | |||
| Draft as of 2024-11-21 | Computable Name: ImmunizationMedicationInformation | |||
| Other Identifiers: urn:ietf:rfc:3986#Uniform Resource Identifier (URI)#urn:hl7ii:2.16.840.1.113883.10.20.22.4.54:2014-06-09 | ||||
The Immunization Medication Information represents product information about the immunization substance. The vaccine manufacturer and vaccine lot number are typically recorded in the medical record and should be included if known.
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 |
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) should-manufacturerOrganization: SHOULD contain manufacturerOrganization |
  Slices for templateId |
1..* | II | Slice: Unordered, Open by value:root, value:extension | |
   templateId:immunization-med-info |
1..1 | II | ||
  @root |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.54 | |
  @extension |
1..1 | st | Required Pattern: 2014-06-09 | |
 @classCode |
1..1 | cs | ||
| id |
0..* | II | ||
| manufacturedMaterial |
C | 1..1 | Material | should-lotNumberText: SHOULD contain lotNumberText |
| code |
1..1 | CE | Binding: CVX Vaccines Administered Vaccine Set  (required) | |
 lotNumberText |
0..1 | ST | 𝗨𝗦𝗖𝗗𝗜: Lot Number Text - lotNumberText should be included if known. It may not be known for historical immunizations, planned immunizations, or refused/deferred immunizations. | |
| manufacturerOrganization |
0..1 | Organization | ||
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| ManufacturedProduct.manufacturedMaterial.code | required | CVXVaccinesAdministeredVaccineSet http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1010.6 |
| Id | Grade | Path(s) | Details | Requirements |
| should-lotNumberText | warning | ManufacturedProduct.manufacturedMaterial | SHOULD contain lotNumberText : lotNumberText.exists() | |
| should-manufacturerOrganization | warning | ManufacturedProduct | SHOULD contain manufacturerOrganization : manufacturerOrganization.exists() |
| 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) should-manufacturerOrganization: SHOULD contain manufacturerOrganization |
| Slices for templateId |
1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:immunization-med-info |
1..1 | II | ||
 @root |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.54 | |
| @extension |
1..1 | st | Required Pattern: 2014-06-09 | |
| @classCode |
1..1 | cs | Binding: RoleClassManufacturedProduct (required) Fixed Value: MANU | |
 id |
0..* | II | ||
| manufacturedMaterial |
C | 1..1 | Material | should-lotNumberText: SHOULD contain lotNumberText |
| code |
1..1 | CE | Binding: CVX Vaccines Administered Vaccine Set (required) | |
| lotNumberText |
0..1 | ST | 𝗨𝗦𝗖𝗗𝗜: Lot Number Text - lotNumberText should be included if known. It may not be known for historical immunizations, planned immunizations, or refused/deferred immunizations. | |
| 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 | CVXVaccinesAdministeredVaccineSet http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1010.6 |
| Id | Grade | Path(s) | Details | Requirements |
| product-choice | error | ManufacturedProduct | manufacturedLabeledDrug and manufacturedMaterial are mutually exclusive (one must be present) : (manufacturedLabeledDrug | manufacturedMaterial).count() = 1 | |
| should-lotNumberText | warning | ManufacturedProduct.manufacturedMaterial | SHOULD contain lotNumberText : lotNumberText.exists() | |
| should-manufacturerOrganization | warning | ManufacturedProduct | SHOULD contain manufacturerOrganization : manufacturerOrganization.exists() |
| 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) should-manufacturerOrganization: SHOULD contain manufacturerOrganization |
| @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:immunization-med-info |
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.54 | |
| @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 |
C | 1..1 | Material | should-lotNumberText: SHOULD contain lotNumberText |
| @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: CVX Vaccines Administered Vaccine Set (required) | |
| name |
0..1 | EN | ||
| lotNumberText |
0..1 | ST | 𝗨𝗦𝗖𝗗𝗜: Lot Number Text - lotNumberText should be included if known. It may not be known for historical immunizations, planned immunizations, or refused/deferred immunizations. | |
| 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:immunization-med-info.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 | CVXVaccinesAdministeredVaccineSet http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1010.6 |
| Id | Grade | Path(s) | Details | Requirements |
| product-choice | error | ManufacturedProduct | manufacturedLabeledDrug and manufacturedMaterial are mutually exclusive (one must be present) : (manufacturedLabeledDrug | manufacturedMaterial).count() = 1 | |
| should-lotNumberText | warning | ManufacturedProduct.manufacturedMaterial | SHOULD contain lotNumberText : lotNumberText.exists() | |
| should-manufacturerOrganization | warning | ManufacturedProduct | SHOULD contain manufacturerOrganization : manufacturerOrganization.exists() |
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 |
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) should-manufacturerOrganization: SHOULD contain manufacturerOrganization |
| Slices for templateId |
1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:immunization-med-info |
1..1 | II | ||
| @root |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.54 | |
| @extension |
1..1 | st | Required Pattern: 2014-06-09 | |
| @classCode |
1..1 | cs | ||
| id |
0..* | II | ||
| manufacturedMaterial |
C | 1..1 | Material | should-lotNumberText: SHOULD contain lotNumberText |
| code |
1..1 | CE | Binding: CVX Vaccines Administered Vaccine Set (required) | |
| lotNumberText |
0..1 | ST | 𝗨𝗦𝗖𝗗𝗜: Lot Number Text - lotNumberText should be included if known. It may not be known for historical immunizations, planned immunizations, or refused/deferred immunizations. | |
| manufacturerOrganization |
0..1 | Organization | ||
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| ManufacturedProduct.manufacturedMaterial.code | required | CVXVaccinesAdministeredVaccineSet http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1010.6 |
| Id | Grade | Path(s) | Details | Requirements |
| should-lotNumberText | warning | ManufacturedProduct.manufacturedMaterial | SHOULD contain lotNumberText : lotNumberText.exists() | |
| should-manufacturerOrganization | warning | ManufacturedProduct | SHOULD contain manufacturerOrganization : manufacturerOrganization.exists() |
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) should-manufacturerOrganization: SHOULD contain manufacturerOrganization |
| Slices for templateId |
1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:immunization-med-info |
1..1 | II | ||
| @root |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.54 | |
| @extension |
1..1 | st | Required Pattern: 2014-06-09 | |
| @classCode |
1..1 | cs | Binding: RoleClassManufacturedProduct (required) Fixed Value: MANU | |
| id |
0..* | II | ||
| manufacturedMaterial |
C | 1..1 | Material | should-lotNumberText: SHOULD contain lotNumberText |
| code |
1..1 | CE | Binding: CVX Vaccines Administered Vaccine Set (required) | |
| lotNumberText |
0..1 | ST | 𝗨𝗦𝗖𝗗𝗜: Lot Number Text - lotNumberText should be included if known. It may not be known for historical immunizations, planned immunizations, or refused/deferred immunizations. | |
| 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 | CVXVaccinesAdministeredVaccineSet http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1010.6 |
| Id | Grade | Path(s) | Details | Requirements |
| product-choice | error | ManufacturedProduct | manufacturedLabeledDrug and manufacturedMaterial are mutually exclusive (one must be present) : (manufacturedLabeledDrug | manufacturedMaterial).count() = 1 | |
| should-lotNumberText | warning | ManufacturedProduct.manufacturedMaterial | SHOULD contain lotNumberText : lotNumberText.exists() | |
| should-manufacturerOrganization | warning | ManufacturedProduct | SHOULD contain manufacturerOrganization : manufacturerOrganization.exists() |
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) should-manufacturerOrganization: SHOULD contain manufacturerOrganization |
| @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:immunization-med-info |
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.54 | |
| @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 |
C | 1..1 | Material | should-lotNumberText: SHOULD contain lotNumberText |
| @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: CVX Vaccines Administered Vaccine Set (required) | |
| name |
0..1 | EN | ||
| lotNumberText |
0..1 | ST | 𝗨𝗦𝗖𝗗𝗜: Lot Number Text - lotNumberText should be included if known. It may not be known for historical immunizations, planned immunizations, or refused/deferred immunizations. | |
| 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:immunization-med-info.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 | CVXVaccinesAdministeredVaccineSet http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1010.6 |
| Id | Grade | Path(s) | Details | Requirements |
| product-choice | error | ManufacturedProduct | manufacturedLabeledDrug and manufacturedMaterial are mutually exclusive (one must be present) : (manufacturedLabeledDrug | manufacturedMaterial).count() = 1 | |
| should-lotNumberText | warning | ManufacturedProduct.manufacturedMaterial | SHOULD contain lotNumberText : lotNumberText.exists() | |
| should-manufacturerOrganization | warning | ManufacturedProduct | SHOULD contain manufacturerOrganization : manufacturerOrganization.exists() |
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#4.0.0-ballot based on FHIR 5.0.0. Generated 2024-11-21
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change