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

Draft as of 2023-09-29

Definitions for the ProvenanceAuthorParticipation 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
Comments

SHALL contain exactly one [1..1] templateId (CONF:4515-32980) such that it

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
  • value @ extension
4. Author.templateId:templateId1
Slice NametemplateId1
ShorttemplateId
Control1..1
6. Author.templateId:templateId1.root
Comments

SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.5.6" (CONF:4515-15).

Control1..?
Pattern Value2.16.840.1.113883.10.20.22.5.6
8. Author.templateId:templateId1.extension
Comments

SHALL contain exactly one [1..1] @extension="2019-10-01" (CONF:4515-36).

Control1..?
Pattern Value2019-10-01
10. Author.time
Comments

SHALL contain exactly one [1..1] time (CONF:4515-32983).

12. Author.assignedAuthor
Comments

SHALL contain exactly one [1..1] assignedAuthor (CONF:4515-32975).

14. Author.assignedAuthor.id
Comments

This assignedAuthor SHALL contain exactly one [1..1] id (CONF:4515-20) such that. it This assignedAuthor SHALL contain at least one [1..*] id (CONF:4515-2).

Invariants4515-64: If the assignedAuthor/id is not referencing a Provenance Author described elsewhere in the document with a representedOrganization populated, this assignedAuthor SHALL contain exactly one [1..1] representedOrganization (CONF:4515-64). ()
SlicingThis element introduces a set of slices on Author.assignedAuthor.id. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ root
16. Author.assignedAuthor.id:id2
Slice Nameid2
Shortid
Comments

This assignedAuthor SHALL contain exactly one [1..1] id (CONF:4515-20) such that it

Control1..1
18. Author.assignedAuthor.id:id2.nullFlavor
Comments

MAY contain zero or one [0..1] @nullFlavor="UNK" Unknown (CodeSystem: HL7NullFlavor urn:oid:2.16.840.1.113883.5.1008) (CONF:4515-21).

Fixed ValueUNK
20. Author.assignedAuthor.id:id2.root
Comments

SHALL contain exactly one [1..1] @root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:4515-22).

Control1..?
Pattern Value2.16.840.1.113883.4.6
22. Author.assignedAuthor.id:id2.extension
Comments

SHOULD contain zero or one [0..1] @extension (CONF:4515-23).

24. Author.assignedAuthor.code
Comments

This assignedAuthor SHOULD contain zero or one [0..1] code (CONF:4515-32979).

Invariants4515-56: If the content is provider authored, the code SHOULD be selected from ValueSet Healthcare Provider Taxonomy urn:oid:2.16.840.1.114222.4.11.1066 DYNAMIC (CONF:4515-56). ()
4515-57: If the author is a person who is not acting in the role of a clinician, the code SHOULD be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:4515-57). ()
26. Author.assignedAuthor.assignedPerson
Comments

This assignedAuthor SHOULD contain zero or one [0..1] assignedPerson (CONF:4515-32976).

28. Author.assignedAuthor.assignedPerson.name
Comments

The assignedPerson, if present, SHALL contain at least one [1..*] name (CONF:4515-32977).

Control1..?
30. Author.assignedAuthor.assignedPerson.name.family
Comments

Such names SHALL contain exactly one [1..1] family (CONF:4515-17).

Control1..1
32. Author.assignedAuthor.assignedPerson.name.given
Comments

Such names SHOULD contain zero or more [0..*] given (CONF:4515-18).

34. Author.assignedAuthor.assignedAuthoringDevice
Comments

This assignedAuthor MAY contain zero or one [0..1] assignedAuthoringDevice (CONF:4515-32).

36. Author.assignedAuthor.representedOrganization
Comments

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

38. Author.assignedAuthor.representedOrganization.nullFlavor
Comments

The representedOrganization, if present, MAY contain zero or one [0..1] @nullFlavor (CONF:4515-35).

40. Author.assignedAuthor.representedOrganization.id
Comments

The representedOrganization, if present, SHALL contain exactly one [1..1] id (CONF:4515-28) such that it. The representedOrganization, if present, SHALL contain at least one [1..*] id (CONF:4515-32981).

