Patient (CDA Class) - Clinical Document Architecture v2.0.1

Clinical Document Architecture
2.0.1 - active

Clinical Document Architecture, published by Health Level 7. This is not an authorized publication; it is the continuous build for version 2.0.1). This version is based on the current content of https://github.com/HL7/CDA-core-2.0/ 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.1
Active as of 2023-10-03				Computable Name: CDAR2.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 Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

Differential Table
Key Elements Table
Snapshot Table
Statistics/References
All

This structure is derived from Base

Name	Card.	Type	Description & Constraints
Patient	1..1	Base	XML Namespace: urn:hl7-org:v3 Base for all types and resources
@classCode	0..1	cs	Binding: EntityClassLivingSubject (required) Fixed Value: PSN
@determinerCode	0..1	cs	Binding: EntityDeterminer (required) Fixed Value: INSTANCE
templateId	0..*	II
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 (extensible)
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 (extensible)
religiousAffiliationCode	0..1	CE	Binding: ReligiousAffiliation (extensible)
raceCode	0..1	CE	Binding: Race (extensible)
sdtcRaceCode	0..*	CE	XML Namespace: urn:hl7-org:sdtc XML: raceCode (urn:hl7-org:sdtc) Binding: Race (extensible)
ethnicGroupCode	0..1	CE	Binding: Ethnicity (extensible)
sdtcEthnicGroupCode	0..*	CE	XML Namespace: urn:hl7-org:sdtc XML: ethnicGroupCode (urn:hl7-org:sdtc) Binding: Ethnicity (extensible)
guardian	0..*	Guardian
birthplace	0..1	Birthplace
languageCommunication	0..*	LanguageCommunication
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet / Code
Patient.classCode	required	Fixed Value: PSN
Patient.determinerCode	required	Fixed Value: INSTANCE
Patient.administrativeGenderCode	extensible	AdministrativeGender
Patient.maritalStatusCode	extensible	MaritalStatus
Patient.religiousAffiliationCode	extensible	ReligiousAffiliation
Patient.raceCode	extensible	Race
Patient.sdtcRaceCode	extensible	Race
Patient.ethnicGroupCode	extensible	Ethnicity
Patient.sdtcEthnicGroupCode	extensible	Ethnicity

Name	Card.	Type	Description & Constraints
Patient	1..1	Base	XML Namespace: urn:hl7-org:v3 Base for all types and resources
@classCode	0..1	cs	Binding: EntityClassLivingSubject (required) Fixed Value: PSN
@determinerCode	0..1	cs	Binding: EntityDeterminer (required) Fixed Value: INSTANCE
templateId	0..*	II
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 (extensible)
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 (extensible)
religiousAffiliationCode	0..1	CE	Binding: ReligiousAffiliation (extensible)
raceCode	0..1	CE	Binding: Race (extensible)
sdtcRaceCode	0..*	CE	XML Namespace: urn:hl7-org:sdtc XML: raceCode (urn:hl7-org:sdtc) Binding: Race (extensible)
ethnicGroupCode	0..1	CE	Binding: Ethnicity (extensible)
sdtcEthnicGroupCode	0..*	CE	XML Namespace: urn:hl7-org:sdtc XML: ethnicGroupCode (urn:hl7-org:sdtc) Binding: Ethnicity (extensible)
guardian	0..*	Guardian
birthplace	0..1	Birthplace
languageCommunication	0..*	LanguageCommunication
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code
Patient.classCode	required	Fixed Value: PSN
Patient.determinerCode	required	Fixed Value: INSTANCE
Patient.administrativeGenderCode	extensible	AdministrativeGender
Patient.maritalStatusCode	extensible	MaritalStatus
Patient.religiousAffiliationCode	extensible	ReligiousAffiliation
Patient.raceCode	extensible	Race
Patient.sdtcRaceCode	extensible	Race
Patient.ethnicGroupCode	extensible	Ethnicity
Patient.sdtcEthnicGroupCode	extensible	Ethnicity

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	ALL elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())

Name	Card.	Type	Description & Constraints
Patient	1..1	Base	XML Namespace: urn:hl7-org:v3 Base for all types and resources
@classCode	0..1	cs	Binding: EntityClassLivingSubject (required) Fixed Value: PSN
@determinerCode	0..1	cs	Binding: EntityDeterminer (required) Fixed Value: INSTANCE
templateId	0..*	II
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 (extensible)
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 (extensible)
religiousAffiliationCode	0..1	CE	Binding: ReligiousAffiliation (extensible)
raceCode	0..1	CE	Binding: Race (extensible)
sdtcRaceCode	0..*	CE	XML Namespace: urn:hl7-org:sdtc XML: raceCode (urn:hl7-org:sdtc) Binding: Race (extensible)
ethnicGroupCode	0..1	CE	Binding: Ethnicity (extensible)
sdtcEthnicGroupCode	0..*	CE	XML Namespace: urn:hl7-org:sdtc XML: ethnicGroupCode (urn:hl7-org:sdtc) Binding: Ethnicity (extensible)
guardian	0..*	Guardian
birthplace	0..1	Birthplace
languageCommunication	0..*	LanguageCommunication
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code
Patient.classCode	required	Fixed Value: PSN
Patient.determinerCode	required	Fixed Value: INSTANCE
Patient.administrativeGenderCode	extensible	AdministrativeGender
Patient.maritalStatusCode	extensible	MaritalStatus
Patient.religiousAffiliationCode	extensible	ReligiousAffiliation
Patient.raceCode	extensible	Race
Patient.sdtcRaceCode	extensible	Race
Patient.ethnicGroupCode	extensible	Ethnicity
Patient.sdtcEthnicGroupCode	extensible	Ethnicity

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	ALL elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())

