Consolidated CDA Release 2.1 StructureDefinition Prototype Publication
2.1.0-draft1 - CI Build United States of America

This page is part of the CCDA: Consolidated CDA Release (v2.1.0-draft1: CCDA 2.1 Draft) generated with FHIR v5.0.0. . For a full list of available versions, see the Directory of published versions

Resource Profile: DICOM Object Catalog Section - DCM 121181

Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/2.16.840.1.113883.10.20.6.1.1 Version: 2.1.0-draft1
Active as of 2023-01-16 Computable Name: DICOMObjectCatalogSectionDCM121181
Other Identifiers: id: urn:oid:2.16.840.1.113883.10.20.6.1.1

DICOM Object Catalog lists all referenced objects and their parent Series and Studies, plus other DICOM attributes required for retrieving the objects.

DICOM Object Catalog sections are not intended for viewing and contain empty section text.

Usage:

Formal Views of Profile Content

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

This structure is derived from CDAR2.Section

NameFlagsCard.TypeDescription & Constraintsdoco
.. Section C1..1CDAR2.SectionBase for all types and resources
81-8527: A DICOM Object Catalog SHALL be present if the document contains references to DICOM Images. If present, it SHALL be the first section in the document (CONF:81-8527).
... Slices for templateId 0..*IISlice: Unordered, Open by value:root
.... templateId:primary 1..1II
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.6.1.1
... code 1..1CE
.... code 1..1stringRequired Pattern: 121181
.... codeSystem 1..1stringRequired Pattern: 1.2.840.10008.2.16.4
... entry 1..*Element
.... act 1..1StudyActBase for all types and resources

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
81-8527warningSectionA DICOM Object Catalog SHALL be present if the document contains references to DICOM Images. If present, it SHALL be the first section in the document (CONF:81-8527).
:
NameFlagsCard.TypeDescription & Constraintsdoco
.. Section C1..1CDAR2.SectionBase for all types and resources
81-8527: A DICOM Object Catalog SHALL be present if the document contains references to DICOM Images. If present, it SHALL be the first section in the document (CONF:81-8527).
... classCode 1..1codeBinding: ActClassRecordOrganizer (required)
Fixed Value: DOCSECT
... moodCode 1..1codeBinding: ActMood (required)
Fixed Value: EVN
... Slices for templateId 0..*IISlice: Unordered, Open by value:root
.... templateId:primary 1..1II
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.6.1.1
.... code 1..1stringRequired Pattern: 121181
.... codeSystem 1..1stringRequired Pattern: 1.2.840.10008.2.16.4
... text S0..1xhtml
... entry C1..*Element
.... typeCode 1..1code
.... contextConductionInd 1..1boolean
.... act 1..1StudyActBase for all types and resources

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Section.classCoderequiredFixed Value: DOCSECT
Section.moodCoderequiredFixed Value: EVN
Section.codeextensibleDocumentSectionType

Constraints

