Related Person Relationship and Name Participant - Definitions - Consolidated CDA Release 2.1 StructureDefinition Publication v2.1

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: RelatedPersonRelationshipAndNameParticipant - Detailed Descriptions

Draft as of 2023-09-29

Definitions for the RelatedPersonRelationshipAndNameParticipant logical model.

Differential Elements Table
Key Elements Table
Snapshot Elements Table

Guidance on how to interpret the contents of this table can be found here

0. Participant1
XML Format	In the XML format, this property has the namespace `urn:hl7-org:v3`.
2. Participant1.typeCode
Comments	SHALL contain exactly one [1..1] @typeCode="IND" Indirect (CodeSystem: HL7ParticipationType urn:oid:2.16.840.1.113883.5.90) (CONF:4537-32982).
Control	1..?
Fixed Value	IND
4. Participant1.templateId
Control	1..?
Slicing	This element introduces a set of slices on `Participant1.templateId`. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: value @ Participant1.root value @ Participant1.extension
6. Participant1.templateId:templateId1
Slice Name	templateId1
Short	templateId
Comments	SHALL contain exactly one [1..1] templateId (CONF:4537-32977) such that it
Control	1..1
8. Participant1.templateId:templateId1.root
Comments	SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.5.8" (CONF:4537-32983).
Control	1..?
Pattern Value	2.16.840.1.113883.10.20.22.5.8
10. Participant1.templateId:templateId1.extension
Comments	SHALL contain exactly one [1..1] @extension="2023-05-01" (CONF:4537-32984).
Control	1..?
Pattern Value	2023-05-01
12. Participant1.associatedEntity
Comments	SHALL contain exactly one [1..1] associatedEntity (CONF:4537-32978).
14. Participant1.associatedEntity.classCode
Comments	This associatedEntity SHALL contain exactly one [1..1] @classCode="PRS" Person (CodeSystem: HL7RoleCode urn:oid:2.16.840.1.113883.5.111) (CONF:4537-33076).
Fixed Value	PRS
16. Participant1.associatedEntity.code
Comments	This associatedEntity SHALL contain exactly one [1..1] code, which SHALL be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:4537-32985).
Control	1..?
Binding	The codes SHALL be taken from Personal And Legal Relationship Role Type
18. Participant1.associatedEntity.addr
Comments	This associatedEntity SHOULD contain zero or more [0..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:4537-32979).
Type	http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address (AD.US.FIELDED))
20. Participant1.associatedEntity.telecom
Comments	This associatedEntity SHOULD contain zero or more [0..*] telecom (CONF:4537-32986).
22. Participant1.associatedEntity.associatedPerson
Comments	This associatedEntity SHALL contain exactly one [1..1] associatedPerson (CONF:4537-32980).
Control	1..?
24. Participant1.associatedEntity.associatedPerson.name
Comments	This associatedPerson SHALL contain at least one [1..*] US Realm Person Name (PN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1.1) (CONF:4537-32987).
Control	1..?
Type	http://hl7.org/cda/stds/core/StructureDefinition/PN(US Realm Person Name (PN.US.FIELDED))

Guidance on how to interpret the contents of this table can be found here