This structure is derived from Base

Summary

Fixed Value: 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 Base

Name	Card.	Type	Description & Constraints
Patient	1..1	Base	XML Namespace: urn:hl7-org:v3 Base for all types and resources
@classCode	0..1	cs	Binding: EntityClassLivingSubject (required) Fixed Value: PSN
@determinerCode	0..1	cs	Binding: EntityDeterminer (required) Fixed Value: INSTANCE
templateId	0..*	II
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 (extensible)
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 (extensible)
religiousAffiliationCode	0..1	CE	Binding: ReligiousAffiliation (extensible)
raceCode	0..1	CE	Binding: Race (extensible)
sdtcRaceCode	0..*	CE	XML Namespace: urn:hl7-org:sdtc XML: raceCode (urn:hl7-org:sdtc) Binding: Race (extensible)
ethnicGroupCode	0..1	CE	Binding: Ethnicity (extensible)
sdtcEthnicGroupCode	0..*	CE	XML Namespace: urn:hl7-org:sdtc XML: ethnicGroupCode (urn:hl7-org:sdtc) Binding: Ethnicity (extensible)
guardian	0..*	Guardian
birthplace	0..1	Birthplace
languageCommunication	0..*	LanguageCommunication
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet / Code
Patient.classCode	required	Fixed Value: PSN
Patient.determinerCode	required	Fixed Value: INSTANCE
Patient.administrativeGenderCode	extensible	AdministrativeGender
Patient.maritalStatusCode	extensible	MaritalStatus
Patient.religiousAffiliationCode	extensible	ReligiousAffiliation
Patient.raceCode	extensible	Race
Patient.sdtcRaceCode	extensible	Race
Patient.ethnicGroupCode	extensible	Ethnicity
Patient.sdtcEthnicGroupCode	extensible	Ethnicity

Key Elements View

Name	Card.	Type	Description & Constraints
Patient	1..1	Base	XML Namespace: urn:hl7-org:v3 Base for all types and resources
@classCode	0..1	cs	Binding: EntityClassLivingSubject (required) Fixed Value: PSN
@determinerCode	0..1	cs	Binding: EntityDeterminer (required) Fixed Value: INSTANCE
templateId	0..*	II
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 (extensible)
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 (extensible)
religiousAffiliationCode	0..1	CE	Binding: ReligiousAffiliation (extensible)
raceCode	0..1	CE	Binding: Race (extensible)
sdtcRaceCode	0..*	CE	XML Namespace: urn:hl7-org:sdtc XML: raceCode (urn:hl7-org:sdtc) Binding: Race (extensible)
ethnicGroupCode	0..1	CE	Binding: Ethnicity (extensible)
sdtcEthnicGroupCode	0..*	CE	XML Namespace: urn:hl7-org:sdtc XML: ethnicGroupCode (urn:hl7-org:sdtc) Binding: Ethnicity (extensible)
guardian	0..*	Guardian
birthplace	0..1	Birthplace
languageCommunication	0..*	LanguageCommunication
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code
Patient.classCode	required	Fixed Value: PSN
Patient.determinerCode	required	Fixed Value: INSTANCE
Patient.administrativeGenderCode	extensible	AdministrativeGender
Patient.maritalStatusCode	extensible	MaritalStatus
Patient.religiousAffiliationCode	extensible	ReligiousAffiliation
Patient.raceCode	extensible	Race
Patient.sdtcRaceCode	extensible	Race
Patient.ethnicGroupCode	extensible	Ethnicity
Patient.sdtcEthnicGroupCode	extensible	Ethnicity

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	ALL elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())

Snapshot View

Name	Card.	Type	Description & Constraints
Patient	1..1	Base	XML Namespace: urn:hl7-org:v3 Base for all types and resources
@classCode	0..1	cs	Binding: EntityClassLivingSubject (required) Fixed Value: PSN
@determinerCode	0..1	cs	Binding: EntityDeterminer (required) Fixed Value: INSTANCE
templateId	0..*	II
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 (extensible)
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 (extensible)
religiousAffiliationCode	0..1	CE	Binding: ReligiousAffiliation (extensible)
raceCode	0..1	CE	Binding: Race (extensible)
sdtcRaceCode	0..*	CE	XML Namespace: urn:hl7-org:sdtc XML: raceCode (urn:hl7-org:sdtc) Binding: Race (extensible)
ethnicGroupCode	0..1	CE	Binding: Ethnicity (extensible)
sdtcEthnicGroupCode	0..*	CE	XML Namespace: urn:hl7-org:sdtc XML: ethnicGroupCode (urn:hl7-org:sdtc) Binding: Ethnicity (extensible)
guardian	0..*	Guardian
birthplace	0..1	Birthplace
languageCommunication	0..*	LanguageCommunication
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code
Patient.classCode	required	Fixed Value: PSN
Patient.determinerCode	required	Fixed Value: INSTANCE
Patient.administrativeGenderCode	extensible	AdministrativeGender
Patient.maritalStatusCode	extensible	MaritalStatus
Patient.religiousAffiliationCode	extensible	ReligiousAffiliation
Patient.raceCode	extensible	Race
Patient.sdtcRaceCode	extensible	Race
Patient.ethnicGroupCode	extensible	Ethnicity
Patient.sdtcEthnicGroupCode	extensible	Ethnicity

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	ALL elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())

This structure is derived from Base

Summary

Fixed Value: 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.1 based on FHIR 5.0.0. Generated 2023-10-03
Links: Table of Contents | QA Report | Version History external | | Propose a change