Consolidated CDA Release 2.2
2.2 - CI Build United States of America flag

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

Resource Profile: Author Participation

Official URL: http://hl7.org/fhir/cda/ccda/StructureDefinition/2.16.840.1.113883.10.20.22.4.119 Version: 2.2
Active as of 2022-05-13 Computable Name: AuthorParticipation
Other Identifiers: : urn:oid:2.16.840.1.113883.10.20.22.4.119

This template represents the Author Participation (including the author timestamp). CDA R2 requires that Author and Author timestamp be asserted in the document header. From there, authorship propagates to contained sections and contained entries, unless explicitly overridden.

The Author Participation template was added to those templates in scope for analysis in R2. Although it is not explicitly stated in all templates the Author Participation template can be used in any template.

Usage:

Formal Views of Profile Content

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

This structure is derived from CDAR2.Author

Summary

Mandatory: 5 elements

Slices

This structure defines the following Slices:

  • The element Author.templateId is sliced based on the value of value:root

This structure is derived from CDAR2.Author

NameFlagsCard.TypeDescription & Constraintsdoco
.. Author 1..1CDAR2.Author
... Slices for templateId 0..*IISlice: Unordered, Open by value:root
.... templateId:primary 1..1II
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.4.119
... time 1..1TS
... assignedAuthor 1..1AssignedAuthor
.... id I1..*IIThis 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.
1098-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).
.... code I0..1CEBinding: Healthcare Provider Taxonomy (preferred)
1098-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).
.... assignedPerson 0..1Person
..... name 0..*EN
.... representedOrganization 0..1Organization
..... id 0..*II
..... name 0..*ON
..... telecom 0..*TEL
..... addr 0..*AD

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Author 1..1CDAR2.Author
... nullFlavor 0..1codeBinding: NullFlavor (required)
... typeCode 0..1codeBinding: ParticipationType (required)
Fixed Value: AUT
... contextControlCode 0..1codeBinding: ContextControl (required)
Fixed Value: OP
... typeId 0..1II
... Slices for templateId 0..*IISlice: Unordered, Open by value:root
.... templateId:primary 1..1II
..... nullFlavor 0..1codeBinding: NullFlavor (required)
..... assigningAuthorityName 0..1string
..... displayable 0..1boolean
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.4.119
..... extension 0..1string
... functionCode 0..1CE
... time 1..1TS
... assignedAuthor 1..1AssignedAuthor
.... classCode 1..1codeBinding: RoleClassAssignedEntity (required)
Fixed Value: ASSIGNED
.... templateId 0..*II
.... id I1..*IIThis 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.
1098-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).
.... sdtcIdentifiedBy 0..*IdentifiedByXML: identifiedBy (urn:hl7-org:sdtc)
.... code I0..1CEBinding: Healthcare Provider Taxonomy (preferred)
1098-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).
.... addr 0..*AD
.... telecom 0..*TEL
.... assignedPerson 0..1Person
..... classCode 1..1codeBinding: EntityClassLivingSubject (required)
Fixed Value: PSN
..... determinerCode 1..1codeBinding: EntityDeterminer (required)
Fixed Value: INSTANCE
..... templateId 0..*II
..... name 0..*EN
..... sdtcAsPatientRelationship 0..*CEXML: asPatientRelationship (urn:hl7-org:sdtc)
.... assignedAuthoringDevice 0..1AuthoringDevice
.... representedOrganization 0..1Organization
..... classCode 1..1codeBinding: EntityClassOrganization (required)
Fixed Value: ORG
..... determinerCode 1..1codeBinding: EntityDeterminer (required)
Fixed Value: INSTANCE
..... templateId 0..*II
..... id 0..*II
..... name 0..*ON
..... telecom 0..*TEL
..... addr 0..*AD
..... standardIndustryClassCode 0..1CEBinding: OrganizationIndustryClassNAICS (extensible)
..... asOrganizationPartOf 0..1OrganizationPartOf

doco Documentation for this format

This structure is derived from CDAR2.Author

Summary

Mandatory: 5 elements

Slices

This structure defines the following Slices:

  • The element Author.templateId is sliced based on the value of value:root

