{ "resourceType" : "StructureDefinition", "id" : "ImmunizationsSection", "text" : { "status" : "extensions", "div" : "

Generated Narrative: StructureDefinition ImmunizationsSection

\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
NameFlagsCard.TypeDescription & Constraints\"doco\"
\".\"\".\" Section C1..1SectionXML 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..1csIf a required section contains no information, the @nullFlavor MAY be set to NI
\".\"\".\"\".\" Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
\".\"\".\"\".\"\".\" templateId:section 1..1II
\".\"\".\"\".\"\".\"\".\" @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.2.2.1
\".\"\".\"\".\"\".\"\".\" @extension 1..1stRequired Pattern: 2015-08-01
\".\"\".\"\".\" code 1..1CEHistory of Immunization Narrative
\".\"\".\"\".\"\".\" @code 1..1csRequired Pattern: 11369-6
\".\"\".\"\".\"\".\" @codeSystem 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.6.1
\".\"\".\"\".\" title 1..1ST
\".\"\".\"\".\" text 1..1xhtml
\".\"\".\"\".\" Slices for entry 0..*EntryIf section/@nullFlavor is not present...
Slice: Unordered, Open by profile:substanceAdministration
\".\"\".\"\".\"\".\" entry:activity 0..*Entry𝗨𝗦𝗖𝗗𝗜: Immunizations
\".\"\".\"\".\"\".\"\".\" substanceAdministration 1..1ImmunizationActivity

\"doco\" Documentation for this format
" }, "extension" : [{ "url" : "http://hl7.org/fhir/tools/StructureDefinition/logical-target", "_valueBoolean" : { "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/data-absent-reason", "valueCode" : "not-applicable" }] } }, { "url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace", "valueUri" : "urn:hl7-org:v3" }, { "url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-name", "valueString" : "section" }, { "url" : "http://hl7.org/fhir/tools/StructureDefinition/logical-container", "valueUri" : "http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument" }, { "url" : "http://hl7.org/fhir/tools/StructureDefinition/type-profile-style", "valueCode" : "cda" }], "url" : "http://hl7.org/cda/us/ccda/StructureDefinition/ImmunizationsSection", "identifier" : [{ "system" : "urn:ietf:rfc:3986", "value" : "urn:hl7ii:2.16.840.1.113883.10.20.22.2.2.1:2015-08-01" }], "version" : "4.0.0", "name" : "ImmunizationsSection", "title" : "Immunizations Section", "status" : "draft", "date" : "2025-06-20T08:56:08+08:00", "publisher" : "Health Level Seven", "contact" : [{ "name" : "HL7 International - Structured Documents", "telecom" : [{ "system" : "url", "value" : "http://www.hl7.org/Special/committees/structure" }] }], "description" : "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.\n\n#### Templates Used\nAlthough open templates may contain any valid CDA content, the following templates are specifically called out by this template:\n\n**Required Entries**: [ImmunizationActivity](StructureDefinition-ImmunizationActivity.html)", "jurisdiction" : [{ "coding" : [{ "system" : "urn:iso:std:iso:3166", "code" : "US" }] }], "fhirVersion" : "5.0.0", "mapping" : [{ "identity" : "rim", "uri" : "http://hl7.org/v3", "name" : "RIM Mapping" }], "kind" : "logical", "abstract" : false, "type" : "http://hl7.org/cda/stds/core/StructureDefinition/Section", "baseDefinition" : "http://hl7.org/cda/stds/core/StructureDefinition/Section", "derivation" : "constraint", "snapshot" : { "extension" : [{ "url" : "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version", "valueString" : "2.0.1-sd" }], "element" : [{ "id" : "Section", "path" : "Section", "short" : "Base for all types and resources", "definition" : "Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.", "min" : 1, "max" : "1", "base" : { "path" : "Base", "min" : 0, "max" : "*" }, "constraint" : [{ "key" : "shall-immunization-activity", "severity" : "error", "human" : "If section/@nullFlavor is not present, SHALL contain at least one Immunization Activity", "expression" : "nullFlavor.exists() or entry.where(substanceAdministration.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/ImmunizationActivity')).exists()", "source" : "http://hl7.org/cda/us/ccda/StructureDefinition/ImmunizationsSection" }], "isModifier" : false, "mapping" : [{ "identity" : "rim", "map" : "n/a" }] }, { "id" : "Section.nullFlavor", "path" : "Section.nullFlavor", "representation" : ["xmlAttr"], "label" : "Exceptional Value Detail", "short" : "If a required section contains no information, the @nullFlavor MAY be set to NI", "definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.", "min" : 0, "max" : "1", "base" : { "path" : "ANY.nullFlavor", "min" : 0, "max" : "1" }, "type" : [{ "code" : "code", "profile" : ["http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"] }], "binding" : { "strength" : "required", "valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor" } }, { "id" : "Section.realmCode", "path" : "Section.realmCode", "definition" : "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question", "min" : 0, "max" : "*", "base" : { "path" : "InfrastructureRoot.realmCode", "min" : 0, "max" : "*" }, "type" : [{ "code" : "http://hl7.org/cda/stds/core/StructureDefinition/CS" }] }, { "id" : "Section.typeId", "path" : "Section.typeId", "definition" : "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.", "min" : 0, "max" : "1", "base" : { "path" : "InfrastructureRoot.typeId", "min" : 0, "max" : "1" }, "type" : [{ "code" : "http://hl7.org/cda/stds/core/StructureDefinition/II" }], "constraint" : [{ "key" : "II-1", "severity" : "error", "human" : "An II instance must have either a root or an nullFlavor.", "expression" : "root.exists() or nullFlavor.exists()", "source" : "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot" }] }, { "id" : "Section.typeId.nullFlavor", "path" : "Section.typeId.nullFlavor", "representation" : ["xmlAttr"], "label" : "Exceptional Value Detail", "definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.", "min" : 0, "max" : "1", "base" : { "path" : "ANY.nullFlavor", "min" : 0, "max" : "1" }, "type" : [{ "code" : "code", "profile" : ["http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"] }], "binding" : { "strength" : "required", "valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor" } }, { "id" : "Section.typeId.assigningAuthorityName", "path" : "Section.typeId.assigningAuthorityName", "representation" : ["xmlAttr"], "label" : "Assigning Authority Name", "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.", "min" : 0, "max" : "1", "base" : { "path" : "II.assigningAuthorityName", "min" : 0, "max" : "1" }, "type" : [{ "code" : "string", "profile" : ["http://hl7.org/cda/stds/core/StructureDefinition/st-simple"] }] }, { "id" : "Section.typeId.displayable", "path" : "Section.typeId.displayable", "representation" : ["xmlAttr"], "label" : "Displayable", "definition" : "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).", "min" : 0, "max" : "1", "base" : { "path" : "II.displayable", "min" : 0, "max" : "1" }, "type" : [{ "code" : "boolean", "profile" : ["http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"] }] }, { "id" : "Section.typeId.root", "path" : "Section.typeId.root", "representation" : ["xmlAttr"], "label" : "Root", "definition" : "Identifies the type as an HL7 Registered model", "min" : 1, "max" : "1", "base" : { "path" : "II.root", "min" : 0, "max" : "1" }, "type" : [{ "code" : "string", "profile" : ["http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid"] }], "fixedString" : "2.16.840.1.113883.1.3" }, { "id" : "Section.typeId.extension", "path" : "Section.typeId.extension", "representation" : ["xmlAttr"], "label" : "Extension", "definition" : "A character string as a unique identifier within the scope of the identifier root.", "min" : 1, "max" : "1", "base" : { "path" : "II.extension", "min" : 0, "max" : "1" }, "type" : [{ "code" : "string", "profile" : ["http://hl7.org/cda/stds/core/StructureDefinition/st-simple"] }] }, { "id" : "Section.templateId", "path" : "Section.templateId", "slicing" : { "discriminator" : [{ "type" : "value", "path" : "root" }, { "type" : "value", "path" : "extension" }], "rules" : "open" }, "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", "min" : 1, "max" : "*", "base" : { "path" : "InfrastructureRoot.templateId", "min" : 0, "max" : "*" }, "type" : [{ "code" : "http://hl7.org/cda/stds/core/StructureDefinition/II" }] }, { "id" : "Section.templateId:section", "path" : "Section.templateId", "sliceName" : "section", "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", "min" : 1, "max" : "1", "base" : { "path" : "InfrastructureRoot.templateId", "min" : 0, "max" : "*" }, "type" : [{ "code" : "http://hl7.org/cda/stds/core/StructureDefinition/II" }] }, { "id" : "Section.templateId:section.nullFlavor", "path" : "Section.templateId.nullFlavor", "representation" : ["xmlAttr"], "label" : "Exceptional Value Detail", "definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.", "min" : 0, "max" : "1", "base" : { "path" : "ANY.nullFlavor", "min" : 0, "max" : "1" }, "type" : [{ "code" : "code", "profile" : ["http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"] }], "binding" : { "strength" : "required", "valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor" } }, { "id" : "Section.templateId:section.assigningAuthorityName", "path" : "Section.templateId.assigningAuthorityName", "representation" : ["xmlAttr"], "label" : "Assigning Authority Name", "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.", "min" : 0, "max" : "1", "base" : { "path" : "II.assigningAuthorityName", "min" : 0, "max" : "1" }, "type" : [{ "code" : "string", "profile" : ["http://hl7.org/cda/stds/core/StructureDefinition/st-simple"] }] }, { "id" : "Section.templateId:section.displayable", "path" : "Section.templateId.displayable", "representation" : ["xmlAttr"], "label" : "Displayable", "definition" : "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).", "min" : 0, "max" : "1", "base" : { "path" : "II.displayable", "min" : 0, "max" : "1" }, "type" : [{ "code" : "boolean", "profile" : ["http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"] }] }, { "id" : "Section.templateId:section.root", "path" : "Section.templateId.root", "representation" : ["xmlAttr"], "label" : "Root", "definition" : "A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.", "min" : 1, "max" : "1", "base" : { "path" : "II.root", "min" : 0, "max" : "1" }, "type" : [{ "code" : "string", "profile" : ["http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid"] }], "patternString" : "2.16.840.1.113883.10.20.22.2.2.1" }, { "id" : "Section.templateId:section.extension", "path" : "Section.templateId.extension", "representation" : ["xmlAttr"], "label" : "Extension", "definition" : "A character string as a unique identifier within the scope of the identifier root.", "min" : 1, "max" : "1", "base" : { "path" : "II.extension", "min" : 0, "max" : "1" }, "type" : [{ "code" : "string", "profile" : ["http://hl7.org/cda/stds/core/StructureDefinition/st-simple"] }], "patternString" : "2015-08-01" }, { "id" : "Section.ID", "path" : "Section.ID", "representation" : ["xmlAttr"], "min" : 0, "max" : "1", "base" : { "path" : "Section.ID", "min" : 0, "max" : "1" }, "type" : [{ "code" : "id", "profile" : ["http://hl7.org/cda/stds/core/StructureDefinition/xs-ID"] }] }, { "id" : "Section.classCode", "path" : "Section.classCode", "representation" : ["xmlAttr"], "min" : 0, "max" : "1", "base" : { "path" : "Section.classCode", "min" : 0, "max" : "1" }, "type" : [{ "code" : "code", "profile" : ["http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"] }], "fixedCode" : "DOCSECT", "binding" : { "strength" : "required", "valueSet" : "http://terminology.hl7.org/ValueSet/v3-ActClassRecordOrganizer" } }, { "id" : "Section.moodCode", "path" : "Section.moodCode", "representation" : ["xmlAttr"], "min" : 0, "max" : "1", "base" : { "path" : "Section.moodCode", "min" : 0, "max" : "1" }, "type" : [{ "code" : "code", "profile" : ["http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"] }], "fixedCode" : "EVN", "binding" : { "strength" : "required", "valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDAActMood" } }, { "id" : "Section.id", "path" : "Section.id", "min" : 0, "max" : "1", "base" : { "path" : "Section.id", "min" : 0, "max" : "1" }, "type" : [{ "code" : "http://hl7.org/cda/stds/core/StructureDefinition/II" }] }, { "id" : "Section.code", "path" : "Section.code", "short" : "History of Immunization Narrative", "min" : 1, "max" : "1", "base" : { "path" : "Section.code", "min" : 0, "max" : "1" }, "type" : [{ "code" : "http://hl7.org/cda/stds/core/StructureDefinition/CE" }] }, { "id" : "Section.code.nullFlavor", "path" : "Section.code.nullFlavor", "representation" : ["xmlAttr"], "label" : "Exceptional Value Detail", "definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.", "min" : 0, "max" : "1", "base" : { "path" : "ANY.nullFlavor", "min" : 0, "max" : "1" }, "type" : [{ "code" : "code", "profile" : ["http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"] }], "binding" : { "strength" : "required", "valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor" } }, { "id" : "Section.code.code", "path" : "Section.code.code", "representation" : ["xmlAttr"], "label" : "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.", "min" : 1, "max" : "1", "base" : { "path" : "CD.code", "min" : 0, "max" : "1" }, "type" : [{ "code" : "code", "profile" : ["http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"] }], "patternCode" : "11369-6" }, { "id" : "Section.code.codeSystem", "path" : "Section.code.codeSystem", "representation" : ["xmlAttr"], "label" : "Code System", "definition" : "Specifies the code system that defines the code.", "min" : 1, "max" : "1", "base" : { "path" : "CD.codeSystem", "min" : 0, "max" : "1" }, "type" : [{ "code" : "string", "profile" : ["http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid"] }], "patternString" : "2.16.840.1.113883.6.1" }, { "id" : "Section.code.codeSystemName", "path" : "Section.code.codeSystemName", "representation" : ["xmlAttr"], "label" : "Code System Name", "definition" : "The common name of the coding system.", "min" : 0, "max" : "1", "base" : { "path" : "CD.codeSystemName", "min" : 0, "max" : "1" }, "type" : [{ "code" : "string", "profile" : ["http://hl7.org/cda/stds/core/StructureDefinition/st-simple"] }] }, { "id" : "Section.code.codeSystemVersion", "path" : "Section.code.codeSystemVersion", "representation" : ["xmlAttr"], "label" : "Code System Version", "definition" : "If applicable, a version descriptor defined specifically for the given code system.", "min" : 0, "max" : "1", "base" : { "path" : "CD.codeSystemVersion", "min" : 0, "max" : "1" }, "type" : [{ "code" : "string", "profile" : ["http://hl7.org/cda/stds/core/StructureDefinition/st-simple"] }] }, { "id" : "Section.code.displayName", "path" : "Section.code.displayName", "representation" : ["xmlAttr"], "label" : "Display Name", "definition" : "A name or title for the code, under which the sending system shows the code value to its users.", "min" : 0, "max" : "1", "base" : { "path" : "CD.displayName", "min" : 0, "max" : "1" }, "type" : [{ "code" : "string", "profile" : ["http://hl7.org/cda/stds/core/StructureDefinition/st-simple"] }] }, { "id" : "Section.code.sdtcValueSet", "extension" : [{ "url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace", "valueUri" : "urn:hl7-org:sdtc" }, { "url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-name", "valueString" : "valueSet" }], "path" : "Section.code.sdtcValueSet", "representation" : ["xmlAttr"], "definition" : "The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.", "min" : 0, "max" : "1", "base" : { "path" : "CD.valueSet", "min" : 0, "max" : "1" }, "type" : [{ "code" : "string", "profile" : ["http://hl7.org/cda/stds/core/StructureDefinition/oid"] }] }, { "id" : "Section.code.sdtcValueSetVersion", "extension" : [{ "url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace", "valueUri" : "urn:hl7-org:sdtc" }, { "url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-name", "valueString" : "valueSetVersion" }], "path" : "Section.code.sdtcValueSetVersion", "representation" : ["xmlAttr"], "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.", "min" : 0, "max" : "1", "base" : { "path" : "CD.sdtcValueSetVersion", "min" : 0, "max" : "1" }, "type" : [{ "code" : "string", "profile" : ["http://hl7.org/cda/stds/core/StructureDefinition/st-simple"] }] }, { "id" : "Section.code.originalText", "path" : "Section.code.originalText", "label" : "Original Text", "definition" : "The text or phrase used as the basis for the coding.", "min" : 0, "max" : "1", "base" : { "path" : "CD.originalText", "min" : 0, "max" : "1" }, "type" : [{ "code" : "http://hl7.org/cda/stds/core/StructureDefinition/ED" }] }, { "id" : "Section.code.qualifier", "path" : "Section.code.qualifier", "label" : "Qualifier", "definition" : "Specifies additional codes that increase the specificity of the the primary code.", "min" : 0, "max" : "0", "base" : { "path" : "CD.qualifier", "min" : 0, "max" : "*" }, "type" : [{ "code" : "http://hl7.org/cda/stds/core/StructureDefinition/CR" }] }, { "id" : "Section.code.translation", "path" : "Section.code.translation", "representation" : ["typeAttr"], "label" : "Translation", "definition" : "A set of other concept descriptors that translate this concept descriptor into other code systems.", "min" : 0, "max" : "*", "base" : { "path" : "CD.translation", "min" : 0, "max" : "*" }, "type" : [{ "code" : "http://hl7.org/cda/stds/core/StructureDefinition/CD" }] }, { "id" : "Section.title", "path" : "Section.title", "min" : 1, "max" : "1", "base" : { "path" : "Section.title", "min" : 0, "max" : "1" }, "type" : [{ "code" : "http://hl7.org/cda/stds/core/StructureDefinition/ST" }] }, { "id" : "Section.text", "path" : "Section.text", "representation" : ["cdaText"], "min" : 1, "max" : "1", "base" : { "path" : "Section.text", "min" : 0, "max" : "1" }, "type" : [{ "code" : "xhtml" }] }, { "id" : "Section.confidentialityCode", "path" : "Section.confidentialityCode", "min" : 0, "max" : "1", "base" : { "path" : "Section.confidentialityCode", "min" : 0, "max" : "1" }, "type" : [{ "code" : "http://hl7.org/cda/stds/core/StructureDefinition/CE" }] }, { "id" : "Section.languageCode", "path" : "Section.languageCode", "min" : 0, "max" : "1", "base" : { "path" : "Section.languageCode", "min" : 0, "max" : "1" }, "type" : [{ "code" : "http://hl7.org/cda/stds/core/StructureDefinition/CS" }], "binding" : { "strength" : "required", "valueSet" : "http://hl7.org/fhir/ValueSet/all-languages" } }, { "id" : "Section.subject", "path" : "Section.subject", "min" : 0, "max" : "1", "base" : { "path" : "Section.subject", "min" : 0, "max" : "1" }, "type" : [{ "code" : "http://hl7.org/cda/stds/core/StructureDefinition/Subject" }] }, { "id" : "Section.author", "path" : "Section.author", "min" : 0, "max" : "*", "base" : { "path" : "Section.author", "min" : 0, "max" : "*" }, "type" : [{ "code" : "http://hl7.org/cda/stds/core/StructureDefinition/Author" }] }, { "id" : "Section.informant", "path" : "Section.informant", "min" : 0, "max" : "*", "base" : { "path" : "Section.informant", "min" : 0, "max" : "*" }, "type" : [{ "code" : "http://hl7.org/cda/stds/core/StructureDefinition/Informant" }] }, { "id" : "Section.entry", "path" : "Section.entry", "slicing" : { "discriminator" : [{ "type" : "profile", "path" : "substanceAdministration" }], "rules" : "open" }, "short" : "If section/@nullFlavor is not present...", "min" : 0, "max" : "*", "base" : { "path" : "Section.entry", "min" : 0, "max" : "*" }, "type" : [{ "code" : "http://hl7.org/cda/stds/core/StructureDefinition/Entry" }] }, { "id" : "Section.entry:activity", "extension" : [{ "url" : "http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement", "valueBoolean" : true }], "path" : "Section.entry", "sliceName" : "activity", "short" : "𝗨𝗦𝗖𝗗𝗜: Immunizations", "comment" : "SHALL contain at least one [1..*] entry (CONF:1198-9019) such that it", "min" : 0, "max" : "*", "base" : { "path" : "Section.entry", "min" : 0, "max" : "*" }, "type" : [{ "code" : "http://hl7.org/cda/stds/core/StructureDefinition/Entry" }] }, { "id" : "Section.entry:activity.nullFlavor", "path" : "Section.entry.nullFlavor", "representation" : ["xmlAttr"], "label" : "Exceptional Value Detail", "definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.", "min" : 0, "max" : "1", "base" : { "path" : "ANY.nullFlavor", "min" : 0, "max" : "1" }, "type" : [{ "code" : "code", "profile" : ["http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"] }], "binding" : { "strength" : "required", "valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor" } }, { "id" : "Section.entry:activity.realmCode", "path" : "Section.entry.realmCode", "definition" : "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question", "min" : 0, "max" : "*", "base" : { "path" : "InfrastructureRoot.realmCode", "min" : 0, "max" : "*" }, "type" : [{ "code" : "http://hl7.org/cda/stds/core/StructureDefinition/CS" }] }, { "id" : "Section.entry:activity.typeId", "path" : "Section.entry.typeId", "definition" : "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.", "min" : 0, "max" : "1", "base" : { "path" : "InfrastructureRoot.typeId", "min" : 0, "max" : "1" }, "type" : [{ "code" : "http://hl7.org/cda/stds/core/StructureDefinition/II" }], "constraint" : [{ "key" : "II-1", "severity" : "error", "human" : "An II instance must have either a root or an nullFlavor.", "expression" : "root.exists() or nullFlavor.exists()", "source" : "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot" }] }, { "id" : "Section.entry:activity.typeId.nullFlavor", "path" : "Section.entry.typeId.nullFlavor", "representation" : ["xmlAttr"], "label" : "Exceptional Value Detail", "definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.", "min" : 0, "max" : "1", "base" : { "path" : "ANY.nullFlavor", "min" : 0, "max" : "1" }, "type" : [{ "code" : "code", "profile" : ["http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"] }], "binding" : { "strength" : "required", "valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor" } }, { "id" : "Section.entry:activity.typeId.assigningAuthorityName", "path" : "Section.entry.typeId.assigningAuthorityName", "representation" : ["xmlAttr"], "label" : "Assigning Authority Name", "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.", "min" : 0, "max" : "1", "base" : { "path" : "II.assigningAuthorityName", "min" : 0, "max" : "1" }, "type" : [{ "code" : "string", "profile" : ["http://hl7.org/cda/stds/core/StructureDefinition/st-simple"] }] }, { "id" : "Section.entry:activity.typeId.displayable", "path" : "Section.entry.typeId.displayable", "representation" : ["xmlAttr"], "label" : "Displayable", "definition" : "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).", "min" : 0, "max" : "1", "base" : { "path" : "II.displayable", "min" : 0, "max" : "1" }, "type" : [{ "code" : "boolean", "profile" : ["http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"] }] }, { "id" : "Section.entry:activity.typeId.root", "path" : "Section.entry.typeId.root", "representation" : ["xmlAttr"], "label" : "Root", "definition" : "Identifies the type as an HL7 Registered model", "min" : 1, "max" : "1", "base" : { "path" : "II.root", "min" : 0, "max" : "1" }, "type" : [{ "code" : "string", "profile" : ["http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid"] }], "fixedString" : "2.16.840.1.113883.1.3" }, { "id" : "Section.entry:activity.typeId.extension", "path" : "Section.entry.typeId.extension", "representation" : ["xmlAttr"], "label" : "Extension", "definition" : "A character string as a unique identifier within the scope of the identifier root.", "min" : 1, "max" : "1", "base" : { "path" : "II.extension", "min" : 0, "max" : "1" }, "type" : [{ "code" : "string", "profile" : ["http://hl7.org/cda/stds/core/StructureDefinition/st-simple"] }] }, { "id" : "Section.entry:activity.templateId", "path" : "Section.entry.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", "min" : 0, "max" : "*", "base" : { "path" : "InfrastructureRoot.templateId", "min" : 0, "max" : "*" }, "type" : [{ "code" : "http://hl7.org/cda/stds/core/StructureDefinition/II" }] }, { "id" : "Section.entry:activity.typeCode", "path" : "Section.entry.typeCode", "representation" : ["xmlAttr"], "min" : 0, "max" : "1", "base" : { "path" : "Entry.typeCode", "min" : 0, "max" : "1" }, "type" : [{ "code" : "code", "profile" : ["http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"] }], "defaultValueCode" : "COMP", "binding" : { "strength" : "required", "valueSet" : "http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntry" } }, { "id" : "Section.entry:activity.contextConductionInd", "path" : "Section.entry.contextConductionInd", "representation" : ["xmlAttr"], "min" : 0, "max" : "1", "base" : { "path" : "Entry.contextConductionInd", "min" : 0, "max" : "1" }, "type" : [{ "code" : "boolean", "profile" : ["http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"] }], "fixedBoolean" : true }, { "id" : "Section.entry:activity.act", "path" : "Section.entry.act", "min" : 0, "max" : "1", "base" : { "path" : "Entry.act", "min" : 0, "max" : "1" }, "type" : [{ "code" : "http://hl7.org/cda/stds/core/StructureDefinition/Act" }] }, { "id" : "Section.entry:activity.encounter", "path" : "Section.entry.encounter", "min" : 0, "max" : "1", "base" : { "path" : "Entry.encounter", "min" : 0, "max" : "1" }, "type" : [{ "code" : "http://hl7.org/cda/stds/core/StructureDefinition/Encounter" }] }, { "id" : "Section.entry:activity.observation", "path" : "Section.entry.observation", "min" : 0, "max" : "1", "base" : { "path" : "Entry.observation", "min" : 0, "max" : "1" }, "type" : [{ "code" : "http://hl7.org/cda/stds/core/StructureDefinition/Observation" }] }, { "id" : "Section.entry:activity.observationMedia", "path" : "Section.entry.observationMedia", "min" : 0, "max" : "1", "base" : { "path" : "Entry.observationMedia", "min" : 0, "max" : "1" }, "type" : [{ "code" : "http://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia" }] }, { "id" : "Section.entry:activity.organizer", "path" : "Section.entry.organizer", "min" : 0, "max" : "1", "base" : { "path" : "Entry.organizer", "min" : 0, "max" : "1" }, "type" : [{ "code" : "http://hl7.org/cda/stds/core/StructureDefinition/Organizer" }] }, { "id" : "Section.entry:activity.procedure", "path" : "Section.entry.procedure", "min" : 0, "max" : "1", "base" : { "path" : "Entry.procedure", "min" : 0, "max" : "1" }, "type" : [{ "code" : "http://hl7.org/cda/stds/core/StructureDefinition/Procedure" }] }, { "id" : "Section.entry:activity.regionOfInterest", "path" : "Section.entry.regionOfInterest", "min" : 0, "max" : "1", "base" : { "path" : "Entry.regionOfInterest", "min" : 0, "max" : "1" }, "type" : [{ "code" : "http://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest" }] }, { "id" : "Section.entry:activity.substanceAdministration", "path" : "Section.entry.substanceAdministration", "comment" : "SHALL contain exactly one [1..1] Immunization Activity (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.52:2015-08-01) (CONF:1198-15494).", "min" : 1, "max" : "1", "base" : { "path" : "Entry.substanceAdministration", "min" : 0, "max" : "1" }, "type" : [{ "code" : "http://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration", "profile" : ["http://hl7.org/cda/us/ccda/StructureDefinition/ImmunizationActivity"] }] }, { "id" : "Section.entry:activity.supply", "path" : "Section.entry.supply", "min" : 0, "max" : "1", "base" : { "path" : "Entry.supply", "min" : 0, "max" : "1" }, "type" : [{ "code" : "http://hl7.org/cda/stds/core/StructureDefinition/Supply" }] }, { "id" : "Section.component", "path" : "Section.component", "min" : 0, "max" : "*", "base" : { "path" : "Section.component", "min" : 0, "max" : "*" }, "type" : [{ "code" : "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot" }] }, { "id" : "Section.component.nullFlavor", "path" : "Section.component.nullFlavor", "representation" : ["xmlAttr"], "label" : "Exceptional Value Detail", "definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.", "min" : 0, "max" : "1", "base" : { "path" : "ANY.nullFlavor", "min" : 0, "max" : "1" }, "type" : [{ "code" : "code", "profile" : ["http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"] }], "binding" : { "strength" : "required", "valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor" } }, { "id" : "Section.component.realmCode", "path" : "Section.component.realmCode", "definition" : "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question", "min" : 0, "max" : "*", "base" : { "path" : "InfrastructureRoot.realmCode", "min" : 0, "max" : "*" }, "type" : [{ "code" : "http://hl7.org/cda/stds/core/StructureDefinition/CS" }] }, { "id" : "Section.component.typeId", "path" : "Section.component.typeId", "definition" : "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.", "min" : 0, "max" : "1", "base" : { "path" : "InfrastructureRoot.typeId", "min" : 0, "max" : "1" }, "type" : [{ "code" : "http://hl7.org/cda/stds/core/StructureDefinition/II" }], "constraint" : [{ "key" : "II-1", "severity" : "error", "human" : "An II instance must have either a root or an nullFlavor.", "expression" : "root.exists() or nullFlavor.exists()", "source" : "http://hl7.org/cda/stds/core/StructureDefinition/Section" }] }, { "id" : "Section.component.typeId.nullFlavor", "path" : "Section.component.typeId.nullFlavor", "representation" : ["xmlAttr"], "label" : "Exceptional Value Detail", "definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.", "min" : 0, "max" : "1", "base" : { "path" : "ANY.nullFlavor", "min" : 0, "max" : "1" }, "type" : [{ "code" : "code", "profile" : ["http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"] }], "binding" : { "strength" : "required", "valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor" } }, { "id" : "Section.component.typeId.assigningAuthorityName", "path" : "Section.component.typeId.assigningAuthorityName", "representation" : ["xmlAttr"], "label" : "Assigning Authority Name", "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.", "min" : 0, "max" : "1", "base" : { "path" : "II.assigningAuthorityName", "min" : 0, "max" : "1" }, "type" : [{ "code" : "string", "profile" : ["http://hl7.org/cda/stds/core/StructureDefinition/st-simple"] }] }, { "id" : "Section.component.typeId.displayable", "path" : "Section.component.typeId.displayable", "representation" : ["xmlAttr"], "label" : "Displayable", "definition" : "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).", "min" : 0, "max" : "1", "base" : { "path" : "II.displayable", "min" : 0, "max" : "1" }, "type" : [{ "code" : "boolean", "profile" : ["http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"] }] }, { "id" : "Section.component.typeId.root", "path" : "Section.component.typeId.root", "representation" : ["xmlAttr"], "label" : "Root", "definition" : "Identifies the type as an HL7 Registered model", "min" : 1, "max" : "1", "base" : { "path" : "II.root", "min" : 0, "max" : "1" }, "type" : [{ "code" : "string", "profile" : ["http://hl7.org/cda/stds/core/StructureDefinition/oid", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid"] }], "fixedString" : "2.16.840.1.113883.1.3" }, { "id" : "Section.component.typeId.extension", "path" : "Section.component.typeId.extension", "representation" : ["xmlAttr"], "label" : "Extension", "definition" : "A character string as a unique identifier within the scope of the identifier root.", "min" : 1, "max" : "1", "base" : { "path" : "II.extension", "min" : 0, "max" : "1" }, "type" : [{ "code" : "string", "profile" : ["http://hl7.org/cda/stds/core/StructureDefinition/st-simple"] }] }, { "id" : "Section.component.templateId", "path" : "Section.component.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", "min" : 0, "max" : "*", "base" : { "path" : "InfrastructureRoot.templateId", "min" : 0, "max" : "*" }, "type" : [{ "code" : "http://hl7.org/cda/stds/core/StructureDefinition/II" }] }, { "id" : "Section.component.typeCode", "path" : "Section.component.typeCode", "representation" : ["xmlAttr"], "definition" : "Drawn from concept domain DocumentSectionType", "min" : 0, "max" : "1", "base" : { "path" : "Section.component.typeCode", "min" : 0, "max" : "1" }, "type" : [{ "code" : "code", "profile" : ["http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"] }], "fixedCode" : "COMP" }, { "id" : "Section.component.contextConductionInd", "path" : "Section.component.contextConductionInd", "representation" : ["xmlAttr"], "min" : 0, "max" : "1", "base" : { "path" : "Section.component.contextConductionInd", "min" : 0, "max" : "1" }, "type" : [{ "code" : "boolean", "profile" : ["http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"] }], "fixedBoolean" : true }, { "id" : "Section.component.section", "path" : "Section.component.section", "min" : 1, "max" : "1", "base" : { "path" : "Section.component.section", "min" : 1, "max" : "1" }, "type" : [{ "code" : "http://hl7.org/cda/stds/core/StructureDefinition/Section" }] }] }, "differential" : { "element" : [{ "id" : "Section", "path" : "Section", "constraint" : [{ "key" : "shall-immunization-activity", "severity" : "error", "human" : "If section/@nullFlavor is not present, SHALL contain at least one Immunization Activity", "expression" : "nullFlavor.exists() or entry.where(substanceAdministration.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/ImmunizationActivity')).exists()", "source" : "http://hl7.org/cda/us/ccda/StructureDefinition/ImmunizationsSection" }] }, { "id" : "Section.nullFlavor", "path" : "Section.nullFlavor", "short" : "If a required section contains no information, the @nullFlavor MAY be set to NI" }, { "id" : "Section.templateId", "path" : "Section.templateId", "slicing" : { "discriminator" : [{ "type" : "value", "path" : "root" }, { "type" : "value", "path" : "extension" }], "rules" : "open" }, "min" : 1 }, { "id" : "Section.templateId:section", "path" : "Section.templateId", "sliceName" : "section", "min" : 1, "max" : "1" }, { "id" : "Section.templateId:section.root", "path" : "Section.templateId.root", "min" : 1, "patternString" : "2.16.840.1.113883.10.20.22.2.2.1" }, { "id" : "Section.templateId:section.extension", "path" : "Section.templateId.extension", "min" : 1, "patternString" : "2015-08-01" }, { "id" : "Section.code", "path" : "Section.code", "short" : "History of Immunization Narrative", "min" : 1 }, { "id" : "Section.code.code", "path" : "Section.code.code", "min" : 1, "patternCode" : "11369-6" }, { "id" : "Section.code.codeSystem", "path" : "Section.code.codeSystem", "min" : 1, "patternString" : "2.16.840.1.113883.6.1" }, { "id" : "Section.title", "path" : "Section.title", "min" : 1 }, { "id" : "Section.text", "path" : "Section.text", "min" : 1 }, { "id" : "Section.entry", "path" : "Section.entry", "slicing" : { "discriminator" : [{ "type" : "profile", "path" : "substanceAdministration" }], "rules" : "open" }, "short" : "If section/@nullFlavor is not present..." }, { "id" : "Section.entry:activity", "extension" : [{ "url" : "http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement", "valueBoolean" : true }], "path" : "Section.entry", "sliceName" : "activity", "short" : "𝗨𝗦𝗖𝗗𝗜: Immunizations", "comment" : "SHALL contain at least one [1..*] entry (CONF:1198-9019) such that it", "min" : 0, "max" : "*" }, { "id" : "Section.entry:activity.substanceAdministration", "path" : "Section.entry.substanceAdministration", "comment" : "SHALL contain exactly one [1..1] Immunization Activity (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.52:2015-08-01) (CONF:1198-15494).", "min" : 1, "type" : [{ "code" : "http://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration", "profile" : ["http://hl7.org/cda/us/ccda/StructureDefinition/ImmunizationActivity"] }] }] } }