IdGradePath(s)DetailsRequirements
81-8527warningSectionA DICOM Object Catalog SHALL be present if the document contains references to DICOM Images. If present, it SHALL be the first section in the document (CONF:81-8527).
:
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
only-one-statementerrorSection.entrySHALL have no more than one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer or act.
: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1
NameFlagsCard.TypeDescription & Constraintsdoco
.. Section C1..1CDAR2.SectionBase for all types and resources
81-8527: A DICOM Object Catalog SHALL be present if the document contains references to DICOM Images. If present, it SHALL be the first section in the document (CONF:81-8527).
... ID 0..1string
... nullFlavor 0..1codeBinding: NullFlavor (required)
... classCode 1..1codeBinding: ActClassRecordOrganizer (required)
Fixed Value: DOCSECT
... Slices for templateId 0..*IISlice: Unordered, Open by value:root
.... templateId:primary 1..1II
..... nullFlavor 0..1codeBinding: NullFlavor (required)
..... assigningAuthorityName 0..1string
..... displayable 0..1boolean
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.6.1.1
..... extension 0..1string
... id 0..1II
... code 1..1CEBinding: DocumentSectionType (extensible)
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... code 1..1stringRequired Pattern: 121181
.... codeSystem 1..1stringRequired Pattern: 1.2.840.10008.2.16.4
.... codeSystemName 0..1string
.... codeSystemVersion 0..1string
.... displayName 0..1string
.... sdtcValueSet 0..1stringXML: valueSet (urn:hl7-org:sdtc)
.... sdtcValueSetVersion 0..1stringXML: valueSetVersion (urn:hl7-org:sdtc)
.... originalText 0..1ED
.... translation 0..*CD
... title 0..1ED
... text S0..1xhtml
... confidentialityCode 0..1CE
... languageCode 0..1CSBinding: HumanLanguage (required)
... subject 0..1Element
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1codeBinding: ParticipationTargetSubject (required)
Fixed Value: SBJ
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... awarenessCode 0..1CEBinding: TargetAwareness (extensible)
.... relatedSubject 1..1RelatedSubject
... author 0..*Author
... informant 0..*Element
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1codeBinding: ParticipationInformationGenerator (required)
Fixed Value: INF
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... assignedEntity 0..1AssignedEntity
.... relatedEntity 0..1RelatedEntity
... entry C1..*Element
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1code
.... contextConductionInd 1..1boolean
.... act 1..1StudyActBase for all types and resources
... component 0..*Element
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1codeFixed Value: COMP
.... contextConductionInd 1..1boolean
.... section 1..1Section

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Section.nullFlavorrequiredNullFlavor
Section.classCoderequiredFixed Value: DOCSECT
Section.moodCoderequiredFixed Value: EVN
Section.templateId:primary.nullFlavorrequiredNullFlavor
Section.codeextensibleDocumentSectionType
Section.code.nullFlavorrequiredNullFlavor
Section.languageCoderequiredHumanLanguage (a valid code from http://terminology.hl7.org/CodeSystem/ietf3066)
Section.subject.typeCoderequiredFixed Value: SBJ
Section.subject.contextControlCoderequiredFixed Value: OP
Section.subject.awarenessCodeextensibleTargetAwareness
Section.informant.typeCoderequiredFixed Value: INF
Section.informant.contextControlCoderequiredFixed Value: OP

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
only-one-statementerrorSection.entrySHALL have no more than one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer or act.
: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1

This structure is derived from CDAR2.Section

Summary

Mandatory: 7 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Section.templateId is sliced based on the value of value:root

Differential View

This structure is derived from CDAR2.Section

NameFlagsCard.TypeDescription & Constraintsdoco
.. Section C1..1CDAR2.SectionBase for all types and resources
81-8527: A DICOM Object Catalog SHALL be present if the document contains references to DICOM Images. If present, it SHALL be the first section in the document (CONF:81-8527).
... Slices for templateId 0..*IISlice: Unordered, Open by value:root
.... templateId:primary 1..1II
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.6.1.1
... code 1..1CE
.... code 1..1stringRequired Pattern: 121181
.... codeSystem 1..1stringRequired Pattern: 1.2.840.10008.2.16.4
... entry 1..*Element
.... act 1..1StudyActBase for all types and resources

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
81-8527warningSectionA DICOM Object Catalog SHALL be present if the document contains references to DICOM Images. If present, it SHALL be the first section in the document (CONF:81-8527).
:

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Section C1..1CDAR2.SectionBase for all types and resources
81-8527: A DICOM Object Catalog SHALL be present if the document contains references to DICOM Images. If present, it SHALL be the first section in the document (CONF:81-8527).
... classCode 1..1codeBinding: ActClassRecordOrganizer (required)
Fixed Value: DOCSECT
... moodCode 1..1codeBinding: ActMood (required)
Fixed Value: EVN
... Slices for templateId 0..*IISlice: Unordered, Open by value:root
.... templateId:primary 1..1II
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.6.1.1
.... code 1..1stringRequired Pattern: 121181
.... codeSystem 1..1stringRequired Pattern: 1.2.840.10008.2.16.4
... text S0..1xhtml
... entry C1..*Element
.... typeCode 1..1code
.... contextConductionInd 1..1boolean
.... act 1..1StudyActBase for all types and resources

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Section.classCoderequiredFixed Value: DOCSECT
Section.moodCoderequiredFixed Value: EVN
Section.codeextensibleDocumentSectionType

Constraints

IdGradePath(s)DetailsRequirements
81-8527warningSectionA DICOM Object Catalog SHALL be present if the document contains references to DICOM Images. If present, it SHALL be the first section in the document (CONF:81-8527).
:
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
only-one-statementerrorSection.entrySHALL have no more than one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer or act.
: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Section C1..1CDAR2.SectionBase for all types and resources
81-8527: A DICOM Object Catalog SHALL be present if the document contains references to DICOM Images. If present, it SHALL be the first section in the document (CONF:81-8527).
... ID 0..1string
... nullFlavor 0..1codeBinding: NullFlavor (required)
... classCode 1..1codeBinding: ActClassRecordOrganizer (required)
Fixed Value: DOCSECT
... Slices for templateId 0..*IISlice: Unordered, Open by value:root
.... templateId:primary 1..1II
..... nullFlavor 0..1codeBinding: NullFlavor (required)
..... assigningAuthorityName 0..1string
..... displayable 0..1boolean
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.6.1.1
..... extension 0..1string
... id 0..1II
... code 1..1CEBinding: DocumentSectionType (extensible)
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... code 1..1stringRequired Pattern: 121181
.... codeSystem 1..1stringRequired Pattern: 1.2.840.10008.2.16.4
.... codeSystemName 0..1string
.... codeSystemVersion 0..1string
.... displayName 0..1string
.... sdtcValueSet 0..1stringXML: valueSet (urn:hl7-org:sdtc)
.... sdtcValueSetVersion 0..1stringXML: valueSetVersion (urn:hl7-org:sdtc)
.... originalText 0..1ED
.... translation 0..*CD
... title 0..1ED
... text S0..1xhtml
... confidentialityCode 0..1CE
... languageCode 0..1CSBinding: HumanLanguage (required)
... subject 0..1Element
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1codeBinding: ParticipationTargetSubject (required)
Fixed Value: SBJ
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... awarenessCode 0..1CEBinding: TargetAwareness (extensible)
.... relatedSubject 1..1RelatedSubject
... author 0..*Author
... informant 0..*Element
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1codeBinding: ParticipationInformationGenerator (required)
Fixed Value: INF
.... contextControlCode 1..1codeBinding: ContextControl (required)
Fixed Value: OP
.... assignedEntity 0..1AssignedEntity
.... relatedEntity 0..1RelatedEntity
... entry C1..*Element
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1code
.... contextConductionInd 1..1boolean
.... act 1..1StudyActBase for all types and resources
... component 0..*Element
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... typeCode 1..1codeFixed Value: COMP
.... contextConductionInd 1..1boolean
.... section 1..1Section

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Section.nullFlavorrequiredNullFlavor
Section.classCoderequiredFixed Value: DOCSECT
Section.moodCoderequiredFixed Value: EVN
Section.templateId:primary.nullFlavorrequiredNullFlavor
Section.codeextensibleDocumentSectionType
Section.code.nullFlavorrequiredNullFlavor
Section.languageCoderequiredHumanLanguage (a valid code from http://terminology.hl7.org/CodeSystem/ietf3066)
Section.subject.typeCoderequiredFixed Value: SBJ
Section.subject.contextControlCoderequiredFixed Value: OP
Section.subject.awarenessCodeextensibleTargetAwareness
Section.informant.typeCoderequiredFixed Value: INF
Section.informant.contextControlCoderequiredFixed Value: OP

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
only-one-statementerrorSection.entrySHALL have no more than one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer or act.
: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1

This structure is derived from CDAR2.Section

Summary

Mandatory: 7 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Section.templateId is sliced based on the value of value:root

 

​Other representations of profile: CSV, Excel, Schematron