Clinical Document Architecture with Australian Schema
1.0.1 - active
Clinical Document Architecture with Australian Schema - Local Development build (v1.0.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: http://hl7.org/cda/stds/core/StructureDefinition/Entity | Version: 1.0.1 | |||
| Active as of 2025-10-10 | Maturity Level: 1 | Responsible: HL7 | Computable Name: Entity | |
A physical thing, group of physical things or an organization capable of participating in Acts while in a role.
An entity is a physical object that has, had or will have existence. The only exception to this is Organization, which while not having a physical presence, fulfills the other characteristics of an Entity. Entity stipulates the thing itself, not the Roles it may play: the Role of Patient, e.g., is played by the Person Entity.
Living subjects (including human beings), organizations, materials, places and their specializations.
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:   |
|---|---|---|---|---|
  Entity |
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 | ||
| templateId |
0..* | II | ||
| @classCode |
0..1 | cs | Binding: EntityClassRoot (required) | |
| @determinerCode |
0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
| id |
0..* | II | ||
| code |
0..1 | CE | Binding: CDAEntityCode (example) | |
| desc |
0..1 | ED | ||
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Entity.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| Entity.typeId.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| Entity.classCode | Base | required | EntityClassRoot | 📦2.0.0 | THO v5.2 |
| Entity.determinerCode | Base | required | EntityDeterminer | 📦2.0.0 | THO v5.2 |
| Entity.code | Base | example | CDAEntityCode | 📦1.0.1 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| II-1 | error | Entity.typeId | An II instance must have either a root or an nullFlavor. |
root.exists() or nullFlavor.exists()
|
This structure is derived from InfrastructureRoot
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Entity |
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: EntityClassRoot (required) | |
| @determinerCode |
0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
| id |
0..* | II | ||
| code |
0..1 | CE | Binding: CDAEntityCode (example) | |
| desc |
0..1 | ED | ||
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Entity.classCode | Base | required | EntityClassRoot | 📦2.0.0 | THO v5.2 |
| Entity.determinerCode | Base | required | EntityDeterminer | 📦2.0.0 | THO v5.2 |
| Entity.code | Base | example | CDAEntityCode | 📦1.0.1 | This IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Entity |
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 | ||
| templateId |
0..* | II | ||
| @classCode |
0..1 | cs | Binding: EntityClassRoot (required) | |
| @determinerCode |
0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
| id |
0..* | II | ||
| code |
0..1 | CE | Binding: CDAEntityCode (example) | |
| desc |
0..1 | ED | ||
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Entity.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| Entity.typeId.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| Entity.classCode | Base | required | EntityClassRoot | 📦2.0.0 | THO v5.2 |
| Entity.determinerCode | Base | required | EntityDeterminer | 📦2.0.0 | THO v5.2 |
| Entity.code | Base | example | CDAEntityCode | 📦1.0.1 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| II-1 | error | Entity.typeId | An II instance must have either a root or an nullFlavor. |
root.exists() or nullFlavor.exists()
|
This structure is derived from InfrastructureRoot
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Entity |
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 | ||
| templateId |
0..* | II | ||
| @classCode |
0..1 | cs | Binding: EntityClassRoot (required) | |
| @determinerCode |
0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
| id |
0..* | II | ||
| code |
0..1 | CE | Binding: CDAEntityCode (example) | |
| desc |
0..1 | ED | ||
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Entity.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| Entity.typeId.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| Entity.classCode | Base | required | EntityClassRoot | 📦2.0.0 | THO v5.2 |
| Entity.determinerCode | Base | required | EntityDeterminer | 📦2.0.0 | THO v5.2 |
| Entity.code | Base | example | CDAEntityCode | 📦1.0.1 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| II-1 | error | Entity.typeId | An II instance must have either a root or an nullFlavor. |
root.exists() or nullFlavor.exists()
|
Differential View
This structure is derived from InfrastructureRoot
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Entity |
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: EntityClassRoot (required) | |
| @determinerCode |
0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
| id |
0..* | II | ||
| code |
0..1 | CE | Binding: CDAEntityCode (example) | |
| desc |
0..1 | ED | ||
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Entity.classCode | Base | required | EntityClassRoot | 📦2.0.0 | THO v5.2 |
| Entity.determinerCode | Base | required | EntityDeterminer | 📦2.0.0 | THO v5.2 |
| Entity.code | Base | example | CDAEntityCode | 📦1.0.1 | This IG |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Entity |
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 | ||
| templateId |
0..* | II | ||
| @classCode |
0..1 | cs | Binding: EntityClassRoot (required) | |
| @determinerCode |
0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
| id |
0..* | II | ||
| code |
0..1 | CE | Binding: CDAEntityCode (example) | |
| desc |
0..1 | ED | ||
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Entity.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| Entity.typeId.nullFlavor | Base | required | CDANullFlavor | 📦1.0.1 | This IG |
| Entity.classCode | Base | required | EntityClassRoot | 📦2.0.0 | THO v5.2 |
| Entity.determinerCode | Base | required | EntityDeterminer | 📦2.0.0 | THO v5.2 |
| Entity.code | Base | example | CDAEntityCode | 📦1.0.1 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| II-1 | error | Entity.typeId | An II instance must have either a root or an nullFlavor. |
root.exists() or nullFlavor.exists()
|
This structure is derived from InfrastructureRoot
IG © 2024+ Australian Digital Health Agency. Package au.digitalhealth.cda.schema#1.0.1 based on FHIR 5.0.0. Generated 2025-10-10
Links: Table of Contents | QA Report | Version History | Report an issue or propose a change
