au-Entry
type: StructureDefinition
node role: treeRoot
id:
  v: au-Entry
text:
  status:
    v: generated
  div: CDA entries represent the structured computer-processable components within a document section. Each section can contain zero to many entries. Clinical documents contain a wide breadth of content, requiring much of the RIM to enable a full and complete encoding. The current set of CDA entries have been developed in response to identified requirements and scenarios that are in CDA's scope. Rather than creating specific entries for each scenario, similar requirements are merged to create broader entries, which can then be constrained within a particular realm or implementation. This approach is consistent with the approach taken by CEN, DICOM, and OpenEHR. The model for CDA entries is derived from the shared HL7 Clinical Statement model, which is a collaborative project between several committees striving to provide a consistent representation of clinical observations and acts across various V3 specifications.
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm
  value: integer
    v: 1
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/logical-target
  value: boolean
    extension:
      url:
        v: http://hl7.org/fhir/StructureDefinition/data-absent-reason
      value: code
        v: not-applicable
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/xml-namespace
  value: uri
    v: urn:hl7-org:v3
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/xml-name
  value: string
    v: entry
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/logical-container
  value: uri
    v: http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/type-profile-style
  value: code
    v: cda
url:
  v: http://ns.electronichealth.net.au/cda/StructureDefinition/au-Entry
version:
  v: 1.0.1
name:
  v: au-Entry
title:
  v: ADHA Entry (CDA Class)
status:
  v: active
experimental:
  v: false
date:
  v: 2025-10-10T09:58:30+10:00
publisher:
  v: Australian Digital Health Agency
contact:
  name:
    v: Australian Digital Health Agency
  telecom:
    system:
      v: email
