Clinical Document Architecture
2.0.1-sd-202510-matchbox-patch - release

Clinical Document Architecture - Local Development build (v2.0.1-sd-202510-matchbox-patch) built by the FHIR (HL7® FHIR® Standard) Build Tools. 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-sd-202510-matchbox-patch
Active as of 2025-10-29 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.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Template Content

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

This structure is derived from InfrastructureRoot

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Base for all types and resources

Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
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
... 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

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Patient.classCode Base required EntityClassLivingSubject 📦2.0.0 THO v5.3
Patient.determinerCode Base required EntityDeterminer 📦2.0.0 THO v5.3
Patient.administrativeGenderCode Base example AdministrativeGender 📦2.0.0 THO v5.3
Patient.maritalStatusCode Base example MaritalStatus 📦2.0.0 THO v5.3
Patient.religiousAffiliationCode Base example ReligiousAffiliation 📦2.0.0 THO v5.3
Patient.raceCode Base example Race 📦2.0.0 THO v5.3
Patient.sdtcRaceCode Base example Race 📦2.0.0 THO v5.3
Patient.ethnicGroupCode Base example Ethnicity 📦2.0.0 THO v5.3
Patient.sdtcEthnicGroupCode Base example Ethnicity 📦2.0.0 THO v5.3
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Base for all types and resources

Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
... realmCode 0..* CS
... typeId C 0..1 II Constraints: II-1
.... @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
... @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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.nullFlavor Base required CDANullFlavor 📦2.0.1-sd-202510-matchbox-patch This IG
Patient.typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd-202510-matchbox-patch This IG
Patient.classCode Base required EntityClassLivingSubject 📦2.0.0 THO v5.3
Patient.determinerCode Base required EntityDeterminer 📦2.0.0 THO v5.3
Patient.administrativeGenderCode Base example AdministrativeGender 📦2.0.0 THO v5.3
Patient.maritalStatusCode Base example MaritalStatus 📦2.0.0 THO v5.3
Patient.religiousAffiliationCode Base example ReligiousAffiliation 📦2.0.0 THO v5.3
Patient.raceCode Base example Race 📦2.0.0 THO v5.3
Patient.sdtcRaceCode Base example Race 📦2.0.0 THO v5.3
Patient.ethnicGroupCode Base example Ethnicity 📦2.0.0 THO v5.3
Patient.sdtcEthnicGroupCode Base example Ethnicity 📦2.0.0 THO v5.3

Constraints

Id Grade Path(s) Description Expression
II-1 error Patient.typeId An II instance must have either a root or an nullFlavor. root.exists() or nullFlavor.exists()
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Base for all types and resources

Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
... realmCode 0..* CS
... typeId C 0..1 II Constraints: II-1
.... @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
... @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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.nullFlavor Base required CDANullFlavor 📦2.0.1-sd-202510-matchbox-patch This IG
Patient.typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd-202510-matchbox-patch This IG
Patient.classCode Base required EntityClassLivingSubject 📦2.0.0 THO v5.3
Patient.determinerCode Base required EntityDeterminer 📦2.0.0 THO v5.3
Patient.administrativeGenderCode Base example AdministrativeGender 📦2.0.0 THO v5.3
Patient.maritalStatusCode Base example MaritalStatus 📦2.0.0 THO v5.3
Patient.religiousAffiliationCode Base example ReligiousAffiliation 📦2.0.0 THO v5.3
Patient.raceCode Base example Race 📦2.0.0 THO v5.3
Patient.sdtcRaceCode Base example Race 📦2.0.0 THO v5.3
Patient.ethnicGroupCode Base example Ethnicity 📦2.0.0 THO v5.3
Patient.sdtcEthnicGroupCode Base example Ethnicity 📦2.0.0 THO v5.3

Constraints

Id Grade Path(s) Description Expression
II-1 error Patient.typeId An II instance must have either a root or an nullFlavor. root.exists() or nullFlavor.exists()

