Consolidated CDA Release 2.1 StructureDefinition Publication
2.1 - CI Build United States of America flag

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.

This structure is derived from CDAR2.Participant1

NameFlagsCard.TypeDescription & Constraintsdoco
.. Participant1 1..1CDAR2.Participant1XML 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..1csFixed Value: IND
... Slices for templateId 1..*IISlice: Unordered, Open by value:Participant1.root, value:Participant1.extension
.... templateId:templateId1 1..1IItemplateId
..... root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.5.8
..... extension 1..1stRequired Pattern: 2023-05-01
... associatedEntity 1..1AssociatedEntity
.... classCode 1..1csFixed Value: PRS
.... code 1..1CEBinding: Personal And Legal Relationship Role Type (required)
.... addr 0..*USRealmAddressADUSFIELDEDBase for all types and resources
.... telecom 0..*TEL
.... associatedPerson 1..1Person
..... name 1..*USRealmPersonNamePNUSFIELDEDBase for all types and resources

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Participant1.associatedEntity.coderequiredPersonal And Legal Relationship Role Type
NameFlagsCard.TypeDescription & Constraintsdoco
.. Participant1 1..1CDAR2.Participant1XML 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..1csBinding: ParticipationType (required)
Fixed Value: IND
... Slices for templateId 1..*IISlice: Unordered, Open by value:Participant1.root, value:Participant1.extension
.... templateId:templateId1 1..1IItemplateId
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.5.8
..... @extension 1..1stRequired Pattern: 2023-05-01
... associatedEntity 1..1AssociatedEntity
.... @classCode 1..1csBinding: RoleClassAssociative (required)
Fixed Value: PRS
.... code 1..1CEBinding: Personal And Legal Relationship Role Type (required)
.... addr C0..*USRealmAddressADUSFIELDEDBase for all types and resources
.... telecom 0..*TEL
.... associatedPerson 1..1Person
..... name C1..*USRealmPersonNamePNUSFIELDEDBase for all types and resources

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Participant1.typeCoderequiredFixed Value: IND
Participant1.associatedEntity.classCoderequiredFixed Value: PRS
Participant1.associatedEntity.coderequiredPersonal And Legal Relationship Role Type

Constraints

IdGradePath(s)DetailsRequirements
81-7296errorParticipant1.associatedEntity.addr**SHALL NOT** have mixed content except for white space (CONF:81-7296).
:
81-9371errorParticipant1.associatedEntity.associatedPerson.nameThe content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371).
:
81-9372errorParticipant1.associatedEntity.associatedPerson.nameThe string **SHALL NOT** contain name parts (CONF:81-9372).
:
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
pn-no-lserrorParticipant1.associatedEntity.associatedPerson.nameNo PN name part may have a qualifier of LS.
: (delimiter | family | given | prefix | suffix).where(qualifier = 'LS').empty()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Participant1 1..1CDAR2.Participant1XML 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..1csBinding: NullFlavor (required)
... @typeCode 1..1csBinding: ParticipationType (required)
Fixed Value: IND
... @contextControlCode 0..1csBinding: ContextControl (required)
Fixed Value: OP
... typeId 0..1II
... Slices for templateId 1..*IISlice: Unordered, Open by value:Participant1.root, value:Participant1.extension
.... templateId:templateId1 1..1IItemplateId
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.5.8
..... @extension 1..1stRequired Pattern: 2023-05-01
... functionCode 0..1CE
... time 0..1IVL_TS
... associatedEntity 1..1AssociatedEntity
.... @classCode 1..1csBinding: RoleClassAssociative (required)
Fixed Value: PRS
.... templateId 0..*II
.... id 0..*II
.... sdtcIdentifiedBy 0..*IdentifiedByXML Namespace: urn:hl7-org:sdtc
XML: identifiedBy (urn:hl7-org:sdtc)
.... code 1..1CEBinding: Personal And Legal Relationship Role Type (required)
.... addr C0..*USRealmAddressADUSFIELDEDBase for all types and resources
.... telecom 0..*TEL
.... associatedPerson 1..1Person
..... @classCode 0..1csBinding: EntityClassLivingSubject (required)
Fixed Value: PSN
..... @determinerCode 0..1csBinding: EntityDeterminer (required)
Fixed Value: INSTANCE
..... templateId 0..*II
..... name C1..*USRealmPersonNamePNUSFIELDEDBase for all types and resources
..... sdtcAsPatientRelationship 0..*CEXML Namespace: urn:hl7-org:sdtc
XML: asPatientRelationship (urn:hl7-org:sdtc)
.... scopingOrganization 0..1Organization

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Participant1.nullFlavorrequiredNullFlavor
Participant1.typeCoderequiredFixed Value: IND
Participant1.contextControlCoderequiredFixed Value: OP
Participant1.templateId:templateId1.nullFlavorrequiredNullFlavor
Participant1.associatedEntity.classCoderequiredFixed Value: PRS
Participant1.associatedEntity.coderequiredPersonal And Legal Relationship Role Type
Participant1.associatedEntity.associatedPerson.classCoderequiredFixed Value: PSN
Participant1.associatedEntity.associatedPerson.determinerCoderequiredFixed Value: INSTANCE

Constraints

