Consolidated CDA Release 2.1 StructureDefinition Publication
2.1 - CI Build

Consolidated CDA Release 2.1 StructureDefinition Publication, published by Health Level Seven. This is not an authorized publication; it is the continuous build for version 2.1). This version is based on the current content of https://github.com/HL7/CDA-ccda-2.1-sd/ and changes regularly. See the Directory of published versions

## Logical Model: Related Person Relationship and Name Participant

Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/RelatedPersonRelationshipAndNameParticipant | Version: 2.1
Draft as of 2023-09-29 | Computable Name: RelatedPersonRelationshipAndNameParticipant
Other Identifiers: id: urn:hl7ii:2.16.840.1.113883.10.20.22.5.8:2023-05-01

This template represents a generic participant person that has a relationship to the patient. (e.g., parent, next-of-kin, neighbor). The related person’s name is required and it is recommended that the person’s contact information is present. The more specific CDA participant of Guardian (recordTarget/patientRole/patient/guardian) can be used to represent a legally responsible guardian of the patient within the header. This template may be used to represent a person with any relationship to the patient within the header, or at the entry level when pertinent to a particular clinical statement.

Usage:

- This Logical Model is not used by any profiles in this Implementation Guide

### Formal Views of Profile Content

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

- Differential Table
- Key Elements Table
- Snapshot Table
- Statistics/References
- All

This structure is derived from CDAR2.Participant1

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Participant1 |  | 1..1 | CDAR2.Participant1 | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, @typeCode, @contextControlCode, realmCode, typeId, templateId, functionCode, time, associatedEntity Base for all types and resources
typeCode |  | 1..1 | cs | Fixed Value: IND
Slices for templateId |  | 1..* | II | Slice: Unordered, Open by value:Participant1.root, value:Participant1.extension
templateId:templateId1 |  | 1..1 | II | templateId
root |  | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.5.8
extension |  | 1..1 | st | Required Pattern: 2023-05-01
associatedEntity |  | 1..1 | AssociatedEntity |
classCode |  | 1..1 | cs | Fixed Value: PRS
code |  | 1..1 | CE | Binding: Personal And Legal Relationship Role Type (required)
addr |  | 0..* | USRealmAddressADUSFIELDED | Base for all types and resources
telecom |  | 0..* | TEL |
associatedPerson |  | 1..1 | Person |
name |  | 1..* | USRealmPersonNamePNUSFIELDED | Base for all types and resources
Documentation for this format

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet
Participant1.associatedEntity.code | required | Personal And Legal Relationship Role Type

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Participant1 |  | 1..1 | CDAR2.Participant1 | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, @typeCode, @contextControlCode, realmCode, typeId, templateId, functionCode, time, associatedEntity Base for all types and resources
@typeCode |  | 1..1 | cs | Binding: ParticipationType (required) Fixed Value: IND
Slices for templateId |  | 1..* | II | Slice: Unordered, Open by value:Participant1.root, value:Participant1.extension
templateId:templateId1 |  | 1..1 | II | templateId
@root |  | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.5.8
@extension |  | 1..1 | st | Required Pattern: 2023-05-01
associatedEntity |  | 1..1 | AssociatedEntity |
@classCode |  | 1..1 | cs | Binding: RoleClassAssociative (required) Fixed Value: PRS
code |  | 1..1 | CE | Binding: Personal And Legal Relationship Role Type (required)
addr | C | 0..* | USRealmAddressADUSFIELDED | Base for all types and resources
telecom |  | 0..* | TEL |
associatedPerson |  | 1..1 | Person |
name | C | 1..* | USRealmPersonNamePNUSFIELDED | Base for all types and resources
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code
Participant1.typeCode | required | Fixed Value: IND
Participant1.associatedEntity.classCode | required | Fixed Value: PRS
Participant1.associatedEntity.code | required | Personal And Legal Relationship Role Type

#### Constraints

