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) based on FHIR v5.0.0. . For a full list of available versions, see the Directory of published versions

Resource Profile: Series Act

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

A Series Act contains the DICOM series information for referenced DICOM composite objects. The series information defines the attributes that are used to group composite instances into distinct logical sets. Each series is associated with exactly one study. Series Act clinical statements are only instantiated in the DICOM Object Catalog section inside a Study Act, and thus do not require a separate templateId; in other sections, the SOP Instance Observation is included directly.

Usage:

Formal Views of Profile Content

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

This structure is derived from CDAR2.Act

NameFlagsCard.TypeDescription & Constraintsdoco
.. Act 1..1CDAR2.ActBase for all types and resources
... classCode 1..1codeRequired Pattern: ACT
... moodCode 1..1codeRequired Pattern: 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.22.4.63
.... root 1..1stringThe @root contains the OID of the study instance UID since DICOM study ids consist only of an OID
.... extension 0..0
... code 1..1CD
.... code 1..1stringRequired Pattern: 113015
.... codeSystem 0..1stringRequired Pattern: 1.2.840.10008.2.16.4
.... qualifier 1..1CR
..... name 1..1CV
...... code 1..1stringRequired Pattern: 121139
...... codeSystem 1..1stringRequired Pattern: 1.2.840.10008.2.16.4
..... value 1..1CD
... text 0..1EDIf present, the text element contains the description of the series
... effectiveTime 0..1IVL_TSIf present, the effectiveTime contains the time the series was started
... Slices for entryRelationship 0..*ElementSlice: Unordered, Open by profile:observation
.... entryRelationship:SOPInstanceObservation 1..*Element
..... typeCode 1..1codeRequired Pattern: COMP
..... observation 1..1SOPInstanceObservationBase for all types and resources

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Act 1..1CDAR2.ActBase for all types and resources
... classCode 1..1codeRequired Pattern: ACT
... moodCode 1..1codeRequired Pattern: 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.22.4.63
.... root 1..1stringThe @root contains the OID of the study instance UID since DICOM study ids consist only of an OID
... code 1..1CDBinding: v3 Code System ActCode (extensible)
.... code 1..1stringRequired Pattern: 113015
.... codeSystem 0..1stringRequired Pattern: 1.2.840.10008.2.16.4
.... qualifier 1..1CR
..... name 1..1CV
...... code 1..1stringRequired Pattern: 121139
...... codeSystem 1..1stringRequired Pattern: 1.2.840.10008.2.16.4
..... value 1..1CD
... text 0..1EDIf present, the text element contains the description of the series
... effectiveTime 0..1IVL_TSIf present, the effectiveTime contains the time the series was started
... Slices for entryRelationship C0..*ElementSlice: Unordered, Open by profile:observation
.... entryRelationship:All Slices Content/Rules for all slices
..... typeCode 1..1code
..... contextConductionInd 1..1boolean
.... entryRelationship:SOPInstanceObservation C1..*Element
..... typeCode 1..1codeRequired Pattern: COMP
..... contextConductionInd 1..1boolean
..... observation 1..1SOPInstanceObservationBase for all types and resources

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Act.codeextensibleActCode

Constraints