0. Participant1
Definition	Base definition for all types defined in FHIR type system.
Short	Base for all types and resources
Control	10..1*
Is Modifier	false
XML Format	In the XML format, this property has the namespace `urn:hl7-org:v3`.
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2. Participant1.typeCode
Comments	SHALL contain exactly one [1..1] @typeCode="IND" Indirect (CodeSystem: HL7ParticipationType urn:oid:2.16.840.1.113883.5.90) (CONF:4537-32982).
Control	1..1
Binding	The codes SHALL be taken from ParticipationType
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Fixed Value	IND
4. Participant1.templateId
Definition	When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question
Control	1..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
Slicing	This element introduces a set of slices on `Participant1.templateId`. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: value @ Participant1.root value @ Participant1.extension
6. Participant1.templateId:templateId1
Slice Name	templateId1
Definition	When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question
Short	templateId
Comments	SHALL contain exactly one [1..1] templateId (CONF:4537-32977) such that it
Control	1..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
8. Participant1.templateId:templateId1.root
Definition	A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.
Comments	SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.5.8" (CONF:4537-32983).
Control	1..1
Type	string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Root
Pattern Value	2.16.840.1.113883.10.20.22.5.8
10. Participant1.templateId:templateId1.extension
Definition	A character string as a unique identifier within the scope of the identifier root.
Comments	SHALL contain exactly one [1..1] @extension="2023-05-01" (CONF:4537-32984).
Control	1..1
Type	string(st: Character String)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Extension
Pattern Value	2023-05-01
12. Participant1.associatedEntity
Comments	SHALL contain exactly one [1..1] associatedEntity (CONF:4537-32978).
Control	1..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/AssociatedEntity
14. Participant1.associatedEntity.classCode
Comments	This associatedEntity SHALL contain exactly one [1..1] @classCode="PRS" Person (CodeSystem: HL7RoleCode urn:oid:2.16.840.1.113883.5.111) (CONF:4537-33076).
Control	1..1
Binding	The codes SHALL be taken from RoleClassAssociative
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Fixed Value	PRS
16. Participant1.associatedEntity.code
Comments	This associatedEntity SHALL contain exactly one [1..1] code, which SHALL be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:4537-32985).
Control	1..1
Binding	The codes SHALL be taken from Personal And Legal Relationship Role Type
Type	http://hl7.org/cda/stds/core/StructureDefinition/CE
18. Participant1.associatedEntity.addr
Definition	Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc.
Short	Base for all types and resources
Comments	This associatedEntity SHOULD contain zero or more [0..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:4537-32979).
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address (AD.US.FIELDED))
Is Modifier	false
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) 81-7296: SHALL NOT have mixed content except for white space (CONF:81-7296). ()
20. Participant1.associatedEntity.telecom
Comments	This associatedEntity SHOULD contain zero or more [0..*] telecom (CONF:4537-32986).
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/TEL
22. Participant1.associatedEntity.associatedPerson
Comments	This associatedEntity SHALL contain exactly one [1..1] associatedPerson (CONF:4537-32980).
Control	1..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/Person
24. Participant1.associatedEntity.associatedPerson.name
Definition	A name for a person. A sequence of name parts, such as given name or family name, prefix, suffix, etc. Examples for person name values are "Jim Bob Walton, Jr.", "Adam Everyman", etc. A person name may be as simple as a character string or may consist of several person name parts, such as, "Jim", "Bob", "Walton", and "Jr.". PN differs from EN because the qualifier type cannot include LS (Legal Status). A name associated with the person.
Short	Base for all types and resourcesA name associated with the person
Comments	This associatedPerson SHALL contain at least one [1..*] US Realm Person Name (PN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1.1) (CONF:4537-32987). Person may have multiple names with different uses or applicable periods.
Control	10..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/PNHumanName(US Realm Person Name (PN.US.FIELDED))
Is Modifier	false
Requirements	Need to be able to track the person by multiple names. Examples are your official name and a partner name.
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) pn-no-ls: No PN name part may have a qualifier of LS. (`(delimiter \| family \| given \| prefix \| suffix).where(qualifier = 'LS').empty()`) 81-9371: The content of name SHALL be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). () 81-9372: The string SHALL NOT contain name parts (CONF:81-9372). ()

Guidance on how to interpret the contents of this table can be found here

