This page is part of the CCDA: Consolidated CDA Release (v4.0.0-ballot: CCDA 4.0 Ballot 1) generated with FHIR (HL7® FHIR® Standard) v5.0.0. The current version which supersedes this version is 3.0.0. For a full list of available versions, see the Directory of published versions
Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/AuthorParticipation | Version: 4.0.0-ballot | |||
Draft as of 2024-12-20 | 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.
Usage:
Description of Template, Differentials, Snapshots and how the different presentations work.
This structure is derived from Author
Name | Flags | Card. | Type | Description & Constraints![]() | ||||||
---|---|---|---|---|---|---|---|---|---|---|
![]() ![]() |
Author | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @typeCode, @contextControlCode, functionCode, time, assignedAuthor Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) | ||||||||
![]() ![]() ![]() |
1..* | II | Slice: Unordered, Open by value:root | |||||||
![]() ![]() ![]() ![]() |
1..1 | II | ||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.119 | |||||||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||||
![]() ![]() ![]() |
1..1 | TS | ||||||||
![]() ![]() ![]() |
C | 1..1 | AssignedAuthor | author-details: 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. | ||||||
![]() ![]() ![]() ![]() |
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. | |||||||
![]() ![]() ![]() ![]() |
0..1 | CE | Binding: Healthcare Provider Taxonomy ![]()
| |||||||
![]() ![]() ![]() ![]() |
0..* | USRealmAddress | Required on at least one instance of this author in the document | |||||||
![]() ![]() ![]() ![]() |
0..* | TEL | Required on at least one instance of this author in the document | |||||||
![]() ![]() ![]() ![]() |
0..1 | Person | assignedPerson/name or assignedAuthoringDevice/manufacturerModelName is required on at least one instance of this author in the document | |||||||
![]() ![]() ![]() ![]() ![]() |
0..* | PN | ||||||||
![]() ![]() ![]() ![]() |
0..1 | Organization | assignedPerson/name or representedOrganization/name is required on at least one instance of this author in the document | |||||||
![]() ![]() ![]() ![]() ![]() |
0..* | II | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..* | ON | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..* | TEL | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..* | USRealmAddress | ||||||||
![]() |
Path | Conformance | ValueSet | URI |
Author.assignedAuthor.code | preferred | HealthcareProviderTaxonomy ![]() http://nucc.org/provider-taxonomy )http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066 |
Id | Grade | Path(s) | Details | Requirements |
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![]() | ||||||
---|---|---|---|---|---|---|---|---|---|---|
![]() ![]() |
1..1 | Author | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @typeCode, @contextControlCode, functionCode, time, assignedAuthor Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) | |||||||
![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
![]() ![]() ![]() |
0..* | CS | ||||||||
![]() ![]() ![]() |
C | 0..1 | II | II-1: An II instance must have either a root or an nullFlavor. | ||||||
![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
![]() ![]() ![]() ![]() |
0..1 | st | ||||||||
![]() ![]() ![]() ![]() |
0..1 | bl | ||||||||
![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |||||||
![]() ![]() ![]() ![]() |
1..1 | st | ||||||||
![]() ![]() ![]() |
1..* | II | Slice: Unordered, Open by value:root | |||||||
![]() ![]() ![]() ![]() |
1..1 | II | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | st | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | bl | ||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.119 | |||||||
![]() ![]() ![]() |
0..1 | cs | Binding: CDAParticipationType (required) Fixed Value: AUT | |||||||
![]() ![]() ![]() |
0..1 | cs | Binding: CDAContextControl (required) Fixed Value: OP | |||||||
![]() ![]() ![]() |
0..1 | CE | ||||||||
![]() ![]() ![]() |
1..1 | TS | ||||||||
![]() ![]() ![]() |
C | 1..1 | AssignedAuthor | author-details: 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. | ||||||
![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
![]() ![]() ![]() ![]() |
0..* | CS | ||||||||
![]() ![]() ![]() ![]() |
C | 0..1 | II | II-1: An II instance must have either a root or an nullFlavor. | ||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | st | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | bl | ||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | st | ||||||||
![]() ![]() ![]() ![]() |
0..* | II | ||||||||
![]() ![]() ![]() ![]() |
0..1 | cs | Binding: RoleClassAssignedEntity (required) Fixed Value: ASSIGNED | |||||||
![]() ![]() ![]() ![]() |
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. | |||||||
![]() ![]() ![]() ![]() |
0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |||||||
![]() ![]() ![]() ![]() |
0..1 | CE | Binding: Healthcare Provider Taxonomy ![]()
| |||||||
![]() ![]() ![]() ![]() |
0..* | USRealmAddress | Required on at least one instance of this author in the document | |||||||
![]() ![]() ![]() ![]() |
0..* | TEL | Required on at least one instance of this author in the document | |||||||
![]() ![]() ![]() ![]() |
0..1 | Person | assignedPerson/name or assignedAuthoringDevice/manufacturerModelName is required on at least one instance of this author in the document | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
![]() ![]() ![]() ![]() ![]() |
0..* | CS | ||||||||
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | II | II-1: An II instance must have either a root or an nullFlavor. | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | st | ||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | bl | ||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | st | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..* | II | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: EntityClassLivingSubject (required) Fixed Value: PSN | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |||||||
![]() ![]() ![]() ![]() ![]() |
0..* | PN | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | ED | XML Namespace: urn:hl7-org:sdtc XML: desc (urn:hl7-org:sdtc) | |||||||
![]() ![]() ![]() ![]() ![]() |
0..* | InfrastructureRoot | XML Namespace: urn:hl7-org:sdtc XML: asPatientRelationship (urn:hl7-org:sdtc) | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | CS | ||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
C | 0..1 | II | II-1: An II instance must have either a root or an nullFlavor. | ||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | st | ||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | bl | ||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | st | ||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | II | ||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | cs | Fixed Value: PRS | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Fixed Value: INSTANCE | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CE | XML Namespace: urn:hl7-org:sdtc XML Namespace: urn:hl7-org:sdtc | |||||||
![]() ![]() ![]() ![]() |
0..1 | AuthoringDevice | ||||||||
![]() ![]() ![]() ![]() |
0..1 | Organization | assignedPerson/name or representedOrganization/name is required on at least one instance of this author in the document | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
![]() ![]() ![]() ![]() ![]() |
0..* | CS | ||||||||
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | II | II-1: An II instance must have either a root or an nullFlavor. | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | st | ||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | bl | ||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | st | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..* | II | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: EntityClassOrganization (required) Fixed Value: ORG | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |||||||
![]() ![]() ![]() ![]() ![]() |
0..* | II | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..* | ON | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..* | TEL | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..* | USRealmAddress | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | CE | Binding: OrganizationIndustryClassNAICS (example) | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | OrganizationPartOf | ||||||||
![]() |
Path | Conformance | ValueSet / Code | URI |
Author.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Author.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Author.templateId:author.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Author.typeCode | required | Fixed Value: AUThttp://hl7.org/cda/stds/core/ValueSet/CDAParticipationType | |
Author.contextControlCode | required | Fixed Value: OPhttp://hl7.org/cda/stds/core/ValueSet/CDAContextControl | |
Author.assignedAuthor.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Author.assignedAuthor.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Author.assignedAuthor.classCode | required | Fixed Value: ASSIGNEDhttp://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity | |
Author.assignedAuthor.code | preferred | HealthcareProviderTaxonomy ![]() http://nucc.org/provider-taxonomy )http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066 | |
Author.assignedAuthor.assignedPerson.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Author.assignedAuthor.assignedPerson.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Author.assignedAuthor.assignedPerson.classCode | required | Fixed Value: PSNhttp://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject | |
Author.assignedAuthor.assignedPerson.determinerCode | required | Fixed Value: INSTANCEhttp://terminology.hl7.org/ValueSet/v3-EntityDeterminer | |
Author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Author.assignedAuthor.representedOrganization.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Author.assignedAuthor.representedOrganization.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Author.assignedAuthor.representedOrganization.classCode | required | Fixed Value: ORGhttp://terminology.hl7.org/ValueSet/v3-EntityClassOrganization | |
Author.assignedAuthor.representedOrganization.determinerCode | required | Fixed Value: INSTANCEhttp://terminology.hl7.org/ValueSet/v3-EntityDeterminer | |
Author.assignedAuthor.representedOrganization.standardIndustryClassCode | example | OrganizationIndustryClassNAICShttp://terminology.hl7.org/ValueSet/v3-OrganizationIndustryClassNAICS |
Id | Grade | Path(s) | Details | Requirements |
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![]() | ||||||
---|---|---|---|---|---|---|---|---|---|---|
![]() ![]() |
1..1 | Author | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @typeCode, @contextControlCode, functionCode, time, assignedAuthor Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) | |||||||
![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
![]() ![]() ![]() |
0..* | CS | ||||||||
![]() ![]() ![]() |
C | 0..1 | II | II-1: An II instance must have either a root or an nullFlavor. | ||||||
![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
![]() ![]() ![]() ![]() |
0..1 | st | ||||||||
![]() ![]() ![]() ![]() |
0..1 | bl | ||||||||
![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |||||||
![]() ![]() ![]() ![]() |
1..1 | st | ||||||||
![]() ![]() ![]() |
1..* | II | Slice: Unordered, Open by value:root | |||||||
![]() ![]() ![]() ![]() |
1..1 | II | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | st | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | bl | ||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.119 | |||||||
![]() ![]() ![]() |
0..1 | cs | Binding: CDAParticipationType (required) Fixed Value: AUT | |||||||
![]() ![]() ![]() |
0..1 | cs | Binding: CDAContextControl (required) Fixed Value: OP | |||||||
![]() ![]() ![]() |
0..1 | CE | ||||||||
![]() ![]() ![]() |
1..1 | TS | ||||||||
![]() ![]() ![]() |
C | 1..1 | AssignedAuthor | author-details: 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. | ||||||
![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
![]() ![]() ![]() ![]() |
0..* | CS | ||||||||
![]() ![]() ![]() ![]() |
C | 0..1 | II | II-1: An II instance must have either a root or an nullFlavor. | ||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | st | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | bl | ||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | st | ||||||||
![]() ![]() ![]() ![]() |
0..* | II | ||||||||
![]() ![]() ![]() ![]() |
0..1 | cs | Binding: RoleClassAssignedEntity (required) Fixed Value: ASSIGNED | |||||||
![]() ![]() ![]() ![]() |
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. | |||||||
![]() ![]() ![]() ![]() |
0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |||||||
![]() ![]() ![]() ![]() |
0..1 | CE | Binding: Healthcare Provider Taxonomy ![]()
| |||||||
![]() ![]() ![]() ![]() |
0..* | USRealmAddress | Required on at least one instance of this author in the document | |||||||
![]() ![]() ![]() ![]() |
0..* | TEL | Required on at least one instance of this author in the document | |||||||
![]() ![]() ![]() ![]() |
0..1 | Person | assignedPerson/name or assignedAuthoringDevice/manufacturerModelName is required on at least one instance of this author in the document | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
![]() ![]() ![]() ![]() ![]() |
0..* | CS | ||||||||
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | II | II-1: An II instance must have either a root or an nullFlavor. | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | st | ||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | bl | ||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | st | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..* | II | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: EntityClassLivingSubject (required) Fixed Value: PSN | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |||||||
![]() ![]() ![]() ![]() ![]() |
0..* | PN | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | ED | XML Namespace: urn:hl7-org:sdtc XML: desc (urn:hl7-org:sdtc) | |||||||
![]() ![]() ![]() ![]() ![]() |
0..* | InfrastructureRoot | XML Namespace: urn:hl7-org:sdtc XML: asPatientRelationship (urn:hl7-org:sdtc) | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | CS | ||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
C | 0..1 | II | II-1: An II instance must have either a root or an nullFlavor. | ||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | st | ||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | bl | ||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | st | ||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | II | ||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | cs | Fixed Value: PRS | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Fixed Value: INSTANCE | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CE | XML Namespace: urn:hl7-org:sdtc XML Namespace: urn:hl7-org:sdtc | |||||||
![]() ![]() ![]() ![]() |
0..1 | AuthoringDevice | ||||||||
![]() ![]() ![]() ![]() |
0..1 | Organization | assignedPerson/name or representedOrganization/name is required on at least one instance of this author in the document | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
![]() ![]() ![]() ![]() ![]() |
0..* | CS | ||||||||
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | II | II-1: An II instance must have either a root or an nullFlavor. | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | st | ||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | bl | ||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | st | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..* | II | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: EntityClassOrganization (required) Fixed Value: ORG | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |||||||
![]() ![]() ![]() ![]() ![]() |
0..* | II | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..* | ON | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..* | TEL | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..* | USRealmAddress | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | CE | Binding: OrganizationIndustryClassNAICS (example) | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | OrganizationPartOf | ||||||||
![]() |
Path | Conformance | ValueSet / Code | URI |
Author.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Author.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Author.templateId:author.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Author.typeCode | required | Fixed Value: AUThttp://hl7.org/cda/stds/core/ValueSet/CDAParticipationType | |
Author.contextControlCode | required | Fixed Value: OPhttp://hl7.org/cda/stds/core/ValueSet/CDAContextControl | |
Author.assignedAuthor.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Author.assignedAuthor.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Author.assignedAuthor.classCode | required | Fixed Value: ASSIGNEDhttp://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity | |
Author.assignedAuthor.code | preferred | HealthcareProviderTaxonomy ![]() http://nucc.org/provider-taxonomy )http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066 | |
Author.assignedAuthor.assignedPerson.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Author.assignedAuthor.assignedPerson.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Author.assignedAuthor.assignedPerson.classCode | required | Fixed Value: PSNhttp://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject | |
Author.assignedAuthor.assignedPerson.determinerCode | required | Fixed Value: INSTANCEhttp://terminology.hl7.org/ValueSet/v3-EntityDeterminer | |
Author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Author.assignedAuthor.representedOrganization.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Author.assignedAuthor.representedOrganization.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Author.assignedAuthor.representedOrganization.classCode | required | Fixed Value: ORGhttp://terminology.hl7.org/ValueSet/v3-EntityClassOrganization | |
Author.assignedAuthor.representedOrganization.determinerCode | required | Fixed Value: INSTANCEhttp://terminology.hl7.org/ValueSet/v3-EntityDeterminer | |
Author.assignedAuthor.representedOrganization.standardIndustryClassCode | example | OrganizationIndustryClassNAICShttp://terminology.hl7.org/ValueSet/v3-OrganizationIndustryClassNAICS |
Id | Grade | Path(s) | Details | Requirements |
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![]() | ||||||
---|---|---|---|---|---|---|---|---|---|---|
![]() ![]() |
Author | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @typeCode, @contextControlCode, functionCode, time, assignedAuthor Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) | ||||||||
![]() ![]() ![]() |
1..* | II | Slice: Unordered, Open by value:root | |||||||
![]() ![]() ![]() ![]() |
1..1 | II | ||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.119 | |||||||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||||
![]() ![]() ![]() |
1..1 | TS | ||||||||
![]() ![]() ![]() |
C | 1..1 | AssignedAuthor | author-details: 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. | ||||||
![]() ![]() ![]() ![]() |
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. | |||||||
![]() ![]() ![]() ![]() |
0..1 | CE | Binding: Healthcare Provider Taxonomy ![]()
| |||||||
![]() ![]() ![]() ![]() |
0..* | USRealmAddress | Required on at least one instance of this author in the document | |||||||
![]() ![]() ![]() ![]() |
0..* | TEL | Required on at least one instance of this author in the document | |||||||
![]() ![]() ![]() ![]() |
0..1 | Person | assignedPerson/name or assignedAuthoringDevice/manufacturerModelName is required on at least one instance of this author in the document | |||||||
![]() ![]() ![]() ![]() ![]() |
0..* | PN | ||||||||
![]() ![]() ![]() ![]() |
0..1 | Organization | assignedPerson/name or representedOrganization/name is required on at least one instance of this author in the document | |||||||
![]() ![]() ![]() ![]() ![]() |
0..* | II | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..* | ON | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..* | TEL | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..* | USRealmAddress | ||||||||
![]() |
Path | Conformance | ValueSet | URI |
Author.assignedAuthor.code | preferred | HealthcareProviderTaxonomy ![]() http://nucc.org/provider-taxonomy )http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066 |
Id | Grade | Path(s) | Details | Requirements |
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![]() | ||||||
---|---|---|---|---|---|---|---|---|---|---|
![]() ![]() |
1..1 | Author | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @typeCode, @contextControlCode, functionCode, time, assignedAuthor Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) | |||||||
![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
![]() ![]() ![]() |
0..* | CS | ||||||||
![]() ![]() ![]() |
C | 0..1 | II | II-1: An II instance must have either a root or an nullFlavor. | ||||||
![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
![]() ![]() ![]() ![]() |
0..1 | st | ||||||||
![]() ![]() ![]() ![]() |
0..1 | bl | ||||||||
![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |||||||
![]() ![]() ![]() ![]() |
1..1 | st | ||||||||
![]() ![]() ![]() |
1..* | II | Slice: Unordered, Open by value:root | |||||||
![]() ![]() ![]() ![]() |
1..1 | II | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | st | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | bl | ||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.119 | |||||||
![]() ![]() ![]() |
0..1 | cs | Binding: CDAParticipationType (required) Fixed Value: AUT | |||||||
![]() ![]() ![]() |
0..1 | cs | Binding: CDAContextControl (required) Fixed Value: OP | |||||||
![]() ![]() ![]() |
0..1 | CE | ||||||||
![]() ![]() ![]() |
1..1 | TS | ||||||||
![]() ![]() ![]() |
C | 1..1 | AssignedAuthor | author-details: 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. | ||||||
![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
![]() ![]() ![]() ![]() |
0..* | CS | ||||||||
![]() ![]() ![]() ![]() |
C | 0..1 | II | II-1: An II instance must have either a root or an nullFlavor. | ||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | st | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | bl | ||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | st | ||||||||
![]() ![]() ![]() ![]() |
0..* | II | ||||||||
![]() ![]() ![]() ![]() |
0..1 | cs | Binding: RoleClassAssignedEntity (required) Fixed Value: ASSIGNED | |||||||
![]() ![]() ![]() ![]() |
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. | |||||||
![]() ![]() ![]() ![]() |
0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |||||||
![]() ![]() ![]() ![]() |
0..1 | CE | Binding: Healthcare Provider Taxonomy ![]()
| |||||||
![]() ![]() ![]() ![]() |
0..* | USRealmAddress | Required on at least one instance of this author in the document | |||||||
![]() ![]() ![]() ![]() |
0..* | TEL | Required on at least one instance of this author in the document | |||||||
![]() ![]() ![]() ![]() |
0..1 | Person | assignedPerson/name or assignedAuthoringDevice/manufacturerModelName is required on at least one instance of this author in the document | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
![]() ![]() ![]() ![]() ![]() |
0..* | CS | ||||||||
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | II | II-1: An II instance must have either a root or an nullFlavor. | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | st | ||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | bl | ||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | st | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..* | II | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: EntityClassLivingSubject (required) Fixed Value: PSN | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |||||||
![]() ![]() ![]() ![]() ![]() |
0..* | PN | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | ED | XML Namespace: urn:hl7-org:sdtc XML: desc (urn:hl7-org:sdtc) | |||||||
![]() ![]() ![]() ![]() ![]() |
0..* | InfrastructureRoot | XML Namespace: urn:hl7-org:sdtc XML: asPatientRelationship (urn:hl7-org:sdtc) | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | CS | ||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
C | 0..1 | II | II-1: An II instance must have either a root or an nullFlavor. | ||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | st | ||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | bl | ||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | st | ||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | II | ||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | cs | Fixed Value: PRS | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Fixed Value: INSTANCE | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CE | XML Namespace: urn:hl7-org:sdtc XML Namespace: urn:hl7-org:sdtc | |||||||
![]() ![]() ![]() ![]() |
0..1 | AuthoringDevice | ||||||||
![]() ![]() ![]() ![]() |
0..1 | Organization | assignedPerson/name or representedOrganization/name is required on at least one instance of this author in the document | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
![]() ![]() ![]() ![]() ![]() |
0..* | CS | ||||||||
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | II | II-1: An II instance must have either a root or an nullFlavor. | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | st | ||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | bl | ||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | st | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..* | II | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: EntityClassOrganization (required) Fixed Value: ORG | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |||||||
![]() ![]() ![]() ![]() ![]() |
0..* | II | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..* | ON | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..* | TEL | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..* | USRealmAddress | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | CE | Binding: OrganizationIndustryClassNAICS (example) | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | OrganizationPartOf | ||||||||
![]() |
Path | Conformance | ValueSet / Code | URI |
Author.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Author.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Author.templateId:author.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Author.typeCode | required | Fixed Value: AUThttp://hl7.org/cda/stds/core/ValueSet/CDAParticipationType | |
Author.contextControlCode | required | Fixed Value: OPhttp://hl7.org/cda/stds/core/ValueSet/CDAContextControl | |
Author.assignedAuthor.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Author.assignedAuthor.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Author.assignedAuthor.classCode | required | Fixed Value: ASSIGNEDhttp://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity | |
Author.assignedAuthor.code | preferred | HealthcareProviderTaxonomy ![]() http://nucc.org/provider-taxonomy )http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066 | |
Author.assignedAuthor.assignedPerson.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Author.assignedAuthor.assignedPerson.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Author.assignedAuthor.assignedPerson.classCode | required | Fixed Value: PSNhttp://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject | |
Author.assignedAuthor.assignedPerson.determinerCode | required | Fixed Value: INSTANCEhttp://terminology.hl7.org/ValueSet/v3-EntityDeterminer | |
Author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Author.assignedAuthor.representedOrganization.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Author.assignedAuthor.representedOrganization.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Author.assignedAuthor.representedOrganization.classCode | required | Fixed Value: ORGhttp://terminology.hl7.org/ValueSet/v3-EntityClassOrganization | |
Author.assignedAuthor.representedOrganization.determinerCode | required | Fixed Value: INSTANCEhttp://terminology.hl7.org/ValueSet/v3-EntityDeterminer | |
Author.assignedAuthor.representedOrganization.standardIndustryClassCode | example | OrganizationIndustryClassNAICShttp://terminology.hl7.org/ValueSet/v3-OrganizationIndustryClassNAICS |
Id | Grade | Path(s) | Details | Requirements |
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![]() | ||||||
---|---|---|---|---|---|---|---|---|---|---|
![]() ![]() |
1..1 | Author | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @typeCode, @contextControlCode, functionCode, time, assignedAuthor Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) | |||||||
![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
![]() ![]() ![]() |
0..* | CS | ||||||||
![]() ![]() ![]() |
C | 0..1 | II | II-1: An II instance must have either a root or an nullFlavor. | ||||||
![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
![]() ![]() ![]() ![]() |
0..1 | st | ||||||||
![]() ![]() ![]() ![]() |
0..1 | bl | ||||||||
![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |||||||
![]() ![]() ![]() ![]() |
1..1 | st | ||||||||
![]() ![]() ![]() |
1..* | II | Slice: Unordered, Open by value:root | |||||||
![]() ![]() ![]() ![]() |
1..1 | II | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | st | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | bl | ||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.119 | |||||||
![]() ![]() ![]() |
0..1 | cs | Binding: CDAParticipationType (required) Fixed Value: AUT | |||||||
![]() ![]() ![]() |
0..1 | cs | Binding: CDAContextControl (required) Fixed Value: OP | |||||||
![]() ![]() ![]() |
0..1 | CE | ||||||||
![]() ![]() ![]() |
1..1 | TS | ||||||||
![]() ![]() ![]() |
C | 1..1 | AssignedAuthor | author-details: 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. | ||||||
![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
![]() ![]() ![]() ![]() |
0..* | CS | ||||||||
![]() ![]() ![]() ![]() |
C | 0..1 | II | II-1: An II instance must have either a root or an nullFlavor. | ||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | st | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | bl | ||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | st | ||||||||
![]() ![]() ![]() ![]() |
0..* | II | ||||||||
![]() ![]() ![]() ![]() |
0..1 | cs | Binding: RoleClassAssignedEntity (required) Fixed Value: ASSIGNED | |||||||
![]() ![]() ![]() ![]() |
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. | |||||||
![]() ![]() ![]() ![]() |
0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |||||||
![]() ![]() ![]() ![]() |
0..1 | CE | Binding: Healthcare Provider Taxonomy ![]()
| |||||||
![]() ![]() ![]() ![]() |
0..* | USRealmAddress | Required on at least one instance of this author in the document | |||||||
![]() ![]() ![]() ![]() |
0..* | TEL | Required on at least one instance of this author in the document | |||||||
![]() ![]() ![]() ![]() |
0..1 | Person | assignedPerson/name or assignedAuthoringDevice/manufacturerModelName is required on at least one instance of this author in the document | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
![]() ![]() ![]() ![]() ![]() |
0..* | CS | ||||||||
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | II | II-1: An II instance must have either a root or an nullFlavor. | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | st | ||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | bl | ||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | st | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..* | II | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: EntityClassLivingSubject (required) Fixed Value: PSN | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |||||||
![]() ![]() ![]() ![]() ![]() |
0..* | PN | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | ED | XML Namespace: urn:hl7-org:sdtc XML: desc (urn:hl7-org:sdtc) | |||||||
![]() ![]() ![]() ![]() ![]() |
0..* | InfrastructureRoot | XML Namespace: urn:hl7-org:sdtc XML: asPatientRelationship (urn:hl7-org:sdtc) | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | CS | ||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
C | 0..1 | II | II-1: An II instance must have either a root or an nullFlavor. | ||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | st | ||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | bl | ||||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | st | ||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | II | ||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | cs | Fixed Value: PRS | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Fixed Value: INSTANCE | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CE | XML Namespace: urn:hl7-org:sdtc XML Namespace: urn:hl7-org:sdtc | |||||||
![]() ![]() ![]() ![]() |
0..1 | AuthoringDevice | ||||||||
![]() ![]() ![]() ![]() |
0..1 | Organization | assignedPerson/name or representedOrganization/name is required on at least one instance of this author in the document | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
![]() ![]() ![]() ![]() ![]() |
0..* | CS | ||||||||
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | II | II-1: An II instance must have either a root or an nullFlavor. | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | st | ||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | bl | ||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | st | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..* | II | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: EntityClassOrganization (required) Fixed Value: ORG | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |||||||
![]() ![]() ![]() ![]() ![]() |
0..* | II | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..* | ON | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..* | TEL | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..* | USRealmAddress | ||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | CE | Binding: OrganizationIndustryClassNAICS (example) | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | OrganizationPartOf | ||||||||
![]() |
Path | Conformance | ValueSet / Code | URI |
Author.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Author.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Author.templateId:author.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Author.typeCode | required | Fixed Value: AUThttp://hl7.org/cda/stds/core/ValueSet/CDAParticipationType | |
Author.contextControlCode | required | Fixed Value: OPhttp://hl7.org/cda/stds/core/ValueSet/CDAContextControl | |
Author.assignedAuthor.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Author.assignedAuthor.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Author.assignedAuthor.classCode | required | Fixed Value: ASSIGNEDhttp://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity | |
Author.assignedAuthor.code | preferred | HealthcareProviderTaxonomy ![]() http://nucc.org/provider-taxonomy )http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066 | |
Author.assignedAuthor.assignedPerson.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Author.assignedAuthor.assignedPerson.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Author.assignedAuthor.assignedPerson.classCode | required | Fixed Value: PSNhttp://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject | |
Author.assignedAuthor.assignedPerson.determinerCode | required | Fixed Value: INSTANCEhttp://terminology.hl7.org/ValueSet/v3-EntityDeterminer | |
Author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Author.assignedAuthor.representedOrganization.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Author.assignedAuthor.representedOrganization.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Author.assignedAuthor.representedOrganization.classCode | required | Fixed Value: ORGhttp://terminology.hl7.org/ValueSet/v3-EntityClassOrganization | |
Author.assignedAuthor.representedOrganization.determinerCode | required | Fixed Value: INSTANCEhttp://terminology.hl7.org/ValueSet/v3-EntityDeterminer | |
Author.assignedAuthor.representedOrganization.standardIndustryClassCode | example | OrganizationIndustryClassNAICShttp://terminology.hl7.org/ValueSet/v3-OrganizationIndustryClassNAICS |
Id | Grade | Path(s) | Details | Requirements |
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()))) |