HL7.CDA.UV.CORE\PatientRole (CDA Class) - Definitions

Clinical Document Architecture V2.0.1
2.1.0-draft1 - 1st Draft

This page is part of the CDA: Clinical Document Architecture (v2.1.0-draft1: CDA 2.1 Draft) based on FHIR v5.0.0. . For a full list of available versions, see the Directory of published versions

Logical Model: CDAR2.PatientRole - Detailed Descriptions

Active as of 2023-01-16

Definitions for the PatientRole 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.

1. PatientRole
Control	1..1
XML Representation	In the XML format, this property has the namespace `urn:hl7-org:v3`.
2. PatientRole.classCode
Control	1..1
Binding	The codes SHALL be taken from RoleClassRelationshipFormal
Type	code
XML Representation	In the XML format, this property is represented as an attribute.
Default Value	PAT
Fixed Value	PAT
3. PatientRole.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/fhir/cda/StructureDefinition/II
4. PatientRole.id
Control	1..*
Type	http://hl7.org/fhir/cda/StructureDefinition/II
5. PatientRole.sdtcIdentifiedBy
Control	0..*
Type	http://hl7.org/fhir/cda/StructureDefinition/IdentifiedBy
XML Representation	In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name `identifiedBy`.
6. PatientRole.addr
Control	0..*
Type	http://hl7.org/fhir/cda/StructureDefinition/AD
7. PatientRole.telecom
Control	0..*
Type	http://hl7.org/fhir/cda/StructureDefinition/TEL
8. PatientRole.patient
Control	0..1
Type	http://hl7.org/fhir/cda/StructureDefinition/Patient
9. PatientRole.providerOrganization
Control	0..1
Type	http://hl7.org/fhir/cda/StructureDefinition/Organization

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

1. PatientRole
Definition	Base definition for all types defined in FHIR type system.
Control	10..1*
XML Representation	In the XML format, this property has the namespace `urn:hl7-org:v3`.
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
2. PatientRole.classCode
Control	1..1
Binding	The codes SHALL be taken from RoleClassRelationshipFormal
Type	code
XML Representation	In the XML format, this property is represented as an attribute.
Default Value	PAT
Fixed Value	PAT
3. PatientRole.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/fhir/cda/StructureDefinition/II
4. PatientRole.id
Control	1..*
Type	http://hl7.org/fhir/cda/StructureDefinition/II
5. PatientRole.sdtcIdentifiedBy
Control	0..*
Type	http://hl7.org/fhir/cda/StructureDefinition/IdentifiedBy
XML Representation	In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name `identifiedBy`.
6. PatientRole.addr
Control	0..*
Type	http://hl7.org/fhir/cda/StructureDefinition/AD
7. PatientRole.telecom
Control	0..*
Type	http://hl7.org/fhir/cda/StructureDefinition/TEL
8. PatientRole.patient
Control	0..1
Type	http://hl7.org/fhir/cda/StructureDefinition/Patient
9. PatientRole.providerOrganization
Control	0..1
Type	http://hl7.org/fhir/cda/StructureDefinition/Organization

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

1. PatientRole
Definition	Base definition for all types defined in FHIR type system.
Control	1..1
XML Representation	In the XML format, this property has the namespace `urn:hl7-org:v3`.
2. PatientRole.classCode
Control	1..1
Binding	The codes SHALL be taken from RoleClassRelationshipFormal
Type	code
XML Representation	In the XML format, this property is represented as an attribute.
Default Value	PAT
Fixed Value	PAT
3. PatientRole.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/fhir/cda/StructureDefinition/II
4. PatientRole.id
Control	1..*
Type	http://hl7.org/fhir/cda/StructureDefinition/II
5. PatientRole.sdtcIdentifiedBy
Control	0..*
Type	http://hl7.org/fhir/cda/StructureDefinition/IdentifiedBy
XML Representation	In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name `identifiedBy`.
6. PatientRole.addr
Control	0..*
Type	http://hl7.org/fhir/cda/StructureDefinition/AD
7. PatientRole.telecom
Control	0..*
Type	http://hl7.org/fhir/cda/StructureDefinition/TEL
8. PatientRole.patient
Control	0..1
Type	http://hl7.org/fhir/cda/StructureDefinition/Patient
9. PatientRole.providerOrganization
Control	0..1
Type	http://hl7.org/fhir/cda/StructureDefinition/Organization

IG © 2019+ Health Level 7. Package hl7.cda.uv.core#2.1.0-draft1 based on FHIR 5.0.0-snapshot3. Generated 2023-01-16
Links: Table of Contents | QA Report | Version History external | | Propose a change