Clinical Document Architecture
2.0.0-sd-ballot - ballot

Clinical Document Architecture, published by Health Level 7. This guide is not an authorized publication; it is the continuous build for version 2.0.0-sd-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/ahdis/cda-core-2.0/ and changes regularly. See the Directory of published versions

Logical Model: ServiceEvent (CDA Class)

Official URL: http://hl7.org/cda/stds/core/StructureDefinition/ServiceEvent Version: 2.0.0-sd-ballot
Active as of 2024-03-04 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 Profile Content

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

This structure is derived from InfrastructureRoot

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

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet / CodeURI
ServiceEvent.classCoderequiredActClass
http://terminology.hl7.org/ValueSet/v3-ActClass
ServiceEvent.moodCoderequiredFixed Value: EVN
http://terminology.hl7.org/ValueSet/v3-ActMood
NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceEvent 1..1InfrastructureRootXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId
Base for all types and resources
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @classCode 1..1csBinding: ActClass (required)
... @moodCode 0..1csBinding: ActMood (required)
Fixed Value: EVN
... id 0..*II
... effectiveTime 0..1IVL_TS
... performer 0..*Performer1

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ServiceEvent.classCoderequiredActClass
http://terminology.hl7.org/ValueSet/v3-ActClass
ServiceEvent.moodCoderequiredFixed Value: EVN
http://terminology.hl7.org/ValueSet/v3-ActMood
NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceEvent 1..1InfrastructureRootXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId
Base for all types and resources
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @nullFlavor 0..1csBinding: CDANullFlavor (required)
... realmCode 0..*CS
... typeId 0..1II
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @assigningAuthorityName 0..1st
.... @displayable 0..1bl
.... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1st
... @classCode 1..1csBinding: ActClass (required)
... @moodCode 0..1csBinding: ActMood (required)
Fixed Value: EVN
... id 0..*II
... code 0..1CE
... effectiveTime 0..1IVL_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.classCoderequiredActClass
http://terminology.hl7.org/ValueSet/v3-ActClass
ServiceEvent.moodCoderequiredFixed Value: EVN
http://terminology.hl7.org/ValueSet/v3-ActMood

This structure is derived from InfrastructureRoot

Summary

Mandatory: 0 element (1 nested mandatory element)
Fixed Value: 1 element

Structures

This structure refers to these other structures:

Differential View

This structure is derived from InfrastructureRoot

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

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet / CodeURI
ServiceEvent.classCoderequiredActClass
http://terminology.hl7.org/ValueSet/v3-ActClass
ServiceEvent.moodCoderequiredFixed Value: EVN
http://terminology.hl7.org/ValueSet/v3-ActMood

Key Elements View

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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ServiceEvent.classCoderequiredActClass
http://terminology.hl7.org/ValueSet/v3-ActClass
ServiceEvent.moodCoderequiredFixed Value: EVN
http://terminology.hl7.org/ValueSet/v3-ActMood

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceEvent 1..1InfrastructureRootXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId
Base for all types and resources
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @nullFlavor 0..1csBinding: CDANullFlavor (required)
... realmCode 0..*CS
... typeId 0..1II
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @assigningAuthorityName 0..1st
.... @displayable 0..1bl
.... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1st
... @classCode 1..1csBinding: ActClass (required)
... @moodCode 0..1csBinding: ActMood (required)
Fixed Value: EVN
... id 0..*II
... code 0..1CE
... effectiveTime 0..1IVL_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.classCoderequiredActClass
http://terminology.hl7.org/ValueSet/v3-ActClass
ServiceEvent.moodCoderequiredFixed Value: EVN
http://terminology.hl7.org/ValueSet/v3-ActMood

This structure is derived from InfrastructureRoot

Summary

Mandatory: 0 element (1 nested mandatory element)
Fixed Value: 1 element

Structures

This structure refers to these other structures:

 

Other representations of profile: CSV, Excel