ADHA extension asPersonalRelationship - Clinical Document Architecture with Australian Schema v1.0.0

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: ADHA extension asPersonalRelationship

Official URL: http://ns.electronichealth.net.au/cda/StructureDefinition/asPersonalRelationship				Version: 1.0.0
Active as of 2024-12-18				Computable Name: asPersonalRelationship
Copyright/Legal: 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/.

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

Usage:

Use this Logical Model Profile: ADHA extension personalRelationship

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

Differential Table
Key Elements Table
Snapshot Table
Statistics/References
All

This structure is derived from ANY

Name	Card.	Type	Description & Constraints
asPersonalRelationship	1..1	ANY	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor ADHA CDA extension to represent the relationship with a patient Logical Container: ADHA ClinicalDocument (CDA Class)
@classCode	1..1	cs	Fixed Value: PSN
@determinerCode	1..1	cs	Fixed Value: INSTANCE
id	1..1	II
administrativeGenderCode	0..1	CE
@nullFlavor	1..1	cs	Fixed Value: NA
Documentation for this format

Name	Card.	Type	Description & Constraints
asPersonalRelationship	1..1	ANY	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor ADHA CDA extension to represent the relationship with a patient Logical Container: ADHA ClinicalDocument (CDA Class)
@nullFlavor	0..1	cs	Binding: CDANullFlavor (required)
@classCode	1..1	cs	Fixed Value: PSN
@determinerCode	1..1	cs	Fixed Value: INSTANCE
id	1..1	II
administrativeGenderCode	0..1	CE
@nullFlavor	1..1	cs	Binding: CDANullFlavor (required) Fixed Value: NA
@code	0..1	cs
@codeSystem	0..1	oid, uuid, ruid
@codeSystemName	0..1	st
@codeSystemVersion	0..1	st
@displayName	0..1	st
@sdtcValueSet	0..1	oid	XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc)
@sdtcValueSetVersion	0..1	st	XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc)
originalText	0..1	ED
translation	0..*	CD
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
asPersonalRelationship.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` from this IG
asPersonalRelationship.administrativeGenderCode.nullFlavor	required	Fixed Value: NA `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` from this IG

Name	Card.	Type	Description & Constraints
asPersonalRelationship	1..1	ANY	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor ADHA CDA extension to represent the relationship with a patient Logical Container: ADHA ClinicalDocument (CDA Class)
@nullFlavor	0..1	cs	Binding: CDANullFlavor (required)
@classCode	1..1	cs	Fixed Value: PSN
@determinerCode	1..1	cs	Fixed Value: INSTANCE
id	1..1	II
administrativeGenderCode	0..1	CE
@nullFlavor	1..1	cs	Binding: CDANullFlavor (required) Fixed Value: NA
@code	0..1	cs
@codeSystem	0..1	oid, uuid, ruid
@codeSystemName	0..1	st
@codeSystemVersion	0..1	st
@displayName	0..1	st
@sdtcValueSet	0..1	oid	XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc)
@sdtcValueSetVersion	0..1	st	XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc)
originalText	0..1	ED
translation	0..*	CD
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
asPersonalRelationship.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` from this IG
asPersonalRelationship.administrativeGenderCode.nullFlavor	required	Fixed Value: NA `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` from this IG

This structure is derived from ANY

Summary

Mandatory: 0 element(4 nested mandatory elements)
Fixed: 3 elements

Structures

This structure refers to these other structures:

cs: Coded Simple Value (http://hl7.org/cda/stds/core/StructureDefinition/cs-simple)

Differential View

This structure is derived from ANY

Name	Card.	Type	Description & Constraints
asPersonalRelationship	1..1	ANY	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor ADHA CDA extension to represent the relationship with a patient Logical Container: ADHA ClinicalDocument (CDA Class)
@classCode	1..1	cs	Fixed Value: PSN
@determinerCode	1..1	cs	Fixed Value: INSTANCE
id	1..1	II
administrativeGenderCode	0..1	CE
@nullFlavor	1..1	cs	Fixed Value: NA
Documentation for this format

Key Elements View

Name	Card.	Type	Description & Constraints
asPersonalRelationship	1..1	ANY	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor ADHA CDA extension to represent the relationship with a patient Logical Container: ADHA ClinicalDocument (CDA Class)
@nullFlavor	0..1	cs	Binding: CDANullFlavor (required)
@classCode	1..1	cs	Fixed Value: PSN
@determinerCode	1..1	cs	Fixed Value: INSTANCE
id	1..1	II
administrativeGenderCode	0..1	CE
@nullFlavor	1..1	cs	Binding: CDANullFlavor (required) Fixed Value: NA
@code	0..1	cs
@codeSystem	0..1	oid, uuid, ruid
@codeSystemName	0..1	st
@codeSystemVersion	0..1	st
@displayName	0..1	st
@sdtcValueSet	0..1	oid	XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc)
@sdtcValueSetVersion	0..1	st	XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc)
originalText	0..1	ED
translation	0..*	CD
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
asPersonalRelationship.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` from this IG
asPersonalRelationship.administrativeGenderCode.nullFlavor	required	Fixed Value: NA `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` from this IG

Snapshot View

Name	Card.	Type	Description & Constraints
asPersonalRelationship	1..1	ANY	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor ADHA CDA extension to represent the relationship with a patient Logical Container: ADHA ClinicalDocument (CDA Class)
@nullFlavor	0..1	cs	Binding: CDANullFlavor (required)
@classCode	1..1	cs	Fixed Value: PSN
@determinerCode	1..1	cs	Fixed Value: INSTANCE
id	1..1	II
administrativeGenderCode	0..1	CE
@nullFlavor	1..1	cs	Binding: CDANullFlavor (required) Fixed Value: NA
@code	0..1	cs
@codeSystem	0..1	oid, uuid, ruid
@codeSystemName	0..1	st
@codeSystemVersion	0..1	st
@displayName	0..1	st
@sdtcValueSet	0..1	oid	XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc)
@sdtcValueSetVersion	0..1	st	XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc)
originalText	0..1	ED
translation	0..*	CD
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
asPersonalRelationship.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` from this IG
asPersonalRelationship.administrativeGenderCode.nullFlavor	required	Fixed Value: NA `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` from this IG

This structure is derived from ANY

Summary

Mandatory: 0 element(4 nested mandatory elements)
Fixed: 3 elements

Structures

This structure refers to these other structures:

cs: Coded Simple Value (http://hl7.org/cda/stds/core/StructureDefinition/cs-simple)

Other representations of profile: CSV, Excel