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

Logical Model: au-CustodianOrganization - Detailed Descriptions

Active as of 2024-12-18

Definitions for the au-CustodianOrganization logical model.

Guidance on how to interpret the contents of this table can be found here

0. CustodianOrganization
ShortAustralian adaptation of the HL7 International CDA CustodianOrganization class
Control1..1
Logical ContainerADHA ClinicalDocument (CDA Class)
ValidationInstance of this type are validated by templateId
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
2. CustodianOrganization.classCode
Control0..1
BindingThe codes SHALL be taken from EntityClassOrganization
(required to http://terminology.hl7.org/ValueSet/v3-EntityClassOrganization)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueORG
4. CustodianOrganization.determinerCode
Control0..1
BindingThe codes SHALL be taken from EntityDeterminer
(required to http://terminology.hl7.org/ValueSet/v3-EntityDeterminer)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueINSTANCE
6. CustodianOrganization.id
Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
8. CustodianOrganization.name
Control0..1
Typehttp://ns.electronichealth.net.au/cda/StructureDefinition/au-OrganizationName
10. CustodianOrganization.telecom
ShortAustralian-adapted TelecommunicationAddress datatype
Control0..1
Typehttp://ns.electronichealth.net.au/cda/StructureDefinition/au-Telecom
12. CustodianOrganization.addr
ShortAustralian-adapted PostalAddress datatype
Control0..1
Typehttp://ns.electronichealth.net.au/cda/StructureDefinition/au-Address
14. CustodianOrganization.asEntityIdentifier
ShortADHA CDA extension to represent custodian organisation's identifier
Control0..*
Typehttp://ns.electronichealth.net.au/cda/StructureDefinition/asEntityIdentifier(ADHA extension asEntityIdentifier)
XML FormatIn the XML format, this property has the namespace http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0.

Guidance on how to interpret the contents of this table can be found here

0. CustodianOrganization
Definition

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.


Base definition for all types defined in FHIR type system.

ShortAustralian adaptation of the HL7 International CDA CustodianOrganization classBase for all types and resources
Control10..1*
Is Modifierfalse
Logical ContainerADHA ClinicalDocument (CDA Class)
ValidationInstance of this type are validated by templateId
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
2. CustodianOrganization.nullFlavor
Definition

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

Control0..1
BindingThe codes SHALL be taken from CDANullFlavor
(required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
4. CustodianOrganization.realmCode
Definition

When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
6. CustodianOrganization.typeId
Definition

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.

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
8. CustodianOrganization.typeId.nullFlavor
Definition

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

Control0..1
BindingThe codes SHALL be taken from CDANullFlavor
(required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
10. CustodianOrganization.typeId.assigningAuthorityName
Definition

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.

Control0..1
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelAssigning Authority Name
12. CustodianOrganization.typeId.displayable
Definition

Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).

Control0..1
Typeboolean(bl: Boolean)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelDisplayable
14. CustodianOrganization.typeId.root
Definition

Identifies the type as an HL7 Registered model

Control1..1
Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelRoot
Fixed Value2.16.840.1.113883.1.3
16. CustodianOrganization.typeId.extension
Definition

A character string as a unique identifier within the scope of the identifier root.

Control1..1
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExtension
18. CustodianOrganization.templateId
Definition

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

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
20. CustodianOrganization.classCode
Control0..1
BindingThe codes SHALL be taken from EntityClassOrganization
(required to http://terminology.hl7.org/ValueSet/v3-EntityClassOrganization)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueORG
22. CustodianOrganization.determinerCode
Control0..1
BindingThe codes SHALL be taken from EntityDeterminer
(required to http://terminology.hl7.org/ValueSet/v3-EntityDeterminer)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueINSTANCE
24. CustodianOrganization.id
Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
26. CustodianOrganization.name
Control0..1
Typehttp://ns.electronichealth.net.au/cda/StructureDefinition/au-OrganizationName
28. CustodianOrganization.telecom
ShortAustralian-adapted TelecommunicationAddress datatype
Control0..1
Typehttp://ns.electronichealth.net.au/cda/StructureDefinition/au-Telecom
30. CustodianOrganization.addr
ShortAustralian-adapted PostalAddress datatype
Control0..1
Typehttp://ns.electronichealth.net.au/cda/StructureDefinition/au-Address
32. CustodianOrganization.asEntityIdentifier
ShortADHA CDA extension to represent custodian organisation's identifier
Control0..*
Typehttp://ns.electronichealth.net.au/cda/StructureDefinition/asEntityIdentifier(ADHA extension asEntityIdentifier)
XML FormatIn the XML format, this property has the namespace http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0.

Guidance on how to interpret the contents of this table can be found here

0. CustodianOrganization
Definition

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.

ShortAustralian adaptation of the HL7 International CDA CustodianOrganization class
Control1..1
Is Modifierfalse
Logical ContainerADHA ClinicalDocument (CDA Class)
ValidationInstance of this type are validated by templateId
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
2. CustodianOrganization.nullFlavor
Definition

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

Control0..1
BindingThe codes SHALL be taken from CDANullFlavor
(required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
4. CustodianOrganization.realmCode
Definition

When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
6. CustodianOrganization.typeId
Definition

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.

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
8. CustodianOrganization.typeId.nullFlavor
Definition

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

Control0..1
BindingThe codes SHALL be taken from CDANullFlavor
(required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
10. CustodianOrganization.typeId.assigningAuthorityName
Definition

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.

Control0..1
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelAssigning Authority Name
12. CustodianOrganization.typeId.displayable
Definition

Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).

Control0..1
Typeboolean(bl: Boolean)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelDisplayable
14. CustodianOrganization.typeId.root
Definition

Identifies the type as an HL7 Registered model

Control1..1
Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelRoot
Fixed Value2.16.840.1.113883.1.3
16. CustodianOrganization.typeId.extension
Definition

A character string as a unique identifier within the scope of the identifier root.

Control1..1
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExtension
18. CustodianOrganization.templateId
Definition

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

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
20. CustodianOrganization.classCode
Control0..1
BindingThe codes SHALL be taken from EntityClassOrganization
(required to http://terminology.hl7.org/ValueSet/v3-EntityClassOrganization)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueORG
22. CustodianOrganization.determinerCode
Control0..1
BindingThe codes SHALL be taken from EntityDeterminer
(required to http://terminology.hl7.org/ValueSet/v3-EntityDeterminer)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueINSTANCE
24. CustodianOrganization.id
Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
26. CustodianOrganization.name
Control0..1
Typehttp://ns.electronichealth.net.au/cda/StructureDefinition/au-OrganizationName
28. CustodianOrganization.telecom
ShortAustralian-adapted TelecommunicationAddress datatype
Control0..1
Typehttp://ns.electronichealth.net.au/cda/StructureDefinition/au-Telecom
30. CustodianOrganization.addr
ShortAustralian-adapted PostalAddress datatype
Control0..1
Typehttp://ns.electronichealth.net.au/cda/StructureDefinition/au-Address
32. CustodianOrganization.asEntityIdentifier
ShortADHA CDA extension to represent custodian organisation's identifier
Control0..*
Typehttp://ns.electronichealth.net.au/cda/StructureDefinition/asEntityIdentifier(ADHA extension asEntityIdentifier)
XML FormatIn the XML format, this property has the namespace http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0.