Consolidated CDA (C-CDA)
4.0.0 - STU4
Consolidated CDA (C-CDA)
4.0.0 - STU4
Consolidated CDA (C-CDA), published by Health Level Seven. This guide is not an authorized publication; it is the continuous build for version 4.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/CDA-ccda/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/AuthorParticipation | Version: 4.0.0 | |||
| Draft as of 2025-10-02 | Computable Name: AuthorParticipation | |||
| Other Identifiers: 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.
Usages:
You can also check for usages in the FHIR IG Statistics
Changes since version 3.0.0:
Description of Template, Differentials, Snapshots and how the different presentations work.
This structure is derived from Author
| Name | Flags | Card. | Type | Description & Constraints Filter:   | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
  Author |
Author | XML Namespace: urn:hl7-org:v3 Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) | ||||||||
  Slices for templateId |
1..* | II | Slice: Unordered, Open by value:root | |||||||
   templateId:author |
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 |
C | 1..1 | AssignedAuthor | Constraints: author-details | ||||||
| id |
1..* | II | The first 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. | |||||||
| code |
0..1 | CE | Binding: Healthcare Provider Taxonomy  (preferred)
| |||||||
 addr |
0..* | USRealmAddress | Required on at least one instance of this author in the document | |||||||
| telecom |
0..* | TEL | Required on at least one instance of this author in the document | |||||||
| assignedPerson |
0..1 | Person | assignedPerson/name or assignedAuthoringDevice/manufacturerModelName is required on at least one instance of this author in the document | |||||||
 name |
0..* | PN | ||||||||
| representedOrganization |
0..1 | Organization | assignedPerson/name or representedOrganization/name is required on at least one instance of this author in the document | |||||||
| id |
0..* | II | ||||||||
| name |
0..* | ON | ||||||||
| telecom |
0..* | TEL | ||||||||
| addr |
0..* | USRealmAddress | ||||||||
| Documentation for this format | ||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Author.assignedAuthor.code | Base | preferred |
Healthcare Provider Taxonomy
|
📦20240606 | VSAC v0.23 |
| Id | Grade | Path(s) | Description | Expression |
| author-details | error | Author.assignedAuthor | Authors require addr, telecom, and either assignedPerson/name or assignedAuthoringDevice/manufacturerModelName. These may be present on this author or on another instance of an Author Participation in the document that has an id that matches the first id of this author. |
nullFlavor.exists() or (addr.exists() and telecom.exists() and (assignedPerson.name.exists() or assignedAuthoringDevice.manufacturerModelName.exists())) or (%resource.descendants().ofType(CDA.AssignedAuthor).where(id.exists($this.root = %context.id.first().root and $this.extension ~ %context.id.first().extension) and addr.exists() and telecom.exists() and (assignedPerson.name.exists() or assignedAuthoringDevice.manufacturerModelName.exists())))
|
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| Author |
1..1 | Author | XML Namespace: urn:hl7-org:v3 Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) | |||||||
 @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
