Clinical Document Architecture
2.0.1-sd - release
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
| Official URL: http://hl7.org/cda/stds/core/StructureDefinition/ParticipantRole | Version: 2.0.1-sd | |||
| Active as of 2024-12-18 | Computable Name: ParticipantRole | |||
ParticipantRole (CDA Class)
Usage:
Description of Template, Differentials, Snapshots and how the different presentations work.
This structure is derived from InfrastructureRoot
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  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) | |
| 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 | ||||
| Path | Conformance | ValueSet | URI |
| ParticipantRole.classCode | required | CDARoleClassRoothttp://hl7.org/cda/stds/core/ValueSet/CDARoleClassRootfrom this IG | |
| ParticipantRole.code | example | CDARoleCodehttp://hl7.org/cda/stds/core/ValueSet/CDARoleCodefrom this IG |
| 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 |
|---|---|---|---|---|
| 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 |
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 | ||
| 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 | ||||
| Path | Conformance | ValueSet | URI |
| ParticipantRole.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| ParticipantRole.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| ParticipantRole.classCode | required | CDARoleClassRoothttp://hl7.org/cda/stds/core/ValueSet/CDARoleClassRootfrom this IG | |
| ParticipantRole.code | example | CDARoleCodehttp://hl7.org/cda/stds/core/ValueSet/CDARoleCodefrom this IG |
| 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 |
|---|---|---|---|---|
| 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 |
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 | ||
| 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 | ||||
| Path | Conformance | ValueSet | URI |
| ParticipantRole.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| ParticipantRole.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| ParticipantRole.classCode | required | CDARoleClassRoothttp://hl7.org/cda/stds/core/ValueSet/CDARoleClassRootfrom this IG | |
| ParticipantRole.code | example | CDARoleCodehttp://hl7.org/cda/stds/core/ValueSet/CDARoleCodefrom this IG |
| 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
Differential View
This structure is derived from InfrastructureRoot
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| 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) | |
| 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 | ||||
| Path | Conformance | ValueSet | URI |
| ParticipantRole.classCode | required | CDARoleClassRoothttp://hl7.org/cda/stds/core/ValueSet/CDARoleClassRootfrom this IG | |
| ParticipantRole.code | example | CDARoleCodehttp://hl7.org/cda/stds/core/ValueSet/CDARoleCodefrom this IG |
| 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 |
|---|---|---|---|---|
| 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 |
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 | ||
| 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 | ||||
| Path | Conformance | ValueSet | URI |
| ParticipantRole.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| ParticipantRole.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| ParticipantRole.classCode | required | CDARoleClassRoothttp://hl7.org/cda/stds/core/ValueSet/CDARoleClassRootfrom this IG | |
| ParticipantRole.code | example | CDARoleCodehttp://hl7.org/cda/stds/core/ValueSet/CDARoleCodefrom this IG |
| 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 |
|---|---|---|---|---|
| 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 |
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 | ||
| 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 | ||||
| Path | Conformance | ValueSet | URI |
| ParticipantRole.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| ParticipantRole.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| ParticipantRole.classCode | required | CDARoleClassRoothttp://hl7.org/cda/stds/core/ValueSet/CDARoleClassRootfrom this IG | |
| ParticipantRole.code | example | CDARoleCodehttp://hl7.org/cda/stds/core/ValueSet/CDARoleCodefrom this IG |
| 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
IG © 2019+ Health Level 7. Package hl7.cda.uv.core#2.0.1-sd based on FHIR 5.0.0. Generated 2024-12-18
Links: Table of Contents |
QA Report
| Version History 
|
|
Propose a change