Clinical Document Architecture
2.0.1-sd - release

This page is part of the CDA: Clinical Document Architecture (v2.0.1-sd: CDA 2.0 - Informative) generated with FHIR (HL7® FHIR® Standard) v5.0.0. This is the current published version. For a full list of available versions, see the Directory of published versions

Logical Model: ServiceEvent (CDA Class)

Official URL: http://hl7.org/cda/stds/core/StructureDefinition/ServiceEvent Version: 2.0.1-sd
Active as of 2024-12-18 Computable Name: ServiceEvent

This class represents the main Act, such as a colonoscopy or an appendectomy, being documented.

In some cases, the ServiceEvent is inherent in the ClinicalDocument.code, such as where ClinicalDocument.code is "History and Physical Report" and the procedure being documented is a "History and Physical" act. A ServiceEvent can further specialize the act inherent in the ClinicalDocument.code, such as where the ClinicalDocument.code is simply "Procedure Report" and the procedure was a "colonoscopy". If ServiceEvent is included, it must be equivalent to or further specialize the value inherent in the ClinicalDocument.code, and shall not conflict with the value inherent in the ClinicalDocument.code, as such a conflict would constitute an ambiguous situation.

ServiceEvent.effectiveTime can be used to indicate the time the actual event (as opposed to the encounter surrounding the event) took place.

Usage:

Formal Views of Template Content

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

This structure is derived from InfrastructureRoot

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceEvent 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Base for all types and resources
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @classCode 0..1 cs Binding: CDAActClass (required)
... @moodCode 0..1 cs Binding: CDAActMood (required)
Fixed Value: EVN
... id 0..* II
... effectiveTime 0..1 IVL_TS
... performer 0..* Performer1

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet / CodeURI
ServiceEvent.classCoderequiredCDAActClass
http://hl7.org/cda/stds/core/ValueSet/CDAActClass
from this IG
ServiceEvent.moodCoderequiredFixed Value: EVN
http://hl7.org/cda/stds/core/ValueSet/CDAActMood
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceEvent 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Base for all types and resources
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
... realmCode 0..* CS
... typeId C 0..1 II II-1: An II instance must have either a root or an nullFlavor.
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @assigningAuthorityName 0..1 st
.... @displayable 0..1 bl
.... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1 st
... @classCode 0..1 cs Binding: CDAActClass (required)
... @moodCode 0..1 cs Binding: CDAActMood (required)
Fixed Value: EVN
... id 0..* II
... code 0..1 CE
... effectiveTime 0..1 IVL_TS
... performer 0..* Performer1

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ServiceEvent.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
ServiceEvent.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
ServiceEvent.classCoderequiredCDAActClass
http://hl7.org/cda/stds/core/ValueSet/CDAActClass
from this IG
ServiceEvent.moodCoderequiredFixed Value: EVN
http://hl7.org/cda/stds/core/ValueSet/CDAActMood
from this IG

Constraints

IdGradePath(s)DetailsRequirements
II-1errorServiceEvent.typeIdAn II instance must have either a root or an nullFlavor.
: root.exists() or nullFlavor.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceEvent 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Base for all types and resources
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
... realmCode 0..* CS
... typeId C 0..1 II II-1: An II instance must have either a root or an nullFlavor.
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @assigningAuthorityName 0..1 st
.... @displayable 0..1 bl
.... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1 st
... @classCode 0..1 cs Binding: CDAActClass (required)
... @moodCode 0..1 cs Binding: CDAActMood (required)
Fixed Value: EVN
... id 0..* II
... code 0..1 CE
... effectiveTime 0..1 IVL_TS
... performer 0..* Performer1

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ServiceEvent.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
ServiceEvent.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
ServiceEvent.classCoderequiredCDAActClass
http://hl7.org/cda/stds/core/ValueSet/CDAActClass
from this IG
ServiceEvent.moodCoderequiredFixed Value: EVN
http://hl7.org/cda/stds/core/ValueSet/CDAActMood
from this IG

Constraints

IdGradePath(s)DetailsRequirements
II-1errorServiceEvent.typeIdAn II instance must have either a root or an nullFlavor.
: root.exists() or nullFlavor.exists()

This structure is derived from InfrastructureRoot

Summary

Fixed: 1 element

Structures

This structure refers to these other structures:

Differential View

This structure is derived from InfrastructureRoot

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceEvent 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Base for all types and resources
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @classCode 0..1 cs Binding: CDAActClass (required)
... @moodCode 0..1 cs Binding: CDAActMood (required)
Fixed Value: EVN
... id 0..* II
... effectiveTime 0..1 IVL_TS
... performer 0..* Performer1

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet / CodeURI
ServiceEvent.classCoderequiredCDAActClass
http://hl7.org/cda/stds/core/ValueSet/CDAActClass
from this IG
ServiceEvent.moodCoderequiredFixed Value: EVN
http://hl7.org/cda/stds/core/ValueSet/CDAActMood
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceEvent 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Base for all types and resources
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
... realmCode 0..* CS
... typeId C 0..1 II II-1: An II instance must have either a root or an nullFlavor.
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @assigningAuthorityName 0..1 st
.... @displayable 0..1 bl
.... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1 st
... @classCode 0..1 cs Binding: CDAActClass (required)
... @moodCode 0..1 cs Binding: CDAActMood (required)
Fixed Value: EVN
... id 0..* II
... code 0..1 CE
... effectiveTime 0..1 IVL_TS
... performer 0..* Performer1

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ServiceEvent.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
ServiceEvent.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
ServiceEvent.classCoderequiredCDAActClass
http://hl7.org/cda/stds/core/ValueSet/CDAActClass
from this IG
ServiceEvent.moodCoderequiredFixed Value: EVN
http://hl7.org/cda/stds/core/ValueSet/CDAActMood
from this IG

Constraints

IdGradePath(s)DetailsRequirements
II-1errorServiceEvent.typeIdAn II instance must have either a root or an nullFlavor.
: root.exists() or nullFlavor.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceEvent 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Base for all types and resources
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
... realmCode 0..* CS
... typeId C 0..1 II II-1: An II instance must have either a root or an nullFlavor.
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @assigningAuthorityName 0..1 st
.... @displayable 0..1 bl
.... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1 st
... @classCode 0..1 cs Binding: CDAActClass (required)
... @moodCode 0..1 cs Binding: CDAActMood (required)
Fixed Value: EVN
... id 0..* II
... code 0..1 CE
... effectiveTime 0..1 IVL_TS
... performer 0..* Performer1

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ServiceEvent.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
ServiceEvent.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
ServiceEvent.classCoderequiredCDAActClass
http://hl7.org/cda/stds/core/ValueSet/CDAActClass
from this IG
ServiceEvent.moodCoderequiredFixed Value: EVN
http://hl7.org/cda/stds/core/ValueSet/CDAActMood
from this IG

Constraints

IdGradePath(s)DetailsRequirements
II-1errorServiceEvent.typeIdAn II instance must have either a root or an nullFlavor.
: root.exists() or nullFlavor.exists()

This structure is derived from InfrastructureRoot

Summary

Fixed: 1 element

Structures

This structure refers to these other structures:

 

Other representations of profile: CSV, Excel