Control2..?
SlicingThis element introduces a set of slices on Author.assignedAuthor.representedOrganization.id. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ root
42. Author.assignedAuthor.representedOrganization.id:id1
Slice Nameid1
Shortid
Comments

The representedOrganization, if present, SHALL contain exactly one [1..1] id (CONF:4515-24) such that it

Control1..1
44. Author.assignedAuthor.representedOrganization.id:id1.nullFlavor
Comments

MAY contain zero or one [0..1] @nullFlavor="UNK" Unknown (CodeSystem: HL7NullFlavor urn:oid:2.16.840.1.113883.5.1008) (CONF:4515-25).

Fixed ValueUNK
46. Author.assignedAuthor.representedOrganization.id:id1.root
Comments

SHALL contain exactly one [1..1] @root="2.16.840.1.113883.4.2" Tax ID Number (CONF:4515-26).

Control1..?
Pattern Value2.16.840.1.113883.4.2
48. Author.assignedAuthor.representedOrganization.id:id1.extension
Comments

SHOULD contain zero or one [0..1] @extension (CONF:4515-32982).

50. Author.assignedAuthor.representedOrganization.id:id2
Slice Nameid2
Shortid
Comments

The representedOrganization, if present, SHALL contain exactly one [1..1] id (CONF:4515-28) such that it

Control1..1
52. Author.assignedAuthor.representedOrganization.id:id2.nullFlavor
Comments

MAY contain zero or one [0..1] @nullFlavor="UNK" Unknown (CodeSystem: HL7NullFlavor urn:oid:2.16.840.1.113883.5.1008) (CONF:4515-29).

Fixed ValueUNK
54. Author.assignedAuthor.representedOrganization.id:id2.root
Comments

SHALL contain exactly one [1..1] @root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:4515-30).

Control1..?
Pattern Value2.16.840.1.113883.4.6
56. Author.assignedAuthor.representedOrganization.id:id2.extension
Comments

SHOULD contain zero or one [0..1] @extension (CONF:4515-31).

58. Author.assignedAuthor.representedOrganization.name
Comments

The representedOrganization, if present, SHALL contain exactly one [1..1] name (CONF:4515-11).

Control1..1
60. Author.assignedAuthor.representedOrganization.telecom
Comments

The representedOrganization, if present, SHOULD contain zero or more [0..*] telecom (CONF:4515-12).

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

Comments

SHALL contain exactly one [1..1] templateId (CONF:4515-32980) such that it

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
  • value @ extension
4. Author.templateId:templateId1
Slice NametemplateId1
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

ShorttemplateId
Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
6. Author.templateId:templateId1.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.5.6" (CONF:4515-15).

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.5.6
8. Author.templateId:templateId1.extension
Definition

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

Comments

SHALL contain exactly one [1..1] @extension="2019-10-01" (CONF:4515-36).

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
Pattern Value2019-10-01
10. Author.time
Comments

SHALL contain exactly one [1..1] time (CONF:4515-32983).

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

SHALL contain exactly one [1..1] assignedAuthor (CONF:4515-32975).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AssignedAuthor
14. Author.assignedAuthor.id
Comments

This assignedAuthor SHALL contain exactly one [1..1] id (CONF:4515-20) such that. it This assignedAuthor SHALL contain at least one [1..*] id (CONF:4515-2).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
Invariants4515-64: If the assignedAuthor/id is not referencing a Provenance Author described elsewhere in the document with a representedOrganization populated, this assignedAuthor SHALL contain exactly one [1..1] representedOrganization (CONF:4515-64). ()
SlicingThis element introduces a set of slices on Author.assignedAuthor.id. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ root
16. Author.assignedAuthor.id:id2
Slice Nameid2
Shortid
Comments

This assignedAuthor SHALL contain exactly one [1..1] id (CONF:4515-20) such that it

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
18. Author.assignedAuthor.id:id2.nullFlavor
Definition

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

Comments

MAY contain zero or one [0..1] @nullFlavor="UNK" Unknown (CodeSystem: HL7NullFlavor urn:oid:2.16.840.1.113883.5.1008) (CONF:4515-21).

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
Fixed ValueUNK
20. Author.assignedAuthor.id:id2.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.4.6" National Provider Identifier (CONF:4515-22).

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.4.6
22. Author.assignedAuthor.id:id2.extension
Definition

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