description:
  v: **Australian adaptation of the [HL7 International CDA Entry class]( https://hl7.org/cda/stds/core/2.0.1-sd/StructureDefinition-Entry.html)**. 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
jurisdiction:
  coding:
    system:
      v: urn:iso:std:iso:3166
    code:
      v: AU
copyright:
  v: 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/](https://creativecommons.org/licenses/by/4.0/).
fhir version:
  v: 5.0.0
mapping:
  identity:
    v: rim
  uri:
    v: http://hl7.org/v3
  name:
    v: RIM Mapping
kind:
  v: logical
abstract:
  v: false
type:
  v: http://hl7.org/cda/stds/core/StructureDefinition/Entry
base definition:
  v: http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
  link: http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
derivation:
  v: specialization
snapshot:
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version
    value: string
      v: 1.0.1
  element:
    id:
      v: Entry
    path:
      v: Entry
    short:
      v: Australian adaptation of the HL7 International CDA Entry class
    definition:
      v: Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.
    min:
      v: 1
    max:
      v: *
    base:
      path:
        v: Base
      min:
        v: 0
      max:
        v: *
    constraint:
      key:
        v: entry-only-one
      severity:
        v: error
      human:
        v: SHALL have no more than one of act, encounter, observation, observationMedia, organizer, procedure, regionOfInterest, substanceAdministration, or supply.
      expression:
        v: (act | encounter | observation | observationMedia | organizer | procedure | regionOfInterest | substanceAdministration | supply).count() = 1
    is modifier:
      v: false
    mapping:
      identity:
        v: rim
      map:
        v: n/a
  element:
    id:
      v: Entry.nullFlavor
    path:
      v: Entry.nullFlavor
    representation:
      v: xmlAttr
    label:
      v: Exceptional Value Detail
    definition:
      v: If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
    min:
      v: 0
    max:
      v: 1
    base:
      path:
        v: ANY.nullFlavor
      min:
        v: 0
      max:
        v: 1
    type:
      code:
        v: code
      profile:
        v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
        link: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    binding:
      strength:
        v: required
      value set:
        v: http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
        link: http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
  element:
    id:
      v: Entry.realmCode
    path:
      v: Entry.realmCode
    definition:
      v: When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question
    min:
      v: 0
    max:
      v: *
    base:
      path:
        v: InfrastructureRoot.realmCode
      min:
        v: 0
      max:
        v: *
    type:
      code:
        v: http://hl7.org/cda/stds/core/StructureDefinition/CS
  element:
    id:
      v: Entry.typeId
    path:
      v: Entry.typeId
    definition:
      v: When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.
    min:
      v: 0
    max:
      v: 1

path:
  v: InfrastructureRoot.typeId
min:
  v: 0
max:
  v: 1

key:
  v: II-1
severity:
  v: error
human:
  v: An II instance must have either a root or an nullFlavor.
expression:
  v: root.exists() or nullFlavor.exists()
source:
  v: http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
  link: http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot

id:
  v: Entry.typeId.nullFlavor
path:
  v: Entry.typeId.nullFlavor
representation:
  v: xmlAttr
label:
  v: Exceptional Value Detail
definition:
  v: If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ANY.nullFlavor
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    link: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
binding:
  strength:
    v: required
  value set:
    v: http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    link: http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor

id:
  v: Entry.typeId.assigningAuthorityName
path:
  v: Entry.typeId.assigningAuthorityName
representation:
  v: xmlAttr
label:
  v: Assigning Authority Name
definition:
  v: A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: II.assigningAuthorityName
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
    link: http://hl7.org/cda/stds/core/StructureDefinition/st-simple

id:
  v: Entry.typeId.displayable
path:
  v: Entry.typeId.displayable
representation:
  v: xmlAttr
label:
  v: Displayable
definition:
  v: Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: II.displayable
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: boolean
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/bl-simple
    link: http://hl7.org/cda/stds/core/StructureDefinition/bl-simple

id:
  v: Entry.typeId.root
path:
  v: Entry.typeId.root
representation:
  v: xmlAttr
label:
  v: Root
definition:
  v: Identifies the type as an HL7 Registered model
min:
  v: 1
max:
  v: 1
base:
  path:
    v: II.root
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/oid
    link: http://hl7.org/cda/stds/core/StructureDefinition/oid
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/uuid
    link: http://hl7.org/cda/stds/core/StructureDefinition/uuid
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/ruid
    link: http://hl7.org/cda/stds/core/StructureDefinition/ruid
fixed: string
  v: 2.16.840.1.113883.1.3

id:
  v: Entry.typeId.extension
path:
  v: Entry.typeId.extension
representation:
  v: xmlAttr
label:
  v: Extension
definition:
  v: A character string as a unique identifier within the scope of the identifier root.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: II.extension
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
    link: http://hl7.org/cda/stds/core/StructureDefinition/st-simple

id:
  v: Entry.templateId
path:
  v: Entry.templateId
definition:
  v: When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question
min:
  v: 0
max:
  v: *
base:
  path:
    v: InfrastructureRoot.templateId
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/II

id:
  v: Entry.typeCode
path:
  v: Entry.typeCode
representation:
  v: xmlAttr
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Entry.typeCode
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    link: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
default value: code
  v: COMP
binding:
  strength:
    v: required
  value set:
    v: http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntry
    link: http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntry

id:
  v: Entry.contextConductionInd
path:
  v: Entry.contextConductionInd
representation:
  v: xmlAttr
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Entry.contextConductionInd
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: boolean
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/bl-simple
    link: http://hl7.org/cda/stds/core/StructureDefinition/bl-simple
fixed: boolean
  v: true

id:
  v: Entry.act
path:
  v: Entry.act
short:
  v: Australian-adapted Act class
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Entry.act
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://ns.electronichealth.net.au/cda/StructureDefinition/au-Act
  profile:
    v: http://ns.electronichealth.net.au/cda/StructureDefinition/au-Act
    link: http://ns.electronichealth.net.au/cda/StructureDefinition/au-Act

id:
  v: Entry.encounter
path:
  v: Entry.encounter
short:
  v: Australian-adapted Encounter class
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Entry.encounter
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://ns.electronichealth.net.au/cda/StructureDefinition/au-Encounter
  profile:
    v: http://ns.electronichealth.net.au/cda/StructureDefinition/au-Encounter
    link: http://ns.electronichealth.net.au/cda/StructureDefinition/au-Encounter

id:
  v: Entry.observation
path:
  v: Entry.observation
short:
  v: Australian-adapted Observation class
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Entry.observation
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://ns.electronichealth.net.au/cda/StructureDefinition/au-Observation
  profile:
    v: http://ns.electronichealth.net.au/cda/StructureDefinition/au-Observation
    link: http://ns.electronichealth.net.au/cda/StructureDefinition/au-Observation

id:
  v: Entry.observationMedia
path:
  v: Entry.observationMedia
short:
  v: Australian-adapted ObservationMedia class
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Entry.observationMedia
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://ns.electronichealth.net.au/cda/StructureDefinition/au-ObservationMedia
  profile:
    v: http://ns.electronichealth.net.au/cda/StructureDefinition/au-ObservationMedia
    link: http://ns.electronichealth.net.au/cda/StructureDefinition/au-ObservationMedia

id:
  v: Entry.organizer
path:
  v: Entry.organizer
short:
  v: Australian-adapted Organizer class
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Entry.organizer
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://ns.electronichealth.net.au/cda/StructureDefinition/au-Organizer
  profile:
    v: http://ns.electronichealth.net.au/cda/StructureDefinition/au-Organizer
    link: http://ns.electronichealth.net.au/cda/StructureDefinition/au-Organizer

id:
  v: Entry.procedure
path:
  v: Entry.procedure
short:
  v: Australian-adapted Procedure class
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Entry.procedure
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://ns.electronichealth.net.au/cda/StructureDefinition/au-Procedure
  profile:
    v: http://ns.electronichealth.net.au/cda/StructureDefinition/au-Procedure
    link: http://ns.electronichealth.net.au/cda/StructureDefinition/au-Procedure

id:
  v: Entry.regionOfInterest
path:
  v: Entry.regionOfInterest
short:
  v: Australian-adapted RegionOfInterest class
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Entry.regionOfInterest
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://ns.electronichealth.net.au/cda/StructureDefinition/au-RegionOfInterest
  profile:
    v: http://ns.electronichealth.net.au/cda/StructureDefinition/au-RegionOfInterest
    link: http://ns.electronichealth.net.au/cda/StructureDefinition/au-RegionOfInterest

id:
  v: Entry.substanceAdministration
path:
  v: Entry.substanceAdministration
short:
  v: Australian-adapted SubstanceAdministration class
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Entry.substanceAdministration
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://ns.electronichealth.net.au/cda/StructureDefinition/au-SubstanceAdministration
  profile:
    v: http://ns.electronichealth.net.au/cda/StructureDefinition/au-SubstanceAdministration
    link: http://ns.electronichealth.net.au/cda/StructureDefinition/au-SubstanceAdministration

id:
  v: Entry.supply
path:
  v: Entry.supply
short:
  v: Australian-adapted Supply class
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Entry.supply
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://ns.electronichealth.net.au/cda/StructureDefinition/au-Supply
  profile:
    v: http://ns.electronichealth.net.au/cda/StructureDefinition/au-Supply
    link: http://ns.electronichealth.net.au/cda/StructureDefinition/au-Supply

id:
  v: Entry.controlAct
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/xml-namespace
  value: uri
    v: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
path:
  v: Entry.controlAct
short:
  v: ADHA CDA extension to represent control act
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Entry.controlAct
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://ns.electronichealth.net.au/cda/StructureDefinition/controlAct
  profile:
    v: http://ns.electronichealth.net.au/cda/StructureDefinition/controlAct
    link: http://ns.electronichealth.net.au/cda/StructureDefinition/controlAct

element:
  id:
    v: Entry
  path:
    v: Entry
  short:
    v: Australian adaptation of the HL7 International CDA Entry class
  min:
    v: 1
  max:
    v: *
  constraint:
    key:
      v: entry-only-one
    severity:
      v: error
    human:
      v: SHALL have no more than one of act, encounter, observation, observationMedia, organizer, procedure, regionOfInterest, substanceAdministration, or supply.
    expression:
      v: (act | encounter | observation | observationMedia | organizer | procedure | regionOfInterest | substanceAdministration | supply).count() = 1
element:
  id:
    v: Entry.typeCode
  path:
    v: Entry.typeCode
  representation:
    v: xmlAttr
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: code
    profile:
      v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
      link: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
  default value: code
    v: COMP
  binding:
    strength:
      v: required
    value set:
      v: http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntry
      link: http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntry
element:
  id:
    v: Entry.contextConductionInd
  path:
    v: Entry.contextConductionInd
  representation:
    v: xmlAttr
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: boolean
    profile:
      v: http://hl7.org/cda/stds/core/StructureDefinition/bl-simple
      link: http://hl7.org/cda/stds/core/StructureDefinition/bl-simple
  fixed: boolean
    v: true
element:
  id:
    v: Entry.act
  path:
    v: Entry.act
  short:
    v: Australian-adapted Act class
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: http://ns.electronichealth.net.au/cda/StructureDefinition/au-Act
    profile:
      v: http://ns.electronichealth.net.au/cda/StructureDefinition/au-Act
      link: http://ns.electronichealth.net.au/cda/StructureDefinition/au-Act
element:
  id:
    v: Entry.encounter
  path:
    v: Entry.encounter
  short:
    v: Australian-adapted Encounter class
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: http://ns.electronichealth.net.au/cda/StructureDefinition/au-Encounter
    profile:
      v: http://ns.electronichealth.net.au/cda/StructureDefinition/au-Encounter
      link: http://ns.electronichealth.net.au/cda/StructureDefinition/au-Encounter
element:
  id:
    v: Entry.observation
  path:
    v: Entry.observation
  short:
    v: Australian-adapted Observation class
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: http://ns.electronichealth.net.au/cda/StructureDefinition/au-Observation
    profile:
      v: http://ns.electronichealth.net.au/cda/StructureDefinition/au-Observation
      link: http://ns.electronichealth.net.au/cda/StructureDefinition/au-Observation
element:
  id:
    v: Entry.observationMedia
  path:
    v: Entry.observationMedia
  short:
    v: Australian-adapted ObservationMedia class
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: http://ns.electronichealth.net.au/cda/StructureDefinition/au-ObservationMedia
    profile:
      v: http://ns.electronichealth.net.au/cda/StructureDefinition/au-ObservationMedia
      link: http://ns.electronichealth.net.au/cda/StructureDefinition/au-ObservationMedia
element:
  id:
    v: Entry.organizer
  path:
    v: Entry.organizer
  short:
    v: Australian-adapted Organizer class
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: http://ns.electronichealth.net.au/cda/StructureDefinition/au-Organizer
    profile:
      v: http://ns.electronichealth.net.au/cda/StructureDefinition/au-Organizer
      link: http://ns.electronichealth.net.au/cda/StructureDefinition/au-Organizer
element:
  id:
    v: Entry.procedure
  path:
    v: Entry.procedure
  short:
    v: Australian-adapted Procedure class
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: http://ns.electronichealth.net.au/cda/StructureDefinition/au-Procedure
    profile:
      v: http://ns.electronichealth.net.au/cda/StructureDefinition/au-Procedure
      link: http://ns.electronichealth.net.au/cda/StructureDefinition/au-Procedure
element:
  id:
    v: Entry.regionOfInterest
  path:
    v: Entry.regionOfInterest
  short:
    v: Australian-adapted RegionOfInterest class
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: http://ns.electronichealth.net.au/cda/StructureDefinition/au-RegionOfInterest
    profile:
      v: http://ns.electronichealth.net.au/cda/StructureDefinition/au-RegionOfInterest
      link: http://ns.electronichealth.net.au/cda/StructureDefinition/au-RegionOfInterest
element:
  id:
    v: Entry.substanceAdministration
  path:
    v: Entry.substanceAdministration
  short:
    v: Australian-adapted SubstanceAdministration class
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: http://ns.electronichealth.net.au/cda/StructureDefinition/au-SubstanceAdministration
    profile:
      v: http://ns.electronichealth.net.au/cda/StructureDefinition/au-SubstanceAdministration
      link: http://ns.electronichealth.net.au/cda/StructureDefinition/au-SubstanceAdministration

id:
  v: Entry.supply
path:
  v: Entry.supply
short:
  v: Australian-adapted Supply class
min:
  v: 0
max:
  v: 1
type:
  code:
    v: http://ns.electronichealth.net.au/cda/StructureDefinition/au-Supply
  profile:
    v: http://ns.electronichealth.net.au/cda/StructureDefinition/au-Supply
    link: http://ns.electronichealth.net.au/cda/StructureDefinition/au-Supply

id:
  v: Entry.controlAct
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/xml-namespace
  value: uri
    v: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
path:
  v: Entry.controlAct
short:
  v: ADHA CDA extension to represent control act
min:
  v: 0
max:
  v: 1
type:
  code:
    v: http://ns.electronichealth.net.au/cda/StructureDefinition/controlAct
  profile:
    v: http://ns.electronichealth.net.au/cda/StructureDefinition/controlAct
    link: http://ns.electronichealth.net.au/cda/StructureDefinition/controlAct