Consolidated CDA (C-CDA)
4.0.0 - STU4 United States of America flag

This page is part of the CCDA: Consolidated CDA Release (v4.0.0: CCDA 4.0) generated with FHIR (HL7® FHIR® Standard) v5.0.0. This is the current published version. For a full list of available versions, see the Directory of published versions

Logical Model: Immunizations Section

Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/ImmunizationsSection Version: 4.0.0
Draft as of 2025-06-20 Computable Name: ImmunizationsSection
Other Identifiers: urn:ietf:rfc:3986#Uniform Resource Identifier (URI)#urn:hl7ii:2.16.840.1.113883.10.20.22.2.2.1:2015-08-01

The Immunizations Section defines a patient's current immunization status and pertinent immunization history. The primary use case for the Immunization Section is to enable communication of a patient's immunization status. The section should include current immunization status, and may contain the entire immunization history that is relevant to the period of time being summarized.

Templates Used

Although open templates may contain any valid CDA content, the following templates are specifically called out by this template:

Required Entries: ImmunizationActivity

Usages:

Changes since version 3.0.0:

  • The resource metadata has changed (description)

    • Formal Views of Template Content

    Description of Template, Differentials, Snapshots and how the different presentations work.

    This structure is derived from Section

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Section C 1..1 Section XML Namespace: urn:hl7-org:v3
    Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @ID, @classCode, @moodCode, id, code, title, text, confidentialityCode, languageCode, subject, author, informant, entry, component
    Base for all types and resources
    Instance of this type are validated by templateId
    Logical Container: ClinicalDocument (CDA Class)
    Constraints: shall-immunization-activity
    ... @nullFlavor 0..1 cs If a required section contains no information, the @nullFlavor MAY be set to NI
    ... Slices for templateId 1..* II Slice: Unordered, Open by value:root, value:extension
    .... templateId:section 1..1 II
    ..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.2.2.1
    ..... @extension 1..1 st Required Pattern: 2015-08-01
    ... code 1..1 CE History of Immunization Narrative
    .... @code 1..1 cs Required Pattern: 11369-6
    .... @codeSystem 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.6.1
    ... text 1..1 xhtml
    ... Slices for entry 0..* Entry If section/@nullFlavor is not present...
    Slice: Unordered, Open by profile:substanceAdministration
    .... entry:activity 0..* Entry 𝗨𝗦𝗖𝗗𝗜: Immunizations
    ..... substanceAdministration 1..1 ImmunizationActivity

    doco Documentation for this format

    Constraints

    IdGradePath(s)DetailsRequirements
    shall-immunization-activityerrorSectionIf section/@nullFlavor is not present, SHALL contain at least one Immunization Activity
    : nullFlavor.exists() or entry.where(substanceAdministration.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/ImmunizationActivity')).exists()
    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Section C 1..1 Section XML Namespace: urn:hl7-org:v3
    Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @ID, @classCode, @moodCode, id, code, title, text, confidentialityCode, languageCode, subject, author, informant, entry, component
    Base for all types and resources
    Instance of this type are validated by templateId
    Logical Container: ClinicalDocument (CDA Class)
    Constraints: shall-immunization-activity
    ... @nullFlavor 0..1 cs If a required section contains no information, the @nullFlavor MAY be set to NI
    Binding: CDANullFlavor (required)
    ... realmCode 0..* CS
    ... typeId C 0..1 II Constraints: II-1
    .... @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:section 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.2.2.1
    ..... @extension 1..1 st Required Pattern: 2015-08-01
    ... @ID 0..1 xs:ID
    ... @classCode 0..1 cs Binding: ActClassRecordOrganizer (required)
    Fixed Value: DOCSECT
    ... @moodCode 0..1 cs Binding: CDAActMood (required)
    Fixed Value: EVN
    ... id 0..1 II
    ... code 1..1 CE History of Immunization Narrative
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... @code 1..1 cs Required Pattern: 11369-6
    .... @codeSystem 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.6.1
    .... @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
    ... title 1..1 ST
    ... text 1..1 xhtml
    ... confidentialityCode 0..1 CE
    ... languageCode 0..1 CS Binding: AllLanguages (required)
    ... subject 0..1 Subject
    ... author 0..* Author
    ... informant 0..* Informant
    ... Slices for entry 0..* Entry If section/@nullFlavor is not present...
    Slice: Unordered, Open by profile:substanceAdministration
    .... entry:activity 0..* Entry 𝗨𝗦𝗖𝗗𝗜: Immunizations
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @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
    ..... @typeCode 0..1 cs Binding: x_ActRelationshipEntry (required)
    ..... @contextConductionInd 0..1 bl Fixed Value: true
    ..... act 0..1 Act
    ..... encounter 0..1 Encounter
    ..... observation 0..1 Observation
    ..... observationMedia 0..1 ObservationMedia
    ..... organizer 0..1 Organizer
    ..... procedure 0..1 Procedure
    ..... regionOfInterest 0..1 RegionOfInterest
    ..... substanceAdministration 1..1 ImmunizationActivity
    ..... supply 0..1 Supply
    ... component 0..* InfrastructureRoot
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... realmCode 0..* CS
    .... typeId C 0..1 II Constraints: II-1
    ..... @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
    .... @typeCode 0..1 cs Fixed Value: COMP
    .... @contextConductionInd 0..1 bl Fixed Value: true
    .... section 1..1 Section

    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSet / CodeURI
    Section.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Section.typeId.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Section.templateId:section.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Section.classCoderequiredFixed Value: DOCSECT
    http://terminology.hl7.org/ValueSet/v3-ActClassRecordOrganizer
    Section.moodCoderequiredFixed Value: EVN
    http://hl7.org/cda/stds/core/ValueSet/CDAActMood
    Section.code.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Section.languageCoderequiredAllLanguages
    http://hl7.org/fhir/ValueSet/all-languages
    From the FHIR Standard
    Section.entry:activity.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Section.entry:activity.typeId.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Section.entry:activity.typeCoderequiredXActRelationshipEntry
    http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntry
    Section.component.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Section.component.typeId.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor

    Constraints

    IdGradePath(s)DetailsRequirements
    II-1errorSection.typeId, Section.entry:activity.typeId, Section.component.typeIdAn II instance must have either a root or an nullFlavor.
    : root.exists() or nullFlavor.exists()
    shall-immunization-activityerrorSectionIf section/@nullFlavor is not present, SHALL contain at least one Immunization Activity
    : nullFlavor.exists() or entry.where(substanceAdministration.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/ImmunizationActivity')).exists()
    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Section C 1..1 Section XML Namespace: urn:hl7-org:v3
    Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @ID, @classCode, @moodCode, id, code, title, text, confidentialityCode, languageCode, subject, author, informant, entry, component
    Base for all types and resources
    Instance of this type are validated by templateId
    Logical Container: ClinicalDocument (CDA Class)
    Constraints: shall-immunization-activity
    ... @nullFlavor 0..1 cs If a required section contains no information, the @nullFlavor MAY be set to NI
    Binding: CDANullFlavor (required)
    ... realmCode 0..* CS
    ... typeId C 0..1 II Constraints: II-1
    .... @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:section 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.2.2.1
    ..... @extension 1..1 st Required Pattern: 2015-08-01
    ... @ID 0..1 xs:ID
    ... @classCode 0..1 cs Binding: ActClassRecordOrganizer (required)
    Fixed Value: DOCSECT
    ... @moodCode 0..1 cs Binding: CDAActMood (required)
    Fixed Value: EVN
    ... id 0..1 II
    ... code 1..1 CE History of Immunization Narrative
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... @code 1..1 cs Required Pattern: 11369-6
    .... @codeSystem 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.6.1
    .... @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
    ... title 1..1 ST
    ... text 1..1 xhtml
    ... confidentialityCode 0..1 CE
    ... languageCode 0..1 CS Binding: AllLanguages (required)
    ... subject 0..1 Subject
    ... author 0..* Author
    ... informant 0..* Informant
    ... Slices for entry 0..* Entry If section/@nullFlavor is not present...
    Slice: Unordered, Open by profile:substanceAdministration
    .... entry:activity 0..* Entry 𝗨𝗦𝗖𝗗𝗜: Immunizations
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @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
    ..... @typeCode 0..1 cs Binding: x_ActRelationshipEntry (required)
    ..... @contextConductionInd 0..1 bl Fixed Value: true
    ..... act 0..1 Act
    ..... encounter 0..1 Encounter
    ..... observation 0..1 Observation
    ..... observationMedia 0..1 ObservationMedia
    ..... organizer 0..1 Organizer
    ..... procedure 0..1 Procedure
    ..... regionOfInterest 0..1 RegionOfInterest
    ..... substanceAdministration 1..1 ImmunizationActivity
    ..... supply 0..1 Supply
    ... component 0..* InfrastructureRoot
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... realmCode 0..* CS
    .... typeId C 0..1 II Constraints: II-1
    ..... @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
    .... @typeCode 0..1 cs Fixed Value: COMP
    .... @contextConductionInd 0..1 bl Fixed Value: true
    .... section 1..1 Section

    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSet / CodeURI
    Section.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Section.typeId.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Section.templateId:section.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Section.classCoderequiredFixed Value: DOCSECT
    http://terminology.hl7.org/ValueSet/v3-ActClassRecordOrganizer
    Section.moodCoderequiredFixed Value: EVN
    http://hl7.org/cda/stds/core/ValueSet/CDAActMood
    Section.code.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Section.languageCoderequiredAllLanguages
    http://hl7.org/fhir/ValueSet/all-languages
    From the FHIR Standard
    Section.entry:activity.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Section.entry:activity.typeId.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Section.entry:activity.typeCoderequiredXActRelationshipEntry
    http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntry
    Section.component.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Section.component.typeId.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor

    Constraints

    IdGradePath(s)DetailsRequirements
    II-1errorSection.typeId, Section.entry:activity.typeId, Section.component.typeIdAn II instance must have either a root or an nullFlavor.
    : root.exists() or nullFlavor.exists()
    shall-immunization-activityerrorSectionIf section/@nullFlavor is not present, SHALL contain at least one Immunization Activity
    : nullFlavor.exists() or entry.where(substanceAdministration.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/ImmunizationActivity')).exists()

    This structure is derived from Section

    Summary

    Mandatory: 9 elements(1 nested mandatory element)

    Structures

    This structure refers to these other structures:

    Slices

    This structure defines the following Slices:

    • The element 2 is sliced based on the values of Section.templateId
    • The element 1 is sliced based on the value of Section.entry

    Differential View

    This structure is derived from Section

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Section C 1..1 Section XML Namespace: urn:hl7-org:v3
    Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @ID, @classCode, @moodCode, id, code, title, text, confidentialityCode, languageCode, subject, author, informant, entry, component
    Base for all types and resources
    Instance of this type are validated by templateId
    Logical Container: ClinicalDocument (CDA Class)
    Constraints: shall-immunization-activity
    ... @nullFlavor 0..1 cs If a required section contains no information, the @nullFlavor MAY be set to NI
    ... Slices for templateId 1..* II Slice: Unordered, Open by value:root, value:extension
    .... templateId:section 1..1 II
    ..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.2.2.1
    ..... @extension 1..1 st Required Pattern: 2015-08-01
    ... code 1..1 CE History of Immunization Narrative
    .... @code 1..1 cs Required Pattern: 11369-6
    .... @codeSystem 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.6.1
    ... text 1..1 xhtml
    ... Slices for entry 0..* Entry If section/@nullFlavor is not present...
    Slice: Unordered, Open by profile:substanceAdministration
    .... entry:activity 0..* Entry 𝗨𝗦𝗖𝗗𝗜: Immunizations
    ..... substanceAdministration 1..1 ImmunizationActivity

    doco Documentation for this format

    Constraints

    IdGradePath(s)DetailsRequirements
    shall-immunization-activityerrorSectionIf section/@nullFlavor is not present, SHALL contain at least one Immunization Activity
    : nullFlavor.exists() or entry.where(substanceAdministration.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/ImmunizationActivity')).exists()

    Key Elements View

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Section C 1..1 Section XML Namespace: urn:hl7-org:v3
    Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @ID, @classCode, @moodCode, id, code, title, text, confidentialityCode, languageCode, subject, author, informant, entry, component
    Base for all types and resources
    Instance of this type are validated by templateId
    Logical Container: ClinicalDocument (CDA Class)
    Constraints: shall-immunization-activity
    ... @nullFlavor 0..1 cs If a required section contains no information, the @nullFlavor MAY be set to NI
    Binding: CDANullFlavor (required)
    ... realmCode 0..* CS
    ... typeId C 0..1 II Constraints: II-1
    .... @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:section 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.2.2.1
    ..... @extension 1..1 st Required Pattern: 2015-08-01
    ... @ID 0..1 xs:ID
    ... @classCode 0..1 cs Binding: ActClassRecordOrganizer (required)
    Fixed Value: DOCSECT
    ... @moodCode 0..1 cs Binding: CDAActMood (required)
    Fixed Value: EVN
    ... id 0..1 II
    ... code 1..1 CE History of Immunization Narrative
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... @code 1..1 cs Required Pattern: 11369-6
    .... @codeSystem 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.6.1
    .... @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
    ... title 1..1 ST
    ... text 1..1 xhtml
    ... confidentialityCode 0..1 CE
    ... languageCode 0..1 CS Binding: AllLanguages (required)
    ... subject 0..1 Subject
    ... author 0..* Author
    ... informant 0..* Informant
    ... Slices for entry 0..* Entry If section/@nullFlavor is not present...
    Slice: Unordered, Open by profile:substanceAdministration
    .... entry:activity 0..* Entry 𝗨𝗦𝗖𝗗𝗜: Immunizations
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @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
    ..... @typeCode 0..1 cs Binding: x_ActRelationshipEntry (required)
    ..... @contextConductionInd 0..1 bl Fixed Value: true
    ..... act 0..1 Act
    ..... encounter 0..1 Encounter
    ..... observation 0..1 Observation
    ..... observationMedia 0..1 ObservationMedia
    ..... organizer 0..1 Organizer
    ..... procedure 0..1 Procedure
    ..... regionOfInterest 0..1 RegionOfInterest
    ..... substanceAdministration 1..1 ImmunizationActivity
    ..... supply 0..1 Supply
    ... component 0..* InfrastructureRoot
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... realmCode 0..* CS
    .... typeId C 0..1 II Constraints: II-1
    ..... @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
    .... @typeCode 0..1 cs Fixed Value: COMP
    .... @contextConductionInd 0..1 bl Fixed Value: true
    .... section 1..1 Section

    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSet / CodeURI
    Section.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Section.typeId.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Section.templateId:section.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Section.classCoderequiredFixed Value: DOCSECT
    http://terminology.hl7.org/ValueSet/v3-ActClassRecordOrganizer
    Section.moodCoderequiredFixed Value: EVN
    http://hl7.org/cda/stds/core/ValueSet/CDAActMood
    Section.code.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Section.languageCoderequiredAllLanguages
    http://hl7.org/fhir/ValueSet/all-languages
    From the FHIR Standard
    Section.entry:activity.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Section.entry:activity.typeId.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Section.entry:activity.typeCoderequiredXActRelationshipEntry
    http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntry
    Section.component.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Section.component.typeId.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor

    Constraints

    IdGradePath(s)DetailsRequirements
    II-1errorSection.typeId, Section.entry:activity.typeId, Section.component.typeIdAn II instance must have either a root or an nullFlavor.
    : root.exists() or nullFlavor.exists()
    shall-immunization-activityerrorSectionIf section/@nullFlavor is not present, SHALL contain at least one Immunization Activity
    : nullFlavor.exists() or entry.where(substanceAdministration.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/ImmunizationActivity')).exists()

    Snapshot View

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Section C 1..1 Section XML Namespace: urn:hl7-org:v3
    Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @ID, @classCode, @moodCode, id, code, title, text, confidentialityCode, languageCode, subject, author, informant, entry, component
    Base for all types and resources
    Instance of this type are validated by templateId
    Logical Container: ClinicalDocument (CDA Class)
    Constraints: shall-immunization-activity
    ... @nullFlavor 0..1 cs If a required section contains no information, the @nullFlavor MAY be set to NI
    Binding: CDANullFlavor (required)
    ... realmCode 0..* CS
    ... typeId C 0..1 II Constraints: II-1
    .... @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:section 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.2.2.1
    ..... @extension 1..1 st Required Pattern: 2015-08-01
    ... @ID 0..1 xs:ID
    ... @classCode 0..1 cs Binding: ActClassRecordOrganizer (required)
    Fixed Value: DOCSECT
    ... @moodCode 0..1 cs Binding: CDAActMood (required)
    Fixed Value: EVN
    ... id 0..1 II
    ... code 1..1 CE History of Immunization Narrative
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... @code 1..1 cs Required Pattern: 11369-6
    .... @codeSystem 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.6.1
    .... @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
    ... title 1..1 ST
    ... text 1..1 xhtml
    ... confidentialityCode 0..1 CE
    ... languageCode 0..1 CS Binding: AllLanguages (required)
    ... subject 0..1 Subject
    ... author 0..* Author
    ... informant 0..* Informant
    ... Slices for entry 0..* Entry If section/@nullFlavor is not present...
    Slice: Unordered, Open by profile:substanceAdministration
    .... entry:activity 0..* Entry 𝗨𝗦𝗖𝗗𝗜: Immunizations
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @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
    ..... @typeCode 0..1 cs Binding: x_ActRelationshipEntry (required)
    ..... @contextConductionInd 0..1 bl Fixed Value: true
    ..... act 0..1 Act
    ..... encounter 0..1 Encounter
    ..... observation 0..1 Observation
    ..... observationMedia 0..1 ObservationMedia
    ..... organizer 0..1 Organizer
    ..... procedure 0..1 Procedure
    ..... regionOfInterest 0..1 RegionOfInterest
    ..... substanceAdministration 1..1 ImmunizationActivity
    ..... supply 0..1 Supply
    ... component 0..* InfrastructureRoot
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... realmCode 0..* CS
    .... typeId C 0..1 II Constraints: II-1
    ..... @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
    .... @typeCode 0..1 cs Fixed Value: COMP
    .... @contextConductionInd 0..1 bl Fixed Value: true
    .... section 1..1 Section

    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSet / CodeURI
    Section.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Section.typeId.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Section.templateId:section.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Section.classCoderequiredFixed Value: DOCSECT
    http://terminology.hl7.org/ValueSet/v3-ActClassRecordOrganizer
    Section.moodCoderequiredFixed Value: EVN
    http://hl7.org/cda/stds/core/ValueSet/CDAActMood
    Section.code.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Section.languageCoderequiredAllLanguages
    http://hl7.org/fhir/ValueSet/all-languages
    From the FHIR Standard
    Section.entry:activity.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Section.entry:activity.typeId.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Section.entry:activity.typeCoderequiredXActRelationshipEntry
    http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntry
    Section.component.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Section.component.typeId.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor

    Constraints

    IdGradePath(s)DetailsRequirements
    II-1errorSection.typeId, Section.entry:activity.typeId, Section.component.typeIdAn II instance must have either a root or an nullFlavor.
    : root.exists() or nullFlavor.exists()
    shall-immunization-activityerrorSectionIf section/@nullFlavor is not present, SHALL contain at least one Immunization Activity
    : nullFlavor.exists() or entry.where(substanceAdministration.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/ImmunizationActivity')).exists()

    This structure is derived from Section

    Summary

    Mandatory: 9 elements(1 nested mandatory element)

    Structures

    This structure refers to these other structures:

    Slices

    This structure defines the following Slices:

    • The element 2 is sliced based on the values of Section.templateId
    • The element 1 is sliced based on the value of Section.entry

     

    Other representations of profile: CSV, Excel