Comments

SHOULD contain zero or one [0..1] @extension (CONF:4515-23).

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.
LabelExtension
24. Author.assignedAuthor.code
Comments

This assignedAuthor SHOULD contain zero or one [0..1] code (CONF:4515-32979).

Control0..1
BindingUnless not suitable, these codes SHALL be taken from v3 Code System RoleCode
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
Invariants4515-56: If the content is provider authored, the code SHOULD be selected from ValueSet Healthcare Provider Taxonomy urn:oid:2.16.840.1.114222.4.11.1066 DYNAMIC (CONF:4515-56). ()
4515-57: If the author is a person who is not acting in the role of a clinician, the code SHOULD be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:4515-57). ()
26. Author.assignedAuthor.assignedPerson
Comments

This assignedAuthor SHOULD contain zero or one [0..1] assignedPerson (CONF:4515-32976).

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

A name associated with the person.

ShortA name associated with the person
Comments

The assignedPerson, if present, SHALL contain at least one [1..*] name (CONF:4515-32977).


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

Control10..*
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()))
30. Author.assignedAuthor.assignedPerson.name.family
Comments

Such names SHALL contain exactly one [1..1] family (CONF:4515-17).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ENXP
32. Author.assignedAuthor.assignedPerson.name.given
Comments

Such names SHOULD contain zero or more [0..*] given (CONF:4515-18).

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ENXP
34. Author.assignedAuthor.assignedAuthoringDevice
Comments

This assignedAuthor MAY contain zero or one [0..1] assignedAuthoringDevice (CONF:4515-32).

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AuthoringDevice
36. Author.assignedAuthor.representedOrganization
Comments

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

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

Comments

The representedOrganization, if present, MAY contain zero or one [0..1] @nullFlavor (CONF:4515-35).

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
40. 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, SHALL contain exactly one [1..1] id (CONF:4515-28) such that it. The representedOrganization, if present, SHALL contain at least one [1..*] id (CONF:4515-32981).


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.

Control20..*1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IIid
Is Modifierfalse
SlicingThis element introduces a set of slices on Author.assignedAuthor.representedOrganization.id. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ root
42. Author.assignedAuthor.representedOrganization.id:id1
Slice Nameid1
Definition

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

ShortidLogical id of this artifact
Comments

The representedOrganization, if present, SHALL contain exactly one [1..1] id (CONF:4515-24) such that it


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.

Control10..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IIid
Is Modifierfalse
44. Author.assignedAuthor.representedOrganization.id:id1.nullFlavor
Definition

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

Comments

MAY contain zero or one [0..1] @nullFlavor="UNK" Unknown (CodeSystem: HL7NullFlavor urn:oid:2.16.840.1.113883.5.1008) (CONF:4515-25).

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
Fixed ValueUNK
46. Author.assignedAuthor.representedOrganization.id:id1.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.4.2" Tax ID Number (CONF:4515-26).

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.4.2
48. Author.assignedAuthor.representedOrganization.id:id1.extension
Definition

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

Comments

SHOULD contain zero or one [0..1] @extension (CONF:4515-32982).

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.
LabelExtension
50. Author.assignedAuthor.representedOrganization.id:id2
Slice Nameid2
Definition

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

ShortidLogical id of this artifact
Comments

The representedOrganization, if present, SHALL contain exactly one [1..1] id (CONF:4515-28) such that it


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.

Control10..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IIid
Is Modifierfalse
52. Author.assignedAuthor.representedOrganization.id:id2.nullFlavor
Definition

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

Comments

MAY contain zero or one [0..1] @nullFlavor="UNK" Unknown (CodeSystem: HL7NullFlavor urn:oid:2.16.840.1.113883.5.1008) (CONF:4515-29).

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
Fixed ValueUNK
54. Author.assignedAuthor.representedOrganization.id:id2.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.4.6" National Provider Identifier (CONF:4515-30).

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.4.6
56. Author.assignedAuthor.representedOrganization.id:id2.extension
Definition

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

Comments

SHOULD contain zero or one [0..1] @extension (CONF:4515-31).

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

A name associated with the organization.

ShortName used for the organization
Comments

The representedOrganization, if present, SHALL contain exactly one [1..1] name (CONF:4515-11).


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.

Control10..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()))
60. Author.assignedAuthor.representedOrganization.telecom
Comments

The representedOrganization, if present, SHOULD contain zero or more [0..*] telecom (CONF:4515-12).

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

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

Comments

SHALL contain exactly one [1..1] templateId (CONF:4515-32980) such that it

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
  • value @ extension
14. Author.templateId:templateId1
Slice NametemplateId1
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

ShorttemplateId
Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
16. Author.templateId:templateId1.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:templateId1.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:templateId1.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:templateId1.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.5.6" (CONF:4515-15).

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.5.6
24. Author.templateId:templateId1.extension
Definition

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

Comments

SHALL contain exactly one [1..1] @extension="2019-10-01" (CONF:4515-36).

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
Pattern Value2019-10-01
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:4515-32983).

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

SHALL contain exactly one [1..1] assignedAuthor (CONF:4515-32975).

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
Comments

This assignedAuthor SHALL contain exactly one [1..1] id (CONF:4515-20) such that. it This assignedAuthor SHALL contain at least one [1..*] id (CONF:4515-2).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
Invariants4515-64: If the assignedAuthor/id is not referencing a Provenance Author described elsewhere in the document with a representedOrganization populated, this assignedAuthor SHALL contain exactly one [1..1] representedOrganization (CONF:4515-64). ()
SlicingThis element introduces a set of slices on Author.assignedAuthor.id. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ root
38. Author.assignedAuthor.id:id2
Slice Nameid2
Shortid
Comments

This assignedAuthor SHALL contain exactly one [1..1] id (CONF:4515-20) such that it

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
40. Author.assignedAuthor.id:id2.nullFlavor
Definition

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

Comments

MAY contain zero or one [0..1] @nullFlavor="UNK" Unknown (CodeSystem: HL7NullFlavor urn:oid:2.16.840.1.113883.5.1008) (CONF:4515-21).

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
Fixed ValueUNK
42. Author.assignedAuthor.id:id2.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
44. Author.assignedAuthor.id:id2.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
46. Author.assignedAuthor.id:id2.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.4.6" National Provider Identifier (CONF:4515-22).

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.4.6
48. Author.assignedAuthor.id:id2.extension
Definition

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

Comments

SHOULD contain zero or one [0..1] @extension (CONF:4515-23).

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.
LabelExtension
50. 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.
52. Author.assignedAuthor.code
Comments

This assignedAuthor SHOULD contain zero or one [0..1] code (CONF:4515-32979).

Control0..1
BindingUnless not suitable, these codes SHALL be taken from v3 Code System RoleCode
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
Invariants4515-56: If the content is provider authored, the code SHOULD be selected from ValueSet Healthcare Provider Taxonomy urn:oid:2.16.840.1.114222.4.11.1066 DYNAMIC (CONF:4515-56). ()
4515-57: If the author is a person who is not acting in the role of a clinician, the code SHOULD be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:4515-57). ()
54. Author.assignedAuthor.addr
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AD
56. Author.assignedAuthor.telecom
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/TEL
58. Author.assignedAuthor.assignedPerson
Comments

This assignedAuthor SHOULD contain zero or one [0..1] assignedPerson (CONF:4515-32976).

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Person
60. 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
62. 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
64. 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
66. Author.assignedAuthor.assignedPerson.name
Comments

The assignedPerson, if present, SHALL contain at least one [1..*] name (CONF:4515-32977).

Control1..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/PN
68. Author.assignedAuthor.assignedPerson.name.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
70. Author.assignedAuthor.assignedPerson.name.use
Definition

A set of codes advising a system or user which name in a set of like names to select for a given purpose. A name without specific use code might be a default name useful for any purpose, but a name with a specific use code would be preferred for that respective purpose

Control0..1
BindingThe codes SHALL be taken from EntityNameUse
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.
LabelUse Code
72. Author.assignedAuthor.assignedPerson.name.delimiter
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ENXP
74. Author.assignedAuthor.assignedPerson.name.family
Comments

