0.5.3 - ballot
            
          
This page is part of the IG Tooling by GKL (v0.5.3: DSTU 1) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions
| Official URL: https://gabriel0316.github.io/ig-tooling-pages/ig/ig-tooling-test/StructureDefinition/CDAPatient | Version: 0.5.3 | |||
| Draft as of 2025-10-22 | Computable Name: CDAPatient | |||
Some Patient
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints    Filter:   | 
|---|---|---|---|---|
|   Patient | 1..1 | Patient | XML Namespace: urn:hl7-org:v3 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 | 1..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 | ||||
| Path | Status | Usage | ValueSet | Version | Source | 
| Patient.nullFlavor | Base | required | CDANullFlavor | 📦2.0.0-sd-snapshot1 | Clinical Document Architecture v2.0 | 
| Patient.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.0-sd-snapshot1 | Clinical Document Architecture v2.0 | 
| Patient.classCode | Base | required | EntityClassLivingSubject | 📦3.0.0 | THO v6.5 | 
| Patient.determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 | 
| Patient.administrativeGenderCode | Base | example | AdministrativeGender | 📦3.0.0 | THO v6.5 | 
| Patient.maritalStatusCode | Base | example | MaritalStatus | 📦3.0.0 | THO v6.5 | 
| Patient.religiousAffiliationCode | Base | example | ReligiousAffiliation | 📦3.0.0 | THO v6.5 | 
| Patient.raceCode | Base | example | Race | 📦3.0.0 | THO v6.5 | 
| Patient.sdtcRaceCode | Base | example | Race | 📦3.0.0 | THO v6.5 | 
| Patient.ethnicGroupCode | Base | example | Ethnicity | 📦3.0.0 | THO v6.5 | 
| Patient.sdtcEthnicGroupCode | Base | example | Ethnicity | 📦3.0.0 | THO v6.5 | 
This structure is derived from Patient
| Name | Flags | Card. | Type | Description & Constraints    Filter:   | 
|---|---|---|---|---|
|   Patient | 1..1 | Patient | XML Namespace: urn:hl7-org:v3 Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) | |
|    birthTime | 1..1 | TS | ||
|  Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints    Filter:   | 
|---|---|---|---|---|
|   Patient | 1..1 | Patient | XML Namespace: urn:hl7-org:v3 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 | 1..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 | ||||
| Path | Status | Usage | ValueSet | Version | Source | 
| Patient.nullFlavor | Base | required | CDANullFlavor | 📦2.0.0-sd-snapshot1 | Clinical Document Architecture v2.0 | 
| Patient.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.0-sd-snapshot1 | Clinical Document Architecture v2.0 | 
| Patient.classCode | Base | required | EntityClassLivingSubject | 📦3.0.0 | THO v6.5 | 
| Patient.determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 | 
| Patient.administrativeGenderCode | Base | example | AdministrativeGender | 📦3.0.0 | THO v6.5 | 
| Patient.maritalStatusCode | Base | example | MaritalStatus | 📦3.0.0 | THO v6.5 | 
| Patient.religiousAffiliationCode | Base | example | ReligiousAffiliation | 📦3.0.0 | THO v6.5 | 
| Patient.raceCode | Base | example | Race | 📦3.0.0 | THO v6.5 | 
| Patient.sdtcRaceCode | Base | example | Race | 📦3.0.0 | THO v6.5 | 
| Patient.ethnicGroupCode | Base | example | Ethnicity | 📦3.0.0 | THO v6.5 | 
| Patient.sdtcEthnicGroupCode | Base | example | Ethnicity | 📦3.0.0 | THO v6.5 | 
This structure is derived from Patient
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints    Filter:   | 
|---|---|---|---|---|
|   Patient | 1..1 | Patient | XML Namespace: urn:hl7-org:v3 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 | 1..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 | ||||
| Path | Status | Usage | ValueSet | Version | Source | 
| Patient.nullFlavor | Base | required | CDANullFlavor | 📦2.0.0-sd-snapshot1 | Clinical Document Architecture v2.0 | 
| Patient.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.0-sd-snapshot1 | Clinical Document Architecture v2.0 | 
| Patient.classCode | Base | required | EntityClassLivingSubject | 📦3.0.0 | THO v6.5 | 
| Patient.determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 | 
| Patient.administrativeGenderCode | Base | example | AdministrativeGender | 📦3.0.0 | THO v6.5 | 
| Patient.maritalStatusCode | Base | example | MaritalStatus | 📦3.0.0 | THO v6.5 | 
| Patient.religiousAffiliationCode | Base | example | ReligiousAffiliation | 📦3.0.0 | THO v6.5 | 
| Patient.raceCode | Base | example | Race | 📦3.0.0 | THO v6.5 | 
| Patient.sdtcRaceCode | Base | example | Race | 📦3.0.0 | THO v6.5 | 
| Patient.ethnicGroupCode | Base | example | Ethnicity | 📦3.0.0 | THO v6.5 | 
| Patient.sdtcEthnicGroupCode | Base | example | Ethnicity | 📦3.0.0 | THO v6.5 | 
Differential View
This structure is derived from Patient
| Name | Flags | Card. | Type | Description & Constraints    Filter:   | 
|---|---|---|---|---|
|   Patient | 1..1 | Patient | XML Namespace: urn:hl7-org:v3 Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) | |
|    birthTime | 1..1 | TS | ||
|  Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints    Filter:   | 
|---|---|---|---|---|
|   Patient | 1..1 | Patient | XML Namespace: urn:hl7-org:v3 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 | 1..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 | ||||
| Path | Status | Usage | ValueSet | Version | Source | 
| Patient.nullFlavor | Base | required | CDANullFlavor | 📦2.0.0-sd-snapshot1 | Clinical Document Architecture v2.0 | 
| Patient.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.0-sd-snapshot1 | Clinical Document Architecture v2.0 | 
| Patient.classCode | Base | required | EntityClassLivingSubject | 📦3.0.0 | THO v6.5 | 
| Patient.determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 | 
| Patient.administrativeGenderCode | Base | example | AdministrativeGender | 📦3.0.0 | THO v6.5 | 
| Patient.maritalStatusCode | Base | example | MaritalStatus | 📦3.0.0 | THO v6.5 | 
| Patient.religiousAffiliationCode | Base | example | ReligiousAffiliation | 📦3.0.0 | THO v6.5 | 
| Patient.raceCode | Base | example | Race | 📦3.0.0 | THO v6.5 | 
| Patient.sdtcRaceCode | Base | example | Race | 📦3.0.0 | THO v6.5 | 
| Patient.ethnicGroupCode | Base | example | Ethnicity | 📦3.0.0 | THO v6.5 | 
| Patient.sdtcEthnicGroupCode | Base | example | Ethnicity | 📦3.0.0 | THO v6.5 | 
This structure is derived from Patient