This structure is derived from InfrastructureRoot

Summary

Fixed: 2 elements

Structures

This structure refers to these other structures:

Differential View

This structure is derived from InfrastructureRoot

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Base for all types and resources

Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
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
... 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

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Patient.classCode Base required EntityClassLivingSubject 📦2.0.0 THO v5.3
Patient.determinerCode Base required EntityDeterminer 📦2.0.0 THO v5.3
Patient.administrativeGenderCode Base example AdministrativeGender 📦2.0.0 THO v5.3
Patient.maritalStatusCode Base example MaritalStatus 📦2.0.0 THO v5.3
Patient.religiousAffiliationCode Base example ReligiousAffiliation 📦2.0.0 THO v5.3
Patient.raceCode Base example Race 📦2.0.0 THO v5.3
Patient.sdtcRaceCode Base example Race 📦2.0.0 THO v5.3
Patient.ethnicGroupCode Base example Ethnicity 📦2.0.0 THO v5.3
Patient.sdtcEthnicGroupCode Base example Ethnicity 📦2.0.0 THO v5.3

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Base for all types and resources

Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
... realmCode 0..* CS
... typeId C 0..1 II Constraints: II-1
.... @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
... @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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.nullFlavor Base required CDANullFlavor 📦2.0.1-sd-202510-matchbox-patch This IG
Patient.typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd-202510-matchbox-patch This IG
Patient.classCode Base required EntityClassLivingSubject 📦2.0.0 THO v5.3
Patient.determinerCode Base required EntityDeterminer 📦2.0.0 THO v5.3
Patient.administrativeGenderCode Base example AdministrativeGender 📦2.0.0 THO v5.3
Patient.maritalStatusCode Base example MaritalStatus 📦2.0.0 THO v5.3
Patient.religiousAffiliationCode Base example ReligiousAffiliation 📦2.0.0 THO v5.3
Patient.raceCode Base example Race 📦2.0.0 THO v5.3
Patient.sdtcRaceCode Base example Race 📦2.0.0 THO v5.3
Patient.ethnicGroupCode Base example Ethnicity 📦2.0.0 THO v5.3
Patient.sdtcEthnicGroupCode Base example Ethnicity 📦2.0.0 THO v5.3

Constraints

Id Grade Path(s) Description Expression
II-1 error Patient.typeId An II instance must have either a root or an nullFlavor. root.exists() or nullFlavor.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Patient 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Base for all types and resources

Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
... realmCode 0..* CS
... typeId C 0..1 II Constraints: II-1
.... @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
... @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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Patient.nullFlavor Base required CDANullFlavor 📦2.0.1-sd-202510-matchbox-patch This IG
Patient.typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd-202510-matchbox-patch This IG
Patient.classCode Base required EntityClassLivingSubject 📦2.0.0 THO v5.3
Patient.determinerCode Base required EntityDeterminer 📦2.0.0 THO v5.3
Patient.administrativeGenderCode Base example AdministrativeGender 📦2.0.0 THO v5.3
Patient.maritalStatusCode Base example MaritalStatus 📦2.0.0 THO v5.3
Patient.religiousAffiliationCode Base example ReligiousAffiliation 📦2.0.0 THO v5.3
Patient.raceCode Base example Race 📦2.0.0 THO v5.3
Patient.sdtcRaceCode Base example Race 📦2.0.0 THO v5.3
Patient.ethnicGroupCode Base example Ethnicity 📦2.0.0 THO v5.3
Patient.sdtcEthnicGroupCode Base example Ethnicity 📦2.0.0 THO v5.3

Constraints

Id Grade Path(s) Description Expression
II-1 error Patient.typeId An II instance must have either a root or an nullFlavor. root.exists() or nullFlavor.exists()

This structure is derived from InfrastructureRoot

Summary

Fixed: 2 elements

Structures

This structure refers to these other structures:

 

Other representations of profile: CSV, Excel