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: Patient - Detailed Descriptions

Active as of 2024-12-18

Definitions for the Patient logical model.

Guidance on how to interpret the contents of this table can be found here

0. Patient
Control1..1
Logical ContainerADHA ClinicalDocument (CDA Class)
ValidationInstance of this type are validated by templateId
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
2. Patient.classCode
Control0..1
BindingThe codes SHALL be taken from EntityClassLivingSubject
(required to http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValuePSN
4. Patient.determinerCode
Control0..1
BindingThe codes SHALL be taken from EntityDeterminer
(required to http://terminology.hl7.org/ValueSet/v3-EntityDeterminer)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueINSTANCE
6. Patient.id
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
8. Patient.name
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/PN
10. Patient.sdtcDesc
Definition

The desc extension allows multimedia depictions of patients, healthcare providers, or other individuals to be included in a CDA document.

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namedesc.
12. Patient.administrativeGenderCode
Control0..1
BindingFor example codes, see AdministrativeGender
(example to http://terminology.hl7.org/ValueSet/v3-AdministrativeGender)
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
14. Patient.birthTime
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TS
16. Patient.sdtcDeceasedInd
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namedeceasedInd.
18. Patient.sdtcDeceasedTime
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TS
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namedeceasedTime.
20. Patient.sdtcMultipleBirthInd
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namemultipleBirthInd.
22. Patient.sdtcMultipleBirthOrderNumber
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT-POS
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namemultipleBirthOrderNumber.
24. Patient.maritalStatusCode
Control0..1
BindingFor example codes, see MaritalStatus
(example to http://terminology.hl7.org/ValueSet/v3-MaritalStatus)
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
26. Patient.religiousAffiliationCode
Control0..1
BindingFor example codes, see ReligiousAffiliation
(example to http://terminology.hl7.org/ValueSet/v3-ReligiousAffiliation)
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
28. Patient.raceCode
Control0..1
BindingFor example codes, see Race
(example to http://terminology.hl7.org/ValueSet/v3-Race)
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
30. Patient.sdtcRaceCode
Control0..*
BindingFor example codes, see Race
(example to http://terminology.hl7.org/ValueSet/v3-Race)
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameraceCode.
32. Patient.ethnicGroupCode
Control0..1
BindingFor example codes, see Ethnicity
(example to http://terminology.hl7.org/ValueSet/v3-Ethnicity)
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
34. Patient.sdtcEthnicGroupCode
Control0..*
BindingFor example codes, see Ethnicity
(example to http://terminology.hl7.org/ValueSet/v3-Ethnicity)
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameethnicGroupCode.
36. Patient.guardian
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Guardian
38. Patient.birthplace
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Birthplace
40. Patient.languageCommunication
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/LanguageCommunication

Guidance on how to interpret the contents of this table can be found here

0. Patient
Definition

Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.


Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Control10..1*
Is Modifierfalse
Logical ContainerADHA ClinicalDocument (CDA Class)
ValidationInstance of this type are validated by templateId
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
2. Patient.nullFlavor
Definition

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

Control0..1
BindingThe codes SHALL be taken from CDANullFlavor
(required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
4. Patient.realmCode
Definition

When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
6. Patient.typeId
Definition

When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
8. Patient.typeId.nullFlavor
Definition

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

Control0..1
BindingThe codes SHALL be taken from CDANullFlavor
(required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
10. Patient.typeId.assigningAuthorityName
Definition

A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.

Control0..1
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelAssigning Authority Name
12. Patient.typeId.displayable
Definition

Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).

Control0..1
Typeboolean(bl: Boolean)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelDisplayable
14. Patient.typeId.root
Definition

Identifies the type as an HL7 Registered model

Control1..1
Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelRoot
Fixed Value2.16.840.1.113883.1.3
16. Patient.typeId.extension
Definition

A character string as a unique identifier within the scope of the identifier root.

Control1..1
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExtension
18. Patient.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
20. Patient.classCode
Control0..1
BindingThe codes SHALL be taken from EntityClassLivingSubject
(required to http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValuePSN
22. Patient.determinerCode
Control0..1
BindingThe codes SHALL be taken from EntityDeterminer
(required to http://terminology.hl7.org/ValueSet/v3-EntityDeterminer)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueINSTANCE
24. Patient.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

ShortLogical id of this artifact
Comments

Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IIid
Is Modifierfalse
26. Patient.name
Definition

A name associated with the individual.

ShortA name associated with the patient
Comments

A patient may have multiple names with different uses or applicable periods. For animals, the name is a "HumanName" in the sense that is assigned and used by humans and has the same patterns. Animal names may be communicated as given names, and optionally may include a family name.

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/PNHumanName
Is Modifierfalse
Requirements

Need to be able to track the patient by multiple names. Examples are your official name and a partner name.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
28. Patient.sdtcDesc
Definition

The desc extension allows multimedia depictions of patients, healthcare providers, or other individuals to be included in a CDA document.

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namedesc.
30. Patient.administrativeGenderCode
Control0..1
BindingFor example codes, see AdministrativeGender
(example to http://terminology.hl7.org/ValueSet/v3-AdministrativeGender)
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
32. Patient.birthTime
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TS
34. Patient.sdtcDeceasedInd
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namedeceasedInd.
36. Patient.sdtcDeceasedTime
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TS
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namedeceasedTime.
38. Patient.sdtcMultipleBirthInd
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namemultipleBirthInd.
40. Patient.sdtcMultipleBirthOrderNumber
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT-POS
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namemultipleBirthOrderNumber.
42. Patient.maritalStatusCode
Control0..1
BindingFor example codes, see MaritalStatus
(example to http://terminology.hl7.org/ValueSet/v3-MaritalStatus)
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
44. Patient.religiousAffiliationCode
Control0..1
BindingFor example codes, see ReligiousAffiliation
(example to http://terminology.hl7.org/ValueSet/v3-ReligiousAffiliation)
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
46. Patient.raceCode
Control0..1
BindingFor example codes, see Race
(example to http://terminology.hl7.org/ValueSet/v3-Race)
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
48. Patient.sdtcRaceCode
Control0..*
BindingFor example codes, see Race
(example to http://terminology.hl7.org/ValueSet/v3-Race)
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameraceCode.
50. Patient.ethnicGroupCode
Control0..1
BindingFor example codes, see Ethnicity
(example to http://terminology.hl7.org/ValueSet/v3-Ethnicity)
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
52. Patient.sdtcEthnicGroupCode
Control0..*
BindingFor example codes, see Ethnicity
(example to http://terminology.hl7.org/ValueSet/v3-Ethnicity)
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameethnicGroupCode.
54. Patient.guardian
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Guardian
56. Patient.birthplace
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Birthplace
58. Patient.languageCommunication
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/LanguageCommunication

Guidance on how to interpret the contents of this table can be found here

0. Patient
Definition

Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.

ShortBase for all types and resources
Control1..1
Is Modifierfalse
Logical ContainerADHA ClinicalDocument (CDA Class)
ValidationInstance of this type are validated by templateId
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
2. Patient.nullFlavor
Definition

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

Control0..1
BindingThe codes SHALL be taken from CDANullFlavor
(required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
4. Patient.realmCode
Definition

When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
6. Patient.typeId
Definition

When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
InvariantsII-1: An II instance must have either a root or an nullFlavor. (root.exists() or nullFlavor.exists())
8. Patient.typeId.nullFlavor
Definition

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

Control0..1
BindingThe codes SHALL be taken from CDANullFlavor
(required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExceptional Value Detail
10. Patient.typeId.assigningAuthorityName
Definition

A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.

Control0..1
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelAssigning Authority Name
12. Patient.typeId.displayable
Definition

Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).

Control0..1
Typeboolean(bl: Boolean)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelDisplayable
14. Patient.typeId.root
Definition

Identifies the type as an HL7 Registered model

Control1..1
Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelRoot
Fixed Value2.16.840.1.113883.1.3
16. Patient.typeId.extension
Definition

A character string as a unique identifier within the scope of the identifier root.

Control1..1
Typestring(st: Character String)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
LabelExtension
18. Patient.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
20. Patient.classCode
Control0..1
BindingThe codes SHALL be taken from EntityClassLivingSubject
(required to http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValuePSN
22. Patient.determinerCode
Control0..1
BindingThe codes SHALL be taken from EntityDeterminer
(required to http://terminology.hl7.org/ValueSet/v3-EntityDeterminer)
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueINSTANCE
24. Patient.id
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
26. Patient.name
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/PN
28. Patient.sdtcDesc
Definition

The desc extension allows multimedia depictions of patients, healthcare providers, or other individuals to be included in a CDA document.

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namedesc.
30. Patient.administrativeGenderCode
Control0..1
BindingFor example codes, see AdministrativeGender
(example to http://terminology.hl7.org/ValueSet/v3-AdministrativeGender)
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
32. Patient.birthTime
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TS
34. Patient.sdtcDeceasedInd
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namedeceasedInd.
36. Patient.sdtcDeceasedTime
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TS
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namedeceasedTime.
38. Patient.sdtcMultipleBirthInd
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/BL
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namemultipleBirthInd.
40. Patient.sdtcMultipleBirthOrderNumber
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/INT-POS
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namemultipleBirthOrderNumber.
42. Patient.maritalStatusCode
Control0..1
BindingFor example codes, see MaritalStatus
(example to http://terminology.hl7.org/ValueSet/v3-MaritalStatus)
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
44. Patient.religiousAffiliationCode
Control0..1
BindingFor example codes, see ReligiousAffiliation
(example to http://terminology.hl7.org/ValueSet/v3-ReligiousAffiliation)
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
46. Patient.raceCode
Control0..1
BindingFor example codes, see Race
(example to http://terminology.hl7.org/ValueSet/v3-Race)
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
48. Patient.sdtcRaceCode
Control0..*
BindingFor example codes, see Race
(example to http://terminology.hl7.org/ValueSet/v3-Race)
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameraceCode.
50. Patient.ethnicGroupCode
Control0..1
BindingFor example codes, see Ethnicity
(example to http://terminology.hl7.org/ValueSet/v3-Ethnicity)
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
52. Patient.sdtcEthnicGroupCode
Control0..*
BindingFor example codes, see Ethnicity
(example to http://terminology.hl7.org/ValueSet/v3-Ethnicity)
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameethnicGroupCode.
54. Patient.guardian
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Guardian
56. Patient.birthplace
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Birthplace
58. Patient.languageCommunication
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/LanguageCommunication