Clinical Document Architecture
2.0.0-sd - release

This page is part of the CDA: Clinical Document Architecture (v2.0.0-sd: CDA2 - 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: ParticipantRole (CDA Class)

Official URL: http://hl7.org/cda/stds/core/StructureDefinition/ParticipantRole Version: 2.0.0-sd
Active as of 2024-05-17 Computable Name: ParticipantRole

ParticipantRole (CDA Class)

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
.. ParticipantRole C 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)
role-choice: playingDevice and playingEntity are mutually exclusive
... @classCode 0..1 cs Binding: CDARoleClassRoot (required)
... id 0..* II
... sdtcIdentifiedBy 0..* IdentifiedBy XML Namespace: urn:hl7-org:sdtc
XML: identifiedBy (urn:hl7-org:sdtc)
... addr 0..* AD
... telecom 0..* TEL
... (Choice of one) 0..1
.... playingDevice 0..1 Device
.... playingEntity 0..1 PlayingEntity
... scopingEntity 0..1 Entity

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
ParticipantRole.classCoderequiredCDARoleClassRoot
http://hl7.org/cda/stds/core/ValueSet/CDARoleClassRoot
from this IG
ParticipantRole.codeexampleCDARoleCode
http://hl7.org/cda/stds/core/ValueSet/CDARoleCode
from this IG

Constraints

IdGradePath(s)DetailsRequirements
role-choiceerrorParticipantRoleplayingDevice and playingEntity are mutually exclusive
: (playingDevice | playingEntity).count() <= 1
NameFlagsCard.TypeDescription & Constraintsdoco
.. ParticipantRole C 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)
role-choice: playingDevice and playingEntity are mutually exclusive
... @classCode 0..1 cs Binding: CDARoleClassRoot (required)
... id 0..* II
... sdtcIdentifiedBy 0..* IdentifiedBy XML Namespace: urn:hl7-org:sdtc
XML: identifiedBy (urn:hl7-org:sdtc)
... addr 0..* AD
... telecom 0..* TEL
... (Choice of one) 0..1
.... playingDevice 0..1 Device
.... playingEntity 0..1 PlayingEntity
... scopingEntity 0..1 Entity

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ParticipantRole.classCoderequiredCDARoleClassRoot
http://hl7.org/cda/stds/core/ValueSet/CDARoleClassRoot
from this IG
ParticipantRole.codeexampleCDARoleCode
http://hl7.org/cda/stds/core/ValueSet/CDARoleCode
from this IG

Constraints

IdGradePath(s)DetailsRequirements
role-choiceerrorParticipantRoleplayingDevice and playingEntity are mutually exclusive
: (playingDevice | playingEntity).count() <= 1
NameFlagsCard.TypeDescription & Constraintsdoco
.. ParticipantRole C 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)
role-choice: playingDevice and playingEntity are mutually exclusive
... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
... realmCode 0..* CS
... typeId 0..1 II
.... @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: CDARoleClassRoot (required)
... id 0..* II
... sdtcIdentifiedBy 0..* IdentifiedBy XML Namespace: urn:hl7-org:sdtc
XML: identifiedBy (urn:hl7-org:sdtc)
... code 0..1 CE Binding: CDARoleCode (example)
... addr 0..* AD
... telecom 0..* TEL
... (Choice of one) 0..1
.... playingDevice 0..1 Device
.... playingEntity 0..1 PlayingEntity
... scopingEntity 0..1 Entity

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ParticipantRole.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
ParticipantRole.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
ParticipantRole.classCoderequiredCDARoleClassRoot
http://hl7.org/cda/stds/core/ValueSet/CDARoleClassRoot
from this IG
ParticipantRole.codeexampleCDARoleCode
http://hl7.org/cda/stds/core/ValueSet/CDARoleCode
from this IG

Constraints