0. Participant1
Definition	Base definition for all types defined in FHIR type system.
Short	Base for all types and resources
Control	1..1
Is Modifier	false
XML Format	In the XML format, this property has the namespace `urn:hl7-org:v3`.
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
2. Participant1.nullFlavor
Definition	If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control	0..1
Binding	The codes SHALL be taken from NullFlavor
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Exceptional Value Detail
4. Participant1.typeCode
Comments	SHALL contain exactly one [1..1] @typeCode="IND" Indirect (CodeSystem: HL7ParticipationType urn:oid:2.16.840.1.113883.5.90) (CONF:4537-32982).
Control	1..1
Binding	The codes SHALL be taken from ParticipationType
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Fixed Value	IND
6. Participant1.contextControlCode
Control	0..1
Binding	The codes SHALL be taken from ContextControl
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Fixed Value	OP
8. Participant1.realmCode
Definition	When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/CS
10. Participant1.typeId
Definition	When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
12. Participant1.templateId
Definition	When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question
Control	1..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
Slicing	This element introduces a set of slices on `Participant1.templateId`. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: value @ Participant1.root value @ Participant1.extension
14. Participant1.templateId:templateId1
Slice Name	templateId1
Definition	When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question
Short	templateId
Comments	SHALL contain exactly one [1..1] templateId (CONF:4537-32977) such that it
Control	1..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
16. Participant1.templateId:templateId1.nullFlavor
Definition	If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control	0..1
Binding	The codes SHALL be taken from NullFlavor
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Exceptional Value Detail
18. Participant1.templateId:templateId1.assigningAuthorityName
Definition	A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
Control	0..1
Type	string(st: Character String)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Assigning Authority Name
20. Participant1.templateId:templateId1.displayable
Definition	Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
Control	0..1
Type	boolean(bl: Boolean)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Displayable
22. Participant1.templateId:templateId1.root
Definition	A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.
Comments	SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.5.8" (CONF:4537-32983).
Control	1..1
Type	string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Root
Pattern Value	2.16.840.1.113883.10.20.22.5.8
24. Participant1.templateId:templateId1.extension
Definition	A character string as a unique identifier within the scope of the identifier root.
Comments	SHALL contain exactly one [1..1] @extension="2023-05-01" (CONF:4537-32984).
Control	1..1
Type	string(st: Character String)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Extension
Pattern Value	2023-05-01
26. Participant1.functionCode
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/CE
28. Participant1.time
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
30. Participant1.associatedEntity
Comments	SHALL contain exactly one [1..1] associatedEntity (CONF:4537-32978).
Control	1..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/AssociatedEntity
32. Participant1.associatedEntity.classCode
Comments	This associatedEntity SHALL contain exactly one [1..1] @classCode="PRS" Person (CodeSystem: HL7RoleCode urn:oid:2.16.840.1.113883.5.111) (CONF:4537-33076).
Control	1..1
Binding	The codes SHALL be taken from RoleClassAssociative
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Fixed Value	PRS
34. Participant1.associatedEntity.templateId
Definition	When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
36. Participant1.associatedEntity.id
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
38. Participant1.associatedEntity.sdtcIdentifiedBy
Definition	Element AssociatedEntity.sdtcIdentifiedBy
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy
XML Format	In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`identifiedBy`.
40. Participant1.associatedEntity.code
Comments	This associatedEntity SHALL contain exactly one [1..1] code, which SHALL be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:4537-32985).
Control	1..1
Binding	The codes SHALL be taken from Personal And Legal Relationship Role Type
Type	http://hl7.org/cda/stds/core/StructureDefinition/CE
42. Participant1.associatedEntity.addr
Definition	Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc.
Short	Base for all types and resources
Comments	This associatedEntity SHOULD contain zero or more [0..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:4537-32979).
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address (AD.US.FIELDED))
Is Modifier	false
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) 81-7296: SHALL NOT have mixed content except for white space (CONF:81-7296). ()
44. Participant1.associatedEntity.telecom
Comments	This associatedEntity SHOULD contain zero or more [0..*] telecom (CONF:4537-32986).
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/TEL
46. Participant1.associatedEntity.associatedPerson
Comments	This associatedEntity SHALL contain exactly one [1..1] associatedPerson (CONF:4537-32980).
Control	1..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/Person
48. Participant1.associatedEntity.associatedPerson.classCode
Control	0..1
Binding	The codes SHALL be taken from EntityClassLivingSubject
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Fixed Value	PSN
50. Participant1.associatedEntity.associatedPerson.determinerCode
Control	0..1
Binding	The codes SHALL be taken from EntityDeterminer
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Fixed Value	INSTANCE
52. Participant1.associatedEntity.associatedPerson.templateId
Definition	When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
54. Participant1.associatedEntity.associatedPerson.name
Definition	A name for a person. A sequence of name parts, such as given name or family name, prefix, suffix, etc. Examples for person name values are "Jim Bob Walton, Jr.", "Adam Everyman", etc. A person name may be as simple as a character string or may consist of several person name parts, such as, "Jim", "Bob", "Walton", and "Jr.". PN differs from EN because the qualifier type cannot include LS (Legal Status).
Short	Base for all types and resources
Comments	This associatedPerson SHALL contain at least one [1..*] US Realm Person Name (PN.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.1.1) (CONF:4537-32987).
Control	1..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/PN(US Realm Person Name (PN.US.FIELDED))
Is Modifier	false
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) pn-no-ls: No PN name part may have a qualifier of LS. (`(delimiter \| family \| given \| prefix \| suffix).where(qualifier = 'LS').empty()`) 81-9371: The content of name SHALL be either a conformant Patient Name (PTN.US.FIELDED), or a string (CONF:81-9371). () 81-9372: The string SHALL NOT contain name parts (CONF:81-9372). ()
56. Participant1.associatedEntity.associatedPerson.sdtcAsPatientRelationship
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/CE
XML Format	In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`asPatientRelationship`.
58. Participant1.associatedEntity.scopingOrganization
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/Organization