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://ns.electronichealth.net.au/cda/StructureDefinition/au-Person | Version: 1.0.0 | |||
| Active as of 2024-12-18 | Computable Name: au-Person | |||
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/. |
||||
Australian adaptation of the HL7 International CDA Person class.
This is a generated StructureDefinition that describes CDA - that is, CDA as it actually is for R2. The intent of this StructureDefinition is to enable CDA to be a FHIR resource. That enables the FHIR infrastructure - API, conformance, query - to be used directly against CDA
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from InfrastructureRoot
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Person |
1..1 | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Australian adaptation of the HL7 International CDA Person class Instance of this type are validated by templateId Logical Container: ADHA ClinicalDocument (CDA Class) | |
  @classCode |
0..1 | cs | Binding: EntityClassLivingSubject (required) Fixed Value: PSN | |
| @determinerCode |
0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
 name |
0..* | PN | ||
| administrativeGenderCode |
0..1 | CE | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent a person's administrative gender code XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| birthTime |
0..1 | TS | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent a person's time of birth XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| asEntityIdentifier |
0..* | asEntityIdentifier | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent a person's identifier XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| asEmployment |
0..1 | asEmployment | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent a person's employment XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| asQualifications |
0..1 | asQualifications | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent a person's qualification XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| personalRelationship |
0..* | personalRelationship | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent a person's personal relationship with a patient XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
 languageCommunication |
