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

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

Official URL: http://ns.electronichealth.net.au/cda/StructureDefinition/personalRelationship				Version: 1.0.0
Active as of 2024-08-29				Computable Name: personalRelationship
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 Entity (CDA Class), ADHA Patient (CDA Class) and ADHA Person (CDA Class)

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 InfrastructureRoot

Name	Card.	Type	Description & Constraints
personalRelationship	1..*	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId ADHA CDA extension to represent relationship with patient Instance of this type are validated by templateId Logical Container: ADHA ClinicalDocument (CDA Class)
@classCode	1..1	cs	Fixed Value: PRS
id	0..1	II	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent identification details XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
code	1..1	CD	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent code XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
addr	0..1	AD	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent address details XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
telecom	0..1	TEL	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent telecommunication details XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
statusCode	0..1	CD	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent the status of the relationship XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
effectiveTime	0..1	TS	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent effective time of the relationship XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
asPersonalRelationship	0..1	asPersonalRelationship	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent further personal relationship details XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
Documentation for this format

Name	Card.	Type	Description & Constraints
personalRelationship	1..*	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId ADHA CDA extension to represent relationship with patient Instance of this type are validated by templateId Logical Container: ADHA ClinicalDocument (CDA Class)
@classCode	1..1	cs	Fixed Value: PRS
id	0..1	II	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent identification details XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
code	1..1	CD	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent code XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
addr	0..1	AD	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent address details XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
telecom	0..1	TEL	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent telecommunication details XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
statusCode	0..1	CD	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent the status of the relationship XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
effectiveTime	0..1	TS	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent effective time of the relationship XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
asPersonalRelationship	0..1	asPersonalRelationship	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent further personal relationship details XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
Documentation for this format

Name	Card.	Type	Description & Constraints
personalRelationship	1..*	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId ADHA CDA extension to represent relationship with patient Instance of this type are validated by templateId Logical Container: ADHA ClinicalDocument (CDA Class)
@nullFlavor	0..1	cs	Binding: CDANullFlavor (required)
realmCode	0..*	CS
typeId	0..1	II
@nullFlavor	0..1	cs	Binding: CDANullFlavor (required)
@assigningAuthorityName	0..1	st
@displayable	0..1	bl
@root	1..1	oid, uuid, ruid	Fixed Value: 2.16.840.1.113883.1.3
@extension	1..1	st
templateId	0..*	II
@classCode	1..1	cs	Fixed Value: PRS
id	0..1	II	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent identification details XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
code	1..1	CD	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent code XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
addr	0..1	AD	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent address details XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
telecom	0..1	TEL	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent telecommunication details XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
statusCode	0..1	CD	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent the status of the relationship XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
effectiveTime	0..1	TS	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent effective time of the relationship XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
asPersonalRelationship	0..1	asPersonalRelationship	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent further personal relationship details XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
personalRelationship.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` from this IG
personalRelationship.typeId.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` from this IG

This structure is derived from InfrastructureRoot

Summary

Mandatory: 0 element(2 nested mandatory elements)
Fixed: 1 element

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 InfrastructureRoot

Name	Card.	Type	Description & Constraints
personalRelationship	1..*	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId ADHA CDA extension to represent relationship with patient Instance of this type are validated by templateId Logical Container: ADHA ClinicalDocument (CDA Class)
@classCode	1..1	cs	Fixed Value: PRS
id	0..1	II	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent identification details XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
code	1..1	CD	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent code XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
addr	0..1	AD	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent address details XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
telecom	0..1	TEL	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent telecommunication details XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
statusCode	0..1	CD	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent the status of the relationship XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
effectiveTime	0..1	TS	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent effective time of the relationship XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
asPersonalRelationship	0..1	asPersonalRelationship	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent further personal relationship details XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
Documentation for this format

Key Elements View

Name	Card.	Type	Description & Constraints
personalRelationship	1..*	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId ADHA CDA extension to represent relationship with patient Instance of this type are validated by templateId Logical Container: ADHA ClinicalDocument (CDA Class)
@classCode	1..1	cs	Fixed Value: PRS
id	0..1	II	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent identification details XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
code	1..1	CD	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent code XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
addr	0..1	AD	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent address details XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
telecom	0..1	TEL	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent telecommunication details XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
statusCode	0..1	CD	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent the status of the relationship XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
effectiveTime	0..1	TS	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent effective time of the relationship XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
asPersonalRelationship	0..1	asPersonalRelationship	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent further personal relationship details XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
Documentation for this format

Snapshot View

Name	Card.	Type	Description & Constraints
personalRelationship	1..*	InfrastructureRoot	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId ADHA CDA extension to represent relationship with patient Instance of this type are validated by templateId Logical Container: ADHA ClinicalDocument (CDA Class)
@nullFlavor	0..1	cs	Binding: CDANullFlavor (required)
realmCode	0..*	CS
typeId	0..1	II
@nullFlavor	0..1	cs	Binding: CDANullFlavor (required)
@assigningAuthorityName	0..1	st
@displayable	0..1	bl
@root	1..1	oid, uuid, ruid	Fixed Value: 2.16.840.1.113883.1.3
@extension	1..1	st
templateId	0..*	II
@classCode	1..1	cs	Fixed Value: PRS
id	0..1	II	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent identification details XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
code	1..1	CD	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent code XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
addr	0..1	AD	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent address details XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
telecom	0..1	TEL	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent telecommunication details XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
statusCode	0..1	CD	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent the status of the relationship XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
effectiveTime	0..1	TS	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent effective time of the relationship XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
asPersonalRelationship	0..1	asPersonalRelationship	XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent further personal relationship details XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
personalRelationship.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` from this IG
personalRelationship.typeId.nullFlavor	required	CDANullFlavor `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor` from this IG

This structure is derived from InfrastructureRoot

Summary

Mandatory: 0 element(2 nested mandatory elements)
Fixed: 1 element

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

IG © 2024+ Australian Digital Health Agency. Package au.digitalhealth.cda.schema#1.0.0 based on FHIR 5.0.0. Generated 2024-08-29
Links: Table of Contents | QA Report | Version History | Report an issue or propose a change