Clinical Document Architecture with Australian Schema
1.0.0 - current
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://ns.electronichealth.net.au/cda/StructureDefinition/au-Entity | Version: 1.0.0 | |||
| Active as of 2024-11-24 | Computable Name: au-Entity | |||
Copyright/Legal: Copyright © 2024 Australian Digital Health Agency - All rights reserved. This content is licensed under a Creative Commons Attribution 4.0 International License. See https://creativecommons.org/licenses/by/4.0/. |
||||
Australian adaptation of the HL7 International CDA Entity class.
This is a generated StructureDefinition that describes CDA - that is, CDA as it actually is for R2. The intent of this StructureDefinition is to enable CDA to be a FHIR resource. That enables the FHIR infrastructure - API, conformance, query - to be used directly against CDA
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 Australian adaptation of the HL7 International CDA Entity class 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) | |
| name |
0..* | au-OrganizationName | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent entity's name XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| desc |
0..1 | ED | ||
| telecom |
0..* | TEL | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent entity's telecommunication details XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| addr |
0..* | AD | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent entity's address XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| asOrganizationPartOf |
0..* | au-OrganizationPartOf | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent a which organisation the entity is part of XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| asEntityIdentifier |
0..* | asEntityIdentifier | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent a entity's identifier XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| asQualifiedEntity |
0..1 | asQualifiedEntity | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent a qualified entity XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
 personalRelationship |
0..* | personalRelationship | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent personal relationship of the entity XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| 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/CDAEntityCodefrom 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 Australian adaptation of the HL7 International CDA Entity class 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) | |
| name |
0..* | au-OrganizationName | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent entity's name XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| desc |
0..1 | ED | ||
| telecom |
0..* | TEL | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent entity's telecommunication details XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| addr |
0..* | AD | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent entity's address XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| asOrganizationPartOf |
0..* | au-OrganizationPartOf | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent a which organisation the entity is part of XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| asEntityIdentifier |
0..* | asEntityIdentifier | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent a entity's identifier XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| asQualifiedEntity |
0..1 | asQualifiedEntity | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent a qualified entity XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| personalRelationship |
0..* | personalRelationship | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent personal relationship of the entity XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| 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/CDAEntityCodefrom 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 Australian adaptation of the HL7 International CDA Entity class 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 |
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: EntityClassRoot (required) | |
| @determinerCode |
0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
| id |
0..* | II | ||
| code |
0..1 | CE | Binding: CDAEntityCode (example) | |
| name |
0..* | au-OrganizationName | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent entity's name XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| desc |
0..1 | ED | ||
| telecom |
0..* | TEL | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent entity's telecommunication details XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| addr |
0..* | AD | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent entity's address XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| asOrganizationPartOf |
0..* | au-OrganizationPartOf | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent a which organisation the entity is part of XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| asEntityIdentifier |
0..* | asEntityIdentifier | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent a entity's identifier XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| asQualifiedEntity |
0..1 | asQualifiedEntity | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent a qualified entity XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| personalRelationship |
0..* | personalRelationship | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent personal relationship of the entity XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Entity.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| Entity.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom 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/CDAEntityCodefrom this IG |
This structure is derived from InfrastructureRoot
Summary
Fixed: 1 element
Structures
This structure refers to these other structures:
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 Australian adaptation of the HL7 International CDA Entity class 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) | |
| name |
0..* | au-OrganizationName | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent entity's name XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| desc |
0..1 | ED | ||
| telecom |
0..* | TEL | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent entity's telecommunication details XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| addr |
0..* | AD | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent entity's address XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| asOrganizationPartOf |
0..* | au-OrganizationPartOf | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent a which organisation the entity is part of XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| asEntityIdentifier |
0..* | asEntityIdentifier | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent a entity's identifier XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| asQualifiedEntity |
0..1 | asQualifiedEntity | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent a qualified entity XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| personalRelationship |
0..* | personalRelationship | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent personal relationship of the entity XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| 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/CDAEntityCodefrom 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 Australian adaptation of the HL7 International CDA Entity class 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) | |
| name |
0..* | au-OrganizationName | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent entity's name XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| desc |
0..1 | ED | ||
| telecom |
0..* | TEL | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent entity's telecommunication details XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| addr |
0..* | AD | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent entity's address XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| asOrganizationPartOf |
0..* | au-OrganizationPartOf | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent a which organisation the entity is part of XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| asEntityIdentifier |
0..* | asEntityIdentifier | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent a entity's identifier XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| asQualifiedEntity |
0..1 | asQualifiedEntity | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent a qualified entity XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| personalRelationship |
0..* | personalRelationship | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent personal relationship of the entity XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| 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/CDAEntityCodefrom this IG |
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 Australian adaptation of the HL7 International CDA Entity class 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 |
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: EntityClassRoot (required) | |
| @determinerCode |
0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
| id |
0..* | II | ||
| code |
0..1 | CE | Binding: CDAEntityCode (example) | |
| name |
0..* | au-OrganizationName | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent entity's name XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| desc |
0..1 | ED | ||
| telecom |
0..* | TEL | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent entity's telecommunication details XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| addr |
0..* | AD | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent entity's address XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| asOrganizationPartOf |
0..* | au-OrganizationPartOf | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent a which organisation the entity is part of XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| asEntityIdentifier |
0..* | asEntityIdentifier | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent a entity's identifier XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| asQualifiedEntity |
0..1 | asQualifiedEntity | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent a qualified entity XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| personalRelationship |
0..* | personalRelationship | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent personal relationship of the entity XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Entity.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| Entity.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom 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/CDAEntityCodefrom this IG |
This structure is derived from InfrastructureRoot
Summary
Fixed: 1 element
Structures
This structure refers to these other structures:
IG © 2024+ Australian Digital Health Agency. Package au.digitalhealth.cda.schema#1.0.0 based on FHIR 5.0.0. Generated 2024-11-24
Links: Table of Contents | QA Report | Version History | Report an issue or propose a change
