Clinical Document Architecture V2.0.1
2.1.0-draft1 - 1st Draft

This page is part of the CDA: Clinical Document Architecture (v2.1.0-draft1: CDA 2.1 Draft) based on FHIR v5.0.0. . For a full list of available versions, see the Directory of published versions

Logical Model: Patient (CDA Class)

Official URL: http://hl7.org/fhir/cda/StructureDefinition/Patient Version: 2.1.0-draft1
Active as of 2023-01-16 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:

  • This Logical Model Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

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

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 1..1BaseXML Namespace: urn:hl7-org:v3
Base for all types and resources
... @classCode 1..1codeBinding: EntityClassLivingSubject (required)
Fixed Value: PSN
... @determinerCode 1..1codeBinding: EntityDeterminer (required)
Fixed Value: INSTANCE
... templateId 0..*II
... name 0..*EN
... sdtcDesc 0..1EDXML Namespace: urn:hl7-org:sdtc
XML: desc (urn:hl7-org:sdtc)
... administrativeGenderCode 0..1CEBinding: AdministrativeGender (extensible)
... birthTime 0..1TS
... sdtcDeceasedInd 0..1BLXML Namespace: urn:hl7-org:sdtc
XML: deceasedInd (urn:hl7-org:sdtc)
... sdtcDeceasedTime 0..1TSXML Namespace: urn:hl7-org:sdtc
XML: deceasedTime (urn:hl7-org:sdtc)
... sdtcMultipleBirthInd 0..1BLXML Namespace: urn:hl7-org:sdtc
XML: multipleBirthInd (urn:hl7-org:sdtc)
... sdtcMultipleBirthOrderNumber 0..1INT_POSXML Namespace: urn:hl7-org:sdtc
XML: multipleBirthOrderNumber (urn:hl7-org:sdtc)
... maritalStatusCode 0..1CEBinding: MaritalStatus (extensible)
... religiousAffiliationCode 0..1CEBinding: ReligiousAffiliation (extensible)
... raceCode 0..1CEBinding: Race (extensible)
... sdtcRaceCode 0..*CEXML Namespace: urn:hl7-org:sdtc
XML: raceCode (urn:hl7-org:sdtc)
Binding: Race (extensible)
... ethnicGroupCode 0..1CEBinding: Ethnicity (extensible)
... sdtcEthnicGroupCode 0..*CEXML Namespace: urn:hl7-org:sdtc
XML: ethnicGroupCode (urn:hl7-org:sdtc)
Binding: Ethnicity (extensible)
... guardian 0..*Guardian
... birthplace 0..1Birthplace
... languageCommunication 0..*LanguageCommunication

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet / Code
Patient.classCoderequiredFixed Value: PSN
Patient.determinerCoderequiredFixed Value: INSTANCE
Patient.administrativeGenderCodeextensibleAdministrativeGender
Patient.maritalStatusCodeextensibleMaritalStatus
Patient.religiousAffiliationCodeextensibleReligiousAffiliation
Patient.raceCodeextensibleRace
Patient.sdtcRaceCodeextensibleRace
Patient.ethnicGroupCodeextensibleEthnicity
Patient.sdtcEthnicGroupCodeextensibleEthnicity
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 1..1BaseBase for all types and resources
... classCode 1..1codeBinding: EntityClassLivingSubject (required)
Fixed Value: PSN
... determinerCode 1..1codeBinding: EntityDeterminer (required)
Fixed Value: INSTANCE
... templateId 0..*II
... sdtcDesc 0..1EDXML: desc (urn:hl7-org:sdtc)
... administrativeGenderCode 0..1CEBinding: AdministrativeGender (extensible)
... birthTime 0..1TS
... sdtcDeceasedInd 0..1BLXML: deceasedInd (urn:hl7-org:sdtc)
... sdtcDeceasedTime 0..1TSXML: deceasedTime (urn:hl7-org:sdtc)
... sdtcMultipleBirthInd 0..1BLXML: multipleBirthInd (urn:hl7-org:sdtc)
... sdtcMultipleBirthOrderNumber 0..1INT_POSXML: multipleBirthOrderNumber (urn:hl7-org:sdtc)
... maritalStatusCode 0..1CEBinding: MaritalStatus (extensible)
... religiousAffiliationCode 0..1CEBinding: ReligiousAffiliation (extensible)
... raceCode 0..1CEBinding: Race (extensible)
... sdtcRaceCode 0..*CEXML: raceCode (urn:hl7-org:sdtc)
Binding: Race (extensible)
... ethnicGroupCode 0..1CEBinding: Ethnicity (extensible)
... sdtcEthnicGroupCode 0..*CEXML: ethnicGroupCode (urn:hl7-org:sdtc)
Binding: Ethnicity (extensible)
... guardian 0..*Guardian
... birthplace 0..1Birthplace
... languageCommunication 0..*LanguageCommunication

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Patient.classCoderequiredFixed Value: PSN
Patient.determinerCoderequiredFixed Value: INSTANCE
Patient.administrativeGenderCodeextensibleAdministrativeGender
Patient.maritalStatusCodeextensibleMaritalStatus
Patient.religiousAffiliationCodeextensibleReligiousAffiliation
Patient.raceCodeextensibleRace
Patient.sdtcRaceCodeextensibleRace
Patient.ethnicGroupCodeextensibleEthnicity
Patient.sdtcEthnicGroupCodeextensibleEthnicity

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 1..1BaseBase for all types and resources
... classCode 1..1codeBinding: EntityClassLivingSubject (required)
Fixed Value: PSN
... determinerCode 1..1codeBinding: EntityDeterminer (required)
Fixed Value: INSTANCE
... templateId 0..*II
... sdtcDesc 0..1EDXML: desc (urn:hl7-org:sdtc)
... administrativeGenderCode 0..1CEBinding: AdministrativeGender (extensible)
... birthTime 0..1TS
... sdtcDeceasedInd 0..1BLXML: deceasedInd (urn:hl7-org:sdtc)
... sdtcDeceasedTime 0..1TSXML: deceasedTime (urn:hl7-org:sdtc)
... sdtcMultipleBirthInd 0..1BLXML: multipleBirthInd (urn:hl7-org:sdtc)
... sdtcMultipleBirthOrderNumber 0..1INT_POSXML: multipleBirthOrderNumber (urn:hl7-org:sdtc)
... maritalStatusCode 0..1CEBinding: MaritalStatus (extensible)
... religiousAffiliationCode 0..1CEBinding: ReligiousAffiliation (extensible)
... raceCode 0..1CEBinding: Race (extensible)
... sdtcRaceCode 0..*CEXML: raceCode (urn:hl7-org:sdtc)
Binding: Race (extensible)
... ethnicGroupCode 0..1CEBinding: Ethnicity (extensible)
... sdtcEthnicGroupCode 0..*CEXML: ethnicGroupCode (urn:hl7-org:sdtc)
Binding: Ethnicity (extensible)
... guardian 0..*Guardian
... birthplace 0..1Birthplace
... languageCommunication 0..*LanguageCommunication

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Patient.classCoderequiredFixed Value: PSN
Patient.determinerCoderequiredFixed Value: INSTANCE
Patient.administrativeGenderCodeextensibleAdministrativeGender
Patient.maritalStatusCodeextensibleMaritalStatus
Patient.religiousAffiliationCodeextensibleReligiousAffiliation
Patient.raceCodeextensibleRace
Patient.sdtcRaceCodeextensibleRace
Patient.ethnicGroupCodeextensibleEthnicity
Patient.sdtcEthnicGroupCodeextensibleEthnicity