IdGradePath(s)DetailsRequirements
role-choiceerrorParticipantRoleplayingDevice and playingEntity are mutually exclusive
: (playingDevice | playingEntity).count() <= 1

This structure is derived from InfrastructureRoot

Summary

Structures

This structure refers to these other structures:

Differential View

This structure is derived from InfrastructureRoot

NameFlagsCard.TypeDescription & Constraintsdoco
.. ParticipantRole C 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)
role-choice: playingDevice and playingEntity are mutually exclusive
... @classCode 0..1 cs Binding: CDARoleClassRoot (required)
... id 0..* II
... sdtcIdentifiedBy 0..* IdentifiedBy XML Namespace: urn:hl7-org:sdtc
XML: identifiedBy (urn:hl7-org:sdtc)
... addr 0..* AD
... telecom 0..* TEL
... (Choice of one) 0..1
.... playingDevice 0..1 Device
.... playingEntity 0..1 PlayingEntity
... scopingEntity 0..1 Entity

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
ParticipantRole.classCoderequiredCDARoleClassRoot
http://hl7.org/cda/stds/core/ValueSet/CDARoleClassRoot
from this IG
ParticipantRole.codeexampleCDARoleCode
http://hl7.org/cda/stds/core/ValueSet/CDARoleCode
from this IG

Constraints

IdGradePath(s)DetailsRequirements
role-choiceerrorParticipantRoleplayingDevice and playingEntity are mutually exclusive
: (playingDevice | playingEntity).count() <= 1

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ParticipantRole C 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)
role-choice: playingDevice and playingEntity are mutually exclusive
... @classCode 0..1 cs Binding: CDARoleClassRoot (required)
... id 0..* II
... sdtcIdentifiedBy 0..* IdentifiedBy XML Namespace: urn:hl7-org:sdtc
XML: identifiedBy (urn:hl7-org:sdtc)
... addr 0..* AD
... telecom 0..* TEL
... (Choice of one) 0..1
.... playingDevice 0..1 Device
.... playingEntity 0..1 PlayingEntity
... scopingEntity 0..1 Entity

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ParticipantRole.classCoderequiredCDARoleClassRoot
http://hl7.org/cda/stds/core/ValueSet/CDARoleClassRoot
from this IG
ParticipantRole.codeexampleCDARoleCode
http://hl7.org/cda/stds/core/ValueSet/CDARoleCode
from this IG

Constraints

IdGradePath(s)DetailsRequirements
role-choiceerrorParticipantRoleplayingDevice and playingEntity are mutually exclusive
: (playingDevice | playingEntity).count() <= 1

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ParticipantRole C 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)
role-choice: playingDevice and playingEntity are mutually exclusive
... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
... realmCode 0..* CS
... typeId 0..1 II
.... @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: CDARoleClassRoot (required)
... id 0..* II
... sdtcIdentifiedBy 0..* IdentifiedBy XML Namespace: urn:hl7-org:sdtc
XML: identifiedBy (urn:hl7-org:sdtc)
... code 0..1 CE Binding: CDARoleCode (example)
... addr 0..* AD
... telecom 0..* TEL
... (Choice of one) 0..1
.... playingDevice 0..1 Device
.... playingEntity 0..1 PlayingEntity
... scopingEntity 0..1 Entity

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ParticipantRole.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
ParticipantRole.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
ParticipantRole.classCoderequiredCDARoleClassRoot
http://hl7.org/cda/stds/core/ValueSet/CDARoleClassRoot
from this IG
ParticipantRole.codeexampleCDARoleCode
http://hl7.org/cda/stds/core/ValueSet/CDARoleCode
from this IG

Constraints

IdGradePath(s)DetailsRequirements
role-choiceerrorParticipantRoleplayingDevice and playingEntity are mutually exclusive
: (playingDevice | playingEntity).count() <= 1

This structure is derived from InfrastructureRoot

Summary

Structures

This structure refers to these other structures:

 

Other representations of profile: CSV, Excel