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: ImmunizationMedicationInformation - Detailed Descriptions

Active as of 2022-05-13

Definitions for the 2.16.840.1.113883.10.20.22.4.54 resource profile.

1. ManufacturedProduct
Control1..1
2. ManufacturedProduct.classCode
Control1..1
BindingThe codes SHALL be taken from RoleClassManufacturedProduct
Typecode
Requirements

SHALL contain exactly one [1..1] @classCode="MANU" (CodeSystem: HL7RoleClass urn:oid:2.16.840.1.113883.5.110 STATIC) (CONF:1098-9002).

Default ValueMANU
Fixed ValueMANU
3. ManufacturedProduct.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
SlicingThis element introduces a set of slices on ManufacturedProduct.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ root
  • ,
  • value @ extension
4. ManufacturedProduct.templateId:primary
SliceNameprimary
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

SHALL contain exactly one [1..1] templateId (CONF:1098-9004) such that it

5. ManufacturedProduct.templateId:primary.nullFlavor
Definition

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
6. ManufacturedProduct.templateId:primary.assigningAuthorityName
Definition

A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.

Control0..1
Typestring
7. ManufacturedProduct.templateId:primary.displayable
Definition

Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).

Control0..1
Typeboolean
8. ManufacturedProduct.templateId:primary.root
Definition

A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.

Control1..1
Typestring
Requirements

SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.54" (CONF:1098-10499).

Pattern Value2.16.840.1.113883.10.20.22.4.54
9. ManufacturedProduct.templateId:primary.extension
Definition

A character string as a unique identifier within the scope of the identifier root.

Control1..1
Typestring
Requirements

SHALL contain exactly one [1..1] @extension="2014-06-09" (CONF:1098-32602).

Pattern Value2014-06-09
10. ManufacturedProduct.id
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Requirements

MAY contain zero or more [0..*] id (CONF:1098-9005).

11. ManufacturedProduct.sdtcIdentifiedBy
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/IdentifiedBy
12. ManufacturedProduct.manufacturedLabeledDrug
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/LabeledDrug
13. ManufacturedProduct.manufacturedMaterial
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Material
Requirements

SHALL contain exactly one [1..1] manufacturedMaterial (CONF:1098-9006).

14. ManufacturedProduct.manufacturedMaterial.classCode
Control1..1
BindingThe codes SHALL be taken from EntityClassManufacturedMaterial
Typecode
Default ValueMMAT
Fixed ValueMMAT
15. ManufacturedProduct.manufacturedMaterial.determinerCode
Control1..1
BindingThe codes SHALL be taken from EntityDeterminerDetermined
Typecode
Default ValueKIND
Fixed ValueKIND
16. ManufacturedProduct.manufacturedMaterial.nullFlavor
Definition

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
17. ManufacturedProduct.manufacturedMaterial.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
18. ManufacturedProduct.manufacturedMaterial.code
Control1..1
BindingThe codes SHALL be taken from CVX Vaccines Administered Vaccine Set
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
Requirements

This manufacturedMaterial SHALL contain exactly one [1..1] code, which SHALL be selected from ValueSet CVX Vaccines Administered Vaccine Set urn:oid:2.16.840.1.113762.1.4.1010.6 DYNAMIC (CONF:1098-9007).

19. ManufacturedProduct.manufacturedMaterial.code.nullFlavor
Definition

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
20. ManufacturedProduct.manufacturedMaterial.code.code
Definition

The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache.

Control0..1
Typestring
21. ManufacturedProduct.manufacturedMaterial.code.codeSystem
Definition

Specifies the code system that defines the code.

Control0..1
Typestring
22. ManufacturedProduct.manufacturedMaterial.code.codeSystemName
Definition

The common name of the coding system.

Control0..1
Typestring
23. ManufacturedProduct.manufacturedMaterial.code.codeSystemVersion
Definition

If applicable, a version descriptor defined specifically for the given code system.

Control0..1
Typestring
24. ManufacturedProduct.manufacturedMaterial.code.displayName
Definition

A name or title for the code, under which the sending system shows the code value to its users.

Control0..1
Typestring
25. ManufacturedProduct.manufacturedMaterial.code.sdtcValueSet
Definition

The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.

Control0..1
Typestring
26. ManufacturedProduct.manufacturedMaterial.code.sdtcValueSetVersion
Definition

The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept.

Control0..1
Typestring
27. ManufacturedProduct.manufacturedMaterial.code.originalText
Definition

The text or phrase used as the basis for the coding.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
28. ManufacturedProduct.manufacturedMaterial.code.qualifier
Definition

Specifies additional codes that increase the specificity of the the primary code.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/CR
29. ManufacturedProduct.manufacturedMaterial.code.translation
Definition

A set of other concept descriptors that translate this concept descriptor into other code systems.

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
SlicingThis element introduces a set of slices on ManufacturedProduct.manufacturedMaterial.code.translation. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ $this
30. ManufacturedProduct.manufacturedMaterial.code.translation:vaccine
SliceNamevaccine
Definition

A set of other concept descriptors that translate this concept descriptor into other code systems.

Control0..*
BindingFor example codes, see Vaccine Clinical Drug
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
Requirements

This code MAY contain zero or more [0..*] translation, which MAY be selected from ValueSet Vaccine Clinical Drug urn:oid:2.16.840.1.113762.1.4.1010.8 DYNAMIC (CONF:1098-31543).

31. ManufacturedProduct.manufacturedMaterial.code.translation:specificVaccine
SliceNamespecificVaccine
Definition

A set of other concept descriptors that translate this concept descriptor into other code systems.

Control0..*
BindingFor example codes, see VSAC 2.16.840.1.113762.1.4.1010.10
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
Requirements

This code MAY contain zero or more [0..*] translation (CONF:1098-31881).

32. ManufacturedProduct.manufacturedMaterial.name
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/EN
33. ManufacturedProduct.manufacturedMaterial.lotNumberText
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ST
Requirements

This manufacturedMaterial SHOULD contain zero or one [0..1] lotNumberText (CONF:1098-9014).

34. ManufacturedProduct.manufacturerOrganization
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organization
Requirements

SHOULD contain zero or one [0..1] manufacturerOrganization (CONF:1098-9012).