PatientRole (CDA Class) - Clinical Document Architecture v2.0.0-sd

Clinical Document Architecture
2.0.0-sd - release

This page is part of the CDA: Clinical Document Architecture (v2.0.0-sd: CDA2 - Informative) generated with FHIR (HL7® FHIR® Standard) v5.0.0. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Logical Model: PatientRole (CDA Class)

Official URL: http://hl7.org/cda/stds/core/StructureDefinition/PatientRole				Version: 2.0.0-sd
Active as of 2024-05-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.

Usage:

Use this Logical Model Profile: RecordTarget (CDA Class)

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
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	Card.	Type	Description & Constraints
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

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

Name	Card.	Type	Description & Constraints
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	0..1	II
@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`

This structure is derived from InfrastructureRoot

Differential View

This structure is derived from InfrastructureRoot

Name	Card.	Type	Description & Constraints
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	Card.	Type	Description & Constraints
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

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

Snapshot View

Name	Card.	Type	Description & Constraints
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	0..1	II
@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`

This structure is derived from InfrastructureRoot

Other representations of profile: CSV, Excel

IG © 2019+ Health Level 7. Package hl7.cda.uv.core#2.0.0-sd based on FHIR 5.0.0. Generated 2024-05-17
Links: Table of Contents | QA Report | Version History external | | Propose a change