| realmCode |
0..* | CS | ||||||||
| typeId |
C | 0..1 | II | Constraints: II-1 | ||||||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
| @assigningAuthorityName |
0..1 | st | ||||||||
| @displayable |
0..1 | bl | ||||||||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |||||||
| @extension |
1..1 | st | ||||||||
| Slices for templateId |
1..* | II | Slice: Unordered, Open by value:root | |||||||
| templateId:author |
1..1 | II | ||||||||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (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 | |||||||
| @typeCode |
0..1 | cs | Binding: CDAParticipationType (required) Fixed Value: AUT | |||||||
| @contextControlCode |
0..1 | cs | Binding: CDAContextControl (required) Fixed Value: OP | |||||||
| functionCode |
0..1 | CE | ||||||||
| time |
1..1 | TS | ||||||||
| assignedAuthor |
C | 1..1 | AssignedAuthor | Constraints: author-details | ||||||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
| realmCode |
0..* | CS | ||||||||
| typeId |
C | 0..1 | II | Constraints: II-1 | ||||||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
| @assigningAuthorityName |
0..1 | st | ||||||||
| @displayable |
0..1 | bl | ||||||||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |||||||
| @extension |
1..1 | st | ||||||||
| templateId |
0..* | II | ||||||||
| @classCode |
0..1 | cs | Binding: RoleClassAssignedEntity (required) Fixed Value: ASSIGNED | |||||||
| id |
1..* | II | The first 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. | |||||||
| sdtcIdentifiedBy |
0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |||||||
| code |
0..1 | CE | Binding: Healthcare Provider Taxonomy (preferred)
| |||||||
| addr |
0..* | USRealmAddress | Required on at least one instance of this author in the document | |||||||
| telecom |
0..* | TEL | Required on at least one instance of this author in the document | |||||||
| assignedPerson |
0..1 | Person | assignedPerson/name or assignedAuthoringDevice/manufacturerModelName is required on at least one instance of this author in the document | |||||||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
| realmCode |
0..* | CS | ||||||||
| typeId |
C | 0..1 | II | Constraints: II-1 | ||||||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
| @assigningAuthorityName |
0..1 | st | ||||||||
| @displayable |
0..1 | bl | ||||||||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |||||||
| @extension |
1..1 | st | ||||||||
| templateId |
0..* | II | ||||||||
| @classCode |
0..1 | cs | Binding: EntityClassLivingSubject (required) Fixed Value: PSN | |||||||
| @determinerCode |
0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |||||||
| name |
0..* | PN | ||||||||
| sdtcDesc |
0..1 | ED | XML Namespace: urn:hl7-org:sdtc XML: desc (urn:hl7-org:sdtc) | |||||||
| sdtcAsPatientRelationship |
0..* | InfrastructureRoot | XML Namespace: urn:hl7-org:sdtc XML: asPatientRelationship (urn:hl7-org:sdtc) | |||||||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
| realmCode |
0..* | CS | ||||||||
| typeId |
C | 0..1 | II | Constraints: II-1 | ||||||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
| @assigningAuthorityName |
0..1 | st | ||||||||
| @displayable |
0..1 | bl | ||||||||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |||||||
| @extension |
1..1 | st | ||||||||
| templateId |
0..* | II | ||||||||
| @classCode |
1..1 | cs | Fixed Value: PRS | |||||||
| @determinerCode |
0..1 | cs | Fixed Value: INSTANCE | |||||||
| code |
1..1 | CE | XML Namespace: urn:hl7-org:sdtc XML Namespace: urn:hl7-org:sdtc | |||||||
| assignedAuthoringDevice |
0..1 | AuthoringDevice | ||||||||
| representedOrganization |
0..1 | Organization | assignedPerson/name or representedOrganization/name is required on at least one instance of this author in the document | |||||||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
| realmCode |
0..* | CS | ||||||||
| typeId |
C | 0..1 | II | Constraints: II-1 | ||||||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
| @assigningAuthorityName |
0..1 | st | ||||||||
| @displayable |
0..1 | bl | ||||||||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |||||||
| @extension |
1..1 | st | ||||||||
| templateId |
0..* | II | ||||||||
| @classCode |
0..1 | cs | Binding: EntityClassOrganization (required) Fixed Value: ORG | |||||||
| @determinerCode |
0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |||||||
| id |
0..* | II | ||||||||
| name |
0..* | ON | ||||||||
| telecom |
0..* | TEL | ||||||||
| addr |
0..* | USRealmAddress | ||||||||
| standardIndustryClassCode |
0..1 | CE | Binding: OrganizationIndustryClassNAICS (example) | |||||||
| asOrganizationPartOf |
0..1 | OrganizationPartOf | ||||||||
| Documentation for this format | ||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Author.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Author.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Author.templateId:author.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Author.typeCode | Base | required | CDAParticipationType | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Author.contextControlCode | Base | required | CDAContextControl | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Author.assignedAuthor.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Author.assignedAuthor.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Author.assignedAuthor.classCode | Base | required | RoleClassAssignedEntity | 📦3.0.0 | THO v6.5 |
| Author.assignedAuthor.code | Base | preferred |
Healthcare Provider Taxonomy
|
📦20240606 | VSAC v0.23 |
| Author.assignedAuthor.assignedPerson.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Author.assignedAuthor.assignedPerson.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Author.assignedAuthor.assignedPerson.classCode | Base | required | EntityClassLivingSubject | 📦3.0.0 | THO v6.5 |
| Author.assignedAuthor.assignedPerson.determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
| Author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Author.assignedAuthor.representedOrganization.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Author.assignedAuthor.representedOrganization.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Author.assignedAuthor.representedOrganization.classCode | Base | required | EntityClassOrganization | 📦3.0.0 | THO v6.5 |
| Author.assignedAuthor.representedOrganization.determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
| Author.assignedAuthor.representedOrganization.standardIndustryClassCode | Base | example | OrganizationIndustryClassNAICS | 📦3.0.0 | THO v6.5 |
| Id | Grade | Path(s) | Description | Expression |
| II-1 | error | Author.typeId, Author.assignedAuthor.typeId, Author.assignedAuthor.assignedPerson.typeId, Author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.typeId, Author.assignedAuthor.representedOrganization.typeId | An II instance must have either a root or an nullFlavor. |
root.exists() or nullFlavor.exists()
|
| author-details | error | Author.assignedAuthor | Authors require addr, telecom, and either assignedPerson/name or assignedAuthoringDevice/manufacturerModelName. These may be present on this author or on another instance of an Author Participation in the document that has an id that matches the first id of this author. |
nullFlavor.exists() or (addr.exists() and telecom.exists() and (assignedPerson.name.exists() or assignedAuthoringDevice.manufacturerModelName.exists())) or (%resource.descendants().ofType(CDA.AssignedAuthor).where(id.exists($this.root = %context.id.first().root and $this.extension ~ %context.id.first().extension) and addr.exists() and telecom.exists() and (assignedPerson.name.exists() or assignedAuthoringDevice.manufacturerModelName.exists())))
|
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| Author |
1..1 | Author | XML Namespace: urn:hl7-org:v3 Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) | |||||||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
| realmCode |
0..* | CS | ||||||||
| typeId |
C | 0..1 | II | Constraints: II-1 | ||||||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
| @assigningAuthorityName |
0..1 | st | ||||||||
| @displayable |
0..1 | bl | ||||||||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |||||||
| @extension |
1..1 | st | ||||||||
| Slices for templateId |
1..* | II | Slice: Unordered, Open by value:root | |||||||
| templateId:author |
1..1 | II | ||||||||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (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 | |||||||
| @typeCode |
0..1 | cs | Binding: CDAParticipationType (required) Fixed Value: AUT | |||||||
| @contextControlCode |
0..1 | cs | Binding: CDAContextControl (required) Fixed Value: OP | |||||||
| functionCode |
0..1 | CE | ||||||||
| time |
1..1 | TS | ||||||||
| assignedAuthor |
C | 1..1 | AssignedAuthor | Constraints: author-details | ||||||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
| realmCode |
0..* | CS | ||||||||
| typeId |
C | 0..1 | II | Constraints: II-1 | ||||||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
| @assigningAuthorityName |
0..1 | st | ||||||||
| @displayable |
0..1 | bl | ||||||||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |||||||
| @extension |
1..1 | st | ||||||||
| templateId |
0..* | II | ||||||||
| @classCode |
0..1 | cs | Binding: RoleClassAssignedEntity (required) Fixed Value: ASSIGNED | |||||||
| id |
1..* | II | The first 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. | |||||||
| sdtcIdentifiedBy |
0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |||||||
| code |
0..1 | CE | Binding: Healthcare Provider Taxonomy (preferred)
| |||||||
| addr |
0..* | USRealmAddress | Required on at least one instance of this author in the document | |||||||
| telecom |
0..* | TEL | Required on at least one instance of this author in the document | |||||||
| assignedPerson |
0..1 | Person | assignedPerson/name or assignedAuthoringDevice/manufacturerModelName is required on at least one instance of this author in the document | |||||||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
| realmCode |
0..* | CS | ||||||||
| typeId |
C | 0..1 | II | Constraints: II-1 | ||||||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
| @assigningAuthorityName |
0..1 | st | ||||||||
| @displayable |
0..1 | bl | ||||||||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |||||||
| @extension |
1..1 | st | ||||||||
| templateId |
0..* | II | ||||||||
| @classCode |
0..1 | cs | Binding: EntityClassLivingSubject (required) Fixed Value: PSN | |||||||
| @determinerCode |
0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |||||||
| name |
0..* | PN | ||||||||
| sdtcDesc |
0..1 | ED | XML Namespace: urn:hl7-org:sdtc XML: desc (urn:hl7-org:sdtc) | |||||||
| sdtcAsPatientRelationship |
0..* | InfrastructureRoot | XML Namespace: urn:hl7-org:sdtc XML: asPatientRelationship (urn:hl7-org:sdtc) | |||||||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
| realmCode |
0..* | CS | ||||||||
| typeId |
C | 0..1 | II | Constraints: II-1 | ||||||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
| @assigningAuthorityName |
0..1 | st | ||||||||
| @displayable |
0..1 | bl | ||||||||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |||||||
| @extension |
1..1 | st | ||||||||
| templateId |
0..* | II | ||||||||
| @classCode |
1..1 | cs | Fixed Value: PRS | |||||||
| @determinerCode |
0..1 | cs | Fixed Value: INSTANCE | |||||||
| code |
1..1 | CE | XML Namespace: urn:hl7-org:sdtc XML Namespace: urn:hl7-org:sdtc | |||||||
| assignedAuthoringDevice |
0..1 | AuthoringDevice | ||||||||
| representedOrganization |
0..1 | Organization | assignedPerson/name or representedOrganization/name is required on at least one instance of this author in the document | |||||||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
| realmCode |
0..* | CS | ||||||||
| typeId |
C | 0..1 | II | Constraints: II-1 | ||||||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
| @assigningAuthorityName |
0..1 | st | ||||||||
| @displayable |
0..1 | bl | ||||||||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |||||||
| @extension |
1..1 | st | ||||||||
| templateId |
0..* | II | ||||||||
| @classCode |
0..1 | cs | Binding: EntityClassOrganization (required) Fixed Value: ORG | |||||||
| @determinerCode |
0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |||||||
| id |
0..* | II | ||||||||
| name |
0..* | ON | ||||||||
| telecom |
0..* | TEL | ||||||||
| addr |
0..* | USRealmAddress | ||||||||
| standardIndustryClassCode |
0..1 | CE | Binding: OrganizationIndustryClassNAICS (example) | |||||||
| asOrganizationPartOf |
0..1 | OrganizationPartOf | ||||||||
| Documentation for this format | ||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Author.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Author.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Author.templateId:author.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Author.typeCode | Base | required | CDAParticipationType | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Author.contextControlCode | Base | required | CDAContextControl | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Author.assignedAuthor.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Author.assignedAuthor.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Author.assignedAuthor.classCode | Base | required | RoleClassAssignedEntity | 📦3.0.0 | THO v6.5 |
| Author.assignedAuthor.code | Base | preferred |
Healthcare Provider Taxonomy
|
📦20240606 | VSAC v0.23 |
| Author.assignedAuthor.assignedPerson.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Author.assignedAuthor.assignedPerson.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Author.assignedAuthor.assignedPerson.classCode | Base | required | EntityClassLivingSubject | 📦3.0.0 | THO v6.5 |
| Author.assignedAuthor.assignedPerson.determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
| Author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Author.assignedAuthor.representedOrganization.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Author.assignedAuthor.representedOrganization.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Author.assignedAuthor.representedOrganization.classCode | Base | required | EntityClassOrganization | 📦3.0.0 | THO v6.5 |
| Author.assignedAuthor.representedOrganization.determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
| Author.assignedAuthor.representedOrganization.standardIndustryClassCode | Base | example | OrganizationIndustryClassNAICS | 📦3.0.0 | THO v6.5 |
| Id | Grade | Path(s) | Description | Expression |
| II-1 | error | Author.typeId, Author.assignedAuthor.typeId, Author.assignedAuthor.assignedPerson.typeId, Author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.typeId, Author.assignedAuthor.representedOrganization.typeId | An II instance must have either a root or an nullFlavor. |
root.exists() or nullFlavor.exists()
|
| author-details | error | Author.assignedAuthor | Authors require addr, telecom, and either assignedPerson/name or assignedAuthoringDevice/manufacturerModelName. These may be present on this author or on another instance of an Author Participation in the document that has an id that matches the first id of this author. |
nullFlavor.exists() or (addr.exists() and telecom.exists() and (assignedPerson.name.exists() or assignedAuthoringDevice.manufacturerModelName.exists())) or (%resource.descendants().ofType(CDA.AssignedAuthor).where(id.exists($this.root = %context.id.first().root and $this.extension ~ %context.id.first().extension) and addr.exists() and telecom.exists() and (assignedPerson.name.exists() or assignedAuthoringDevice.manufacturerModelName.exists())))
|
Differential View
This structure is derived from Author
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| Author |
Author | XML Namespace: urn:hl7-org:v3 Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) | ||||||||
| Slices for templateId |
1..* | II | Slice: Unordered, Open by value:root | |||||||
| templateId:author |
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 |
C | 1..1 | AssignedAuthor | Constraints: author-details | ||||||
| id |
1..* | II | The first 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. | |||||||
| code |
0..1 | CE | Binding: Healthcare Provider Taxonomy (preferred)
| |||||||
| addr |
0..* | USRealmAddress | Required on at least one instance of this author in the document | |||||||
| telecom |
0..* | TEL | Required on at least one instance of this author in the document | |||||||
| assignedPerson |
0..1 | Person | assignedPerson/name or assignedAuthoringDevice/manufacturerModelName is required on at least one instance of this author in the document | |||||||
| name |
0..* | PN | ||||||||
| representedOrganization |
0..1 | Organization | assignedPerson/name or representedOrganization/name is required on at least one instance of this author in the document | |||||||
| id |
0..* | II | ||||||||
| name |
0..* | ON | ||||||||
| telecom |
0..* | TEL | ||||||||
| addr |
0..* | USRealmAddress | ||||||||
| Documentation for this format | ||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Author.assignedAuthor.code | Base | preferred |
Healthcare Provider Taxonomy
|
📦20240606 | VSAC v0.23 |
| Id | Grade | Path(s) | Description | Expression |
| author-details | error | Author.assignedAuthor | Authors require addr, telecom, and either assignedPerson/name or assignedAuthoringDevice/manufacturerModelName. These may be present on this author or on another instance of an Author Participation in the document that has an id that matches the first id of this author. |
nullFlavor.exists() or (addr.exists() and telecom.exists() and (assignedPerson.name.exists() or assignedAuthoringDevice.manufacturerModelName.exists())) or (%resource.descendants().ofType(CDA.AssignedAuthor).where(id.exists($this.root = %context.id.first().root and $this.extension ~ %context.id.first().extension) and addr.exists() and telecom.exists() and (assignedPerson.name.exists() or assignedAuthoringDevice.manufacturerModelName.exists())))
|
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| Author |
1..1 | Author | XML Namespace: urn:hl7-org:v3 Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) | |||||||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
| realmCode |
0..* | CS | ||||||||
| typeId |
C | 0..1 | II | Constraints: II-1 | ||||||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
| @assigningAuthorityName |
0..1 | st | ||||||||
| @displayable |
0..1 | bl | ||||||||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |||||||
| @extension |
1..1 | st | ||||||||
| Slices for templateId |
1..* | II | Slice: Unordered, Open by value:root | |||||||
| templateId:author |
1..1 | II | ||||||||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (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 | |||||||
| @typeCode |
0..1 | cs | Binding: CDAParticipationType (required) Fixed Value: AUT | |||||||
| @contextControlCode |
0..1 | cs | Binding: CDAContextControl (required) Fixed Value: OP | |||||||
| functionCode |
0..1 | CE | ||||||||
| time |
1..1 | TS | ||||||||
| assignedAuthor |
C | 1..1 | AssignedAuthor | Constraints: author-details | ||||||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
| realmCode |
0..* | CS | ||||||||
| typeId |
C | 0..1 | II | Constraints: II-1 | ||||||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
| @assigningAuthorityName |
0..1 | st | ||||||||
| @displayable |
0..1 | bl | ||||||||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |||||||
| @extension |
1..1 | st | ||||||||
| templateId |
0..* | II | ||||||||
| @classCode |
0..1 | cs | Binding: RoleClassAssignedEntity (required) Fixed Value: ASSIGNED | |||||||
| id |
1..* | II | The first 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. | |||||||
| sdtcIdentifiedBy |
0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |||||||
| code |
0..1 | CE | Binding: Healthcare Provider Taxonomy (preferred)
| |||||||
| addr |
0..* | USRealmAddress | Required on at least one instance of this author in the document | |||||||
| telecom |
0..* | TEL | Required on at least one instance of this author in the document | |||||||
| assignedPerson |
0..1 | Person | assignedPerson/name or assignedAuthoringDevice/manufacturerModelName is required on at least one instance of this author in the document | |||||||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
| realmCode |
0..* | CS | ||||||||
| typeId |
C | 0..1 | II | Constraints: II-1 | ||||||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
| @assigningAuthorityName |
0..1 | st | ||||||||
| @displayable |
0..1 | bl | ||||||||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |||||||
| @extension |
1..1 | st | ||||||||
| templateId |
0..* | II | ||||||||
| @classCode |
0..1 | cs | Binding: EntityClassLivingSubject (required) Fixed Value: PSN | |||||||
| @determinerCode |
0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |||||||
| name |
0..* | PN | ||||||||
| sdtcDesc |
0..1 | ED | XML Namespace: urn:hl7-org:sdtc XML: desc (urn:hl7-org:sdtc) | |||||||
| sdtcAsPatientRelationship |
0..* | InfrastructureRoot | XML Namespace: urn:hl7-org:sdtc XML: asPatientRelationship (urn:hl7-org:sdtc) | |||||||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
| realmCode |
0..* | CS | ||||||||
| typeId |
C | 0..1 | II | Constraints: II-1 | ||||||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
| @assigningAuthorityName |
0..1 | st | ||||||||
| @displayable |
0..1 | bl | ||||||||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |||||||
| @extension |
1..1 | st | ||||||||
| templateId |
0..* | II | ||||||||
| @classCode |
1..1 | cs | Fixed Value: PRS | |||||||
| @determinerCode |
0..1 | cs | Fixed Value: INSTANCE | |||||||
| code |
1..1 | CE | XML Namespace: urn:hl7-org:sdtc XML Namespace: urn:hl7-org:sdtc | |||||||
| assignedAuthoringDevice |
0..1 | AuthoringDevice | ||||||||
| representedOrganization |
0..1 | Organization | assignedPerson/name or representedOrganization/name is required on at least one instance of this author in the document | |||||||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
| realmCode |
0..* | CS | ||||||||
| typeId |
C | 0..1 | II | Constraints: II-1 | ||||||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
| @assigningAuthorityName |
0..1 | st | ||||||||
| @displayable |
0..1 | bl | ||||||||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |||||||
| @extension |
1..1 | st | ||||||||
| templateId |
0..* | II | ||||||||
| @classCode |
0..1 | cs | Binding: EntityClassOrganization (required) Fixed Value: ORG | |||||||
| @determinerCode |
0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |||||||
| id |
0..* | II | ||||||||
| name |
0..* | ON | ||||||||
| telecom |
0..* | TEL | ||||||||
| addr |
0..* | USRealmAddress | ||||||||
| standardIndustryClassCode |
0..1 | CE | Binding: OrganizationIndustryClassNAICS (example) | |||||||
| asOrganizationPartOf |
0..1 | OrganizationPartOf | ||||||||
| Documentation for this format | ||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Author.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Author.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Author.templateId:author.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Author.typeCode | Base | required | CDAParticipationType | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Author.contextControlCode | Base | required | CDAContextControl | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Author.assignedAuthor.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Author.assignedAuthor.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Author.assignedAuthor.classCode | Base | required | RoleClassAssignedEntity | 📦3.0.0 | THO v6.5 |
| Author.assignedAuthor.code | Base | preferred |
Healthcare Provider Taxonomy
|
📦20240606 | VSAC v0.23 |
| Author.assignedAuthor.assignedPerson.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Author.assignedAuthor.assignedPerson.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Author.assignedAuthor.assignedPerson.classCode | Base | required | EntityClassLivingSubject | 📦3.0.0 | THO v6.5 |
| Author.assignedAuthor.assignedPerson.determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
| Author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Author.assignedAuthor.representedOrganization.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Author.assignedAuthor.representedOrganization.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Author.assignedAuthor.representedOrganization.classCode | Base | required | EntityClassOrganization | 📦3.0.0 | THO v6.5 |
| Author.assignedAuthor.representedOrganization.determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
| Author.assignedAuthor.representedOrganization.standardIndustryClassCode | Base | example | OrganizationIndustryClassNAICS | 📦3.0.0 | THO v6.5 |
| Id | Grade | Path(s) | Description | Expression |
| II-1 | error | Author.typeId, Author.assignedAuthor.typeId, Author.assignedAuthor.assignedPerson.typeId, Author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.typeId, Author.assignedAuthor.representedOrganization.typeId | An II instance must have either a root or an nullFlavor. |
root.exists() or nullFlavor.exists()
|
| author-details | error | Author.assignedAuthor | Authors require addr, telecom, and either assignedPerson/name or assignedAuthoringDevice/manufacturerModelName. These may be present on this author or on another instance of an Author Participation in the document that has an id that matches the first id of this author. |
nullFlavor.exists() or (addr.exists() and telecom.exists() and (assignedPerson.name.exists() or assignedAuthoringDevice.manufacturerModelName.exists())) or (%resource.descendants().ofType(CDA.AssignedAuthor).where(id.exists($this.root = %context.id.first().root and $this.extension ~ %context.id.first().extension) and addr.exists() and telecom.exists() and (assignedPerson.name.exists() or assignedAuthoringDevice.manufacturerModelName.exists())))
|
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| Author |
1..1 | Author | XML Namespace: urn:hl7-org:v3 Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) | |||||||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
| realmCode |
0..* | CS | ||||||||
| typeId |
C | 0..1 | II | Constraints: II-1 | ||||||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
| @assigningAuthorityName |
0..1 | st | ||||||||
| @displayable |
0..1 | bl | ||||||||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |||||||
| @extension |
1..1 | st | ||||||||
| Slices for templateId |
1..* | II | Slice: Unordered, Open by value:root | |||||||
| templateId:author |
1..1 | II | ||||||||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (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 | |||||||
| @typeCode |
0..1 | cs | Binding: CDAParticipationType (required) Fixed Value: AUT | |||||||
| @contextControlCode |
0..1 | cs | Binding: CDAContextControl (required) Fixed Value: OP | |||||||
| functionCode |
0..1 | CE | ||||||||
| time |
1..1 | TS | ||||||||
| assignedAuthor |
C | 1..1 | AssignedAuthor | Constraints: author-details | ||||||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
| realmCode |
0..* | CS | ||||||||
| typeId |
C | 0..1 | II | Constraints: II-1 | ||||||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
| @assigningAuthorityName |
0..1 | st | ||||||||
| @displayable |
0..1 | bl | ||||||||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |||||||
| @extension |
1..1 | st | ||||||||
| templateId |
0..* | II | ||||||||
| @classCode |
0..1 | cs | Binding: RoleClassAssignedEntity (required) Fixed Value: ASSIGNED | |||||||
| id |
1..* | II | The first 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. | |||||||
| sdtcIdentifiedBy |
0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |||||||
| code |
0..1 | CE | Binding: Healthcare Provider Taxonomy (preferred)
| |||||||
| addr |
0..* | USRealmAddress | Required on at least one instance of this author in the document | |||||||
| telecom |
0..* | TEL | Required on at least one instance of this author in the document | |||||||
| assignedPerson |
0..1 | Person | assignedPerson/name or assignedAuthoringDevice/manufacturerModelName is required on at least one instance of this author in the document | |||||||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
| realmCode |
0..* | CS | ||||||||
| typeId |
C | 0..1 | II | Constraints: II-1 | ||||||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
| @assigningAuthorityName |
0..1 | st | ||||||||
| @displayable |
0..1 | bl | ||||||||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |||||||
| @extension |
1..1 | st | ||||||||
| templateId |
0..* | II | ||||||||
| @classCode |
0..1 | cs | Binding: EntityClassLivingSubject (required) Fixed Value: PSN | |||||||
| @determinerCode |
0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |||||||
| name |
0..* | PN | ||||||||
| sdtcDesc |
0..1 | ED | XML Namespace: urn:hl7-org:sdtc XML: desc (urn:hl7-org:sdtc) | |||||||
| sdtcAsPatientRelationship |
0..* | InfrastructureRoot | XML Namespace: urn:hl7-org:sdtc XML: asPatientRelationship (urn:hl7-org:sdtc) | |||||||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
| realmCode |
0..* | CS | ||||||||
| typeId |
C | 0..1 | II | Constraints: II-1 | ||||||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
| @assigningAuthorityName |
0..1 | st | ||||||||
| @displayable |
0..1 | bl | ||||||||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |||||||
| @extension |
1..1 | st | ||||||||
| templateId |
0..* | II | ||||||||
| @classCode |
1..1 | cs | Fixed Value: PRS | |||||||
| @determinerCode |
0..1 | cs | Fixed Value: INSTANCE | |||||||
| code |
1..1 | CE | XML Namespace: urn:hl7-org:sdtc XML Namespace: urn:hl7-org:sdtc | |||||||
| assignedAuthoringDevice |
0..1 | AuthoringDevice | ||||||||
| representedOrganization |
0..1 | Organization | assignedPerson/name or representedOrganization/name is required on at least one instance of this author in the document | |||||||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
| realmCode |
0..* | CS | ||||||||
| typeId |
C | 0..1 | II | Constraints: II-1 | ||||||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
| @assigningAuthorityName |
0..1 | st | ||||||||
| @displayable |
0..1 | bl | ||||||||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |||||||
| @extension |
1..1 | st | ||||||||
| templateId |
0..* | II | ||||||||
| @classCode |
0..1 | cs | Binding: EntityClassOrganization (required) Fixed Value: ORG | |||||||
| @determinerCode |
0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |||||||
| id |
0..* | II | ||||||||
| name |
0..* | ON | ||||||||
| telecom |
0..* | TEL | ||||||||
| addr |
0..* | USRealmAddress | ||||||||
| standardIndustryClassCode |
0..1 | CE | Binding: OrganizationIndustryClassNAICS (example) | |||||||
| asOrganizationPartOf |
0..1 | OrganizationPartOf | ||||||||
| Documentation for this format | ||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Author.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Author.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Author.templateId:author.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Author.typeCode | Base | required | CDAParticipationType | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Author.contextControlCode | Base | required | CDAContextControl | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Author.assignedAuthor.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Author.assignedAuthor.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Author.assignedAuthor.classCode | Base | required | RoleClassAssignedEntity | 📦3.0.0 | THO v6.5 |
| Author.assignedAuthor.code | Base | preferred |
Healthcare Provider Taxonomy
|
📦20240606 | VSAC v0.23 |
| Author.assignedAuthor.assignedPerson.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Author.assignedAuthor.assignedPerson.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Author.assignedAuthor.assignedPerson.classCode | Base | required | EntityClassLivingSubject | 📦3.0.0 | THO v6.5 |
| Author.assignedAuthor.assignedPerson.determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
| Author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Author.assignedAuthor.representedOrganization.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Author.assignedAuthor.representedOrganization.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Author.assignedAuthor.representedOrganization.classCode | Base | required | EntityClassOrganization | 📦3.0.0 | THO v6.5 |
| Author.assignedAuthor.representedOrganization.determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
| Author.assignedAuthor.representedOrganization.standardIndustryClassCode | Base | example | OrganizationIndustryClassNAICS | 📦3.0.0 | THO v6.5 |
| Id | Grade | Path(s) | Description | Expression |
| II-1 | error | Author.typeId, Author.assignedAuthor.typeId, Author.assignedAuthor.assignedPerson.typeId, Author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.typeId, Author.assignedAuthor.representedOrganization.typeId | An II instance must have either a root or an nullFlavor. |
root.exists() or nullFlavor.exists()
|
| author-details | error | Author.assignedAuthor | Authors require addr, telecom, and either assignedPerson/name or assignedAuthoringDevice/manufacturerModelName. These may be present on this author or on another instance of an Author Participation in the document that has an id that matches the first id of this author. |
nullFlavor.exists() or (addr.exists() and telecom.exists() and (assignedPerson.name.exists() or assignedAuthoringDevice.manufacturerModelName.exists())) or (%resource.descendants().ofType(CDA.AssignedAuthor).where(id.exists($this.root = %context.id.first().root and $this.extension ~ %context.id.first().extension) and addr.exists() and telecom.exists() and (assignedPerson.name.exists() or assignedAuthoringDevice.manufacturerModelName.exists())))
|
IG © 2019+ Health Level Seven. Package hl7.cda.us.ccda#4.0.0 based on FHIR 5.0.0. Generated 2025-10-02
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change