Id | Grade | Path(s) | Details | Requirements
81-7296 | error | Participant1.associatedEntity.addr | **SHALL NOT** have mixed content except for white space (CONF:81-7296). : |
81-9371 | error | Participant1.associatedEntity.associatedPerson.name | The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). : |
81-9372 | error | Participant1.associatedEntity.associatedPerson.name | The string **SHALL NOT** contain name parts (CONF:81-9372). : |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
pn-no-ls | error | Participant1.associatedEntity.associatedPerson.name | No PN name part may have a qualifier of LS. : (delimiter | family | given | prefix | suffix).where(qualifier = 'LS').empty() |

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Participant1 |  | 1..1 | CDAR2.Participant1 | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, @typeCode, @contextControlCode, realmCode, typeId, templateId, functionCode, time, associatedEntity Base for all types and resources
@nullFlavor |  | 0..1 | cs | Binding: NullFlavor (required)
@typeCode |  | 1..1 | cs | Binding: ParticipationType (required) Fixed Value: IND
@contextControlCode |  | 0..1 | cs | Binding: ContextControl (required) Fixed Value: OP
realmCode |  | 0..* | CS |
typeId |  | 0..1 | II |
Slices for templateId |  | 1..* | II | Slice: Unordered, Open by value:Participant1.root, value:Participant1.extension
templateId:templateId1 |  | 1..1 | II | templateId
@nullFlavor |  | 0..1 | cs | Binding: NullFlavor (required)
@assigningAuthorityName |  | 0..1 | st |
@displayable |  | 0..1 | bl |
@root |  | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.5.8
@extension |  | 1..1 | st | Required Pattern: 2023-05-01
functionCode |  | 0..1 | CE |
time |  | 0..1 | IVL_TS |
associatedEntity |  | 1..1 | AssociatedEntity |
@classCode |  | 1..1 | cs | Binding: RoleClassAssociative (required) Fixed Value: PRS
templateId |  | 0..* | II |
id |  | 0..* | II |
sdtcIdentifiedBy |  | 0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc)
code |  | 1..1 | CE | Binding: Personal And Legal Relationship Role Type (required)
addr | C | 0..* | USRealmAddressADUSFIELDED | Base for all types and resources
telecom |  | 0..* | TEL |
associatedPerson |  | 1..1 | Person |
@classCode |  | 0..1 | cs | Binding: EntityClassLivingSubject (required) Fixed Value: PSN
@determinerCode |  | 0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE
templateId |  | 0..* | II |
name | C | 1..* | USRealmPersonNamePNUSFIELDED | Base for all types and resources
sdtcAsPatientRelationship |  | 0..* | CE | XML Namespace: urn:hl7-org:sdtc XML: asPatientRelationship (urn:hl7-org:sdtc)
scopingOrganization |  | 0..1 | Organization |
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code
Participant1.nullFlavor | required | NullFlavor
Participant1.typeCode | required | Fixed Value: IND
Participant1.contextControlCode | required | Fixed Value: OP
Participant1.templateId:templateId1.nullFlavor | required | NullFlavor
Participant1.associatedEntity.classCode | required | Fixed Value: PRS
Participant1.associatedEntity.code | required | Personal And Legal Relationship Role Type
Participant1.associatedEntity.associatedPerson.classCode | required | Fixed Value: PSN
Participant1.associatedEntity.associatedPerson.determinerCode | required | Fixed Value: INSTANCE

#### Constraints

Id | Grade | Path(s) | Details | Requirements
81-7296 | error | Participant1.associatedEntity.addr | **SHALL NOT** have mixed content except for white space (CONF:81-7296). : |
81-9371 | error | Participant1.associatedEntity.associatedPerson.name | The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). : |
81-9372 | error | Participant1.associatedEntity.associatedPerson.name | The string **SHALL NOT** contain name parts (CONF:81-9372). : |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
pn-no-ls | error | Participant1.associatedEntity.associatedPerson.name | No PN name part may have a qualifier of LS. : (delimiter | family | given | prefix | suffix).where(qualifier = 'LS').empty() |