Differential View

This structure is derived from CDAR2.Author

NameFlagsCard.TypeDescription & Constraintsdoco
.. Author 1..1CDAR2.Author
... Slices for templateId 0..*IISlice: Unordered, Open by value:root
.... templateId:primary 1..1II
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.4.119
... time 1..1TS
... assignedAuthor 1..1AssignedAuthor
.... id I1..*IIThis 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.
1098-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).
.... code I0..1CEBinding: Healthcare Provider Taxonomy (preferred)
1098-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).
.... assignedPerson 0..1Person
..... name 0..*EN
.... representedOrganization 0..1Organization
..... id 0..*II
..... name 0..*ON
..... telecom 0..*TEL
..... addr 0..*AD

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Author 1..1CDAR2.Author
... nullFlavor 0..1codeBinding: NullFlavor (required)
... typeCode 0..1codeBinding: ParticipationType (required)
Fixed Value: AUT
... contextControlCode 0..1codeBinding: ContextControl (required)
Fixed Value: OP
... typeId 0..1II
... Slices for templateId 0..*IISlice: Unordered, Open by value:root
.... templateId:primary 1..1II
..... nullFlavor 0..1codeBinding: NullFlavor (required)
..... assigningAuthorityName 0..1string
..... displayable 0..1boolean
..... root 1..1stringRequired Pattern: 2.16.840.1.113883.10.20.22.4.119
..... extension 0..1string
... functionCode 0..1CE
... time 1..1TS
... assignedAuthor 1..1AssignedAuthor
.... classCode 1..1codeBinding: RoleClassAssignedEntity (required)
Fixed Value: ASSIGNED
.... templateId 0..*II
.... id I1..*IIThis 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.
1098-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).
.... sdtcIdentifiedBy 0..*IdentifiedByXML: identifiedBy (urn:hl7-org:sdtc)
.... code I0..1CEBinding: Healthcare Provider Taxonomy (preferred)
1098-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).
.... addr 0..*AD
.... telecom 0..*TEL
.... assignedPerson 0..1Person
..... classCode 1..1codeBinding: EntityClassLivingSubject (required)
Fixed Value: PSN
..... determinerCode 1..1codeBinding: EntityDeterminer (required)
Fixed Value: INSTANCE
..... templateId 0..*II
..... name 0..*EN
..... sdtcAsPatientRelationship 0..*CEXML: asPatientRelationship (urn:hl7-org:sdtc)
.... assignedAuthoringDevice 0..1AuthoringDevice
.... representedOrganization 0..1Organization
..... classCode 1..1codeBinding: EntityClassOrganization (required)
Fixed Value: ORG
..... determinerCode 1..1codeBinding: EntityDeterminer (required)
Fixed Value: INSTANCE
..... templateId 0..*II
..... id 0..*II
..... name 0..*ON
..... telecom 0..*TEL
..... addr 0..*AD
..... standardIndustryClassCode 0..1CEBinding: OrganizationIndustryClassNAICS (extensible)
..... asOrganizationPartOf 0..1OrganizationPartOf

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet / Code
Author.nullFlavorrequiredNullFlavor
Author.typeCoderequiredFixed Value: AUT
Author.contextControlCoderequiredFixed Value: OP
Author.templateId:primary.nullFlavorrequiredNullFlavor
Author.assignedAuthor.classCoderequiredFixed Value: ASSIGNED
Author.assignedAuthor.codepreferredHealthcareProviderTaxonomy
Author.assignedAuthor.assignedPerson.classCoderequiredFixed Value: PSN
Author.assignedAuthor.assignedPerson.determinerCoderequiredFixed Value: INSTANCE
Author.assignedAuthor.representedOrganization.classCoderequiredFixed Value: ORG
Author.assignedAuthor.representedOrganization.determinerCoderequiredFixed Value: INSTANCE
Author.assignedAuthor.representedOrganization.standardIndustryClassCodeextensibleOrganizationIndustryClassNAICS

Constraints

IdGradePathDetailsRequirements
1098-32628errorAuthor.assignedAuthor.idIf 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).
:
1098-32315warningAuthor.assignedAuthor.codeIf 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).
: