Clinical Document Architecture with Australian Schema, published by Australian Digital Health Agency. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/AuDigitalHealth/cda-au-schema/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org/cda/stds/core/StructureDefinition/Entity | Version: 1.0.0 | |||
Active as of 2024-12-18 | 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.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from InfrastructureRoot
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Entity | 1..1 | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Base for all types and resources Instance of this type are validated by templateId Logical Container: ADHA 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 | Conformance | ValueSet / Code | URI |
Entity.classCode | required | EntityClassRoothttp://terminology.hl7.org/ValueSet/v3-EntityClassRoot | |
Entity.determinerCode | required | Fixed Value: INSTANCEhttp://terminology.hl7.org/ValueSet/v3-EntityDeterminer | |
Entity.code | example | CDAEntityCodehttp://hl7.org/cda/stds/core/ValueSet/CDAEntityCode from this IG |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Entity | 1..1 | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Base for all types and resources Instance of this type are validated by templateId Logical Container: ADHA ClinicalDocument (CDA Class) | |
@nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
realmCode | 0..* | CS | ||
typeId | C | 0..1 | II | II-1: An II instance must have either a root or an nullFlavor. |
@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 | Conformance | ValueSet / Code | URI |
Entity.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG | |
Entity.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG | |
Entity.classCode | required | EntityClassRoothttp://terminology.hl7.org/ValueSet/v3-EntityClassRoot | |
Entity.determinerCode | required | Fixed Value: INSTANCEhttp://terminology.hl7.org/ValueSet/v3-EntityDeterminer | |
Entity.code | example | CDAEntityCodehttp://hl7.org/cda/stds/core/ValueSet/CDAEntityCode from this IG |
Id | Grade | Path(s) | Details | Requirements |
II-1 | error | Entity.typeId | An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists() |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Entity | 1..1 | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Base for all types and resources Instance of this type are validated by templateId Logical Container: ADHA ClinicalDocument (CDA Class) | |
@nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
realmCode | 0..* | CS | ||
typeId | C | 0..1 | II | II-1: An II instance must have either a root or an nullFlavor. |
@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 | Conformance | ValueSet / Code | URI |
Entity.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG | |
Entity.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG | |
Entity.classCode | required | EntityClassRoothttp://terminology.hl7.org/ValueSet/v3-EntityClassRoot | |
Entity.determinerCode | required | Fixed Value: INSTANCEhttp://terminology.hl7.org/ValueSet/v3-EntityDeterminer | |
Entity.code | example | CDAEntityCodehttp://hl7.org/cda/stds/core/ValueSet/CDAEntityCode from this IG |
Id | Grade | Path(s) | Details | Requirements |
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
Differential View
This structure is derived from InfrastructureRoot
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Entity | 1..1 | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Base for all types and resources Instance of this type are validated by templateId Logical Container: ADHA 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 | Conformance | ValueSet / Code | URI |
Entity.classCode | required | EntityClassRoothttp://terminology.hl7.org/ValueSet/v3-EntityClassRoot | |
Entity.determinerCode | required | Fixed Value: INSTANCEhttp://terminology.hl7.org/ValueSet/v3-EntityDeterminer | |
Entity.code | example | CDAEntityCodehttp://hl7.org/cda/stds/core/ValueSet/CDAEntityCode from this IG |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Entity | 1..1 | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Base for all types and resources Instance of this type are validated by templateId Logical Container: ADHA ClinicalDocument (CDA Class) | |
@nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
realmCode | 0..* | CS | ||
typeId | C | 0..1 | II | II-1: An II instance must have either a root or an nullFlavor. |
@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 | Conformance | ValueSet / Code | URI |
Entity.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG | |
Entity.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG | |
Entity.classCode | required | EntityClassRoothttp://terminology.hl7.org/ValueSet/v3-EntityClassRoot | |
Entity.determinerCode | required | Fixed Value: INSTANCEhttp://terminology.hl7.org/ValueSet/v3-EntityDeterminer | |
Entity.code | example | CDAEntityCodehttp://hl7.org/cda/stds/core/ValueSet/CDAEntityCode from this IG |
Id | Grade | Path(s) | Details | Requirements |
II-1 | error | Entity.typeId | An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Entity | 1..1 | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Base for all types and resources Instance of this type are validated by templateId Logical Container: ADHA ClinicalDocument (CDA Class) | |
@nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
realmCode | 0..* | CS | ||
typeId | C | 0..1 | II | II-1: An II instance must have either a root or an nullFlavor. |
@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 | Conformance | ValueSet / Code | URI |
Entity.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG | |
Entity.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor from this IG | |
Entity.classCode | required | EntityClassRoothttp://terminology.hl7.org/ValueSet/v3-EntityClassRoot | |
Entity.determinerCode | required | Fixed Value: INSTANCEhttp://terminology.hl7.org/ValueSet/v3-EntityDeterminer | |
Entity.code | example | CDAEntityCodehttp://hl7.org/cda/stds/core/ValueSet/CDAEntityCode from this IG |
Id | Grade | Path(s) | Details | Requirements |
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