PatientRole (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: PatientRole (CDA Class)

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

A recordTarget is represented as a relationship between a person and an organization, where the person is in a patient role (PatientRole class). The entity playing the role is a patient (Patient class). The entity scoping the role is an organization (Organization class). A patient is uniquely identified via the PatientRole.id attribute.

Usages:

Use this Logical Model: RecordTarget (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	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
PatientRole	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)
@classCode	0..1	cs	Binding: RoleClassRelationshipFormal (required) Fixed Value: PAT
id	1..*	II
sdtcIdentifiedBy	0..*	IdentifiedBy	XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc)
addr	0..*	AD
telecom	0..*	TEL
patient	0..1	Patient
providerOrganization	0..1	Organization
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet / Code	URI
PatientRole.classCode	required	Fixed Value: PAT `http://terminology.hl7.org/ValueSet/v3-RoleClassRelationshipFormal`

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
PatientRole		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)
@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: RoleClassRelationshipFormal (required) Fixed Value: PAT
id		1..*	II
sdtcIdentifiedBy		0..*	IdentifiedBy	XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc)
addr		0..*	AD
telecom		0..*	TEL
patient		0..1	Patient
providerOrganization		0..1	Organization
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
PatientRole.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` From this IG
PatientRole.typeId.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` From this IG
PatientRole.classCode	required	Fixed Value: PAT `http://terminology.hl7.org/ValueSet/v3-RoleClassRelationshipFormal`

Constraints

Id	Grade	Path(s)	Details	Requirements
II-1	error	PatientRole.typeId	An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists()

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
PatientRole		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)
@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: RoleClassRelationshipFormal (required) Fixed Value: PAT
id		1..*	II
sdtcIdentifiedBy		0..*	IdentifiedBy	XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc)
addr		0..*	AD
telecom		0..*	TEL
patient		0..1	Patient
providerOrganization		0..1	Organization
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
PatientRole.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` From this IG
PatientRole.typeId.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` From this IG
PatientRole.classCode	required	Fixed Value: PAT `http://terminology.hl7.org/ValueSet/v3-RoleClassRelationshipFormal`

Constraints

Id	Grade	Path(s)	Details	Requirements
II-1	error	PatientRole.typeId	An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists()

This structure is derived from InfrastructureRoot

Summary

Mandatory: 0 element(1 nested mandatory element)
Fixed: 1 element

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	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
PatientRole	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)
@classCode	0..1	cs	Binding: RoleClassRelationshipFormal (required) Fixed Value: PAT
id	1..*	II
sdtcIdentifiedBy	0..*	IdentifiedBy	XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc)
addr	0..*	AD
telecom	0..*	TEL
patient	0..1	Patient
providerOrganization	0..1	Organization
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet / Code	URI
PatientRole.classCode	required	Fixed Value: PAT `http://terminology.hl7.org/ValueSet/v3-RoleClassRelationshipFormal`

Key Elements View

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
PatientRole		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)
@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: RoleClassRelationshipFormal (required) Fixed Value: PAT
id		1..*	II
sdtcIdentifiedBy		0..*	IdentifiedBy	XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc)
addr		0..*	AD
telecom		0..*	TEL
patient		0..1	Patient
providerOrganization		0..1	Organization
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
PatientRole.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` From this IG
PatientRole.typeId.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` From this IG
PatientRole.classCode	required	Fixed Value: PAT `http://terminology.hl7.org/ValueSet/v3-RoleClassRelationshipFormal`

Constraints

Id	Grade	Path(s)	Details	Requirements
II-1	error	PatientRole.typeId	An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
PatientRole		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)
@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: RoleClassRelationshipFormal (required) Fixed Value: PAT
id		1..*	II
sdtcIdentifiedBy		0..*	IdentifiedBy	XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc)
addr		0..*	AD
telecom		0..*	TEL
patient		0..1	Patient
providerOrganization		0..1	Organization
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
PatientRole.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` From this IG
PatientRole.typeId.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` From this IG
PatientRole.classCode	required	Fixed Value: PAT `http://terminology.hl7.org/ValueSet/v3-RoleClassRelationshipFormal`

Constraints

Id	Grade	Path(s)	Details	Requirements
II-1	error	PatientRole.typeId	An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists()

This structure is derived from InfrastructureRoot

Summary

Mandatory: 0 element(1 nested mandatory element)
Fixed: 1 element

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