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: PatientRole (CDA Class)

Official URL: http://hl7.org/cda/stds/core/StructureDefinition/PatientRole Version: 1.0.0
Active as of 2024-12-18 Responsible: HL7 Computable Name: PatientRole

A recordTarget is represented as a relationship between a person and an organization, where the person is in a patient role (PatientRole class). The entity playing the role is a patient (Patient class). The entity scoping the role is an organization (Organization class). A patient is uniquely identified via the PatientRole.id attribute.

Usage:

Formal Views of Profile Content

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

This structure is derived from InfrastructureRoot

NameFlagsCard.TypeDescription & Constraintsdoco
.. PatientRole 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 0..1 cs Binding: RoleClassRelationshipFormal (required)
Fixed Value: PAT
... id 1..* II
... sdtcIdentifiedBy 0..* IdentifiedBy XML Namespace: urn:hl7-org:sdtc
XML: identifiedBy (urn:hl7-org:sdtc)
... telecom 0..* TEL
... patient 0..1 Patient
... providerOrganization 0..1 Organization

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet / CodeURI
PatientRole.classCoderequiredFixed Value: PAT
http://terminology.hl7.org/ValueSet/v3-RoleClassRelationshipFormal
NameFlagsCard.TypeDescription & Constraintsdoco
.. PatientRole 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
... @classCode 0..1 cs Binding: RoleClassRelationshipFormal (required)
Fixed Value: PAT
... id 1..* II
... sdtcIdentifiedBy 0..* IdentifiedBy XML Namespace: urn:hl7-org:sdtc
XML: identifiedBy (urn:hl7-org:sdtc)
... addr 0..* AD
... telecom 0..* TEL
... patient 0..1 Patient
... providerOrganization 0..1 Organization

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
PatientRole.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
PatientRole.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
PatientRole.classCoderequiredFixed Value: PAT
http://terminology.hl7.org/ValueSet/v3-RoleClassRelationshipFormal

Constraints

IdGradePath(s)DetailsRequirements
II-1errorPatientRole.typeIdAn II instance must have either a root or an nullFlavor.
: root.exists() or nullFlavor.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. PatientRole 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
... @classCode 0..1 cs Binding: RoleClassRelationshipFormal (required)
Fixed Value: PAT
... id 1..* II
... sdtcIdentifiedBy 0..* IdentifiedBy XML Namespace: urn:hl7-org:sdtc
XML: identifiedBy (urn:hl7-org:sdtc)
... addr 0..* AD
... telecom 0..* TEL
... patient 0..1 Patient
... providerOrganization 0..1 Organization

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
PatientRole.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
PatientRole.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
PatientRole.classCoderequiredFixed Value: PAT
http://terminology.hl7.org/ValueSet/v3-RoleClassRelationshipFormal

Constraints

IdGradePath(s)DetailsRequirements
II-1errorPatientRole.typeIdAn II instance must have either a root or an nullFlavor.
: root.exists() or nullFlavor.exists()

This structure is derived from InfrastructureRoot

Summary

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

Structures

This structure refers to these other structures:

Differential View

This structure is derived from InfrastructureRoot

NameFlagsCard.TypeDescription & Constraintsdoco
.. PatientRole 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 0..1 cs Binding: RoleClassRelationshipFormal (required)
Fixed Value: PAT
... id 1..* II
... sdtcIdentifiedBy 0..* IdentifiedBy XML Namespace: urn:hl7-org:sdtc
XML: identifiedBy (urn:hl7-org:sdtc)
... telecom 0..* TEL
... patient 0..1 Patient
... providerOrganization 0..1 Organization

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet / CodeURI
PatientRole.classCoderequiredFixed Value: PAT
http://terminology.hl7.org/ValueSet/v3-RoleClassRelationshipFormal

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. PatientRole 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
... @classCode 0..1 cs Binding: RoleClassRelationshipFormal (required)
Fixed Value: PAT
... id 1..* II
... sdtcIdentifiedBy 0..* IdentifiedBy XML Namespace: urn:hl7-org:sdtc
XML: identifiedBy (urn:hl7-org:sdtc)
... addr 0..* AD
... telecom 0..* TEL
... patient 0..1 Patient
... providerOrganization 0..1 Organization

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
PatientRole.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
PatientRole.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
PatientRole.classCoderequiredFixed Value: PAT
http://terminology.hl7.org/ValueSet/v3-RoleClassRelationshipFormal

Constraints

IdGradePath(s)DetailsRequirements
II-1errorPatientRole.typeIdAn II instance must have either a root or an nullFlavor.
: root.exists() or nullFlavor.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. PatientRole 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
... @classCode 0..1 cs Binding: RoleClassRelationshipFormal (required)
Fixed Value: PAT
... id 1..* II
... sdtcIdentifiedBy 0..* IdentifiedBy XML Namespace: urn:hl7-org:sdtc
XML: identifiedBy (urn:hl7-org:sdtc)
... addr 0..* AD
... telecom 0..* TEL
... patient 0..1 Patient
... providerOrganization 0..1 Organization

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
PatientRole.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
PatientRole.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
PatientRole.classCoderequiredFixed Value: PAT
http://terminology.hl7.org/ValueSet/v3-RoleClassRelationshipFormal

Constraints

IdGradePath(s)DetailsRequirements
II-1errorPatientRole.typeIdAn II instance must have either a root or an nullFlavor.
: root.exists() or nullFlavor.exists()

This structure is derived from InfrastructureRoot

Summary

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

Structures

This structure refers to these other structures:

 

Other representations of profile: CSV, Excel