Consolidated CDA Release 2.1 StructureDefinition Publication
2.1 - CI Build United States of America flag

Consolidated CDA Release 2.1 StructureDefinition Publication, published by Health Level Seven. This is not an authorized publication; it is the continuous build for version 2.1). This version is based on the current content of https://github.com/HL7/CDA-ccda-2.1-sd/ and changes regularly. See the Directory of published versions

Logical Model: AuthorParticipation - Detailed Descriptions

Draft as of 2023-09-29

Definitions for the AuthorParticipation logical model.

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

0. Author
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
2. Author.templateId
Control1..?
SlicingThis element introduces a set of slices on Author.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ root
4. Author.templateId:primary
Slice Nameprimary
Comments

SHALL contain exactly one [1..1] templateId (CONF:1098-32017) such that it, SHALL not contain [0..0] extension.

Control1..1
6. Author.templateId:primary.root
Comments

SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.119" (CONF:1098-32018).

Control1..?
Pattern Value2.16.840.1.113883.10.20.22.4.119
8. Author.templateId:primary.extension
Control0..0
10. Author.time
Comments

SHALL contain exactly one [1..1] time (CONF:1098-31471).

12. Author.assignedAuthor
Comments

SHALL contain exactly one [1..1] assignedAuthor (CONF:1098-31472).

14. Author.assignedAuthor.id
ShortThis id may be set equal to (a pointer to) an id on a participant elsewhere in the document (header or entries) or a new author participant can be described here. If the id is pointing to a participant already described elsewhere in the document, assignedAuthor/id is sufficient to identify this participant and none of the remaining details of assignedAuthor are required to be set. Application Software must be responsible for resolving the identifier back to its original object and then rendering the information in the correct place in the containing section's narrative text. This id must be a pointer to another author participant.
Comments

This assignedAuthor SHALL contain at least one [1..*] id (CONF:1098-31473).

Invariants1098-32628: If the ID isn't referencing an author described elsewhere in the document, then the author components required in US Realm Header are required here as well (CONF:1098-32628). ()
16. Author.assignedAuthor.code
Comments

This assignedAuthor SHOULD contain zero or one [0..1] code, which SHOULD be selected from ValueSet Healthcare Provider Taxonomy urn:oid:2.16.840.1.114222.4.11.1066 DYNAMIC (CONF:1098-31671).

BindingThe codes SHOULD be taken from Healthcare Provider Taxonomy
Invariants1098-32315: If the content is patient authored the code **SHOULD** be selected from Personal And Legal Relationship Role Type (2.16.840.1.113883.11.20.12.1) (CONF:1098-32315). ()
18. Author.assignedAuthor.assignedPerson
Comments

This assignedAuthor MAY contain zero or one [0..1] assignedPerson (CONF:1098-31474).

20. Author.assignedAuthor.assignedPerson.name
Comments

The assignedPerson, if present, MAY contain zero or more [0..*] name (CONF:1098-31475).

22. Author.assignedAuthor.representedOrganization
Comments

This assignedAuthor MAY contain zero or one [0..1] representedOrganization (CONF:1098-31476).

24. Author.assignedAuthor.representedOrganization.id
Comments

The representedOrganization, if present, MAY contain zero or more [0..*] id (CONF:1098-31478).

26. Author.assignedAuthor.representedOrganization.name
Comments

The representedOrganization, if present, MAY contain zero or more [0..*] name (CONF:1098-31479).

28. Author.assignedAuthor.representedOrganization.telecom
Comments

The representedOrganization, if present, MAY contain zero or more [0..*] telecom (CONF:1098-31480).

30. Author.assignedAuthor.representedOrganization.addr
Comments

The representedOrganization, if present, MAY contain zero or more [0..*] addr (CONF:1098-31481).

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

0. Author
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Control10..1*
Is Modifierfalse
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2. Author.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

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
SlicingThis element introduces a set of slices on Author.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ root
4. Author.templateId:primary
Slice Nameprimary
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

Comments

SHALL contain exactly one [1..1] templateId (CONF:1098-32017) such that it, SHALL not contain [0..0] extension.

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
6. Author.templateId:primary.root
Definition

A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.

Comments

SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.119" (CONF:1098-32018).

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
Pattern Value2.16.840.1.113883.10.20.22.4.119
8. Author.templateId:primary.extension
Definition

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

Control0..0
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
10. Author.time
Comments