0..* | au-languageCommunication | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 Australian-adapted languageCommunication class XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Person.classCode | required | Fixed Value: PSNhttp://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject | |
| Person.determinerCode | required | Fixed Value: INSTANCEhttp://terminology.hl7.org/ValueSet/v3-EntityDeterminer |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Person |
1..1 | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Australian adaptation of the HL7 International CDA Person class 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 |
0..1 | cs | Binding: EntityClassLivingSubject (required) Fixed Value: PSN | |
| @determinerCode |
0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
| name |
0..* | PN | ||
| administrativeGenderCode |
0..1 | CE | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent a person's administrative gender code XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| birthTime |
0..1 | TS | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent a person's time of birth XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| asEntityIdentifier |
0..* | asEntityIdentifier | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent a person's identifier XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| asEmployment |
0..1 | asEmployment | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent a person's employment XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| asQualifications |
0..1 | asQualifications | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent a person's qualification XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| personalRelationship |
0..* | personalRelationship | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent a person's personal relationship with a patient XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| languageCommunication |
0..* | au-languageCommunication | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 Australian-adapted languageCommunication class XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Person.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| Person.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| Person.classCode | required | Fixed Value: PSNhttp://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject | |
| Person.determinerCode | required | Fixed Value: INSTANCEhttp://terminology.hl7.org/ValueSet/v3-EntityDeterminer |
| Id | Grade | Path(s) | Details | Requirements |
| II-1 | error | Person.typeId | An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists() |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Person |
1..1 | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Australian adaptation of the HL7 International CDA Person class 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 |
0..1 | cs | Binding: EntityClassLivingSubject (required) Fixed Value: PSN | |
| @determinerCode |
0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
| name |
0..* | PN | ||
| administrativeGenderCode |
0..1 | CE | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent a person's administrative gender code XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| birthTime |
0..1 | TS | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent a person's time of birth XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| asEntityIdentifier |
0..* | asEntityIdentifier | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent a person's identifier XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| asEmployment |
0..1 | asEmployment | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent a person's employment XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| asQualifications |
0..1 | asQualifications | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent a person's qualification XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| personalRelationship |
0..* | personalRelationship | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent a person's personal relationship with a patient XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| languageCommunication |
0..* | au-languageCommunication | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 Australian-adapted languageCommunication class XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Person.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| Person.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| Person.classCode | required | Fixed Value: PSNhttp://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject | |
| Person.determinerCode | required | Fixed Value: INSTANCEhttp://terminology.hl7.org/ValueSet/v3-EntityDeterminer |
| Id | Grade | Path(s) | Details | Requirements |
| II-1 | error | Person.typeId | An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists() |
This structure is derived from InfrastructureRoot
Summary
Fixed: 2 elements
Structures
This structure refers to these other structures:
Differential View
This structure is derived from InfrastructureRoot
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Person |
1..1 | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Australian adaptation of the HL7 International CDA Person class Instance of this type are validated by templateId Logical Container: ADHA ClinicalDocument (CDA Class) | |
| @classCode |
0..1 | cs | Binding: EntityClassLivingSubject (required) Fixed Value: PSN | |
| @determinerCode |
0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
| name |
0..* | PN | ||
| administrativeGenderCode |
0..1 | CE | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent a person's administrative gender code XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| birthTime |
0..1 | TS | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent a person's time of birth XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| asEntityIdentifier |
0..* | asEntityIdentifier | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent a person's identifier XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| asEmployment |
0..1 | asEmployment | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent a person's employment XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| asQualifications |
0..1 | asQualifications | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent a person's qualification XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| personalRelationship |
0..* | personalRelationship | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent a person's personal relationship with a patient XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| languageCommunication |
0..* | au-languageCommunication | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 Australian-adapted languageCommunication class XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Person.classCode | required | Fixed Value: PSNhttp://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject | |
| Person.determinerCode | required | Fixed Value: INSTANCEhttp://terminology.hl7.org/ValueSet/v3-EntityDeterminer |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Person |
1..1 | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Australian adaptation of the HL7 International CDA Person class 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 |
0..1 | cs | Binding: EntityClassLivingSubject (required) Fixed Value: PSN | |
| @determinerCode |
0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
| name |
0..* | PN | ||
| administrativeGenderCode |
0..1 | CE | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent a person's administrative gender code XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| birthTime |
0..1 | TS | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent a person's time of birth XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| asEntityIdentifier |
0..* | asEntityIdentifier | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent a person's identifier XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| asEmployment |
0..1 | asEmployment | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent a person's employment XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| asQualifications |
0..1 | asQualifications | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent a person's qualification XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| personalRelationship |
0..* | personalRelationship | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent a person's personal relationship with a patient XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| languageCommunication |
0..* | au-languageCommunication | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 Australian-adapted languageCommunication class XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Person.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| Person.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| Person.classCode | required | Fixed Value: PSNhttp://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject | |
| Person.determinerCode | required | Fixed Value: INSTANCEhttp://terminology.hl7.org/ValueSet/v3-EntityDeterminer |
| Id | Grade | Path(s) | Details | Requirements |
| II-1 | error | Person.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 |
|---|---|---|---|---|
| Person |
1..1 | InfrastructureRoot | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Australian adaptation of the HL7 International CDA Person class 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 |
0..1 | cs | Binding: EntityClassLivingSubject (required) Fixed Value: PSN | |
| @determinerCode |
0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
| name |
0..* | PN | ||
| administrativeGenderCode |
0..1 | CE | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent a person's administrative gender code XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| birthTime |
0..1 | TS | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent a person's time of birth XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| asEntityIdentifier |
0..* | asEntityIdentifier | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent a person's identifier XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| asEmployment |
0..1 | asEmployment | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent a person's employment XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| asQualifications |
0..1 | asQualifications | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent a person's qualification XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| personalRelationship |
0..* | personalRelationship | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent a person's personal relationship with a patient XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| languageCommunication |
0..* | au-languageCommunication | XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 Australian-adapted languageCommunication class XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Person.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| Person.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavorfrom this IG | |
| Person.classCode | required | Fixed Value: PSNhttp://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject | |
| Person.determinerCode | required | Fixed Value: INSTANCEhttp://terminology.hl7.org/ValueSet/v3-EntityDeterminer |
| Id | Grade | Path(s) | Details | Requirements |
| II-1 | error | Person.typeId | An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.exists() |
This structure is derived from InfrastructureRoot
Summary
Fixed: 2 elements
Structures
This structure refers to these other structures:
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
