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

Clinical Document Architecture
2.0.0-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.0-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: Guardian (CDA Class)

Official URL: http://hl7.org/cda/stds/core/StructureDefinition/Guardian				Version: 2.0.0-sd
Active as of 2024-10-25				Computable Name: Guardian

A patient's guardian is a person or organization in the role of guardian (Guardian class). The entity playing the role of guardian is a person (Person class) or organization (Organization class). The entity scoping the role is the patient (Patient class).

Where a guardian is not explicitly stated, the value should default to local business practice (e.g. the patient makes their own health care decisions unless incapacitated in which case healthcare decisions are made by the patient's spouse).

Usage:

Use this Logical Model Profile: Patient (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	Flags	Card.	Type	Description & Constraints
Guardian	C	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) guardian-choice: guardianPerson and guardianOrganization are mutually exclusive (one must be present)
@classCode		0..1	cs	Binding: RoleClassAgent (required) Fixed Value: GUARD
id		0..*	II
sdtcIdentifiedBy		0..*	IdentifiedBy	XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc)
code		0..1	CE	Binding: CDARoleCode (example)
addr		0..*	AD
telecom		0..*	TEL
(Choice of one)		1..1
guardianPerson		0..1	Person
guardianOrganization		0..1	Organization
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet / Code	URI
Guardian.classCode	required	Fixed Value: GUARD `http://terminology.hl7.org/ValueSet/v3-RoleClassAgent`
Guardian.code	example	CDARoleCode `http://hl7.org/cda/stds/core/ValueSet/CDARoleCode` from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
guardian-choice	error	Guardian	guardianPerson and guardianOrganization are mutually exclusive (one must be present) : (guardianPerson \| guardianOrganization).count() = 1

Name	Flags	Card.	Type	Description & Constraints
Guardian	C	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) guardian-choice: guardianPerson and guardianOrganization are mutually exclusive (one must be present)
@classCode		0..1	cs	Binding: RoleClassAgent (required) Fixed Value: GUARD
id		0..*	II
sdtcIdentifiedBy		0..*	IdentifiedBy	XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc)
code		0..1	CE	Binding: CDARoleCode (example)
addr		0..*	AD
telecom		0..*	TEL
(Choice of one)		1..1
guardianPerson		0..1	Person
guardianOrganization		0..1	Organization
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Guardian.classCode	required	Fixed Value: GUARD `http://terminology.hl7.org/ValueSet/v3-RoleClassAgent`
Guardian.code	example	CDARoleCode `http://hl7.org/cda/stds/core/ValueSet/CDARoleCode` from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
guardian-choice	error	Guardian	guardianPerson and guardianOrganization are mutually exclusive (one must be present) : (guardianPerson \| guardianOrganization).count() = 1

Name	Flags	Card.	Type	Description & Constraints
Guardian	C	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) guardian-choice: guardianPerson and guardianOrganization are mutually exclusive (one must be present)
@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: RoleClassAgent (required) Fixed Value: GUARD
id		0..*	II
sdtcIdentifiedBy		0..*	IdentifiedBy	XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc)
code		0..1	CE	Binding: CDARoleCode (example)
addr		0..*	AD
telecom		0..*	TEL
(Choice of one)		1..1
guardianPerson		0..1	Person
guardianOrganization		0..1	Organization
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Guardian.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` from this IG
Guardian.typeId.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` from this IG
Guardian.classCode	required	Fixed Value: GUARD `http://terminology.hl7.org/ValueSet/v3-RoleClassAgent`
Guardian.code	example	CDARoleCode `http://hl7.org/cda/stds/core/ValueSet/CDARoleCode` from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
guardian-choice	error	Guardian	guardianPerson and guardianOrganization are mutually exclusive (one must be present) : (guardianPerson \| guardianOrganization).count() = 1

This structure is derived from InfrastructureRoot

Summary

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	Flags	Card.	Type	Description & Constraints
Guardian	C	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) guardian-choice: guardianPerson and guardianOrganization are mutually exclusive (one must be present)
@classCode		0..1	cs	Binding: RoleClassAgent (required) Fixed Value: GUARD
id		0..*	II
sdtcIdentifiedBy		0..*	IdentifiedBy	XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc)
code		0..1	CE	Binding: CDARoleCode (example)
addr		0..*	AD
telecom		0..*	TEL
(Choice of one)		1..1
guardianPerson		0..1	Person
guardianOrganization		0..1	Organization
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet / Code	URI
Guardian.classCode	required	Fixed Value: GUARD `http://terminology.hl7.org/ValueSet/v3-RoleClassAgent`
Guardian.code	example	CDARoleCode `http://hl7.org/cda/stds/core/ValueSet/CDARoleCode` from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
guardian-choice	error	Guardian	guardianPerson and guardianOrganization are mutually exclusive (one must be present) : (guardianPerson \| guardianOrganization).count() = 1

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Guardian	C	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) guardian-choice: guardianPerson and guardianOrganization are mutually exclusive (one must be present)
@classCode		0..1	cs	Binding: RoleClassAgent (required) Fixed Value: GUARD
id		0..*	II
sdtcIdentifiedBy		0..*	IdentifiedBy	XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc)
code		0..1	CE	Binding: CDARoleCode (example)
addr		0..*	AD
telecom		0..*	TEL
(Choice of one)		1..1
guardianPerson		0..1	Person
guardianOrganization		0..1	Organization
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Guardian.classCode	required	Fixed Value: GUARD `http://terminology.hl7.org/ValueSet/v3-RoleClassAgent`
Guardian.code	example	CDARoleCode `http://hl7.org/cda/stds/core/ValueSet/CDARoleCode` from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
guardian-choice	error	Guardian	guardianPerson and guardianOrganization are mutually exclusive (one must be present) : (guardianPerson \| guardianOrganization).count() = 1

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Guardian	C	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) guardian-choice: guardianPerson and guardianOrganization are mutually exclusive (one must be present)
@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: RoleClassAgent (required) Fixed Value: GUARD
id		0..*	II
sdtcIdentifiedBy		0..*	IdentifiedBy	XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc)
code		0..1	CE	Binding: CDARoleCode (example)
addr		0..*	AD
telecom		0..*	TEL
(Choice of one)		1..1
guardianPerson		0..1	Person
guardianOrganization		0..1	Organization
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Guardian.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` from this IG
Guardian.typeId.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` from this IG
Guardian.classCode	required	Fixed Value: GUARD `http://terminology.hl7.org/ValueSet/v3-RoleClassAgent`
Guardian.code	example	CDARoleCode `http://hl7.org/cda/stds/core/ValueSet/CDARoleCode` from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
guardian-choice	error	Guardian	guardianPerson and guardianOrganization are mutually exclusive (one must be present) : (guardianPerson \| guardianOrganization).count() = 1

This structure is derived from InfrastructureRoot

Summary

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.0-sd based on FHIR 5.0.0. Generated 2024-10-25
Links: Table of Contents | QA Report | Version History external | | Propose a change