Profile Comparison between http://hl7.org/cda/us/ccda/StructureDefinition/ImmunizationActivity vs http://hl7.org/cda/us/ccda/StructureDefinition/ImmunizationActivity

Left:Immunization Activity (http://hl7.org/cda/us/ccda/StructureDefinition/ImmunizationActivity)
Right:Immunization Activity (http://hl7.org/cda/us/ccda/StructureDefinition/ImmunizationActivity)

Messages

InformationSubstanceAdministration.typeIdStructureDefinition ImmunizationActivity has added constraint that is not found in ImmunizationActivity and it is uncertain whether they are compatible (root.exists() or nullFlavor.exists())
InformationSubstanceAdministration.doseQuantity.unitExample/preferred bindings differ at SubstanceAdministration.doseQuantity.unit using binding from ImmunizationActivity
InformationSubstanceAdministration.consumable.typeIdStructureDefinition ImmunizationActivity has added constraint that is not found in ImmunizationActivity and it is uncertain whether they are compatible (root.exists() or nullFlavor.exists())
InformationSubstanceAdministration.consumable.manufacturedProductStructureDefinition ImmunizationActivity has a constraint that is removed in ImmunizationActivity and it is uncertain whether they are compatible ((manufacturedLabeledDrug | manufacturedMaterial).count() = 1)
InformationSubstanceAdministration.consumable.manufacturedProductStructureDefinition ImmunizationActivity has a constraint that is removed in ImmunizationActivity and it is uncertain whether they are compatible (manufacturerOrganization.exists())

Metadata

NameValueComments
.abstractfalse
    .baseDefinitionhttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
      .copyright
        .descriptionAn Immunization Activity describes immunization substance administrations that have actually occurred or are intended to occur. Immunization Activities in "INT" mood are reflections of immunizations a clinician intends a patient to receive. Immunization Activities in "EVN" mood reflect immunizations actually received. An Immunization Activity is very similar to a Medication Activity with some key differentiators. The drug code system is constrained to CVX codes. Administration timing is less complex. Patient refusal reasons should be captured. All vaccines administered should be fully documented in the patient's permanent medical record. Healthcare providers who administer vaccines covered by the National Childhood Vaccine Injury Act are required to ensure that the permanent medical record of the recipient indicates: 1. Date of administration 2. Vaccine manufacturer 3. Vaccine lot number 4. Name and title of the person who administered the vaccine and the address of the clinic or facility where the permanent record will reside 5. Vaccine information statement (VIS) a. Date printed on the VIS b. Date VIS given to patient or parent/guardian. This information should be included in an Immunization Activity when available. (Reference: [https://www.cdc.gov/vaccines/pubs/pinkbook/downloads/appendices/c/vis-instruct.pdf])An Immunization Activity describes immunization substance administrations that have actually occurred or are intended to occur. Immunization Activities in "INT" mood are reflections of immunizations a clinician intends a patient to receive. Immunization Activities in "EVN" mood reflect immunizations actually received. An Immunization Activity is very similar to a Medication Activity with some key differentiators. The drug code system is constrained to CVX codes. Administration timing is less complex. Patient refusal reasons should be captured. All vaccines administered should be fully documented in the patient's permanent medical record. Healthcare providers who administer vaccines covered by the National Childhood Vaccine Injury Act are required to ensure that the permanent medical record of the recipient indicates: 1. Date of administration 2. Vaccine manufacturer 3. Vaccine lot number 4. Name and title of the person who administered the vaccine and the address of the clinic or facility where the permanent record will reside 5. Vaccine information statement (VIS) 1. Date printed on the VIS 2. Date VIS given to patient or parent/guardian. This information should be included in an Immunization Activity when available. Reference: [CDC Instructions](https://www.cdc.gov/vaccines/pubs/pinkbook/downloads/appendices/c/vis-instruct.pdf) #### Templates Used Although open templates may contain any valid CDA content, the following templates are specifically called out by this template: **Optional EntryRelationships**: [ImmunizationNotGivenReason](StructureDefinition-ImmunizationNotGivenReason.html), [Indication](StructureDefinition-Indication.html), [InstructionObservation](StructureDefinition-InstructionObservation.html), [MedicationDispense](StructureDefinition-MedicationDispense.html), [MedicationSupplyOrder](StructureDefinition-MedicationSupplyOrder.html), [ReactionObservation](StructureDefinition-ReactionObservation.html), [SubstanceAdministeredAct](StructureDefinition-SubstanceAdministeredAct.html)
        • Values Differ
        .experimental
          .fhirVersion5.0.0
            .jurisdiction
              ..jurisdiction[0]urn:iso:std:iso:3166#US
                .kindlogical
                  .nameImmunizationActivity
                    .publisherHealth Level Seven
                      .purpose
                        .statusdraft
                          .titleImmunization Activity
                            .typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
                              .urlhttp://hl7.org/cda/us/ccda/StructureDefinition/ImmunizationActivity

                                Structure

                                NameL FlagsL Card.L TypeL Description & ConstraintsR FlagsR Card.R TypeR Description & ConstraintsCommentsdoco
                                .. SubstanceAdministration C1..1SubstanceAdministrationBase for all types and resources
                                Instance of this type are validated by templateId
                                Logical Container: ClinicalDocument (CDA Class)
                                Constraints: should-text-ref-value, should-doseQuantity, dose-unit-or-admin-unit, should-performer, should-author
                                		C1..1SubstanceAdministrationBase for all types and resources
                                Instance of this type are validated by templateId
                                Logical Container: ClinicalDocument (CDA Class)
                                Constraints: should-text-ref-value, should-doseQuantity, dose-unit-or-admin-unit, should-performer, should-author
                                  ... nullFlavor 0..1??Binding: ?? (required)0..1??Binding: ?? (required)
                                    ... realmCode 0..*CS0..*CS
                                      ... typeId 0..1IIC0..1II
                                      • StructureDefinition ImmunizationActivity has added constraint that is not found in ImmunizationActivity and it is uncertain whether they are compatible (root.exists() or nullFlavor.exists())
                                      .... nullFlavor 0..1??Binding: ?? (required)0..1??Binding: ?? (required)
                                        .... assigningAuthorityName 0..1??0..1??
                                          .... displayable 0..1??0..1??
                                            .... root 1..1??, ??, ??Fixed Value: 2.16.840.1.113883.1.31..1??, ??, ??Fixed Value: 2.16.840.1.113883.1.3
                                              .... extension 1..1stringPrimitive Type string
                                              URL: http://hl7.org/cda/stds/core/StructureDefinition/st-simple                                              		1..1stringPrimitive Type string
                                              URL: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
                                                ... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
                                                		1..*IISlice: Unordered, Open by value:root, value:extension
                                                  ... classCode 1..1??Binding: ?? (required)
                                                  Fixed Value: SBADM                                                  		1..1??Binding: ?? (required)
                                                  Fixed Value: SBADM
                                                    ... moodCode 1..1??Binding: ?? (required)1..1??Binding: ?? (required)
                                                      ... id 1..*II1..*II
                                                        ... code 0..1CDSubstanceAdministration.code is an optional field. Per HL7 Pharmacy Committee, "this is intended to further specify the nature of the substance administration act. To date the committee has made no use of this attribute". Because the type of substance administration is generally implicit in the routeCode, in the consumable participant, etc., the field is generally not used and there is no defined value set.
                                                        Binding: ?? (example)                                                        		0..1CDSubstanceAdministration.code is an optional field. Per HL7 Pharmacy Committee, "this is intended to further specify the nature of the substance administration act. To date the committee has made no use of this attribute". Because the type of substance administration is generally implicit in the routeCode, in the consumable participant, etc., the field is generally not used and there is no defined value set.
                                                        Binding: ?? (example)
                                                          ... negationInd 1..1??Use negationInd="true" to indicate that the immunization was not given.1..1??Use negationInd="true" to indicate that the immunization was not given.
                                                            ... text 0..1EDSHOULD reference the portion of section narrative text corresponding to this entry0..1EDSHOULD reference the portion of section narrative text corresponding to this entry
                                                              .... nullFlavor 0..1??Binding: ?? (required)0..1??Binding: ?? (required)
                                                                .... compression 0..1??Binding: ?? (required)0..1??Binding: ?? (required)
                                                                  .... integrityCheck 0..1??0..1??
                                                                    .... integrityCheckAlgorithm 0..1??Binding: ?? (required)0..1??Binding: ?? (required)
                                                                      .... language 0..1??0..1??
                                                                        .... mediaType 0..1??Binding: ?? (example)0..1??Binding: ?? (example)
                                                                          .... representation 0..1??Binding: ?? (required)0..1??Binding: ?? (required)
                                                                            .... xmlText 0..1??Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string.0..1??Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string.
                                                                              .... reference C0..1TELConstraints: value-starts-octothorpeC0..1TELConstraints: value-starts-octothorpe
                                                                                .... thumbnail 0..1ED0..1ED
                                                                                  ... statusCode 1..1CSBinding: ?? (required)1..1CSBinding: ?? (required)
                                                                                    .... nullFlavor 0..00..0
                                                                                      .... code 1..1??Binding: ?? (required)1..1??Binding: ?? (required)
                                                                                        .... codeSystem 0..00..0
                                                                                          .... codeSystemName 0..00..0
                                                                                            .... codeSystemVersion 0..00..0
                                                                                              .... displayName 0..00..0
                                                                                                .... sdtcValueSet 0..1??XML: valueSet (urn:hl7-org:sdtc)0..1??XML: valueSet (urn:hl7-org:sdtc)
                                                                                                  .... sdtcValueSetVersion 0..1??XML: valueSetVersion (urn:hl7-org:sdtc)0..1??XML: valueSetVersion (urn:hl7-org:sdtc)
                                                                                                    .... originalText 0..00..0
                                                                                                      .... qualifier 0..00..0
                                                                                                        .... translation 0..00..0
                                                                                                          ... effectiveTime 1..1SXCM_TS, IVL_TS, EIVL_TS, PIVL_TS, SXPR_TS1..1SXCM_TS, IVL_TS, EIVL_TS, PIVL_TS, SXPR_TS
                                                                                                            ... priorityCode 0..1CEBinding: ?? (example)0..1CEBinding: ?? (example)
                                                                                                              ... repeatNumber C0..1IVL_INTIn "INT" (intent) mood, the repeatNumber defines the number of allowed administrations. For example, a repeatNumber of "3" means that the substance can be administered up to 3 times. In "EVN" (event) mood, the repeatNumber is the number of occurrences. For example, a repeatNumber of "3" in a substance administration event means that the current administration is the 3rd in a series.
                                                                                                              Constraints: value-only                                                                                                              		C0..1IVL_INTIn "INT" (intent) mood, the repeatNumber defines the number of allowed administrations. For example, a repeatNumber of "3" means that the substance can be administered up to 3 times. In "EVN" (event) mood, the repeatNumber is the number of occurrences. For example, a repeatNumber of "3" in a substance administration event means that the current administration is the 3rd in a series.
                                                                                                              Constraints: value-only
                                                                                                                .... nullFlavor 0..1??Binding: ?? (required)0..1??Binding: ?? (required)
                                                                                                                  .... value 0..1??value should be used instead of low/high0..1??value should be used instead of low/high
                                                                                                                    .... operator 0..1??Binding: ?? (required)0..1??Binding: ?? (required)
                                                                                                                      .... low 0..1IVXB_INT0..1IVXB_INT
                                                                                                                        .... center 0..1INT0..1INT
                                                                                                                          .... width 0..1INT0..1INT
                                                                                                                            .... high 0..1IVXB_INT0..1IVXB_INT
                                                                                                                              ... routeCode C0..1CEBinding: ?? (required)
                                                                                                                              Constraints: should-translation                                                                                                                              		C0..1CEBinding: ?? (required)
                                                                                                                              Constraints: should-translation
                                                                                                                                .... nullFlavor 0..1??Binding: ?? (required)0..1??Binding: ?? (required)
                                                                                                                                  .... code 0..1??0..1??
                                                                                                                                    .... codeSystem 0..1??, ??, ??0..1??, ??, ??
                                                                                                                                      .... codeSystemName 0..1??0..1??
                                                                                                                                        .... codeSystemVersion 0..1??0..1??
                                                                                                                                          .... displayName 0..1??0..1??
                                                                                                                                            .... sdtcValueSet 0..1??XML: valueSet (urn:hl7-org:sdtc)0..1??XML: valueSet (urn:hl7-org:sdtc)
                                                                                                                                              .... sdtcValueSetVersion 0..1??XML: valueSetVersion (urn:hl7-org:sdtc)0..1??XML: valueSetVersion (urn:hl7-org:sdtc)
                                                                                                                                                .... originalText 0..1ED0..1ED
                                                                                                                                                  .... qualifier 0..00..0
                                                                                                                                                    .... translation 0..*CDBinding: ?? (preferred)
                                                                                                                                                    		0..*CDBinding: ?? (preferred)
                                                                                                                                                      ... approachSiteCode 0..1CDBinding: ?? (required)
                                                                                                                                                      		0..1CDBinding: ?? (required)
                                                                                                                                                        ... doseQuantity C0..1IVL_PQConstraints: should-unitC0..1IVL_PQConstraints: should-unit
                                                                                                                                                          .... nullFlavor 0..1??Binding: ?? (required)0..1??Binding: ?? (required)
                                                                                                                                                            .... unit 0..1??NOTE: The base CDA R2.0 standard requires @unit to be drawn from UCUM, and best practice is to use case sensitive UCUM units
                                                                                                                                                            Binding: ?? (preferred)                                                                                                                                                            		0..1??NOTE: The base CDA R2.0 standard requires @unit to be drawn from UCUM, and best practice is to use case sensitive UCUM units
                                                                                                                                                            Binding: ?? (preferred)
                                                                                                                                                            • Example/preferred bindings differ at SubstanceAdministration.doseQuantity.unit using binding from ImmunizationActivity
                                                                                                                                                            .... value 0..1??0..1??
                                                                                                                                                              .... translation 0..*PQR0..*PQR
                                                                                                                                                                .... operator 0..1??Binding: ?? (required)0..1??Binding: ?? (required)
                                                                                                                                                                  .... low 0..1IVXB_PQ0..1IVXB_PQ
                                                                                                                                                                    .... center 0..1PQ0..1PQ
                                                                                                                                                                      .... width 0..1PQ0..1PQ
                                                                                                                                                                        .... high 0..1IVXB_PQ0..1IVXB_PQ
                                                                                                                                                                          ... rateQuantity 0..1IVL_PQ0..1IVL_PQ
                                                                                                                                                                            ... maxDoseQuantity 0..1RTO_PQ_PQ0..1RTO_PQ_PQ
                                                                                                                                                                              ... administrationUnitCode 0..1CEBinding: ?? (required)0..1CEBinding: ?? (required)
                                                                                                                                                                                ... consumable 1..1InfrastructureRoot1..1InfrastructureRoot
                                                                                                                                                                                  .... nullFlavor 0..1??Binding: ?? (required)0..1??Binding: ?? (required)
                                                                                                                                                                                    .... realmCode 0..*CS0..*CS
                                                                                                                                                                                      .... typeId 0..1IIC0..1II
                                                                                                                                                                                      • StructureDefinition ImmunizationActivity has added constraint that is not found in ImmunizationActivity and it is uncertain whether they are compatible (root.exists() or nullFlavor.exists())
                                                                                                                                                                                      ..... nullFlavor 0..1??Binding: ?? (required)0..1??Binding: ?? (required)
                                                                                                                                                                                        ..... assigningAuthorityName 0..1??0..1??
                                                                                                                                                                                          ..... displayable 0..1??0..1??
                                                                                                                                                                                            ..... root 1..1??, ??, ??Fixed Value: 2.16.840.1.113883.1.31..1??, ??, ??Fixed Value: 2.16.840.1.113883.1.3
                                                                                                                                                                                              ..... extension 1..1stringPrimitive Type string
                                                                                                                                                                                              URL: http://hl7.org/cda/stds/core/StructureDefinition/st-simple                                                                                                                                                                                              		1..1stringPrimitive Type string
                                                                                                                                                                                              URL: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
                                                                                                                                                                                                .... templateId 0..*II0..*II
                                                                                                                                                                                                  .... typeCode 0..1??Binding: ?? (required)
                                                                                                                                                                                                  Fixed Value: CSM                                                                                                                                                                                                  		0..1??Binding: ?? (required)
                                                                                                                                                                                                  Fixed Value: CSM
                                                                                                                                                                                                    .... manufacturedProduct C1..1??Base for all types and resources1..1??
                                                                                                                                                                                                    • StructureDefinition ImmunizationActivity has a constraint that is removed in ImmunizationActivity and it is uncertain whether they are compatible ((manufacturedLabeledDrug | manufacturedMaterial).count() = 1)
                                                                                                                                                                                                    • StructureDefinition ImmunizationActivity has a constraint that is removed in ImmunizationActivity and it is uncertain whether they are compatible (manufacturerOrganization.exists())
                                                                                                                                                                                                    ... subject 0..1Subject0..1Subject
                                                                                                                                                                                                      ... specimen 0..*Specimen0..*Specimen
                                                                                                                                                                                                        ... performer 0..1Performer20..1Performer2
                                                                                                                                                                                                          ... author 0..*??Base for all types and resources
                                                                                                                                                                                                          		0..*??
                                                                                                                                                                                                            ... informant 0..*Informant0..*Informant
                                                                                                                                                                                                              ... Slices for participant 0..*Participant2Slice: Unordered, Open by value:typeCode
                                                                                                                                                                                                              		0..*Participant2Slice: Unordered, Open by value:typeCode
                                                                                                                                                                                                                ... Slices for entryRelationship 0..*EntryRelationshipSlice: Unordered, Open by profile:act, profile:observation, profile:supply
                                                                                                                                                                                                                		0..*EntryRelationshipSlice: Unordered, Open by profile:act, profile:observation, profile:supply
                                                                                                                                                                                                                  ... reference 0..*Reference0..*Reference
                                                                                                                                                                                                                    ... Slices for precondition 0..*PreconditionSlice: Unordered, Open by profile:criterion
                                                                                                                                                                                                                    		0..*PreconditionSlice: Unordered, Open by profile:criterion
                                                                                                                                                                                                                      ... sdtcInFulfillmentOf1 0..*InFulfillmentOf1XML: inFulfillmentOf1 (urn:hl7-org:sdtc)
                                                                                                                                                                                                                      		0..*InFulfillmentOf1XML: inFulfillmentOf1 (urn:hl7-org:sdtc)

                                                                                                                                                                                                                        doco Documentation for this format