This structure is derived from Base

Summary

Mandatory: 0 element (2 nested mandatory elements)
Fixed Value: 2 elements

Differential View

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 1..1BaseXML Namespace: urn:hl7-org:v3
Base for all types and resources
... @classCode 1..1codeBinding: EntityClassLivingSubject (required)
Fixed Value: PSN
... @determinerCode 1..1codeBinding: EntityDeterminer (required)
Fixed Value: INSTANCE
... templateId 0..*II
... name 0..*EN
... sdtcDesc 0..1EDXML Namespace: urn:hl7-org:sdtc
XML: desc (urn:hl7-org:sdtc)
... administrativeGenderCode 0..1CEBinding: AdministrativeGender (extensible)
... birthTime 0..1TS
... sdtcDeceasedInd 0..1BLXML Namespace: urn:hl7-org:sdtc
XML: deceasedInd (urn:hl7-org:sdtc)
... sdtcDeceasedTime 0..1TSXML Namespace: urn:hl7-org:sdtc
XML: deceasedTime (urn:hl7-org:sdtc)
... sdtcMultipleBirthInd 0..1BLXML Namespace: urn:hl7-org:sdtc
XML: multipleBirthInd (urn:hl7-org:sdtc)
... sdtcMultipleBirthOrderNumber 0..1INT_POSXML Namespace: urn:hl7-org:sdtc
XML: multipleBirthOrderNumber (urn:hl7-org:sdtc)
... maritalStatusCode 0..1CEBinding: MaritalStatus (extensible)
... religiousAffiliationCode 0..1CEBinding: ReligiousAffiliation (extensible)
... raceCode 0..1CEBinding: Race (extensible)
... sdtcRaceCode 0..*CEXML Namespace: urn:hl7-org:sdtc
XML: raceCode (urn:hl7-org:sdtc)
Binding: Race (extensible)
... ethnicGroupCode 0..1CEBinding: Ethnicity (extensible)
... sdtcEthnicGroupCode 0..*CEXML Namespace: urn:hl7-org:sdtc
XML: ethnicGroupCode (urn:hl7-org:sdtc)
Binding: Ethnicity (extensible)
... guardian 0..*Guardian
... birthplace 0..1Birthplace
... languageCommunication 0..*LanguageCommunication

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet / Code
Patient.classCoderequiredFixed Value: PSN
Patient.determinerCoderequiredFixed Value: INSTANCE
Patient.administrativeGenderCodeextensibleAdministrativeGender
Patient.maritalStatusCodeextensibleMaritalStatus
Patient.religiousAffiliationCodeextensibleReligiousAffiliation
Patient.raceCodeextensibleRace
Patient.sdtcRaceCodeextensibleRace
Patient.ethnicGroupCodeextensibleEthnicity
Patient.sdtcEthnicGroupCodeextensibleEthnicity

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 1..1BaseBase for all types and resources
... classCode 1..1codeBinding: EntityClassLivingSubject (required)
Fixed Value: PSN
... determinerCode 1..1codeBinding: EntityDeterminer (required)
Fixed Value: INSTANCE
... templateId 0..*II
... sdtcDesc 0..1EDXML: desc (urn:hl7-org:sdtc)
... administrativeGenderCode 0..1CEBinding: AdministrativeGender (extensible)
... birthTime 0..1TS
... sdtcDeceasedInd 0..1BLXML: deceasedInd (urn:hl7-org:sdtc)
... sdtcDeceasedTime 0..1TSXML: deceasedTime (urn:hl7-org:sdtc)
... sdtcMultipleBirthInd 0..1BLXML: multipleBirthInd (urn:hl7-org:sdtc)
... sdtcMultipleBirthOrderNumber 0..1INT_POSXML: multipleBirthOrderNumber (urn:hl7-org:sdtc)
... maritalStatusCode 0..1CEBinding: MaritalStatus (extensible)
... religiousAffiliationCode 0..1CEBinding: ReligiousAffiliation (extensible)
... raceCode 0..1CEBinding: Race (extensible)
... sdtcRaceCode 0..*CEXML: raceCode (urn:hl7-org:sdtc)
Binding: Race (extensible)
... ethnicGroupCode 0..1CEBinding: Ethnicity (extensible)
... sdtcEthnicGroupCode 0..*CEXML: ethnicGroupCode (urn:hl7-org:sdtc)
Binding: Ethnicity (extensible)
... guardian 0..*Guardian
... birthplace 0..1Birthplace
... languageCommunication 0..*LanguageCommunication

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Patient.classCoderequiredFixed Value: PSN
Patient.determinerCoderequiredFixed Value: INSTANCE
Patient.administrativeGenderCodeextensibleAdministrativeGender
Patient.maritalStatusCodeextensibleMaritalStatus
Patient.religiousAffiliationCodeextensibleReligiousAffiliation
Patient.raceCodeextensibleRace
Patient.sdtcRaceCodeextensibleRace
Patient.ethnicGroupCodeextensibleEthnicity
Patient.sdtcEthnicGroupCodeextensibleEthnicity

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 1..1BaseBase for all types and resources
... classCode 1..1codeBinding: EntityClassLivingSubject (required)
Fixed Value: PSN
... determinerCode 1..1codeBinding: EntityDeterminer (required)
Fixed Value: INSTANCE
... templateId 0..*II
... sdtcDesc 0..1EDXML: desc (urn:hl7-org:sdtc)
... administrativeGenderCode 0..1CEBinding: AdministrativeGender (extensible)
... birthTime 0..1TS
... sdtcDeceasedInd 0..1BLXML: deceasedInd (urn:hl7-org:sdtc)
... sdtcDeceasedTime 0..1TSXML: deceasedTime (urn:hl7-org:sdtc)
... sdtcMultipleBirthInd 0..1BLXML: multipleBirthInd (urn:hl7-org:sdtc)
... sdtcMultipleBirthOrderNumber 0..1INT_POSXML: multipleBirthOrderNumber (urn:hl7-org:sdtc)
... maritalStatusCode 0..1CEBinding: MaritalStatus (extensible)
... religiousAffiliationCode 0..1CEBinding: ReligiousAffiliation (extensible)
... raceCode 0..1CEBinding: Race (extensible)
... sdtcRaceCode 0..*CEXML: raceCode (urn:hl7-org:sdtc)
Binding: Race (extensible)
... ethnicGroupCode 0..1CEBinding: Ethnicity (extensible)
... sdtcEthnicGroupCode 0..*CEXML: ethnicGroupCode (urn:hl7-org:sdtc)
Binding: Ethnicity (extensible)
... guardian 0..*Guardian
... birthplace 0..1Birthplace
... languageCommunication 0..*LanguageCommunication

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Patient.classCoderequiredFixed Value: PSN
Patient.determinerCoderequiredFixed Value: INSTANCE
Patient.administrativeGenderCodeextensibleAdministrativeGender
Patient.maritalStatusCodeextensibleMaritalStatus
Patient.religiousAffiliationCodeextensibleReligiousAffiliation
Patient.raceCodeextensibleRace
Patient.sdtcRaceCodeextensibleRace
Patient.ethnicGroupCodeextensibleEthnicity
Patient.sdtcEthnicGroupCodeextensibleEthnicity

This structure is derived from Base

Summary

Mandatory: 0 element (2 nested mandatory elements)
Fixed Value: 2 elements

 

Other representations of profile: CSV, Excel