Consolidated CDA Release 2.1 StructureDefinition Publication
2.1 - CI Build
Consolidated CDA Release 2.1 StructureDefinition Publication
2.1 - CI Build
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
| Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/AuthorParticipation | Version: 2.1 | |||
| Draft as of 2023-09-29 | Computable Name: AuthorParticipation | |||
| Other Identifiers: id: 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:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from CDAR2.Author
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Author | CDAR2.Author | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, @typeCode, @contextControlCode, realmCode, typeId, templateId, functionCode, time, assignedAuthor | ||
  Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root | |
   templateId:primary | 1..1 | II | ||
  root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.119 | |
  extension | 0..0 | |||
 time | 1..1 | TS | ||
 assignedAuthor | 1..1 | AssignedAuthor | ||
| id | C | 1..* | II | This 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 | C | 0..1 | CE | Binding: 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..1 | Person | ||
 name | 0..* | PN | ||
| representedOrganization | 0..1 | Organization | ||
| id | 0..* | II | ||
| name | 0..* | ON | ||
| telecom | 0..* | TEL | ||
| addr | 0..* | AD | ||
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Author.assignedAuthor.code | preferred | Healthcare Provider Taxonomy (a valid code from http://nucc.org/provider-taxonomy) |
| Id | Grade | Path(s) | Details | Requirements |
| 1098-32315 | warning | Author.assignedAuthor.code | 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). : | |
| 1098-32628 | error | Author.assignedAuthor.id | 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). : |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Author | 1..1 | CDAR2.Author | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, @typeCode, @contextControlCode, realmCode, typeId, templateId, functionCode, time, assignedAuthor Base for all types and resources | |
| Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root | |
| templateId:primary | 1..1 | II | ||
 @root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.119 | |
 time | 1..1 | TS | ||
| assignedAuthor | 1..1 | AssignedAuthor | ||
| id | C | 1..* | II | This 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 | C | 0..1 | CE | Binding: 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..1 | Person | ||
| name | 0..* | PN | ||
| representedOrganization | 0..1 | Organization | ||
| id | 0..* | II | ||
| name | 0..* | ON | ||
| telecom | 0..* | TEL | ||
| addr | 0..* | AD | ||
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Author.assignedAuthor.code | preferred | Healthcare Provider Taxonomy (a valid code from http://nucc.org/provider-taxonomy) |
| Id | Grade | Path(s) | Details | Requirements |
| 1098-32315 | warning | Author.assignedAuthor.code | 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). : | |
| 1098-32628 | error | Author.assignedAuthor.id | 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). : | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Author | 1..1 | CDAR2.Author | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, @typeCode, @contextControlCode, realmCode, typeId, templateId, functionCode, time, assignedAuthor Base for all types and resources | |
| @nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
| @typeCode | 0..1 | cs | Binding: ParticipationType (required) Fixed Value: AUT | |
| @contextControlCode | 0..1 | cs | Binding: ContextControl (required) Fixed Value: OP | |
| realmCode | 0..* | CS | ||
| typeId | 0..1 | II | ||
| Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root | |
| templateId:primary | 1..1 | II | ||
| @nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
| @assigningAuthorityName | 0..1 | st | ||
| @displayable | 0..1 | bl | ||
| @root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.119 | |
| functionCode | 0..1 | CE | ||
| time | 1..1 | TS | ||
| assignedAuthor | 1..1 | AssignedAuthor | ||
| @classCode | 0..1 | cs | Binding: RoleClassAssignedEntity (required) Fixed Value: ASSIGNED | |
| templateId | 0..* | II | ||
| id | C | 1..* | II | This 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..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |
| code | C | 0..1 | CE | Binding: 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..1 | Person | ||
| @classCode | 0..1 | cs | Binding: EntityClassLivingSubject (required) Fixed Value: PSN | |
| @determinerCode | 0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
| templateId | 0..* | II | ||
| name | 0..* | PN | ||
| sdtcAsPatientRelationship | 0..* | CE | XML Namespace: urn:hl7-org:sdtc XML: asPatientRelationship (urn:hl7-org:sdtc) | |
| assignedAuthoringDevice | 0..1 | AuthoringDevice | ||
| representedOrganization | 0..1 | Organization | ||
| @nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
| @classCode | 0..1 | cs | Binding: EntityClassOrganization (required) Fixed Value: ORG | |
| @determinerCode | 0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
| realmCode | 0..* | CS | ||
| typeId | 0..1 | II | ||
| templateId | 0..* | II | ||
| id | 0..* | II | ||
| name | 0..* | ON | ||
| telecom | 0..* | TEL | ||
| addr | 0..* | AD | ||
| standardIndustryClassCode | 0..1 | CE | Binding: OrganizationIndustryClassNAICS (extensible) | |
| asOrganizationPartOf | 0..1 | OrganizationPartOf | ||
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Author.nullFlavor | required | NullFlavor |
| Author.typeCode | required | Fixed Value: AUT |
| Author.contextControlCode | required | Fixed Value: OP |
| Author.templateId:primary.nullFlavor | required | NullFlavor |
| Author.assignedAuthor.classCode | required | Fixed Value: ASSIGNED |
| Author.assignedAuthor.code | preferred | Healthcare Provider Taxonomy (a valid code from http://nucc.org/provider-taxonomy) |
| Author.assignedAuthor.assignedPerson.classCode | required | Fixed Value: PSN |
| Author.assignedAuthor.assignedPerson.determinerCode | required | Fixed Value: INSTANCE |
| Author.assignedAuthor.representedOrganization.nullFlavor | required | NullFlavor |
| Author.assignedAuthor.representedOrganization.classCode | required | Fixed Value: ORG |
| Author.assignedAuthor.representedOrganization.determinerCode | required | Fixed Value: INSTANCE |
| Author.assignedAuthor.representedOrganization.standardIndustryClassCode | extensible | OrganizationIndustryClassNAICS |
| Id | Grade | Path(s) | Details | Requirements |
| 1098-32315 | warning | Author.assignedAuthor.code | 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). : | |
| 1098-32628 | error | Author.assignedAuthor.id | 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). : | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
This structure is derived from CDAR2.Author
Summary
Mandatory: 3 elements
Prohibited: 1 element
Slices
This structure defines the following Slices:
Differential View
This structure is derived from CDAR2.Author
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Author | CDAR2.Author | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, @typeCode, @contextControlCode, realmCode, typeId, templateId, functionCode, time, assignedAuthor | ||
| Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root | |
| templateId:primary | 1..1 | II | ||
| root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.119 | |
| extension | 0..0 | |||
| time | 1..1 | TS | ||
| assignedAuthor | 1..1 | AssignedAuthor | ||
| id | C | 1..* | II | This 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 | C | 0..1 | CE | Binding: 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..1 | Person | ||
| name | 0..* | PN | ||
| representedOrganization | 0..1 | Organization | ||
| id | 0..* | II | ||
| name | 0..* | ON | ||
| telecom | 0..* | TEL | ||
| addr | 0..* | AD | ||
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Author.assignedAuthor.code | preferred | Healthcare Provider Taxonomy (a valid code from http://nucc.org/provider-taxonomy) |
| Id | Grade | Path(s) | Details | Requirements |
| 1098-32315 | warning | Author.assignedAuthor.code | 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). : | |
| 1098-32628 | error | Author.assignedAuthor.id | 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). : |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Author | 1..1 | CDAR2.Author | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, @typeCode, @contextControlCode, realmCode, typeId, templateId, functionCode, time, assignedAuthor Base for all types and resources | |
| Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root | |
| templateId:primary | 1..1 | II | ||
| @root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.119 | |
| time | 1..1 | TS | ||
| assignedAuthor | 1..1 | AssignedAuthor | ||
| id | C | 1..* | II | This 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 | C | 0..1 | CE | Binding: 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..1 | Person | ||
| name | 0..* | PN | ||
| representedOrganization | 0..1 | Organization | ||
| id | 0..* | II | ||
| name | 0..* | ON | ||
| telecom | 0..* | TEL | ||
| addr | 0..* | AD | ||
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Author.assignedAuthor.code | preferred | Healthcare Provider Taxonomy (a valid code from http://nucc.org/provider-taxonomy) |
| Id | Grade | Path(s) | Details | Requirements |
| 1098-32315 | warning | Author.assignedAuthor.code | 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). : | |
| 1098-32628 | error | Author.assignedAuthor.id | 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). : | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Author | 1..1 | CDAR2.Author | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, @typeCode, @contextControlCode, realmCode, typeId, templateId, functionCode, time, assignedAuthor Base for all types and resources | |
| @nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
| @typeCode | 0..1 | cs | Binding: ParticipationType (required) Fixed Value: AUT | |
| @contextControlCode | 0..1 | cs | Binding: ContextControl (required) Fixed Value: OP | |
| realmCode | 0..* | CS | ||
| typeId | 0..1 | II | ||
| Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root | |
| templateId:primary | 1..1 | II | ||
| @nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
| @assigningAuthorityName | 0..1 | st | ||
| @displayable | 0..1 | bl | ||
| @root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.119 | |
| functionCode | 0..1 | CE | ||
| time | 1..1 | TS | ||
| assignedAuthor | 1..1 | AssignedAuthor | ||
| @classCode | 0..1 | cs | Binding: RoleClassAssignedEntity (required) Fixed Value: ASSIGNED | |
| templateId | 0..* | II | ||
| id | C | 1..* | II | This 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..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |
| code | C | 0..1 | CE | Binding: 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..1 | Person | ||
| @classCode | 0..1 | cs | Binding: EntityClassLivingSubject (required) Fixed Value: PSN | |
| @determinerCode | 0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
| templateId | 0..* | II | ||
| name | 0..* | PN | ||
| sdtcAsPatientRelationship | 0..* | CE | XML Namespace: urn:hl7-org:sdtc XML: asPatientRelationship (urn:hl7-org:sdtc) | |
| assignedAuthoringDevice | 0..1 | AuthoringDevice | ||
| representedOrganization | 0..1 | Organization | ||
| @nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
| @classCode | 0..1 | cs | Binding: EntityClassOrganization (required) Fixed Value: ORG | |
| @determinerCode | 0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
| realmCode | 0..* | CS | ||
| typeId | 0..1 | II | ||
| templateId | 0..* | II | ||
| id | 0..* | II | ||
| name | 0..* | ON | ||
| telecom | 0..* | TEL | ||
| addr | 0..* | AD | ||
| standardIndustryClassCode | 0..1 | CE | Binding: OrganizationIndustryClassNAICS (extensible) | |
| asOrganizationPartOf | 0..1 | OrganizationPartOf | ||
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Author.nullFlavor | required | NullFlavor |
| Author.typeCode | required | Fixed Value: AUT |
| Author.contextControlCode | required | Fixed Value: OP |
| Author.templateId:primary.nullFlavor | required | NullFlavor |
| Author.assignedAuthor.classCode | required | Fixed Value: ASSIGNED |
| Author.assignedAuthor.code | preferred | Healthcare Provider Taxonomy (a valid code from http://nucc.org/provider-taxonomy) |
| Author.assignedAuthor.assignedPerson.classCode | required | Fixed Value: PSN |
| Author.assignedAuthor.assignedPerson.determinerCode | required | Fixed Value: INSTANCE |
| Author.assignedAuthor.representedOrganization.nullFlavor | required | NullFlavor |
| Author.assignedAuthor.representedOrganization.classCode | required | Fixed Value: ORG |
| Author.assignedAuthor.representedOrganization.determinerCode | required | Fixed Value: INSTANCE |
| Author.assignedAuthor.representedOrganization.standardIndustryClassCode | extensible | OrganizationIndustryClassNAICS |
| Id | Grade | Path(s) | Details | Requirements |
| 1098-32315 | warning | Author.assignedAuthor.code | 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). : | |
| 1098-32628 | error | Author.assignedAuthor.id | 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). : | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
This structure is derived from CDAR2.Author
Summary
Mandatory: 3 elements
Prohibited: 1 element
Slices
This structure defines the following Slices:
IG © 2019+ Health Level Seven. Package hl7.cda.us.ccda#2.1 based on FHIR 5.0.0. Generated 2023-09-29
Links: Table of Contents |
QA Report
| Version History 
|
|
Propose a change