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

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

A LivingSubject as a recipient of health care services from a healthcare provider. The patient is the player; the provider is the scoper.

Usage:

Use this Logical Model Profile: PatientRole (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
Patient	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: EntityClassLivingSubject (required) Fixed Value: PSN
@determinerCode	0..1	cs	Binding: EntityDeterminer (required) Fixed Value: INSTANCE
id	0..1	II
name	0..*	PN
sdtcDesc	0..1	ED	XML Namespace: urn:hl7-org:sdtc XML: desc (urn:hl7-org:sdtc)
administrativeGenderCode	0..1	CE	Binding: AdministrativeGender (example)
birthTime	0..1	TS
sdtcDeceasedInd	0..1	BL	XML Namespace: urn:hl7-org:sdtc XML: deceasedInd (urn:hl7-org:sdtc)
sdtcDeceasedTime	0..1	TS	XML Namespace: urn:hl7-org:sdtc XML: deceasedTime (urn:hl7-org:sdtc)
sdtcMultipleBirthInd	0..1	BL	XML Namespace: urn:hl7-org:sdtc XML: multipleBirthInd (urn:hl7-org:sdtc)
sdtcMultipleBirthOrderNumber	0..1	INT_POS	XML Namespace: urn:hl7-org:sdtc XML: multipleBirthOrderNumber (urn:hl7-org:sdtc)
maritalStatusCode	0..1	CE	Binding: MaritalStatus (example)
religiousAffiliationCode	0..1	CE	Binding: ReligiousAffiliation (example)
raceCode	0..1	CE	Binding: Race (example)
sdtcRaceCode	0..*	CE	XML Namespace: urn:hl7-org:sdtc XML: raceCode (urn:hl7-org:sdtc) Binding: Race (example)
ethnicGroupCode	0..1	CE	Binding: Ethnicity (example)
sdtcEthnicGroupCode	0..*	CE	XML Namespace: urn:hl7-org:sdtc XML: ethnicGroupCode (urn:hl7-org:sdtc) Binding: Ethnicity (example)
guardian	0..*	Guardian
birthplace	0..1	Birthplace
languageCommunication	0..*	LanguageCommunication
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet / Code	URI
Patient.classCode	required	Fixed Value: PSN `http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject`
Patient.determinerCode	required	Fixed Value: INSTANCE `http://terminology.hl7.org/ValueSet/v3-EntityDeterminer`
Patient.administrativeGenderCode	example	AdministrativeGender `http://terminology.hl7.org/ValueSet/v3-AdministrativeGender`
Patient.maritalStatusCode	example	MaritalStatus `http://terminology.hl7.org/ValueSet/v3-MaritalStatus`
Patient.religiousAffiliationCode	example	ReligiousAffiliation `http://terminology.hl7.org/ValueSet/v3-ReligiousAffiliation`
Patient.raceCode	example	Race `http://terminology.hl7.org/ValueSet/v3-Race`
Patient.sdtcRaceCode	example	Race `http://terminology.hl7.org/ValueSet/v3-Race`
Patient.ethnicGroupCode	example	Ethnicity `http://terminology.hl7.org/ValueSet/v3-Ethnicity`
Patient.sdtcEthnicGroupCode	example	Ethnicity `http://terminology.hl7.org/ValueSet/v3-Ethnicity`

Name	Card.	Type	Description & Constraints
Patient	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: EntityClassLivingSubject (required) Fixed Value: PSN
@determinerCode	0..1	cs	Binding: EntityDeterminer (required) Fixed Value: INSTANCE
id	0..1	II
name	0..*	PN
sdtcDesc	0..1	ED	XML Namespace: urn:hl7-org:sdtc XML: desc (urn:hl7-org:sdtc)
administrativeGenderCode	0..1	CE	Binding: AdministrativeGender (example)
birthTime	0..1	TS
sdtcDeceasedInd	0..1	BL	XML Namespace: urn:hl7-org:sdtc XML: deceasedInd (urn:hl7-org:sdtc)
sdtcDeceasedTime	0..1	TS	XML Namespace: urn:hl7-org:sdtc XML: deceasedTime (urn:hl7-org:sdtc)
sdtcMultipleBirthInd	0..1	BL	XML Namespace: urn:hl7-org:sdtc XML: multipleBirthInd (urn:hl7-org:sdtc)
sdtcMultipleBirthOrderNumber	0..1	INT_POS	XML Namespace: urn:hl7-org:sdtc XML: multipleBirthOrderNumber (urn:hl7-org:sdtc)
maritalStatusCode	0..1	CE	Binding: MaritalStatus (example)
religiousAffiliationCode	0..1	CE	Binding: ReligiousAffiliation (example)
raceCode	0..1	CE	Binding: Race (example)
sdtcRaceCode	0..*	CE	XML Namespace: urn:hl7-org:sdtc XML: raceCode (urn:hl7-org:sdtc) Binding: Race (example)
ethnicGroupCode	0..1	CE	Binding: Ethnicity (example)
sdtcEthnicGroupCode	0..*	CE	XML Namespace: urn:hl7-org:sdtc XML: ethnicGroupCode (urn:hl7-org:sdtc) Binding: Ethnicity (example)
guardian	0..*	Guardian
birthplace	0..1	Birthplace
languageCommunication	0..*	LanguageCommunication
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Patient.classCode	required	Fixed Value: PSN `http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject`
Patient.determinerCode	required	Fixed Value: INSTANCE `http://terminology.hl7.org/ValueSet/v3-EntityDeterminer`
Patient.administrativeGenderCode	example	AdministrativeGender `http://terminology.hl7.org/ValueSet/v3-AdministrativeGender`
Patient.maritalStatusCode	example	MaritalStatus `http://terminology.hl7.org/ValueSet/v3-MaritalStatus`
Patient.religiousAffiliationCode	example	ReligiousAffiliation `http://terminology.hl7.org/ValueSet/v3-ReligiousAffiliation`
Patient.raceCode	example	Race `http://terminology.hl7.org/ValueSet/v3-Race`
Patient.sdtcRaceCode	example	Race `http://terminology.hl7.org/ValueSet/v3-Race`
Patient.ethnicGroupCode	example	Ethnicity `http://terminology.hl7.org/ValueSet/v3-Ethnicity`
Patient.sdtcEthnicGroupCode	example	Ethnicity `http://terminology.hl7.org/ValueSet/v3-Ethnicity`

Name	Card.	Type	Description & Constraints
Patient	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: EntityClassLivingSubject (required) Fixed Value: PSN
@determinerCode	0..1	cs	Binding: EntityDeterminer (required) Fixed Value: INSTANCE
id	0..1	II
name	0..*	PN
sdtcDesc	0..1	ED	XML Namespace: urn:hl7-org:sdtc XML: desc (urn:hl7-org:sdtc)
administrativeGenderCode	0..1	CE	Binding: AdministrativeGender (example)
birthTime	0..1	TS
sdtcDeceasedInd	0..1	BL	XML Namespace: urn:hl7-org:sdtc XML: deceasedInd (urn:hl7-org:sdtc)
sdtcDeceasedTime	0..1	TS	XML Namespace: urn:hl7-org:sdtc XML: deceasedTime (urn:hl7-org:sdtc)
sdtcMultipleBirthInd	0..1	BL	XML Namespace: urn:hl7-org:sdtc XML: multipleBirthInd (urn:hl7-org:sdtc)
sdtcMultipleBirthOrderNumber	0..1	INT_POS	XML Namespace: urn:hl7-org:sdtc XML: multipleBirthOrderNumber (urn:hl7-org:sdtc)
maritalStatusCode	0..1	CE	Binding: MaritalStatus (example)
religiousAffiliationCode	0..1	CE	Binding: ReligiousAffiliation (example)
raceCode	0..1	CE	Binding: Race (example)
sdtcRaceCode	0..*	CE	XML Namespace: urn:hl7-org:sdtc XML: raceCode (urn:hl7-org:sdtc) Binding: Race (example)
ethnicGroupCode	0..1	CE	Binding: Ethnicity (example)
sdtcEthnicGroupCode	0..*	CE	XML Namespace: urn:hl7-org:sdtc XML: ethnicGroupCode (urn:hl7-org:sdtc) Binding: Ethnicity (example)
guardian	0..*	Guardian
birthplace	0..1	Birthplace
languageCommunication	0..*	LanguageCommunication
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Patient.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` from this IG
Patient.typeId.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` from this IG
Patient.classCode	required	Fixed Value: PSN `http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject`
Patient.determinerCode	required	Fixed Value: INSTANCE `http://terminology.hl7.org/ValueSet/v3-EntityDeterminer`
Patient.administrativeGenderCode	example	AdministrativeGender `http://terminology.hl7.org/ValueSet/v3-AdministrativeGender`
Patient.maritalStatusCode	example	MaritalStatus `http://terminology.hl7.org/ValueSet/v3-MaritalStatus`
Patient.religiousAffiliationCode	example	ReligiousAffiliation `http://terminology.hl7.org/ValueSet/v3-ReligiousAffiliation`
Patient.raceCode	example	Race `http://terminology.hl7.org/ValueSet/v3-Race`
Patient.sdtcRaceCode	example	Race `http://terminology.hl7.org/ValueSet/v3-Race`
Patient.ethnicGroupCode	example	Ethnicity `http://terminology.hl7.org/ValueSet/v3-Ethnicity`
Patient.sdtcEthnicGroupCode	example	Ethnicity `http://terminology.hl7.org/ValueSet/v3-Ethnicity`

This structure is derived from InfrastructureRoot

Summary

Fixed: 2 elements

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
Patient	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: EntityClassLivingSubject (required) Fixed Value: PSN
@determinerCode	0..1	cs	Binding: EntityDeterminer (required) Fixed Value: INSTANCE
id	0..1	II
name	0..*	PN
sdtcDesc	0..1	ED	XML Namespace: urn:hl7-org:sdtc XML: desc (urn:hl7-org:sdtc)
administrativeGenderCode	0..1	CE	Binding: AdministrativeGender (example)
birthTime	0..1	TS
sdtcDeceasedInd	0..1	BL	XML Namespace: urn:hl7-org:sdtc XML: deceasedInd (urn:hl7-org:sdtc)
sdtcDeceasedTime	0..1	TS	XML Namespace: urn:hl7-org:sdtc XML: deceasedTime (urn:hl7-org:sdtc)
sdtcMultipleBirthInd	0..1	BL	XML Namespace: urn:hl7-org:sdtc XML: multipleBirthInd (urn:hl7-org:sdtc)
sdtcMultipleBirthOrderNumber	0..1	INT_POS	XML Namespace: urn:hl7-org:sdtc XML: multipleBirthOrderNumber (urn:hl7-org:sdtc)
maritalStatusCode	0..1	CE	Binding: MaritalStatus (example)
religiousAffiliationCode	0..1	CE	Binding: ReligiousAffiliation (example)
raceCode	0..1	CE	Binding: Race (example)
sdtcRaceCode	0..*	CE	XML Namespace: urn:hl7-org:sdtc XML: raceCode (urn:hl7-org:sdtc) Binding: Race (example)
ethnicGroupCode	0..1	CE	Binding: Ethnicity (example)
sdtcEthnicGroupCode	0..*	CE	XML Namespace: urn:hl7-org:sdtc XML: ethnicGroupCode (urn:hl7-org:sdtc) Binding: Ethnicity (example)
guardian	0..*	Guardian
birthplace	0..1	Birthplace
languageCommunication	0..*	LanguageCommunication
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet / Code	URI
Patient.classCode	required	Fixed Value: PSN `http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject`
Patient.determinerCode	required	Fixed Value: INSTANCE `http://terminology.hl7.org/ValueSet/v3-EntityDeterminer`
Patient.administrativeGenderCode	example	AdministrativeGender `http://terminology.hl7.org/ValueSet/v3-AdministrativeGender`
Patient.maritalStatusCode	example	MaritalStatus `http://terminology.hl7.org/ValueSet/v3-MaritalStatus`
Patient.religiousAffiliationCode	example	ReligiousAffiliation `http://terminology.hl7.org/ValueSet/v3-ReligiousAffiliation`
Patient.raceCode	example	Race `http://terminology.hl7.org/ValueSet/v3-Race`
Patient.sdtcRaceCode	example	Race `http://terminology.hl7.org/ValueSet/v3-Race`
Patient.ethnicGroupCode	example	Ethnicity `http://terminology.hl7.org/ValueSet/v3-Ethnicity`
Patient.sdtcEthnicGroupCode	example	Ethnicity `http://terminology.hl7.org/ValueSet/v3-Ethnicity`

Key Elements View

Name	Card.	Type	Description & Constraints
Patient	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: EntityClassLivingSubject (required) Fixed Value: PSN
@determinerCode	0..1	cs	Binding: EntityDeterminer (required) Fixed Value: INSTANCE
id	0..1	II
name	0..*	PN
sdtcDesc	0..1	ED	XML Namespace: urn:hl7-org:sdtc XML: desc (urn:hl7-org:sdtc)
administrativeGenderCode	0..1	CE	Binding: AdministrativeGender (example)
birthTime	0..1	TS
sdtcDeceasedInd	0..1	BL	XML Namespace: urn:hl7-org:sdtc XML: deceasedInd (urn:hl7-org:sdtc)
sdtcDeceasedTime	0..1	TS	XML Namespace: urn:hl7-org:sdtc XML: deceasedTime (urn:hl7-org:sdtc)
sdtcMultipleBirthInd	0..1	BL	XML Namespace: urn:hl7-org:sdtc XML: multipleBirthInd (urn:hl7-org:sdtc)
sdtcMultipleBirthOrderNumber	0..1	INT_POS	XML Namespace: urn:hl7-org:sdtc XML: multipleBirthOrderNumber (urn:hl7-org:sdtc)
maritalStatusCode	0..1	CE	Binding: MaritalStatus (example)
religiousAffiliationCode	0..1	CE	Binding: ReligiousAffiliation (example)
raceCode	0..1	CE	Binding: Race (example)
sdtcRaceCode	0..*	CE	XML Namespace: urn:hl7-org:sdtc XML: raceCode (urn:hl7-org:sdtc) Binding: Race (example)
ethnicGroupCode	0..1	CE	Binding: Ethnicity (example)
sdtcEthnicGroupCode	0..*	CE	XML Namespace: urn:hl7-org:sdtc XML: ethnicGroupCode (urn:hl7-org:sdtc) Binding: Ethnicity (example)
guardian	0..*	Guardian
birthplace	0..1	Birthplace
languageCommunication	0..*	LanguageCommunication
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Patient.classCode	required	Fixed Value: PSN `http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject`
Patient.determinerCode	required	Fixed Value: INSTANCE `http://terminology.hl7.org/ValueSet/v3-EntityDeterminer`
Patient.administrativeGenderCode	example	AdministrativeGender `http://terminology.hl7.org/ValueSet/v3-AdministrativeGender`
Patient.maritalStatusCode	example	MaritalStatus `http://terminology.hl7.org/ValueSet/v3-MaritalStatus`
Patient.religiousAffiliationCode	example	ReligiousAffiliation `http://terminology.hl7.org/ValueSet/v3-ReligiousAffiliation`
Patient.raceCode	example	Race `http://terminology.hl7.org/ValueSet/v3-Race`
Patient.sdtcRaceCode	example	Race `http://terminology.hl7.org/ValueSet/v3-Race`
Patient.ethnicGroupCode	example	Ethnicity `http://terminology.hl7.org/ValueSet/v3-Ethnicity`
Patient.sdtcEthnicGroupCode	example	Ethnicity `http://terminology.hl7.org/ValueSet/v3-Ethnicity`

Snapshot View

Name	Card.	Type	Description & Constraints
Patient	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: EntityClassLivingSubject (required) Fixed Value: PSN
@determinerCode	0..1	cs	Binding: EntityDeterminer (required) Fixed Value: INSTANCE
id	0..1	II
name	0..*	PN
sdtcDesc	0..1	ED	XML Namespace: urn:hl7-org:sdtc XML: desc (urn:hl7-org:sdtc)
administrativeGenderCode	0..1	CE	Binding: AdministrativeGender (example)
birthTime	0..1	TS
sdtcDeceasedInd	0..1	BL	XML Namespace: urn:hl7-org:sdtc XML: deceasedInd (urn:hl7-org:sdtc)
sdtcDeceasedTime	0..1	TS	XML Namespace: urn:hl7-org:sdtc XML: deceasedTime (urn:hl7-org:sdtc)
sdtcMultipleBirthInd	0..1	BL	XML Namespace: urn:hl7-org:sdtc XML: multipleBirthInd (urn:hl7-org:sdtc)
sdtcMultipleBirthOrderNumber	0..1	INT_POS	XML Namespace: urn:hl7-org:sdtc XML: multipleBirthOrderNumber (urn:hl7-org:sdtc)
maritalStatusCode	0..1	CE	Binding: MaritalStatus (example)
religiousAffiliationCode	0..1	CE	Binding: ReligiousAffiliation (example)
raceCode	0..1	CE	Binding: Race (example)
sdtcRaceCode	0..*	CE	XML Namespace: urn:hl7-org:sdtc XML: raceCode (urn:hl7-org:sdtc) Binding: Race (example)
ethnicGroupCode	0..1	CE	Binding: Ethnicity (example)
sdtcEthnicGroupCode	0..*	CE	XML Namespace: urn:hl7-org:sdtc XML: ethnicGroupCode (urn:hl7-org:sdtc) Binding: Ethnicity (example)
guardian	0..*	Guardian
birthplace	0..1	Birthplace
languageCommunication	0..*	LanguageCommunication
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Patient.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` from this IG
Patient.typeId.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` from this IG
Patient.classCode	required	Fixed Value: PSN `http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject`
Patient.determinerCode	required	Fixed Value: INSTANCE `http://terminology.hl7.org/ValueSet/v3-EntityDeterminer`
Patient.administrativeGenderCode	example	AdministrativeGender `http://terminology.hl7.org/ValueSet/v3-AdministrativeGender`
Patient.maritalStatusCode	example	MaritalStatus `http://terminology.hl7.org/ValueSet/v3-MaritalStatus`
Patient.religiousAffiliationCode	example	ReligiousAffiliation `http://terminology.hl7.org/ValueSet/v3-ReligiousAffiliation`
Patient.raceCode	example	Race `http://terminology.hl7.org/ValueSet/v3-Race`
Patient.sdtcRaceCode	example	Race `http://terminology.hl7.org/ValueSet/v3-Race`
Patient.ethnicGroupCode	example	Ethnicity `http://terminology.hl7.org/ValueSet/v3-Ethnicity`
Patient.sdtcEthnicGroupCode	example	Ethnicity `http://terminology.hl7.org/ValueSet/v3-Ethnicity`

This structure is derived from InfrastructureRoot

Summary

Fixed: 2 elements

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