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: asPersonalRelationship - Detailed Descriptions

Active as of 2024-08-29

Definitions for the asPersonalRelationship logical model.

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

0. asPersonalRelationship
Definition

The relationship of a participant to a subject of care (patient).

ShortADHA CDA extension to represent the relationship with a patient
Control1..1
Logical ContainerADHA ClinicalDocument (CDA Class)
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
2. asPersonalRelationship.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 ValuePSN
4. asPersonalRelationship.determinerCode
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 ValueINSTANCE
6. asPersonalRelationship.id
Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
8. asPersonalRelationship.administrativeGenderCode
Control0..1
Typehttp://ns.electronichealth.net.au/cda/StructureDefinition/au-CE
10. asPersonalRelationship.administrativeGenderCode.nullFlavor
Control1..1
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueNA

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

0. asPersonalRelationship
Definition

The relationship of a participant to a subject of care (patient).


Base definition for all types defined in FHIR type system.

ShortADHA CDA extension to represent the relationship with a patientBase for all types and resources
Control10..1*
Is Modifierfalse
Logical ContainerADHA ClinicalDocument (CDA Class)
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
2. asPersonalRelationship.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 ValuePSN
4. asPersonalRelationship.determinerCode
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 ValueINSTANCE
6. asPersonalRelationship.id
Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
8. asPersonalRelationship.administrativeGenderCode
Control0..1
Typehttp://ns.electronichealth.net.au/cda/StructureDefinition/au-CE
10. asPersonalRelationship.administrativeGenderCode.nullFlavor
Definition

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

Control1..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
Fixed ValueNA
12. asPersonalRelationship.administrativeGenderCode.qualifier
Definition

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

Control0..0
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CR
LabelQualifier

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

0. asPersonalRelationship
Definition

The relationship of a participant to a subject of care (patient).

ShortADHA CDA extension to represent the relationship with a patient
Control1..1
Is Modifierfalse
Logical ContainerADHA ClinicalDocument (CDA Class)
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
2. asPersonalRelationship.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. asPersonalRelationship.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 ValuePSN
6. asPersonalRelationship.determinerCode
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 ValueINSTANCE
8. asPersonalRelationship.id
Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
10. asPersonalRelationship.administrativeGenderCode
Control0..1
Typehttp://ns.electronichealth.net.au/cda/StructureDefinition/au-CE
12. asPersonalRelationship.administrativeGenderCode.nullFlavor
Definition

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

Control1..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
Fixed ValueNA
14. asPersonalRelationship.administrativeGenderCode.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
16. asPersonalRelationship.administrativeGenderCode.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
18. asPersonalRelationship.administrativeGenderCode.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
20. asPersonalRelationship.administrativeGenderCode.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
22. asPersonalRelationship.administrativeGenderCode.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
24. asPersonalRelationship.administrativeGenderCode.originalText
Definition

The text or phrase used as the basis for the coding.

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
LabelOriginal Text
26. asPersonalRelationship.administrativeGenderCode.qualifier
Definition

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

Control0..0
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CR
LabelQualifier
28. asPersonalRelationship.administrativeGenderCode.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