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
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:
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:
This structure is derived from CDAR2.Author
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Author | 1..1 | CDAR2.Author | ||
Slices for templateId | 0..* | II | Slice: Unordered, Open by value:root | |
templateId:primary | 1..1 | II | ||
root | 1..1 | string | Required Pattern: 2.16.840.1.113883.10.20.22.4.119 | |
time | 1..1 | TS | ||
assignedAuthor | 1..1 | AssignedAuthor | ||
id | I | 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 | I | 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..* | EN | ||
representedOrganization | 0..1 | Organization | ||
id | 0..* | II | ||
name | 0..* | ON | ||
telecom | 0..* | TEL | ||
addr | 0..* | AD | ||
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Author | 1..1 | CDAR2.Author | ||
nullFlavor | 0..1 | code | Binding: NullFlavor (required) | |
typeCode | 0..1 | code | Binding: ParticipationType (required) Fixed Value: AUT | |
contextControlCode | 0..1 | code | Binding: ContextControl (required) Fixed Value: OP | |
realmCode | 0..* | CS | ||
typeId | 0..1 | II | ||
Slices for templateId | 0..* | II | Slice: Unordered, Open by value:root | |
templateId:primary | 1..1 | II | ||
nullFlavor | 0..1 | code | Binding: NullFlavor (required) | |
assigningAuthorityName | 0..1 | string | ||
displayable | 0..1 | boolean | ||
root | 1..1 | string | Required Pattern: 2.16.840.1.113883.10.20.22.4.119 | |
extension | 0..1 | string | ||
functionCode | 0..1 | CE | ||
time | 1..1 | TS | ||
assignedAuthor | 1..1 | AssignedAuthor | ||
classCode | 1..1 | code | Binding: RoleClassAssignedEntity (required) Fixed Value: ASSIGNED | |
templateId | 0..* | II | ||
id | I | 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: identifiedBy (urn:hl7-org:sdtc) | |
code | I | 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 | 1..1 | code | Binding: EntityClassLivingSubject (required) Fixed Value: PSN | |
determinerCode | 1..1 | code | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
templateId | 0..* | II | ||
name | 0..* | EN | ||
sdtcAsPatientRelationship | 0..* | CE | XML: asPatientRelationship (urn:hl7-org:sdtc) | |
assignedAuthoringDevice | 0..1 | AuthoringDevice | ||
representedOrganization | 0..1 | Organization | ||
classCode | 1..1 | code | Binding: EntityClassOrganization (required) Fixed Value: ORG | |
determinerCode | 1..1 | code | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
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 |
This structure is derived from CDAR2.Author
Summary
Mandatory: 5 elements
Slices
This structure defines the following Slices:
Differential View
This structure is derived from CDAR2.Author
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Author | 1..1 | CDAR2.Author | ||
Slices for templateId | 0..* | II | Slice: Unordered, Open by value:root | |
templateId:primary | 1..1 | II | ||
root | 1..1 | string | Required Pattern: 2.16.840.1.113883.10.20.22.4.119 | |
time | 1..1 | TS | ||
assignedAuthor | 1..1 | AssignedAuthor | ||
id | I | 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 | I | 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..* | EN | ||
representedOrganization | 0..1 | Organization | ||
id | 0..* | II | ||
name | 0..* | ON | ||
telecom | 0..* | TEL | ||
addr | 0..* | AD | ||
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Author | 1..1 | CDAR2.Author | ||
nullFlavor | 0..1 | code | Binding: NullFlavor (required) | |
typeCode | 0..1 | code | Binding: ParticipationType (required) Fixed Value: AUT | |
contextControlCode | 0..1 | code | Binding: ContextControl (required) Fixed Value: OP | |
realmCode | 0..* | CS | ||
typeId | 0..1 | II | ||
Slices for templateId | 0..* | II | Slice: Unordered, Open by value:root | |
templateId:primary | 1..1 | II | ||
nullFlavor | 0..1 | code | Binding: NullFlavor (required) | |
assigningAuthorityName | 0..1 | string | ||
displayable | 0..1 | boolean | ||
root | 1..1 | string | Required Pattern: 2.16.840.1.113883.10.20.22.4.119 | |
extension | 0..1 | string | ||
functionCode | 0..1 | CE | ||
time | 1..1 | TS | ||
assignedAuthor | 1..1 | AssignedAuthor | ||
classCode | 1..1 | code | Binding: RoleClassAssignedEntity (required) Fixed Value: ASSIGNED | |
templateId | 0..* | II | ||
id | I | 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: identifiedBy (urn:hl7-org:sdtc) | |
code | I | 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 | 1..1 | code | Binding: EntityClassLivingSubject (required) Fixed Value: PSN | |
determinerCode | 1..1 | code | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
templateId | 0..* | II | ||
name | 0..* | EN | ||
sdtcAsPatientRelationship | 0..* | CE | XML: asPatientRelationship (urn:hl7-org:sdtc) | |
assignedAuthoringDevice | 0..1 | AuthoringDevice | ||
representedOrganization | 0..1 | Organization | ||
classCode | 1..1 | code | Binding: EntityClassOrganization (required) Fixed Value: ORG | |
determinerCode | 1..1 | code | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
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 |
Other representations of profile: CSV, Excel, Schematron
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 | HealthcareProviderTaxonomy |
Author.assignedAuthor.assignedPerson.classCode | required | Fixed Value: PSN |
Author.assignedAuthor.assignedPerson.determinerCode | required | Fixed Value: INSTANCE |
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 | Details | Requirements |
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). : | |
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). : |