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://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship | Version: 1.0.0 | |||
| Active as of 2025-08-28 | Maturity Level: 1 | Responsible: HL7 | Computable Name: EntryRelationship | |
CDA entries represent the structured computer-processable components within a document section. Each section can contain zero to many entries.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Path | Conformance | ValueSet | URI |
| EntryRelationship.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorFrom this IG | |
| EntryRelationship.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorFrom this IG | |
| EntryRelationship.typeCode | required | XActRelationshipEntryRelationshiphttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship |
| Id | Grade | Path(s) | Details | Requirements |
| II-1 | error | EntryRelationship.typeId | An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists() | |
| entry-rel-only-one | error | EntryRelationship | SHALL have no more than one of act, encounter, observation, observationMedia, organizer, procedure, regionOfInterest, substanceAdministration, or supply. : (act | encounter | observation | observationMedia | organizer | procedure | regionOfInterest | substanceAdministration | supply).count() = 1 |
This structure is derived from InfrastructureRoot
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  EntryRelationship |
C | 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: ClinicalDocument (CDA Class) Constraints: entry-rel-only-one |
  @typeCode |
1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) | |
| @inversionInd |
0..1 | bl | ||
| @contextConductionInd |
0..1 | bl | ||
| @negationInd |
0..1 | bl | ||
 sequenceNumber |
0..1 | INT | ||
| seperatableInd |
0..1 | BL | ||
  (Choice of one) |
1..1 | |||
  act |
0..1 | Act | ||
| encounter |
0..1 | Encounter | ||
| observation |
0..1 | Observation | ||
| observationMedia |
0..1 | ObservationMedia | ||
| organizer |
0..1 | Organizer | ||
| procedure |
0..1 | Procedure | ||
| regionOfInterest |
0..1 | RegionOfInterest | ||
| substanceAdministration |
0..1 | SubstanceAdministration | ||
 supply |
0..1 | Supply | ||
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| EntryRelationship.typeCode | required | XActRelationshipEntryRelationshiphttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship |
| Id | Grade | Path(s) | Details | Requirements |
| entry-rel-only-one | error | EntryRelationship | SHALL have no more than one of act, encounter, observation, observationMedia, organizer, procedure, regionOfInterest, substanceAdministration, or supply. : (act | encounter | observation | observationMedia | organizer | procedure | regionOfInterest | substanceAdministration | supply).count() = 1 |
| Path | Conformance | ValueSet | URI |
| EntryRelationship.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorFrom this IG | |
| EntryRelationship.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorFrom this IG | |
| EntryRelationship.typeCode | required | XActRelationshipEntryRelationshiphttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship |
| Id | Grade | Path(s) | Details | Requirements |
| II-1 | error | EntryRelationship.typeId | An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists() | |
| entry-rel-only-one | error | EntryRelationship | SHALL have no more than one of act, encounter, observation, observationMedia, organizer, procedure, regionOfInterest, substanceAdministration, or supply. : (act | encounter | observation | observationMedia | organizer | procedure | regionOfInterest | substanceAdministration | supply).count() = 1 |
This structure is derived from InfrastructureRoot
Summary
Mandatory: 0 element(1 nested mandatory element)
Structures
This structure refers to these other structures:
Maturity: 1
Key Elements View
| Path | Conformance | ValueSet | URI |
| EntryRelationship.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorFrom this IG | |
| EntryRelationship.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorFrom this IG | |
| EntryRelationship.typeCode | required | XActRelationshipEntryRelationshiphttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship |
| Id | Grade | Path(s) | Details | Requirements |
| II-1 | error | EntryRelationship.typeId | An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists() | |
| entry-rel-only-one | error | EntryRelationship | SHALL have no more than one of act, encounter, observation, observationMedia, organizer, procedure, regionOfInterest, substanceAdministration, or supply. : (act | encounter | observation | observationMedia | organizer | procedure | regionOfInterest | substanceAdministration | supply).count() = 1 |
Differential View
This structure is derived from InfrastructureRoot
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| EntryRelationship |
C | 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: ClinicalDocument (CDA Class) Constraints: entry-rel-only-one |
| @typeCode |
1..1 | cs | Binding: x_ActRelationshipEntryRelationship (required) | |
| @inversionInd |
0..1 | bl | ||
| @contextConductionInd |
0..1 | bl | ||
| @negationInd |
0..1 | bl | ||
| sequenceNumber |
0..1 | INT | ||
| seperatableInd |
0..1 | BL | ||
| (Choice of one) |
1..1 | |||
| act |
0..1 | Act | ||
| encounter |
0..1 | Encounter | ||
| observation |
0..1 | Observation | ||
| observationMedia |
0..1 | ObservationMedia | ||
| organizer |
0..1 | Organizer | ||
| procedure |
0..1 | Procedure | ||
| regionOfInterest |
0..1 | RegionOfInterest | ||
| substanceAdministration |
0..1 | SubstanceAdministration | ||
| supply |
0..1 | Supply | ||
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| EntryRelationship.typeCode | required | XActRelationshipEntryRelationshiphttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship |
| Id | Grade | Path(s) | Details | Requirements |
| entry-rel-only-one | error | EntryRelationship | SHALL have no more than one of act, encounter, observation, observationMedia, organizer, procedure, regionOfInterest, substanceAdministration, or supply. : (act | encounter | observation | observationMedia | organizer | procedure | regionOfInterest | substanceAdministration | supply).count() = 1 |
Snapshot View
| Path | Conformance | ValueSet | URI |
| EntryRelationship.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorFrom this IG | |
| EntryRelationship.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorFrom this IG | |
| EntryRelationship.typeCode | required | XActRelationshipEntryRelationshiphttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship |
| Id | Grade | Path(s) | Details | Requirements |
| II-1 | error | EntryRelationship.typeId | An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists() | |
| entry-rel-only-one | error | EntryRelationship | SHALL have no more than one of act, encounter, observation, observationMedia, organizer, procedure, regionOfInterest, substanceAdministration, or supply. : (act | encounter | observation | observationMedia | organizer | procedure | regionOfInterest | substanceAdministration | supply).count() = 1 |
This structure is derived from InfrastructureRoot
Summary
Mandatory: 0 element(1 nested mandatory element)
Structures
This structure refers to these other structures:
Maturity: 1
IG © 2024+ Australian Digital Health Agency. Package au.digitalhealth.cda.schema#1.0.0 based on FHIR 5.0.0. Generated 2025-08-28
Links: Table of Contents | QA Report | Version History | Report an issue or propose a change