This structure is derived from CDAR2.Participant1

Summary

Mandatory: 8 elements
Fixed Value: 2 elements

Structures

This structure refers to these other structures:

- US Realm Address (AD.US.FIELDED) (http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddressADUSFIELDED)
- US Realm Person Name (PN.US.FIELDED) (http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPersonNamePNUSFIELDED)

Slices

This structure defines the following Slices:

- The element Participant1.templateId is sliced based on the values of value:Participant1.root, value:Participant1.extension

Differential View

This structure is derived from CDAR2.Participant1

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Participant1 |  | 1..1 | CDAR2.Participant1 | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, @typeCode, @contextControlCode, realmCode, typeId, templateId, functionCode, time, associatedEntity Base for all types and resources
typeCode |  | 1..1 | cs | Fixed Value: IND
Slices for templateId |  | 1..* | II | Slice: Unordered, Open by value:Participant1.root, value:Participant1.extension
templateId:templateId1 |  | 1..1 | II | templateId
root |  | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.5.8
extension |  | 1..1 | st | Required Pattern: 2023-05-01
associatedEntity |  | 1..1 | AssociatedEntity |
classCode |  | 1..1 | cs | Fixed Value: PRS
code |  | 1..1 | CE | Binding: Personal And Legal Relationship Role Type (required)
addr |  | 0..* | USRealmAddressADUSFIELDED | Base for all types and resources
telecom |  | 0..* | TEL |
associatedPerson |  | 1..1 | Person |
name |  | 1..* | USRealmPersonNamePNUSFIELDED | Base for all types and resources
Documentation for this format

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet
Participant1.associatedEntity.code | required | Personal And Legal Relationship Role Type

Key Elements View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Participant1 |  | 1..1 | CDAR2.Participant1 | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, @typeCode, @contextControlCode, realmCode, typeId, templateId, functionCode, time, associatedEntity Base for all types and resources
@typeCode |  | 1..1 | cs | Binding: ParticipationType (required) Fixed Value: IND
Slices for templateId |  | 1..* | II | Slice: Unordered, Open by value:Participant1.root, value:Participant1.extension
templateId:templateId1 |  | 1..1 | II | templateId
@root |  | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.5.8
@extension |  | 1..1 | st | Required Pattern: 2023-05-01
associatedEntity |  | 1..1 | AssociatedEntity |
@classCode |  | 1..1 | cs | Binding: RoleClassAssociative (required) Fixed Value: PRS
code |  | 1..1 | CE | Binding: Personal And Legal Relationship Role Type (required)
addr | C | 0..* | USRealmAddressADUSFIELDED | Base for all types and resources
telecom |  | 0..* | TEL |
associatedPerson |  | 1..1 | Person |
name | C | 1..* | USRealmPersonNamePNUSFIELDED | Base for all types and resources
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code
Participant1.typeCode | required | Fixed Value: IND
Participant1.associatedEntity.classCode | required | Fixed Value: PRS
Participant1.associatedEntity.code | required | Personal And Legal Relationship Role Type

#### Constraints

Id | Grade | Path(s) | Details | Requirements
81-7296 | error | Participant1.associatedEntity.addr | **SHALL NOT** have mixed content except for white space (CONF:81-7296). : |
81-9371 | error | Participant1.associatedEntity.associatedPerson.name | The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). : |
81-9372 | error | Participant1.associatedEntity.associatedPerson.name | The string **SHALL NOT** contain name parts (CONF:81-9372). : |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
pn-no-ls | error | Participant1.associatedEntity.associatedPerson.name | No PN name part may have a qualifier of LS. : (delimiter | family | given | prefix | suffix).where(qualifier = 'LS').empty() |

