{
"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.",
"_filename": "StructureDefinition-ImmunizationsSection.json",
"package_name": "hl7.cda.us.ccda",
"date": "2023-12-21T01:13:10+10:00",
"derivation": "constraint",
"publisher": "Health Level Seven",
"fhirVersion": "5.0.0",
"jurisdiction": [ {
"coding": [ {
"code": "US",
"system": "urn:iso:std:iso:3166"
} ]
} ],
"name": "ImmunizationsSection",
"mapping": [ {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
} ],
"abstract": false,
"type": "http://hl7.org/cda/stds/core/StructureDefinition/Section",
"experimental": null,
"resourceType": "StructureDefinition",
"title": "Immunizations Section",
"package_version": "3.0.0-ballot",
"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",
"valueUri": "cda"
} ],
"snapshot": {
"element": [ {
"constraint": [ {
"key": "shall-immunization-activity",
"human": "SHALL contain at least one Immunization Activity",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/ImmunizationsSection",
"severity": "error",
"expression": "nullFlavor.exists() or entry.where(substanceAdministration.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/ImmunizationActivity'))"
} ],
"path": "Section",
"min": 1,
"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.",
"isModifier": false,
"short": "Base for all types and resources",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"max": "1",
"id": "Section",
"base": {
"max": "*",
"min": 0,
"path": "Base"
}
}, {
"path": "Section.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"short": "If a required section contains no information, the @nullFlavor MAY be set to NI",
"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"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "Section.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "Section.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "Section.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"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"
}, {
"id": "Section.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "Section.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"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."
}, {
"path": "Section.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"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"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "Section.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "Section.typeId.assigningAuthorityName",
"min": 0,
"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.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "Section.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "Section.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "Section.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "Section.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"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" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "Section.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "Section.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "Section.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "Section.templateId",
"max": "*",
"min": 1,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "Section.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "root",
"type": "value"
}, {
"path": "extension",
"type": "value"
} ]
},
"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"
}, {
"id": "Section.templateId:section",
"max": "1",
"min": 1,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "Section.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"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"
}, {
"path": "Section.templateId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"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"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "Section.templateId:section.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "Section.templateId.assigningAuthorityName",
"min": 0,
"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.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "Section.templateId:section.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "Section.templateId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "Section.templateId:section.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "Section.templateId.root",
"min": 1,
"definition": "A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.",
"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",
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Root",
"id": "Section.templateId:section.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "Section.templateId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"patternString": "2015-08-01",
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "Section.templateId:section.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "Section.ID",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "Section.ID"
},
"path": "Section.ID",
"type": [ {
"code": "id",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/xs-ID" ]
} ],
"representation": [ "xmlAttr" ]
}, {
"path": "Section.classCode",
"fixedCode": "DOCSECT",
"min": 0,
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-ActClassRecordOrganizer"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Section.classCode",
"base": {
"max": "1",
"min": 0,
"path": "Section.classCode"
}
}, {
"path": "Section.moodCode",
"fixedCode": "EVN",
"min": 0,
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-ActMood"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Section.moodCode",
"base": {
"max": "1",
"min": 0,
"path": "Section.moodCode"
}
}, {
"id": "Section.id",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "Section.id"
},
"path": "Section.id",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ]
}, {
"id": "Section.code",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 0,
"path": "Section.code"
},
"path": "Section.code",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CE"
} ],
"short": "Immunizations",
"binding": {
"strength": "example",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-DocumentSectionType"
}
}, {
"path": "Section.code.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"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"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "Section.code.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "Section.code.code",
"min": 1,
"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.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"patternCode": "11369-6",
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Code",
"id": "Section.code.code",
"base": {
"max": "1",
"min": 0,
"path": "CD.code"
}
}, {
"path": "Section.code.codeSystem",
"min": 1,
"definition": "Specifies the code system that defines the code.",
"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",
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Code System",
"id": "Section.code.codeSystem",
"base": {
"max": "1",
"min": 0,
"path": "CD.codeSystem"
}
}, {
"path": "Section.code.codeSystemName",
"min": 0,
"definition": "The common name of the coding system.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Code System Name",
"id": "Section.code.codeSystemName",
"base": {
"max": "1",
"min": 0,
"path": "CD.codeSystemName"
}
}, {
"path": "Section.code.codeSystemVersion",
"min": 0,
"definition": "If applicable, a version descriptor defined specifically for the given code system.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Code System Version",
"id": "Section.code.codeSystemVersion",
"base": {
"max": "1",
"min": 0,
"path": "CD.codeSystemVersion"
}
}, {
"path": "Section.code.displayName",
"min": 0,
"definition": "A name or title for the code, under which the sending system shows the code value to its users.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Display Name",
"id": "Section.code.displayName",
"base": {
"max": "1",
"min": 0,
"path": "CD.displayName"
}
}, {
"path": "Section.code.sdtcValueSet",
"min": 0,
"definition": "The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid" ]
} ],
"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"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Section.code.sdtcValueSet",
"base": {
"max": "1",
"min": 0,
"path": "CD.valueSet"
}
}, {
"path": "Section.code.sdtcValueSetVersion",
"min": 0,
"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.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"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"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Section.code.sdtcValueSetVersion",
"base": {
"max": "1",
"min": 0,
"path": "CD.sdtcValueSetVersion"
}
}, {
"id": "Section.code.originalText",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "CD.originalText"
},
"path": "Section.code.originalText",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ED"
} ],
"label": "Original Text",
"definition": "The text or phrase used as the basis for the coding."
}, {
"id": "Section.code.qualifier",
"max": "0",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "CD.qualifier"
},
"path": "Section.code.qualifier",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CR"
} ],
"label": "Qualifier",
"definition": "Specifies additional codes that increase the specificity of the the primary code."
}, {
"path": "Section.code.translation",
"min": 0,
"definition": "A set of other concept descriptors that translate this concept descriptor into other code systems.",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CD"
} ],
"representation": [ "typeAttr" ],
"max": "*",
"label": "Translation",
"id": "Section.code.translation",
"base": {
"max": "*",
"min": 0,
"path": "CD.translation"
}
}, {
"id": "Section.title",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 0,
"path": "Section.title"
},
"path": "Section.title",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ST"
} ]
}, {
"id": "Section.text",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 0,
"path": "Section.text"
},
"path": "Section.text",
"type": [ {
"code": "xhtml"
} ],
"representation": [ "cdaText" ]
}, {
"id": "Section.confidentialityCode",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "Section.confidentialityCode"
},
"path": "Section.confidentialityCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CE"
} ]
}, {
"id": "Section.languageCode",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "Section.languageCode"
},
"path": "Section.languageCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/all-languages"
}
}, {
"id": "Section.subject",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "Section.subject"
},
"path": "Section.subject",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Subject"
} ]
}, {
"id": "Section.author",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "Section.author"
},
"path": "Section.author",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Author"
} ]
}, {
"id": "Section.informant",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "Section.informant"
},
"path": "Section.informant",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Informant"
} ]
}, {
"id": "Section.entry",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "Section.entry"
},
"path": "Section.entry",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Entry"
} ],
"short": "If section/@nullFlavor is not present...",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "substanceAdministration",
"type": "profile"
} ]
}
}, {
"path": "Section.entry",
"min": 0,
"short": "(USCDI) Immunizations",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Entry"
} ],
"sliceName": "activity",
"extension": [ {
"url": "http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement",
"valueBoolean": true
} ],
"max": "*",
"id": "Section.entry:activity",
"comment": "SHALL contain at least one [1..*] entry (CONF:1198-9019) such that it",
"base": {
"max": "*",
"min": 0,
"path": "Section.entry"
}
}, {
"path": "Section.entry.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"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"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "Section.entry:activity.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "Section.entry:activity.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "Section.entry.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"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"
}, {
"id": "Section.entry:activity.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "Section.entry.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"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."
}, {
"path": "Section.entry.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"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"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "Section.entry:activity.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "Section.entry.typeId.assigningAuthorityName",
"min": 0,
"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.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "Section.entry:activity.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "Section.entry.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "Section.entry:activity.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "Section.entry.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"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" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "Section.entry:activity.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "Section.entry.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "Section.entry:activity.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "Section.entry:activity.templateId",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "Section.entry.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"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"
}, {
"path": "Section.entry.typeCode",
"min": 0,
"defaultValueCode": "COMP",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntry"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Section.entry:activity.typeCode",
"base": {
"max": "1",
"min": 0,
"path": "Entry.typeCode"
}
}, {
"id": "Section.entry:activity.contextConductionInd",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "Entry.contextConductionInd"
},
"path": "Section.entry.contextConductionInd",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"fixedBoolean": true,
"representation": [ "xmlAttr" ]
}, {
"id": "Section.entry:activity.act",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "Entry.act"
},
"path": "Section.entry.act",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Act"
} ]
}, {
"id": "Section.entry:activity.encounter",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "Entry.encounter"
},
"path": "Section.entry.encounter",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Encounter"
} ]
}, {
"id": "Section.entry:activity.observation",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "Entry.observation"
},
"path": "Section.entry.observation",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Observation"
} ]
}, {
"id": "Section.entry:activity.observationMedia",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "Entry.observationMedia"
},
"path": "Section.entry.observationMedia",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia"
} ]
}, {
"id": "Section.entry:activity.organizer",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "Entry.organizer"
},
"path": "Section.entry.organizer",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Organizer"
} ]
}, {
"id": "Section.entry:activity.procedure",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "Entry.procedure"
},
"path": "Section.entry.procedure",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Procedure"
} ]
}, {
"id": "Section.entry:activity.regionOfInterest",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "Entry.regionOfInterest"
},
"path": "Section.entry.regionOfInterest",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest"
} ]
}, {
"constraint": [ {
"key": "should-text-ref-value",
"human": "SHOULD contain text/reference/@value",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/ImmunizationActivity",
"severity": "warning",
"expression": "text.reference.value.exists()"
}, {
"key": "should-doseQuantity",
"human": "SHOULD contain doseQuantity",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/ImmunizationActivity",
"severity": "warning",
"expression": "doseQuantity.exists()"
}, {
"key": "dose-unit-or-admin-unit",
"human": "If doseQuantity/@unit is present, then administrationUnitCode SHALL NOT be present.",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/ImmunizationActivity",
"severity": "error",
"expression": "doseQuantity.unit.exists() implies administrationUnitCode.empty()"
}, {
"key": "should-performer",
"human": "SHOULD contain performer",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/ImmunizationActivity",
"severity": "warning",
"expression": "performer.exists()"
}, {
"key": "should-author",
"human": "SHOULD contain author",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/ImmunizationActivity",
"severity": "warning",
"expression": "author.exists()"
} ],
"path": "Section.entry.substanceAdministration",
"min": 1,
"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.",
"isModifier": false,
"short": "Base for all types and resources",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration",
"profile": [ "http://hl7.org/cda/us/ccda/StructureDefinition/ImmunizationActivity" ]
} ],
"max": "1",
"id": "Section.entry:activity.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).",
"base": {
"max": "1",
"min": 0,
"path": "Entry.substanceAdministration"
}
}, {
"id": "Section.entry:activity.supply",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "Entry.supply"
},
"path": "Section.entry.supply",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Supply"
} ]
}, {
"id": "Section.component",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "Section.component"
},
"path": "Section.component",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot"
} ]
}, {
"path": "Section.component.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"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"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "Section.component.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "Section.component.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "Section.component.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"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"
}, {
"id": "Section.component.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "Section.component.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"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."
}, {
"path": "Section.component.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"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"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "Section.component.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "Section.component.typeId.assigningAuthorityName",
"min": 0,
"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.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "Section.component.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "Section.component.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "Section.component.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "Section.component.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"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" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "Section.component.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "Section.component.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "Section.component.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "Section.component.templateId",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "Section.component.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"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"
}, {
"path": "Section.component.typeCode",
"fixedCode": "COMP",
"min": 0,
"definition": "Drawn from concept domain DocumentSectionType",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Section.component.typeCode",
"base": {
"max": "1",
"min": 0,
"path": "Section.component.typeCode"
}
}, {
"id": "Section.component.contextConductionInd",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "Section.component.contextConductionInd"
},
"path": "Section.component.contextConductionInd",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"fixedBoolean": true,
"representation": [ "xmlAttr" ]
}, {
"id": "Section.component.section",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "Section.component.section"
},
"path": "Section.component.section",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Section"
} ]
} ]
},
"status": "draft",
"id": "1b24768b-861d-4542-911c-edbc7c7880aa",
"kind": "logical",
"url": "http://hl7.org/cda/us/ccda/StructureDefinition/ImmunizationsSection",
"identifier": [ {
"value": "urn:hl7ii:2.16.840.1.113883.10.20.22.2.2.1:2015-08-01"
} ],
"version": "3.0.0-ballot",
"differential": {
"element": [ {
"id": "Section",
"path": "Section",
"constraint": [ {
"key": "shall-immunization-activity",
"human": "SHALL contain at least one Immunization Activity",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/ImmunizationsSection",
"severity": "error",
"expression": "nullFlavor.exists() or entry.where(substanceAdministration.hasTemplateIdOf('http://hl7.org/cda/us/ccda/StructureDefinition/ImmunizationActivity'))"
} ]
}, {
"id": "Section.nullFlavor",
"path": "Section.nullFlavor",
"short": "If a required section contains no information, the @nullFlavor MAY be set to NI"
}, {
"id": "Section.templateId",
"min": 1,
"path": "Section.templateId",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "root",
"type": "value"
}, {
"path": "extension",
"type": "value"
} ]
}
}, {
"id": "Section.templateId:section",
"max": "1",
"min": 1,
"path": "Section.templateId",
"sliceName": "section"
}, {
"id": "Section.templateId:section.root",
"min": 1,
"path": "Section.templateId.root",
"patternString": "2.16.840.1.113883.10.20.22.2.2.1"
}, {
"id": "Section.templateId:section.extension",
"min": 1,
"path": "Section.templateId.extension",
"patternString": "2015-08-01"
}, {
"id": "Section.code",
"min": 1,
"path": "Section.code",
"short": "Immunizations"
}, {
"id": "Section.code.code",
"min": 1,
"path": "Section.code.code",
"patternCode": "11369-6"
}, {
"id": "Section.code.codeSystem",
"min": 1,
"path": "Section.code.codeSystem",
"patternString": "2.16.840.1.113883.6.1"
}, {
"id": "Section.title",
"min": 1,
"path": "Section.title"
}, {
"id": "Section.text",
"min": 1,
"path": "Section.text"
}, {
"id": "Section.entry",
"path": "Section.entry",
"short": "If section/@nullFlavor is not present...",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "substanceAdministration",
"type": "profile"
} ]
}
}, {
"id": "Section.entry:activity",
"max": "*",
"min": 0,
"path": "Section.entry",
"short": "(USCDI) Immunizations",
"comment": "SHALL contain at least one [1..*] entry (CONF:1198-9019) such that it",
"extension": [ {
"url": "http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement",
"valueBoolean": true
} ],
"sliceName": "activity"
}, {
"id": "Section.entry:activity.substanceAdministration",
"min": 1,
"path": "Section.entry.substanceAdministration",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration",
"profile": [ "http://hl7.org/cda/us/ccda/StructureDefinition/ImmunizationActivity" ]
} ],
"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)."
} ]
},
"contact": [ {
"name": "HL7 International - Structured Documents",
"telecom": [ {
"value": "http://www.hl7.org/Special/committees/structure",
"system": "url"
} ]
} ],
"baseDefinition": "http://hl7.org/cda/stds/core/StructureDefinition/Section"
}