SHALL contain exactly one [1..1] time (CONF:1098-31471).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TS
12. Author.assignedAuthor
Comments

SHALL contain exactly one [1..1] assignedAuthor (CONF:1098-31472).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AssignedAuthor
14. Author.assignedAuthor.id
ShortThis id may be set equal to (a pointer to) an id on a participant elsewhere in the document (header or entries) or a new author participant can be described here. If the id is pointing to a participant already described elsewhere in the document, assignedAuthor/id is sufficient to identify this participant and none of the remaining details of assignedAuthor are required to be set. Application Software must be responsible for resolving the identifier back to its original object and then rendering the information in the correct place in the containing section's narrative text. This id must be a pointer to another author participant.
Comments

This assignedAuthor SHALL contain at least one [1..*] id (CONF:1098-31473).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
Invariants1098-32628: If the ID isn't referencing an author described elsewhere in the document, then the author components required in US Realm Header are required here as well (CONF:1098-32628). ()
16. Author.assignedAuthor.code
Comments

This assignedAuthor SHOULD contain zero or one [0..1] code, which SHOULD be selected from ValueSet Healthcare Provider Taxonomy urn:oid:2.16.840.1.114222.4.11.1066 DYNAMIC (CONF:1098-31671).

Control0..1
BindingThe codes SHOULD be taken from Healthcare Provider Taxonomy
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
Invariants1098-32315: If the content is patient authored the code **SHOULD** be selected from Personal And Legal Relationship Role Type (2.16.840.1.113883.11.20.12.1) (CONF:1098-32315). ()
18. Author.assignedAuthor.assignedPerson
Comments

This assignedAuthor MAY contain zero or one [0..1] assignedPerson (CONF:1098-31474).

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Person
20. Author.assignedAuthor.assignedPerson.name
Definition

A name associated with the person.

ShortA name associated with the person
Comments

The assignedPerson, if present, MAY contain zero or more [0..*] name (CONF:1098-31475).


Person may have multiple names with different uses or applicable periods.

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

Need to be able to track the person 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()))
22. Author.assignedAuthor.representedOrganization
Comments

This assignedAuthor MAY contain zero or one [0..1] representedOrganization (CONF:1098-31476).

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organization
24. Author.assignedAuthor.representedOrganization.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

The representedOrganization, if present, MAY contain zero or more [0..*] id (CONF:1098-31478).


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. Author.assignedAuthor.representedOrganization.name
Definition

A name associated with the organization.

ShortName used for the organization
Comments

The representedOrganization, if present, MAY contain zero or more [0..*] name (CONF:1098-31479).


If the name of an organization changes, consider putting the old name in the alias column so that it can still be located through searches.

Control0..*1
This element is affected by the following invariants: org-1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ONstring
Is Modifierfalse
Requirements

Need to use the name as the label of the organization.

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
28. Author.assignedAuthor.representedOrganization.telecom
Comments

The representedOrganization, if present, MAY contain zero or more [0..*] telecom (CONF:1098-31480).

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
30. Author.assignedAuthor.representedOrganization.addr
Comments

The representedOrganization, if present, MAY contain zero or more [0..*] addr (CONF:1098-31481).

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AD

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

0. Author
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Control1..1
Is Modifierfalse
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2. Author.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 NullFlavor
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. Author.typeCode
Control0..1
BindingThe codes SHALL be taken from ParticipationType
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 ValueAUT
6. Author.contextControlCode
Control0..1
BindingThe codes SHALL be taken from ContextControl
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 ValueOP
8. Author.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
10. Author.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
12. Author.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

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
SlicingThis element introduces a set of slices on Author.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ root
14. Author.templateId:primary
Slice Nameprimary
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

Comments

SHALL contain exactly one [1..1] templateId (CONF:1098-32017) such that it, SHALL not contain [0..0] extension.

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
16. Author.templateId:primary.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 NullFlavor
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
18. Author.templateId:primary.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
20. Author.templateId:primary.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
22. Author.templateId:primary.root
Definition

A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.

Comments

SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.119" (CONF:1098-32018).

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
Pattern Value2.16.840.1.113883.10.20.22.4.119
24. Author.templateId:primary.extension
Definition

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

Control0..0
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
26. Author.functionCode
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
28. Author.time
Comments

SHALL contain exactly one [1..1] time (CONF:1098-31471).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TS
30. Author.assignedAuthor
Comments

