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-10-02 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:

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.

This structure is derived from InfrastructureRoot

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PatientRole 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Base for all types and resources

Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
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)
... telecom 0..* TEL
... patient 0..1 Patient
... providerOrganization 0..1 Organization

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
PatientRole.classCode Base required RoleClassRelationshipFormal 📦2.0.0 THO v5.2
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PatientRole 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Base for all types and resources

Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
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
... @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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
PatientRole.nullFlavor Base required CDANullFlavor 📦2.0.1-sd This IG
PatientRole.typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd This IG
PatientRole.classCode Base required RoleClassRelationshipFormal 📦2.0.0 THO v5.2

Constraints

Id Grade Path(s) Description Expression
II-1 error PatientRole.typeId An II instance must have either a root or an nullFlavor. root.exists() or nullFlavor.exists()
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PatientRole 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Base for all types and resources

Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
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
... @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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
PatientRole.nullFlavor Base required CDANullFlavor 📦2.0.1-sd This IG
PatientRole.typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd This IG
PatientRole.classCode Base required RoleClassRelationshipFormal 📦2.0.0 THO v5.2

Constraints

Id Grade Path(s) Description Expression
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:

Differential View

This structure is derived from InfrastructureRoot

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PatientRole 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Base for all types and resources

Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
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)
... telecom 0..* TEL
... patient 0..1 Patient
... providerOrganization 0..1 Organization

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
PatientRole.classCode Base required RoleClassRelationshipFormal 📦2.0.0 THO v5.2

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PatientRole 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Base for all types and resources

Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
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
... @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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
PatientRole.nullFlavor Base required CDANullFlavor 📦2.0.1-sd This IG
PatientRole.typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd This IG
PatientRole.classCode Base required RoleClassRelationshipFormal 📦2.0.0 THO v5.2

Constraints

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

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PatientRole 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Base for all types and resources

Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
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
... @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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
PatientRole.nullFlavor Base required CDANullFlavor 📦2.0.1-sd This IG
PatientRole.typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd This IG
PatientRole.classCode Base required RoleClassRelationshipFormal 📦2.0.0 THO v5.2

Constraints

Id Grade Path(s) Description Expression
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:

 

Other representations of profile: CSV, Excel