IdGradePath(s)DetailsRequirements
act-er-1errorAct.entryRelationship, Act.entryRelationship:SOPInstanceObservationOnly one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act
: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
NameFlagsCard.TypeDescription & Constraintsdoco
.. Act 1..1CDAR2.ActBase for all types and resources
... classCode 1..1codeRequired Pattern: ACT
... moodCode 1..1codeRequired Pattern: EVN
... realmCode 0..*CS
... 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.22.4.63
..... extension 0..1string
... id 1..*II
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... assigningAuthorityName 0..1string
.... displayable 0..1boolean
.... root 1..1stringThe @root contains the OID of the study instance UID since DICOM study ids consist only of an OID
... code 1..1CDBinding: v3 Code System ActCode (extensible)
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... code 1..1stringRequired Pattern: 113015
.... codeSystem 0..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
.... qualifier 1..1CR
..... nullFlavor 0..1codeBinding: NullFlavor (required)
..... inverted 0..1boolean
..... name 1..1CV
...... nullFlavor 0..1codeBinding: NullFlavor (required)
...... code 1..1stringRequired Pattern: 121139
...... 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
..... value 1..1CD
.... translation 0..*CD
... negationInd 0..1boolean
... text 0..1EDIf present, the text element contains the description of the series
... statusCode 0..1CSBinding: ActStatus (required)
... effectiveTime 0..1IVL_TSIf present, the effectiveTime contains the time the series was started
... priorityCode 0..1CEBinding: ActPriority (extensible)
... 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
... specimen 0..*Specimen
... performer 0..*Performer2
... 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
... participant 0..*Participant2
... Slices for entryRelationship C0..*ElementSlice: Unordered, Open by profile:observation
.... entryRelationship:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... typeCode 1..1code
..... inversionInd 0..1boolean
..... contextConductionInd 1..1boolean
..... sequenceNumber 0..1INT
..... negationInd 0..1boolean
..... seperatableInd 0..1BL
..... (Choice of one) 1..1
...... observation 0..1Observation
...... regionOfInterest 0..1RegionOfInterest
...... observationMedia 0..1ObservationMedia
...... substanceAdministration 0..1SubstanceAdministration
...... supply 0..1Supply
...... procedure 0..1Procedure
...... encounter 0..1Encounter
...... organizer 0..1Organizer
...... act 0..1Act
.... entryRelationship:SOPInstanceObservation 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..1codeRequired Pattern: COMP
..... inversionInd 0..1boolean
..... contextConductionInd 1..1boolean
..... sequenceNumber 0..1INT
..... negationInd 0..1boolean
..... seperatableInd 0..1BL
..... observation 1..1SOPInstanceObservationBase for all types and resources
... reference 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..1code
.... seperatableInd 0..1BL
.... externalAct 0..1ExternalAct
.... externalObservation 0..1ExternalObservation
.... externalProcedure 0..1ExternalProcedure
.... externalDocument 0..1ExternalDocument
... precondition 0..*Precondition

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Act.templateId:primary.nullFlavorrequiredNullFlavor
Act.id.nullFlavorrequiredNullFlavor
Act.codeextensibleActCode
Act.code.nullFlavorrequiredNullFlavor
Act.code.qualifier.nullFlavorrequiredNullFlavor
Act.code.qualifier.name.nullFlavorrequiredNullFlavor
Act.statusCoderequiredActStatus
Act.priorityCodeextensibleActPriority
Act.languageCoderequiredHumanLanguage (a valid code from http://terminology.hl7.org/CodeSystem/ietf3066)
Act.subject.typeCoderequiredFixed Value: SBJ
Act.subject.contextControlCoderequiredFixed Value: OP
Act.subject.awarenessCodeextensibleTargetAwareness
Act.informant.typeCoderequiredFixed Value: INF
Act.informant.contextControlCoderequiredFixed Value: OP

Constraints

IdGradePath(s)DetailsRequirements
act-er-1errorAct.entryRelationship, Act.entryRelationship:SOPInstanceObservationOnly one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act
: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1
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()

This structure is derived from CDAR2.Act

Summary

Mandatory: 16 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Act.templateId is sliced based on the value of value:root
  • The element Act.entryRelationship is sliced based on the value of profile:observation

Differential View

This structure is derived from CDAR2.Act

NameFlagsCard.TypeDescription & Constraintsdoco
.. Act 1..1CDAR2.ActBase for all types and resources
... classCode 1..1codeRequired Pattern: ACT
... moodCode 1..1codeRequired Pattern: 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.22.4.63
.... root 1..1stringThe @root contains the OID of the study instance UID since DICOM study ids consist only of an OID
.... extension 0..0
... code 1..1CD
.... code 1..1stringRequired Pattern: 113015
.... codeSystem 0..1stringRequired Pattern: 1.2.840.10008.2.16.4
.... qualifier 1..1CR
..... name 1..1CV
...... code 1..1stringRequired Pattern: 121139
...... codeSystem 1..1stringRequired Pattern: 1.2.840.10008.2.16.4
..... value 1..1CD
... text 0..1EDIf present, the text element contains the description of the series
... effectiveTime 0..1IVL_TSIf present, the effectiveTime contains the time the series was started
... Slices for entryRelationship 0..*ElementSlice: Unordered, Open by profile:observation
.... entryRelationship:SOPInstanceObservation 1..*Element
..... typeCode 1..1codeRequired Pattern: COMP
..... observation 1..1SOPInstanceObservationBase for all types and resources

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Act 1..1CDAR2.ActBase for all types and resources
... classCode 1..1codeRequired Pattern: ACT
... moodCode 1..1codeRequired Pattern: 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.22.4.63
.... root 1..1stringThe @root contains the OID of the study instance UID since DICOM study ids consist only of an OID
... code 1..1CDBinding: v3 Code System ActCode (extensible)
.... code 1..1stringRequired Pattern: 113015
.... codeSystem 0..1stringRequired Pattern: 1.2.840.10008.2.16.4
.... qualifier 1..1CR
..... name 1..1CV
...... code 1..1stringRequired Pattern: 121139
...... codeSystem 1..1stringRequired Pattern: 1.2.840.10008.2.16.4
..... value 1..1CD
... text 0..1EDIf present, the text element contains the description of the series
... effectiveTime 0..1IVL_TSIf present, the effectiveTime contains the time the series was started
... Slices for entryRelationship C0..*ElementSlice: Unordered, Open by profile:observation
.... entryRelationship:All Slices Content/Rules for all slices
..... typeCode 1..1code
..... contextConductionInd 1..1boolean
.... entryRelationship:SOPInstanceObservation C1..*Element
..... typeCode 1..1codeRequired Pattern: COMP
..... contextConductionInd 1..1boolean
..... observation 1..1SOPInstanceObservationBase for all types and resources

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Act.codeextensibleActCode

Constraints

IdGradePath(s)DetailsRequirements
act-er-1errorAct.entryRelationship, Act.entryRelationship:SOPInstanceObservationOnly one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act
: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Act 1..1CDAR2.ActBase for all types and resources
... classCode 1..1codeRequired Pattern: ACT
... moodCode 1..1codeRequired Pattern: EVN
... realmCode 0..*CS
... 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.22.4.63
..... extension 0..1string
... id 1..*II
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... assigningAuthorityName 0..1string
.... displayable 0..1boolean
.... root 1..1stringThe @root contains the OID of the study instance UID since DICOM study ids consist only of an OID
... code 1..1CDBinding: v3 Code System ActCode (extensible)
.... nullFlavor 0..1codeBinding: NullFlavor (required)
.... code 1..1stringRequired Pattern: 113015
.... codeSystem 0..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
.... qualifier 1..1CR
..... nullFlavor 0..1codeBinding: NullFlavor (required)
..... inverted 0..1boolean
..... name 1..1CV
...... nullFlavor 0..1codeBinding: NullFlavor (required)
...... code 1..1stringRequired Pattern: 121139
...... 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
..... value 1..1CD
.... translation 0..*CD
... negationInd 0..1boolean
... text 0..1EDIf present, the text element contains the description of the series
... statusCode 0..1CSBinding: ActStatus (required)
... effectiveTime 0..1IVL_TSIf present, the effectiveTime contains the time the series was started
... priorityCode 0..1CEBinding: ActPriority (extensible)
... 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
... specimen 0..*Specimen
... performer 0..*Performer2
... 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
... participant 0..*Participant2
... Slices for entryRelationship C0..*ElementSlice: Unordered, Open by profile:observation
.... entryRelationship:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... typeCode 1..1code
..... inversionInd 0..1boolean
..... contextConductionInd 1..1boolean
..... sequenceNumber 0..1INT
..... negationInd 0..1boolean
..... seperatableInd 0..1BL
..... (Choice of one) 1..1
...... observation 0..1Observation
...... regionOfInterest 0..1RegionOfInterest
...... observationMedia 0..1ObservationMedia
...... substanceAdministration 0..1SubstanceAdministration
...... supply 0..1Supply
...... procedure 0..1Procedure
...... encounter 0..1Encounter
...... organizer 0..1Organizer
...... act 0..1Act
.... entryRelationship:SOPInstanceObservation 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..1codeRequired Pattern: COMP
..... inversionInd 0..1boolean
..... contextConductionInd 1..1boolean
..... sequenceNumber 0..1INT
..... negationInd 0..1boolean
..... seperatableInd 0..1BL
..... observation 1..1SOPInstanceObservationBase for all types and resources
... reference 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..1code
.... seperatableInd 0..1BL
.... externalAct 0..1ExternalAct
.... externalObservation 0..1ExternalObservation
.... externalProcedure 0..1ExternalProcedure
.... externalDocument 0..1ExternalDocument
... precondition 0..*Precondition

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Act.templateId:primary.nullFlavorrequiredNullFlavor
Act.id.nullFlavorrequiredNullFlavor
Act.codeextensibleActCode
Act.code.nullFlavorrequiredNullFlavor
Act.code.qualifier.nullFlavorrequiredNullFlavor
Act.code.qualifier.name.nullFlavorrequiredNullFlavor
Act.statusCoderequiredActStatus
Act.priorityCodeextensibleActPriority
Act.languageCoderequiredHumanLanguage (a valid code from http://terminology.hl7.org/CodeSystem/ietf3066)
Act.subject.typeCoderequiredFixed Value: SBJ
Act.subject.contextControlCoderequiredFixed Value: OP
Act.subject.awarenessCodeextensibleTargetAwareness
Act.informant.typeCoderequiredFixed Value: INF
Act.informant.contextControlCoderequiredFixed Value: OP

Constraints

IdGradePath(s)DetailsRequirements
act-er-1errorAct.entryRelationship, Act.entryRelationship:SOPInstanceObservationOnly one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act
: (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1
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()

This structure is derived from CDAR2.Act

Summary

Mandatory: 16 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Act.templateId is sliced based on the value of value:root
  • The element Act.entryRelationship is sliced based on the value of profile:observation

 

​Other representations of profile: CSV, Excel, Schematron