Such names SHALL contain exactly one [1..1] family (CONF:4515-17).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ENXP
76. Author.assignedAuthor.assignedPerson.name.given
Comments

Such names SHOULD contain zero or more [0..*] given (CONF:4515-18).

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ENXP
78. Author.assignedAuthor.assignedPerson.name.prefix
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ENXP
80. Author.assignedAuthor.assignedPerson.name.suffix
Definition

Element EN.family

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ENXP
82. Author.assignedAuthor.assignedPerson.name.other
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 unadorned text.
84. Author.assignedAuthor.assignedPerson.name.validTime
Definition

An interval of time specifying the time during which the name is or was used for the entity. This accomodates the fact that people change names for people, places and things.

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
LabelValid Time
86. 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.
88. Author.assignedAuthor.assignedAuthoringDevice
Comments

This assignedAuthor MAY contain zero or one [0..1] assignedAuthoringDevice (CONF:4515-32).

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/AuthoringDevice
90. Author.assignedAuthor.representedOrganization
Comments

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

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

Comments

The representedOrganization, if present, MAY contain zero or one [0..1] @nullFlavor (CONF:4515-35).

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
94. 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
96. 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
98. Author.assignedAuthor.representedOrganization.realmCode
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
100. Author.assignedAuthor.representedOrganization.typeId
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
102. 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
104. Author.assignedAuthor.representedOrganization.id
Comments

The representedOrganization, if present, SHALL contain exactly one [1..1] id (CONF:4515-28) such that it. The representedOrganization, if present, SHALL contain at least one [1..*] id (CONF:4515-32981).

Control2..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
SlicingThis element introduces a set of slices on Author.assignedAuthor.representedOrganization.id. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ root
106. Author.assignedAuthor.representedOrganization.id:id1
Slice Nameid1
Shortid
Comments

The representedOrganization, if present, SHALL contain exactly one [1..1] id (CONF:4515-24) such that it

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
108. Author.assignedAuthor.representedOrganization.id:id1.nullFlavor
Definition

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

Comments

MAY contain zero or one [0..1] @nullFlavor="UNK" Unknown (CodeSystem: HL7NullFlavor urn:oid:2.16.840.1.113883.5.1008) (CONF:4515-25).

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
Fixed ValueUNK
110. Author.assignedAuthor.representedOrganization.id:id1.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
112. Author.assignedAuthor.representedOrganization.id:id1.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
114. Author.assignedAuthor.representedOrganization.id:id1.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.4.2" Tax ID Number (CONF:4515-26).

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.4.2
116. Author.assignedAuthor.representedOrganization.id:id1.extension
Definition

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

Comments

SHOULD contain zero or one [0..1] @extension (CONF:4515-32982).

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.
LabelExtension
118. Author.assignedAuthor.representedOrganization.id:id2
Slice Nameid2
Shortid
Comments

The representedOrganization, if present, SHALL contain exactly one [1..1] id (CONF:4515-28) such that it

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
120. Author.assignedAuthor.representedOrganization.id:id2.nullFlavor
Definition

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

Comments

MAY contain zero or one [0..1] @nullFlavor="UNK" Unknown (CodeSystem: HL7NullFlavor urn:oid:2.16.840.1.113883.5.1008) (CONF:4515-29).

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
Fixed ValueUNK
122. Author.assignedAuthor.representedOrganization.id:id2.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
124. Author.assignedAuthor.representedOrganization.id:id2.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
126. Author.assignedAuthor.representedOrganization.id:id2.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.4.6" National Provider Identifier (CONF:4515-30).

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.4.6
128. Author.assignedAuthor.representedOrganization.id:id2.extension
Definition

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

Comments

SHOULD contain zero or one [0..1] @extension (CONF:4515-31).

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.
LabelExtension
130. Author.assignedAuthor.representedOrganization.name
Comments

The representedOrganization, if present, SHALL contain exactly one [1..1] name (CONF:4515-11).

Control1..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ON
132. Author.assignedAuthor.representedOrganization.telecom
Comments

The representedOrganization, if present, SHOULD contain zero or more [0..*] telecom (CONF:4515-12).

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