Clinical Document Architecture with Australian Schema
1.0.0 - current
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
| Official URL: http://hl7.org/cda/stds/core/StructureDefinition/RelatedEntity | Version: 1.0.0 | |||
| Active as of 2024-12-18 | Responsible: HL7 | Computable Name: RelatedEntity | ||
The RelatedEntity role is used to represent an informant without a role.id (e.g. a parent or guy on the street).
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from InfrastructureRoot
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  RelatedEntity |
1..1 | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Base for all types and resources Instance of this type are validated by templateId Logical Container: ADHA ClinicalDocument (CDA Class) | |
  @classCode |
1..1 | cs | Binding: CDARoleClassMutualRelationship (required) | |
 code |
0..1 | CE | Binding: PersonalRelationshipRoleType (example) | |
| addr |
0..* | AD | ||
| telecom |
0..* | TEL | ||
| effectiveTime |
0..1 | IVL_TS | ||
 relatedPerson |
0..1 | Person | ||
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| RelatedEntity.classCode | required | CDARoleClassMutualRelationshiphttp://hl7.org/cda/stds/core/ValueSet/CDARoleClassMutualRelationshipfrom this IG | |
| RelatedEntity.code | example | PersonalRelationshipRoleTypehttp://terminology.hl7.org/ValueSet/v3-PersonalRelationshipRoleType |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| RelatedEntity |
1..1 | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Base for all types and resources 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 |
C | 0..1 | II | II-1: An II instance must have either a root or an nullFlavor. |
 @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 | Binding: CDARoleClassMutualRelationship (required) | |
| code |
0..1 | CE | Binding: PersonalRelationshipRoleType (example) | |
| addr |
0..* | AD | ||
| telecom |
0..* | TEL | ||
| effectiveTime |
0..1 | IVL_TS | ||
| relatedPerson |
0..1 | Person | ||
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| RelatedEntity.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| RelatedEntity.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| RelatedEntity.classCode | required | CDARoleClassMutualRelationshiphttp://hl7.org/cda/stds/core/ValueSet/CDARoleClassMutualRelationshipfrom this IG | |
| RelatedEntity.code | example | PersonalRelationshipRoleTypehttp://terminology.hl7.org/ValueSet/v3-PersonalRelationshipRoleType |
| Id | Grade | Path(s) | Details | Requirements |
| II-1 | error | RelatedEntity.typeId | An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists() |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| RelatedEntity |
1..1 | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Base for all types and resources 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 |
C | 0..1 | II | II-1: An II instance must have either a root or an nullFlavor. |
| @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 | Binding: CDARoleClassMutualRelationship (required) | |
| code |
0..1 | CE | Binding: PersonalRelationshipRoleType (example) | |
| addr |
0..* | AD | ||
| telecom |
0..* | TEL | ||
| effectiveTime |
0..1 | IVL_TS | ||
| relatedPerson |
0..1 | Person | ||
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| RelatedEntity.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| RelatedEntity.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| RelatedEntity.classCode | required | CDARoleClassMutualRelationshiphttp://hl7.org/cda/stds/core/ValueSet/CDARoleClassMutualRelationshipfrom this IG | |
| RelatedEntity.code | example | PersonalRelationshipRoleTypehttp://terminology.hl7.org/ValueSet/v3-PersonalRelationshipRoleType |
| Id | Grade | Path(s) | Details | Requirements |
| II-1 | error | RelatedEntity.typeId | An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists() |
This structure is derived from InfrastructureRoot
Differential View
This structure is derived from InfrastructureRoot
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| RelatedEntity |
1..1 | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Base for all types and resources Instance of this type are validated by templateId Logical Container: ADHA ClinicalDocument (CDA Class) | |
| @classCode |
1..1 | cs | Binding: CDARoleClassMutualRelationship (required) | |
| code |
0..1 | CE | Binding: PersonalRelationshipRoleType (example) | |
| addr |
0..* | AD | ||
| telecom |
0..* | TEL | ||
| effectiveTime |
0..1 | IVL_TS | ||
| relatedPerson |
0..1 | Person | ||
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| RelatedEntity.classCode | required | CDARoleClassMutualRelationshiphttp://hl7.org/cda/stds/core/ValueSet/CDARoleClassMutualRelationshipfrom this IG | |
| RelatedEntity.code | example | PersonalRelationshipRoleTypehttp://terminology.hl7.org/ValueSet/v3-PersonalRelationshipRoleType |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| RelatedEntity |
1..1 | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Base for all types and resources 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 |
C | 0..1 | II | II-1: An II instance must have either a root or an nullFlavor. |
| @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 | Binding: CDARoleClassMutualRelationship (required) | |
| code |
0..1 | CE | Binding: PersonalRelationshipRoleType (example) | |
| addr |
0..* | AD | ||
| telecom |
0..* | TEL | ||
| effectiveTime |
0..1 | IVL_TS | ||
| relatedPerson |
0..1 | Person | ||
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| RelatedEntity.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| RelatedEntity.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| RelatedEntity.classCode | required | CDARoleClassMutualRelationshiphttp://hl7.org/cda/stds/core/ValueSet/CDARoleClassMutualRelationshipfrom this IG | |
| RelatedEntity.code | example | PersonalRelationshipRoleTypehttp://terminology.hl7.org/ValueSet/v3-PersonalRelationshipRoleType |
| Id | Grade | Path(s) | Details | Requirements |
| II-1 | error | RelatedEntity.typeId | An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| RelatedEntity |
1..1 | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Base for all types and resources 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 |
C | 0..1 | II | II-1: An II instance must have either a root or an nullFlavor. |
| @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 | Binding: CDARoleClassMutualRelationship (required) | |
| code |
0..1 | CE | Binding: PersonalRelationshipRoleType (example) | |
| addr |
0..* | AD | ||
| telecom |
0..* | TEL | ||
| effectiveTime |
0..1 | IVL_TS | ||
| relatedPerson |
0..1 | Person | ||
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| RelatedEntity.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| RelatedEntity.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| RelatedEntity.classCode | required | CDARoleClassMutualRelationshiphttp://hl7.org/cda/stds/core/ValueSet/CDARoleClassMutualRelationshipfrom this IG | |
| RelatedEntity.code | example | PersonalRelationshipRoleTypehttp://terminology.hl7.org/ValueSet/v3-PersonalRelationshipRoleType |
| Id | Grade | Path(s) | Details | Requirements |
| II-1 | error | RelatedEntity.typeId | An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists() |
This structure is derived from InfrastructureRoot
IG © 2024+ Australian Digital Health Agency. Package au.digitalhealth.cda.schema#1.0.0 based on FHIR 5.0.0. Generated 2024-12-18
Links: Table of Contents | QA Report | Version History | Report an issue or propose a change
