ParticipantRole (CDA Class) - Clinical Document Architecture v2.0.1-sd

Clinical Document Architecture
2.0.1-sd - release

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

Logical Model: ParticipantRole (CDA Class)

Official URL: http://hl7.org/cda/stds/core/StructureDefinition/ParticipantRole				Version: 2.0.1-sd
Active as of 2025-09-17				Computable Name: ParticipantRole

ParticipantRole (CDA Class)

Usages:

Use this Logical Model: Participant2 (CDA Class)

You can also check for usages in the FHIR IG Statistics

Formal Views of Template Content

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

Key Elements Table
Differential Table
Snapshot Table
Statistics/References
All

This structure is derived from InfrastructureRoot

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
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) Constraints: role-choice
@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
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
ParticipantRole.classCode	required	CDARoleClassRoot `http://hl7.org/cda/stds/core/ValueSet/CDARoleClassRoot` From this IG
ParticipantRole.code	example	CDARoleCode `http://hl7.org/cda/stds/core/ValueSet/CDARoleCode` From this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
role-choice	error	ParticipantRole	playingDevice and playingEntity are mutually exclusive : (playingDevice \| playingEntity).count() <= 1

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
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) Constraints: role-choice
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
realmCode		0..*	CS
typeId	C	0..1	II	Constraints: II-1
@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
templateId		0..*	II
@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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
ParticipantRole.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` From this IG
ParticipantRole.typeId.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` From this IG
ParticipantRole.classCode	required	CDARoleClassRoot `http://hl7.org/cda/stds/core/ValueSet/CDARoleClassRoot` From this IG
ParticipantRole.code	example	CDARoleCode `http://hl7.org/cda/stds/core/ValueSet/CDARoleCode` From this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
II-1	error	ParticipantRole.typeId	An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists()
role-choice	error	ParticipantRole	playingDevice and playingEntity are mutually exclusive : (playingDevice \| playingEntity).count() <= 1

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
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) Constraints: role-choice
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
realmCode		0..*	CS
typeId	C	0..1	II	Constraints: II-1
@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
templateId		0..*	II
@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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
ParticipantRole.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` From this IG
ParticipantRole.typeId.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` From this IG
ParticipantRole.classCode	required	CDARoleClassRoot `http://hl7.org/cda/stds/core/ValueSet/CDARoleClassRoot` From this IG
ParticipantRole.code	example	CDARoleCode `http://hl7.org/cda/stds/core/ValueSet/CDARoleCode` From this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
II-1	error	ParticipantRole.typeId	An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists()
role-choice	error	ParticipantRole	playingDevice and playingEntity are mutually exclusive : (playingDevice \| playingEntity).count() <= 1

This structure is derived from InfrastructureRoot

Summary

Structures

This structure refers to these other structures:

cs: Coded Simple Value (http://hl7.org/cda/stds/core/StructureDefinition/cs-simple)

Differential View

This structure is derived from InfrastructureRoot

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
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) Constraints: role-choice
@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
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
ParticipantRole.classCode	required	CDARoleClassRoot `http://hl7.org/cda/stds/core/ValueSet/CDARoleClassRoot` From this IG
ParticipantRole.code	example	CDARoleCode `http://hl7.org/cda/stds/core/ValueSet/CDARoleCode` From this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
role-choice	error	ParticipantRole	playingDevice and playingEntity are mutually exclusive : (playingDevice \| playingEntity).count() <= 1

Key Elements View

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
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) Constraints: role-choice
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
realmCode		0..*	CS
typeId	C	0..1	II	Constraints: II-1
@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
templateId		0..*	II
@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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
ParticipantRole.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` From this IG
ParticipantRole.typeId.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` From this IG
ParticipantRole.classCode	required	CDARoleClassRoot `http://hl7.org/cda/stds/core/ValueSet/CDARoleClassRoot` From this IG
ParticipantRole.code	example	CDARoleCode `http://hl7.org/cda/stds/core/ValueSet/CDARoleCode` From this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
II-1	error	ParticipantRole.typeId	An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists()
role-choice	error	ParticipantRole	playingDevice and playingEntity are mutually exclusive : (playingDevice \| playingEntity).count() <= 1

Snapshot View

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
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) Constraints: role-choice
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
realmCode		0..*	CS
typeId	C	0..1	II	Constraints: II-1
@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
templateId		0..*	II
@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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
ParticipantRole.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` From this IG
ParticipantRole.typeId.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` From this IG
ParticipantRole.classCode	required	CDARoleClassRoot `http://hl7.org/cda/stds/core/ValueSet/CDARoleClassRoot` From this IG
ParticipantRole.code	example	CDARoleCode `http://hl7.org/cda/stds/core/ValueSet/CDARoleCode` From this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
II-1	error	ParticipantRole.typeId	An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists()
role-choice	error	ParticipantRole	playingDevice and playingEntity are mutually exclusive : (playingDevice \| playingEntity).count() <= 1

This structure is derived from InfrastructureRoot

Summary

Structures

This structure refers to these other structures:

cs: Coded Simple Value (http://hl7.org/cda/stds/core/StructureDefinition/cs-simple)

Other representations of profile: CSV, Excel

IG © 2019+ Health Level 7. Package hl7.cda.uv.core#2.0.1-sd based on FHIR 5.0.0. Generated 2025-09-17
Links: Table of Contents | QA Report | Version History external | | Propose a change