IdGradePath(s)DetailsRequirements
81-7296errorParticipant1.associatedEntity.addr**SHALL NOT** have mixed content except for white space (CONF:81-7296).
:
81-9371errorParticipant1.associatedEntity.associatedPerson.nameThe content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371).
:
81-9372errorParticipant1.associatedEntity.associatedPerson.nameThe string **SHALL NOT** contain name parts (CONF:81-9372).
:
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
pn-no-lserrorParticipant1.associatedEntity.associatedPerson.nameNo 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:

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Participant1 1..1CDAR2.Participant1XML 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..1csFixed Value: IND
... Slices for templateId 1..*IISlice: Unordered, Open by value:Participant1.root, value:Participant1.extension
.... templateId:templateId1 1..1IItemplateId
..... root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.5.8
..... extension 1..1stRequired Pattern: 2023-05-01
... associatedEntity 1..1AssociatedEntity
.... classCode 1..1csFixed Value: PRS
.... code 1..1CEBinding: Personal And Legal Relationship Role Type (required)
.... addr 0..*USRealmAddressADUSFIELDEDBase for all types and resources
.... telecom 0..*TEL
.... associatedPerson 1..1Person
..... name 1..*USRealmPersonNamePNUSFIELDEDBase for all types and resources

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Participant1.associatedEntity.coderequiredPersonal And Legal Relationship Role Type

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Participant1 1..1CDAR2.Participant1XML 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..1csBinding: ParticipationType (required)
Fixed Value: IND
... Slices for templateId 1..*IISlice: Unordered, Open by value:Participant1.root, value:Participant1.extension
.... templateId:templateId1 1..1IItemplateId
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.5.8
..... @extension 1..1stRequired Pattern: 2023-05-01
... associatedEntity 1..1AssociatedEntity
.... @classCode 1..1csBinding: RoleClassAssociative (required)
Fixed Value: PRS
.... code 1..1CEBinding: Personal And Legal Relationship Role Type (required)
.... addr C0..*USRealmAddressADUSFIELDEDBase for all types and resources
.... telecom 0..*TEL
.... associatedPerson 1..1Person
..... name C1..*USRealmPersonNamePNUSFIELDEDBase for all types and resources

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Participant1.typeCoderequiredFixed Value: IND
Participant1.associatedEntity.classCoderequiredFixed Value: PRS
Participant1.associatedEntity.coderequiredPersonal And Legal Relationship Role Type

Constraints

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

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Participant1 1..1CDAR2.Participant1XML 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..1csBinding: NullFlavor (required)
... @typeCode 1..1csBinding: ParticipationType (required)
Fixed Value: IND
... @contextControlCode 0..1csBinding: ContextControl (required)
Fixed Value: OP
... typeId 0..1II
... Slices for templateId 1..*IISlice: Unordered, Open by value:Participant1.root, value:Participant1.extension
.... templateId:templateId1 1..1IItemplateId
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.5.8
..... @extension 1..1stRequired Pattern: 2023-05-01
... functionCode 0..1CE
... time 0..1IVL_TS
... associatedEntity 1..1AssociatedEntity
.... @classCode 1..1csBinding: RoleClassAssociative (required)
Fixed Value: PRS
.... templateId 0..*II
.... id 0..*II
.... sdtcIdentifiedBy 0..*IdentifiedByXML Namespace: urn:hl7-org:sdtc
XML: identifiedBy (urn:hl7-org:sdtc)
.... code 1..1CEBinding: Personal And Legal Relationship Role Type (required)
.... addr C0..*USRealmAddressADUSFIELDEDBase for all types and resources
.... telecom 0..*TEL
.... associatedPerson 1..1Person
..... @classCode 0..1csBinding: EntityClassLivingSubject (required)
Fixed Value: PSN
..... @determinerCode 0..1csBinding: EntityDeterminer (required)
Fixed Value: INSTANCE
..... templateId 0..*II
..... name C1..*USRealmPersonNamePNUSFIELDEDBase for all types and resources
..... sdtcAsPatientRelationship 0..*CEXML Namespace: urn:hl7-org:sdtc
XML: asPatientRelationship (urn:hl7-org:sdtc)
.... scopingOrganization 0..1Organization

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Participant1.nullFlavorrequiredNullFlavor
Participant1.typeCoderequiredFixed Value: IND
Participant1.contextControlCoderequiredFixed Value: OP
Participant1.templateId:templateId1.nullFlavorrequiredNullFlavor
Participant1.associatedEntity.classCoderequiredFixed Value: PRS
Participant1.associatedEntity.coderequiredPersonal And Legal Relationship Role Type
Participant1.associatedEntity.associatedPerson.classCoderequiredFixed Value: PSN
Participant1.associatedEntity.associatedPerson.determinerCoderequiredFixed Value: INSTANCE

Constraints

IdGradePath(s)DetailsRequirements
81-7296errorParticipant1.associatedEntity.addr**SHALL NOT** have mixed content except for white space (CONF:81-7296).
:
81-9371errorParticipant1.associatedEntity.associatedPerson.nameThe content of name **SHALL** be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371).
:
81-9372errorParticipant1.associatedEntity.associatedPerson.nameThe string **SHALL NOT** contain name parts (CONF:81-9372).
:
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
pn-no-lserrorParticipant1.associatedEntity.associatedPerson.nameNo 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:

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