SHALL contain exactly one [1..1] assignedAuthor (CONF:1098-31472).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AssignedAuthor
32. Author.assignedAuthor.classCode
Control0..1
BindingThe codes SHALL be taken from RoleClassAssignedEntity
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 ValueASSIGNED
34. Author.assignedAuthor.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
36. Author.assignedAuthor.id
ShortThis id may be set equal to (a pointer to) an id on a participant elsewhere in the document (header or entries) or a new author participant can be described here. If the id is pointing to a participant already described elsewhere in the document, assignedAuthor/id is sufficient to identify this participant and none of the remaining details of assignedAuthor are required to be set. Application Software must be responsible for resolving the identifier back to its original object and then rendering the information in the correct place in the containing section's narrative text. This id must be a pointer to another author participant.
Comments

This assignedAuthor SHALL contain at least one [1..*] id (CONF:1098-31473).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
Invariants1098-32628: If the ID isn't referencing an author described elsewhere in the document, then the author components required in US Realm Header are required here as well (CONF:1098-32628). ()
38. Author.assignedAuthor.sdtcIdentifiedBy
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameidentifiedBy.
40. Author.assignedAuthor.code
Comments

This assignedAuthor SHOULD contain zero or one [0..1] code, which SHOULD be selected from ValueSet Healthcare Provider Taxonomy urn:oid:2.16.840.1.114222.4.11.1066 DYNAMIC (CONF:1098-31671).

Control0..1
BindingThe codes SHOULD be taken from Healthcare Provider Taxonomy
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
Invariants1098-32315: If the content is patient authored the code **SHOULD** be selected from Personal And Legal Relationship Role Type (2.16.840.1.113883.11.20.12.1) (CONF:1098-32315). ()
42. Author.assignedAuthor.addr
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AD
44. Author.assignedAuthor.telecom
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
46. Author.assignedAuthor.assignedPerson
Comments

This assignedAuthor MAY contain zero or one [0..1] assignedPerson (CONF:1098-31474).

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Person
48. Author.assignedAuthor.assignedPerson.classCode
Control0..1
BindingThe codes SHALL be taken from 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
50. Author.assignedAuthor.assignedPerson.determinerCode
Control0..1
BindingThe codes SHALL be taken from 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
52. Author.assignedAuthor.assignedPerson.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
54. Author.assignedAuthor.assignedPerson.name
Comments

The assignedPerson, if present, MAY contain zero or more [0..*] name (CONF:1098-31475).

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/PN
56. Author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship
Control0..*
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 nameasPatientRelationship.
58. Author.assignedAuthor.assignedAuthoringDevice
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AuthoringDevice
60. Author.assignedAuthor.representedOrganization
Comments

This assignedAuthor MAY contain zero or one [0..1] representedOrganization (CONF:1098-31476).

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organization
62. Author.assignedAuthor.representedOrganization.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 NullFlavor
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
64. Author.assignedAuthor.representedOrganization.classCode
Control0..1
BindingThe codes SHALL be taken from EntityClassOrganization
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 ValueORG
66. Author.assignedAuthor.representedOrganization.determinerCode
Control0..1
BindingThe codes SHALL be taken from 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
68. Author.assignedAuthor.representedOrganization.realmCode
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
70. Author.assignedAuthor.representedOrganization.typeId
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
72. Author.assignedAuthor.representedOrganization.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
74. Author.assignedAuthor.representedOrganization.id
Comments

The representedOrganization, if present, MAY contain zero or more [0..*] id (CONF:1098-31478).

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
76. Author.assignedAuthor.representedOrganization.name
Comments

The representedOrganization, if present, MAY contain zero or more [0..*] name (CONF:1098-31479).

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ON
78. Author.assignedAuthor.representedOrganization.telecom
Comments

The representedOrganization, if present, MAY contain zero or more [0..*] telecom (CONF:1098-31480).

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
80. Author.assignedAuthor.representedOrganization.addr
Comments

The representedOrganization, if present, MAY contain zero or more [0..*] addr (CONF:1098-31481).

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AD
82. Author.assignedAuthor.representedOrganization.standardIndustryClassCode
Control0..1
BindingUnless not suitable, these codes SHALL be taken from OrganizationIndustryClassNAICS
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
84. Author.assignedAuthor.representedOrganization.asOrganizationPartOf
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/OrganizationPartOf