| Package | au.digitalhealth.cda.schema |
| Resource Type | StructureDefinition |
| Id | asPersonalRelationship |
| FHIR Version | R5 |
| Source | http://ns.electronichealth.net.au/cda/https://build.fhir.org/ig/AuDigitalHealth/cda-au-schema/StructureDefinition-asPersonalRelationship.html |
| URL | http://ns.electronichealth.net.au/cda/StructureDefinition/asPersonalRelationship |
| Version | 1.0.0 |
| Status | active |
| Date | 2025-07-24T05:34:11+00:00 |
| Name | asPersonalRelationship |
| Title | ADHA extension asPersonalRelationship |
| Realm | au |
| Authority | national |
| Description | The relationship of a participant to a subject of care (patient). |
| Copyright | 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/](https://creativecommons.org/licenses/by/4.0/). |
| Type | http://ns.electronichealth.net.au/cda/StructureDefinition/asPersonalRelationship |
| Kind | logical |
| StructureDefinition | |
| personalRelationship | ADHA extension personalRelationship |
| StructureDefinition | |
| ANY | ANY: DataValue (V3 Data Type) |
| CE | CE: CodedWithEquivalents (V3 Data Type) |
| II | II: InstanceIdentifier (V3 Data Type) |
| cs-simple | cs: Coded Simple Value |
Note: links and images are rebased to the (stated) source
Generated Narrative: StructureDefinition asPersonalRelationship
| Name | Flags | 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: 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 | ||||
FHIR{
"resourceType": "StructureDefinition",
"id": "asPersonalRelationship",
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/logical-target",
"_valueBoolean": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
"valueCode": "not-applicable"
}
]
}
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-namespace",
"valueUri": "urn:hl7-org:v3"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:v3"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/logical-container",
"valueUri": "http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 1,
"_valueInteger": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical": "http://ns.electronichealth.net.au/cda/ImplementationGuide/au.digitalhealth.cda.schema"
}
]
}
}
],
"url": "http://ns.electronichealth.net.au/cda/StructureDefinition/asPersonalRelationship",
"version": "1.0.0",
"name": "asPersonalRelationship",
"title": "ADHA extension asPersonalRelationship",
"status": "active",
"experimental": false,
"date": "2025-07-24T05:34:11+00:00",
"publisher": "Australian Digital Health Agency",
"contact": [
{
"name": "Australian Digital Health Agency",
"telecom": [
{
"system": "email",
"value": "mailto:help@digitalhealth.gov.au"
}
]
}
],
"description": "The relationship of a participant to a subject of care (patient).",
"jurisdiction": [
{
"coding": [
{
"system": "urn:iso:std:iso:3166",
"code": "AU"
}
]
}
],
"copyright": "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/](https://creativecommons.org/licenses/by/4.0/).",
"fhirVersion": "5.0.0",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}
],
"kind": "logical",
"abstract": false,
"type": "http://ns.electronichealth.net.au/cda/StructureDefinition/asPersonalRelationship",
"baseDefinition": "http://hl7.org/cda/stds/core/StructureDefinition/ANY",
"derivation": "specialization",
"snapshot": {
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString": "1.0.0"
}
],
"element": [
{
"id": "asPersonalRelationship",
"path": "asPersonalRelationship",
"short": "ADHA CDA extension to represent the relationship with a patient",
"definition": "The relationship of a participant to a subject of care (patient).",
"min": 1,
"max": "1",
"base": {
"path": "Base",
"min": 0,
"max": "*"
},
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "asPersonalRelationship.nullFlavor",
"path": "asPersonalRelationship.nullFlavor",
"representation": [
"xmlAttr"
],
"label": "Exceptional Value Detail",
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min": 0,
"max": "1",
"base": {
"path": "ANY.nullFlavor",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id": "asPersonalRelationship.classCode",
"path": "asPersonalRelationship.classCode",
"representation": [
"xmlAttr"
],
"min": 1,
"max": "1",
"base": {
"path": "asPersonalRelationship.classCode",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode": "PSN"
},
{
"id": "asPersonalRelationship.determinerCode",
"path": "asPersonalRelationship.determinerCode",
"representation": [
"xmlAttr"
],
"min": 1,
"max": "1",
"base": {
"path": "asPersonalRelationship.determinerCode",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode": "INSTANCE"
},
{
"id": "asPersonalRelationship.id",
"path": "asPersonalRelationship.id",
"min": 1,
"max": "1",
"base": {
"path": "asPersonalRelationship.id",
"min": 1,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id": "asPersonalRelationship.administrativeGenderCode",
"path": "asPersonalRelationship.administrativeGenderCode",
"min": 0,
"max": "1",
"base": {
"path": "asPersonalRelationship.administrativeGenderCode",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CE"
}
]
},
{
"id": "asPersonalRelationship.administrativeGenderCode.nullFlavor",
"path": "asPersonalRelationship.administrativeGenderCode.nullFlavor",
"representation": [
"xmlAttr"
],
"label": "Exceptional Value Detail",
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min": 1,
"max": "1",
"base": {
"path": "ANY.nullFlavor",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode": "NA",
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id": "asPersonalRelationship.administrativeGenderCode.code",
"path": "asPersonalRelationship.administrativeGenderCode.code",
"representation": [
"xmlAttr"
],
"label": "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.",
"min": 0,
"max": "1",
"base": {
"path": "CD.code",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
]
},
{
"id": "asPersonalRelationship.administrativeGenderCode.codeSystem",
"path": "asPersonalRelationship.administrativeGenderCode.codeSystem",
"representation": [
"xmlAttr"
],
"label": "Code System",
"definition": "Specifies the code system that defines the code.",
"min": 0,
"max": "1",
"base": {
"path": "CD.codeSystem",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/oid",
"http://hl7.org/cda/stds/core/StructureDefinition/uuid",
"http://hl7.org/cda/stds/core/StructureDefinition/ruid"
]
}
]
},
{
"id": "asPersonalRelationship.administrativeGenderCode.codeSystemName",
"path": "asPersonalRelationship.administrativeGenderCode.codeSystemName",
"representation": [
"xmlAttr"
],
"label": "Code System Name",
"definition": "The common name of the coding system.",
"min": 0,
"max": "1",
"base": {
"path": "CD.codeSystemName",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id": "asPersonalRelationship.administrativeGenderCode.codeSystemVersion",
"path": "asPersonalRelationship.administrativeGenderCode.codeSystemVersion",
"representation": [
"xmlAttr"
],
"label": "Code System Version",
"definition": "If applicable, a version descriptor defined specifically for the given code system.",
"min": 0,
"max": "1",
"base": {
"path": "CD.codeSystemVersion",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id": "asPersonalRelationship.administrativeGenderCode.displayName",
"path": "asPersonalRelationship.administrativeGenderCode.displayName",
"representation": [
"xmlAttr"
],
"label": "Display Name",
"definition": "A name or title for the code, under which the sending system shows the code value to its users.",
"min": 0,
"max": "1",
"base": {
"path": "CD.displayName",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id": "asPersonalRelationship.administrativeGenderCode.sdtcValueSet",
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "valueSet"
}
],
"path": "asPersonalRelationship.administrativeGenderCode.sdtcValueSet",
"representation": [
"xmlAttr"
],
"definition": "The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.",
"min": 0,
"max": "1",
"base": {
"path": "CD.valueSet",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/oid"
]
}
]
},
{
"id": "asPersonalRelationship.administrativeGenderCode.sdtcValueSetVersion",
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:sdtc"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "valueSetVersion"
}
],
"path": "asPersonalRelationship.administrativeGenderCode.sdtcValueSetVersion",
"representation": [
"xmlAttr"
],
"definition": "The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept.",
"min": 0,
"max": "1",
"base": {
"path": "CD.sdtcValueSetVersion",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id": "asPersonalRelationship.administrativeGenderCode.originalText",
"path": "asPersonalRelationship.administrativeGenderCode.originalText",
"label": "Original Text",
"definition": "The text or phrase used as the basis for the coding.",
"min": 0,
"max": "1",
"base": {
"path": "CD.originalText",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ED"
}
]
},
{
"id": "asPersonalRelationship.administrativeGenderCode.qualifier",
"path": "asPersonalRelationship.administrativeGenderCode.qualifier",
"label": "Qualifier",
"definition": "Specifies additional codes that increase the specificity of the the primary code.",
"min": 0,
"max": "0",
"base": {
"path": "CD.qualifier",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CR"
}
]
},
{
"id": "asPersonalRelationship.administrativeGenderCode.translation",
"path": "asPersonalRelationship.administrativeGenderCode.translation",
"representation": [
"typeAttr"
],
"label": "Translation",
"definition": "A set of other concept descriptors that translate this concept descriptor into other code systems.",
"min": 0,
"max": "*",
"base": {
"path": "CD.translation",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CD"
}
]
}
]
},
"differential": {
"element": [
{
"id": "asPersonalRelationship",
"path": "asPersonalRelationship",
"short": "ADHA CDA extension to represent the relationship with a patient",
"definition": "The relationship of a participant to a subject of care (patient).",
"min": 1,
"max": "1"
},
{
"id": "asPersonalRelationship.classCode",
"path": "asPersonalRelationship.classCode",
"representation": [
"xmlAttr"
],
"min": 1,
"max": "1",
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode": "PSN"
},
{
"id": "asPersonalRelationship.determinerCode",
"path": "asPersonalRelationship.determinerCode",
"representation": [
"xmlAttr"
],
"min": 1,
"max": "1",
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode": "INSTANCE"
},
{
"id": "asPersonalRelationship.id",
"path": "asPersonalRelationship.id",
"min": 1,
"max": "1",
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id": "asPersonalRelationship.administrativeGenderCode",
"path": "asPersonalRelationship.administrativeGenderCode",
"min": 0,
"max": "1",
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CE"
}
]
},
{
"id": "asPersonalRelationship.administrativeGenderCode.nullFlavor",
"path": "asPersonalRelationship.administrativeGenderCode.nullFlavor",
"representation": [
"xmlAttr"
],
"min": 1,
"max": "1",
"fixedCode": "NA"
}
]
}
}