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/ImmunizationMedicationInformation | Version: 2.1 | |||
Draft as of 2023-09-29 | Computable Name: ImmunizationMedicationInformation | |||
Other Identifiers: id: 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 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.54 | |
extension | 1..1 | st | Required Pattern: 2014-06-09 | |
id | 0..* | II | ||
manufacturedMaterial | 1..1 | Material | ||
code | 1..1 | CE | Binding: CVX Vaccines Administered Vaccine Set (required) | |
lotNumberText | 0..1 | ST | 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 |
ManufacturedProduct.manufacturedMaterial.code | required | CVX Vaccines Administered Vaccine Set |
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.54 | |
@extension | 1..1 | st | Required Pattern: 2014-06-09 | |
id | 0..* | II | ||
manufacturedMaterial | 1..1 | Material | ||
code | 1..1 | CE | Binding: CVX Vaccines Administered Vaccine Set (required) | |
lotNumberText | 0..1 | ST | 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 |
ManufacturedProduct.classCode | required | Fixed Value: MANU |
ManufacturedProduct.manufacturedMaterial.code | required | CVX Vaccines Administered Vaccine Set |
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()) |
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 | CVX Vaccines Administered Vaccine Set |
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.54 | |
extension | 1..1 | st | Required Pattern: 2014-06-09 | |
id | 0..* | II | ||
manufacturedMaterial | 1..1 | Material | ||
code | 1..1 | CE | Binding: CVX Vaccines Administered Vaccine Set (required) | |
lotNumberText | 0..1 | ST | 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 |
ManufacturedProduct.manufacturedMaterial.code | required | CVX Vaccines Administered Vaccine Set |
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.54 | |
@extension | 1..1 | st | Required Pattern: 2014-06-09 | |
id | 0..* | II | ||
manufacturedMaterial | 1..1 | Material | ||
code | 1..1 | CE | Binding: CVX Vaccines Administered Vaccine Set (required) | |
lotNumberText | 0..1 | ST | 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 |
ManufacturedProduct.classCode | required | Fixed Value: MANU |
ManufacturedProduct.manufacturedMaterial.code | required | CVX Vaccines Administered Vaccine Set |
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
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 | CVX Vaccines Administered Vaccine Set |
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: