Clinical Document Architecture with Australian Schema
1.0.0 - current Australia flag

Clinical Document Architecture with Australian Schema - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Logical Model: asQualifiedEntity - Detailed Descriptions

Active as of 2024-08-29

Definitions for the asQualifiedEntity logical model.

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

0. asQualifications
Definition

The asQualifications extension describes a list of professional certifications, and certificates recognising having passed a course.

ShortADHA CDA extension to represent a person's occupation and employer
Control1..*
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. asQualifications.classCode
Control1..1
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 ValueQUAL
4. asQualifications.code
ShortADHA CDA extension to represent qualification code
Control1..1
Typehttp://ns.electronichealth.net.au/cda/StructureDefinition/au-Code
XML FormatIn the XML format, this property has the namespace http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0.
6. asQualifications.code.originalText
Definition

Qualifications is a text field, so the text list is entered in the originalText field of the code element.

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED

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

0. asQualifications
Definition

The asQualifications extension describes a list of professional certifications, and certificates recognising having passed a course.


Base definition for all types defined in FHIR type system.

ShortADHA CDA extension to represent a person's occupation and employerBase for all types and resources
Control10..*
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. asQualifications.classCode
Control1..1
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 ValueQUAL
4. asQualifications.code
ShortADHA CDA extension to represent qualification code
Control1..1
Typehttp://ns.electronichealth.net.au/cda/StructureDefinition/au-Code
XML FormatIn the XML format, this property has the namespace http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0.
6. asQualifications.code.originalText
Definition

Qualifications is a text field, so the text list is entered in the originalText field of the code element.

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
LabelOriginal Text

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

0. asQualifications
Definition

The asQualifications extension describes a list of professional certifications, and certificates recognising having passed a course.

ShortADHA CDA extension to represent a person's occupation and employer
Control1..*
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. asQualifications.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. asQualifications.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. asQualifications.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
8. asQualifications.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. asQualifications.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. asQualifications.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. asQualifications.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. asQualifications.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. asQualifications.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. asQualifications.classCode
Control1..1
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 ValueQUAL
22. asQualifications.code
ShortADHA CDA extension to represent qualification code
Control1..1
Typehttp://ns.electronichealth.net.au/cda/StructureDefinition/au-Code
XML FormatIn the XML format, this property has the namespace http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0.
24. asQualifications.code.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
26. asQualifications.code.code
Definition

The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache.

Control0..1
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.
LabelCode
28. asQualifications.code.codeSystem
Definition

Specifies the code system that defines the code.

Control0..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.
LabelCode System
30. asQualifications.code.codeSystemName
Definition

The common name of the coding system.

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.
LabelCode System Name
32. asQualifications.code.codeSystemVersion
Definition

If applicable, a version descriptor defined specifically for the given code system.

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.
LabelCode System Version
34. asQualifications.code.displayName
Definition

A name or title for the code, under which the sending system shows the code value to its users.

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.
LabelDisplay Name
36. asQualifications.code.originalText
Definition

Qualifications is a text field, so the text list is entered in the originalText field of the code element.

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
LabelOriginal Text
38. asQualifications.code.qualifier
Definition

Specifies additional codes that increase the specificity of the the primary code.

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CR
LabelQualifier
40. asQualifications.code.translation
Definition

A set of other concept descriptors that translate this concept descriptor into other code systems.

Control0..*
Typehttp://ns.electronichealth.net.au/cda/StructureDefinition/au-Code
XML FormatThe type of this property is determined using the xsi:typeattribute.
LabelTranslation