Snapshot View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Participant1 |  | 1..1 | CDAR2.Participant1 | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, @typeCode, @contextControlCode, realmCode, typeId, templateId, functionCode, time, associatedEntity Base for all types and resources
@nullFlavor |  | 0..1 | cs | Binding: NullFlavor (required)
@typeCode |  | 1..1 | cs | Binding: ParticipationType (required) Fixed Value: IND
@contextControlCode |  | 0..1 | cs | Binding: ContextControl (required) Fixed Value: OP
realmCode |  | 0..* | CS |
typeId |  | 0..1 | II |
Slices for templateId |  | 1..* | II | Slice: Unordered, Open by value:Participant1.root, value:Participant1.extension
templateId:templateId1 |  | 1..1 | II | templateId
@nullFlavor |  | 0..1 | cs | Binding: NullFlavor (required)
@assigningAuthorityName |  | 0..1 | st |
@displayable |  | 0..1 | bl |
@root |  | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.5.8
@extension |  | 1..1 | st | Required Pattern: 2023-05-01
functionCode |  | 0..1 | CE |
time |  | 0..1 | IVL_TS |
associatedEntity |  | 1..1 | AssociatedEntity |
@classCode |  | 1..1 | cs | Binding: RoleClassAssociative (required) Fixed Value: PRS
templateId |  | 0..* | II |
id |  | 0..* | II |
sdtcIdentifiedBy |  | 0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc)
code |  | 1..1 | CE | Binding: Personal And Legal Relationship Role Type (required)
addr | C | 0..* | USRealmAddressADUSFIELDED | Base for all types and resources
telecom |  | 0..* | TEL |
associatedPerson |  | 1..1 | Person |
@classCode |  | 0..1 | cs | Binding: EntityClassLivingSubject (required) Fixed Value: PSN
@determinerCode |  | 0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE
templateId |  | 0..* | II |
name | C | 1..* | USRealmPersonNamePNUSFIELDED | Base for all types and resources
sdtcAsPatientRelationship |  | 0..* | CE | XML Namespace: urn:hl7-org:sdtc XML: asPatientRelationship (urn:hl7-org:sdtc)
scopingOrganization |  | 0..1 | Organization |
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code
Participant1.nullFlavor | required | NullFlavor
Participant1.typeCode | required | Fixed Value: IND
Participant1.contextControlCode | required | Fixed Value: OP
Participant1.templateId:templateId1.nullFlavor | required | NullFlavor
Participant1.associatedEntity.classCode | required | Fixed Value: PRS
Participant1.associatedEntity.code | required | Personal And Legal Relationship Role Type
Participant1.associatedEntity.associatedPerson.classCode | required | Fixed Value: PSN
Participant1.associatedEntity.associatedPerson.determinerCode | required | Fixed Value: INSTANCE

#### Constraints

Id | Grade | Path(s) | Details | Requirements
81-7296 | error | Participant1.associatedEntity.addr | **SHALL NOT** have mixed content except for white space (CONF:81-7296). : |
81-9371 | error | Participant1.associatedEntity.associatedPerson.name | The content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). : |
81-9372 | error | Participant1.associatedEntity.associatedPerson.name | The string **SHALL NOT** contain name parts (CONF:81-9372). : |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
pn-no-ls | error | Participant1.associatedEntity.associatedPerson.name | No PN name part may have a qualifier of LS. : (delimiter | family | given | prefix | suffix).where(qualifier = 'LS').empty() |

This structure is derived from CDAR2.Participant1

Summary

Mandatory: 8 elements
Fixed Value: 2 elements

Structures

This structure refers to these other structures:

- US Realm Address (AD.US.FIELDED) (http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddressADUSFIELDED)
- US Realm Person Name (PN.US.FIELDED) (http://hl7.org/cda/us/ccda/StructureDefinition/USRealmPersonNamePNUSFIELDED)

Slices

This structure defines the following Slices:

- The element Participant1.templateId is sliced based on the values of value:Participant1.root, value:Participant1.extension

Other representations of profile: CSV, Excel