Consolidated CDA (C-CDA), published by Health Level Seven. This guide is not an authorized publication; it is the continuous build for version 3.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

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON

Logical Model: Provenance - Author Participation

This template represents the key information to record Provenance in an Author Participation.

This Participation is appropriate at any place CDA allows an author. For example, at the CDA Header, CDA Section, CDA Entry, or within a CDA entry (e.g. Organizer and contained Observation(s)).

This template is consistent with the C-CDA Author Participation, however, it doesnt use a formal conforms to relationship. All constraints for conformance are defined in this template which specializes the Author Participation (2.16.840.1.113883.10.20.22.4.119).

This template is used to identify primary authorship for an entry. An entry may have many authors, but recipients need a single authoritative point of contact for resolving issues. This is typically the last provider to make substantive changes to the entry If two providers are simultaneously involved in that activity, the implementer must choose one, ideally in a repeatable way.

The assignedAuthor/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.

Note: The Provenance template title includes a version 2 to support moving from the ‘Basic Provenance’ guide to the this Companion Guide, so the templateId has not changed.

Usage:

• This Logical Model is not used by any profiles in this Implementation Guide

Formal Views of Template Content

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

• Key Elements Table
• Differential Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from Author

Name	Flags	Card.	Type	Description & Constraints
Author		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 Instances of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class)
Slices for templateId		1..*	II	Slice: Unordered, Open by value:root, value:extension
templateId:provenance-author		1..1	II
@root		1..1	oid, uuid, ruid	Required Pattern: 2.16.840.1.113883.10.20.22.5.6
@extension		1..1	st	Required Pattern: 2019-10-01
time		1..1	TS	(USCDI) Author Time Stamp
assignedAuthor	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. 4515-64: If the assignedAuthor/id is not referencing a Provenance Author described elsewhere in the document with a representedOrganization populated, this assignedAuthor SHALL contain exactly one [1..1] representedOrganization (CONF:4515-64). should-code: SHOULD contain code
Slices for id		1..*	II	Slice: Unordered, Open by value:root
id:npi		1..1	II
@nullFlavor		0..1	cs	If NPI is unknown, set @nullFlavor to UNK
@root		1..1	oid, uuid, ruid	Required Pattern: 2.16.840.1.113883.4.6
@extension		0..1	st
code		0..1	CE	When the author is a person who is not acting in the role of a clinician, this code encodes the personal or legal relationship between author and the patient. Binding: CDARoleCode (example): See additional bindings Additional Bindings Purpose Documentation Healthcare Provider Taxonomy Preferred Binding Providers Personal And Legal Relationship Role Type Preferred Binding Non-clinicians
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	C	1..*	PN	shall-family: SHALL contain exactly one [1..1] family (CONF:81-7159). should-given: SHOULD contain given
item
family		0..*	ENXP	Family required
given		0..*	ENXP	SHOULD contain given
assignedAuthoringDevice		0..1	AuthoringDevice
representedOrganization	C	0..1	Organization	(USCDI) Author Organization - If the assignedAuthor/id is not referencing a Provenance Author described elsewhere in the document with a representedOrganization populated, this assignedAuthor SHALL contain exactly one [1..1] representedOrganization (See - CONF:4440-64). provenance-org-details: If the author is not a clinician, set nullFlavor='NA'. Otherwise, the taxId, npi, and name are required.
@nullFlavor		0..1	cs	A nullFlavor of "NA" is allowed If the assignedAuthor is not a clinician
Slices for id		0..*	II	Slice: Unordered, Open by value:root
id:taxId		0..1	II
@nullFlavor		0..1	cs	If Tax ID Number is unknown, set @nullFlavor to UNK
@root		1..1	oid, uuid, ruid	Required Pattern: 2.16.840.1.113883.4.2
@extension		0..1	st
id:npi		0..1	II
@nullFlavor		0..1	cs	If NPI is unknown, set @nullFlavor to UNK
@root		1..1	oid, uuid, ruid	Required Pattern: 2.16.840.1.113883.4.6
@extension		0..1	st
name		0..1	ON
telecom		0..*	TEL
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Author.assignedAuthor.code	example	CDARoleCode http://hl7.org/cda/stds/core/ValueSet/CDARoleCode

Constraints

Id	Grade	Path(s)	Details	Requirements
4515-64	error	Author.assignedAuthor	If the assignedAuthor/id is not referencing a Provenance Author described elsewhere in the document with a representedOrganization populated, this assignedAuthor SHALL contain exactly one [1..1] representedOrganization (CONF:4515-64). : representedOrganization.exists() or (%resource.descendants().ofType(CDA.Author).where(templateId.exists($this.root = '2.16.840.1.113883.10.20.22.5.6' and $this.extension = '2019-10-01') and assignedAuthor.representedOrganization.exists() and assignedAuthor.id.exists($this.root = %context.id.first().root and $this.extension ~ %context.id.first().extension)))
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())))
provenance-org-details	error	Author.assignedAuthor.representedOrganization	If the author is not a clinician, set nullFlavor='NA'. Otherwise, the taxId, npi, and name are required. : nullFlavor = 'NA' or (id.where(root='2.16.840.1.113883.4.2').exists() and id.where(root='2.16.840.1.113883.4.6').exists() and name.exists())
shall-family	error	Author.assignedAuthor.assignedPerson.name	SHALL contain exactly one [1..1] family (CONF:81-7159). : nullFlavor.exists() or item.family.count() = 1
should-code	warning	Author.assignedAuthor	SHOULD contain code : code.exists()
should-given	warning	Author.assignedAuthor.assignedPerson.name	SHOULD contain given : item.given.exists()

Name	Flags	Card.	Type	Description & Constraints
Author		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 Instances of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class)
Slices for templateId		1..*	II	Slice: Unordered, Open by value:root, value:extension
templateId:provenance-author		1..1	II
@root		1..1	oid, uuid, ruid	Required Pattern: 2.16.840.1.113883.10.20.22.5.6
@extension		1..1	st	Required Pattern: 2019-10-01
time		1..1	TS	(USCDI) Author Time Stamp
assignedAuthor	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. 4515-64: If the assignedAuthor/id is not referencing a Provenance Author described elsewhere in the document with a representedOrganization populated, this assignedAuthor SHALL contain exactly one [1..1] representedOrganization (CONF:4515-64). should-code: SHOULD contain code
Slices for id		1..*	II	Slice: Unordered, Open by value:root
id:npi		1..1	II
@nullFlavor		0..1	cs	If NPI is unknown, set @nullFlavor to UNK Binding: CDANullFlavor (required)
@root		1..1	oid, uuid, ruid	Required Pattern: 2.16.840.1.113883.4.6
@extension		0..1	st
code		0..1	CE	When the author is a person who is not acting in the role of a clinician, this code encodes the personal or legal relationship between author and the patient. Binding: CDARoleCode (example): See additional bindings Additional Bindings Purpose Documentation Healthcare Provider Taxonomy Preferred Binding Providers Personal And Legal Relationship Role Type Preferred Binding Non-clinicians
addr	C	0..*	USRealmAddress	Required on at least one instance of this author in the document shall-city: SHALL contain exactly one [1..1] city (CONF:81-7292). shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). should-use: SHOULD contain @use should-country: SHOULD contain country 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296) 81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024). 81-10025: If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025). shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country
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	C	1..*	PN	shall-family: SHALL contain exactly one [1..1] family (CONF:81-7159). should-given: SHOULD contain given
item	C	1..*	Base	Choice Group: This is a repeating choice group that does not appear directly in the instance EN-1: Can only have only one of the possible item elements in each choice
family		0..*	ENXP	Family required
given		0..*	ENXP	SHOULD contain given
assignedAuthoringDevice		0..1	AuthoringDevice
representedOrganization	C	0..1	Organization	(USCDI) Author Organization - If the assignedAuthor/id is not referencing a Provenance Author described elsewhere in the document with a representedOrganization populated, this assignedAuthor SHALL contain exactly one [1..1] representedOrganization (See - CONF:4440-64). provenance-org-details: If the author is not a clinician, set nullFlavor='NA'. Otherwise, the taxId, npi, and name are required.
@nullFlavor		0..1	cs	A nullFlavor of "NA" is allowed If the assignedAuthor is not a clinician Binding: CDANullFlavor (required)
Slices for id		0..*	II	Slice: Unordered, Open by value:root
id:taxId		0..1	II
@nullFlavor		0..1	cs	If Tax ID Number is unknown, set @nullFlavor to UNK Binding: CDANullFlavor (required)
@root		1..1	oid, uuid, ruid	Required Pattern: 2.16.840.1.113883.4.2
@extension		0..1	st
id:npi		0..1	II
@nullFlavor		0..1	cs	If NPI is unknown, set @nullFlavor to UNK Binding: CDANullFlavor (required)
@root		1..1	oid, uuid, ruid	Required Pattern: 2.16.840.1.113883.4.6
@extension		0..1	st
name		0..1	ON
telecom		0..*	TEL
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Author.assignedAuthor.id:npi.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Author.assignedAuthor.code	example	CDARoleCode http://hl7.org/cda/stds/core/ValueSet/CDARoleCode
Author.assignedAuthor.representedOrganization.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Author.assignedAuthor.representedOrganization.id:taxId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Author.assignedAuthor.representedOrganization.id:npi.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor

Constraints

Id	Grade	Path(s)	Details	Requirements
4515-64	error	Author.assignedAuthor	If the assignedAuthor/id is not referencing a Provenance Author described elsewhere in the document with a representedOrganization populated, this assignedAuthor SHALL contain exactly one [1..1] representedOrganization (CONF:4515-64). : representedOrganization.exists() or (%resource.descendants().ofType(CDA.Author).where(templateId.exists($this.root = '2.16.840.1.113883.10.20.22.5.6' and $this.extension = '2019-10-01') and assignedAuthor.representedOrganization.exists() and assignedAuthor.id.exists($this.root = %context.id.first().root and $this.extension ~ %context.id.first().extension)))
81-7296	error	Author.assignedAuthor.addr	**SHALL NOT** have mixed content except for white space (CONF:81-7296) : item.xmlText.empty()
81-10024	error	Author.assignedAuthor.addr	If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024). : nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state'))
81-10025	error	Author.assignedAuthor.addr	If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025). : nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?'))
EN-1	error	Author.assignedAuthor.assignedPerson.name.item	Can only have only one of the possible item elements in each choice : (delimiter | family | given | prefix | suffix | xmlText).count() = 1
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())))
provenance-org-details	error	Author.assignedAuthor.representedOrganization	If the author is not a clinician, set nullFlavor='NA'. Otherwise, the taxId, npi, and name are required. : nullFlavor = 'NA' or (id.where(root='2.16.840.1.113883.4.2').exists() and id.where(root='2.16.840.1.113883.4.6').exists() and name.exists())
shall-city	error	Author.assignedAuthor.addr	SHALL contain exactly one [1..1] city (CONF:81-7292). : nullFlavor.exists() or item.city.count() = 1
shall-family	error	Author.assignedAuthor.assignedPerson.name	SHALL contain exactly one [1..1] family (CONF:81-7159). : nullFlavor.exists() or item.family.count() = 1
shall-max-ad-parts	error	Author.assignedAuthor.addr	SHALL have at most one of each: state, city, postalCode, and country : (item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1)
shall-streetAddressLine	error	Author.assignedAuthor.addr	SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). : nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4)
should-code	warning	Author.assignedAuthor	SHOULD contain code : code.exists()
should-country	warning	Author.assignedAuthor.addr	SHOULD contain country : nullFlavor.exists() or item.country.exists()
should-given	warning	Author.assignedAuthor.assignedPerson.name	SHOULD contain given : item.given.exists()
should-use	warning	Author.assignedAuthor.addr	SHOULD contain @use : nullFlavor.exists() or use.exists()

Name	Flags	Card.	Type	Description & Constraints
Author		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 Instances of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class)
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
realmCode		0..*	CS
typeId		0..1	II
@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, value:extension
templateId:provenance-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.5.6
@extension		1..1	st	Required Pattern: 2019-10-01
@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	(USCDI) Author Time Stamp
assignedAuthor	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. 4515-64: If the assignedAuthor/id is not referencing a Provenance Author described elsewhere in the document with a representedOrganization populated, this assignedAuthor SHALL contain exactly one [1..1] representedOrganization (CONF:4515-64). should-code: SHOULD contain code
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
realmCode		0..*	CS
typeId		0..1	II
@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
Slices for id		1..*	II	Slice: Unordered, Open by value:root
id:npi		1..1	II
@nullFlavor		0..1	cs	If NPI is unknown, set @nullFlavor to UNK Binding: CDANullFlavor (required)
@assigningAuthorityName		0..1	st
@displayable		0..1	bl
@root		1..1	oid, uuid, ruid	Required Pattern: 2.16.840.1.113883.4.6
@extension		0..1	st
sdtcIdentifiedBy		0..*	IdentifiedBy	XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc)
code		0..1	CE	When the author is a person who is not acting in the role of a clinician, this code encodes the personal or legal relationship between author and the patient. Binding: CDARoleCode (example): See additional bindings Additional Bindings Purpose Documentation Healthcare Provider Taxonomy Preferred Binding Providers Personal And Legal Relationship Role Type Preferred Binding Non-clinicians
addr	C	0..*	USRealmAddress	Required on at least one instance of this author in the document shall-city: SHALL contain exactly one [1..1] city (CONF:81-7292). shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). should-use: SHOULD contain @use should-country: SHOULD contain country 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296) 81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024). 81-10025: If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025). shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country
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		0..1	II
@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	C	1..*	PN	shall-family: SHALL contain exactly one [1..1] family (CONF:81-7159). should-given: SHOULD contain given
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
@use		0..*	cs	Binding: CDAEntityNameUse (required)
item	C	1..*	Base	Choice Group: This is a repeating choice group that does not appear directly in the instance EN-1: Can only have only one of the possible item elements in each choice
(Choice of one)		1..1
delimiter		0..*	ENXP
family		0..*	ENXP	Family required
given		0..*	ENXP	SHOULD contain given
prefix		0..*	ENXP
suffix		0..*	ENXP
xmlText		0..1	st	Allows for mixed text content
validTime		0..1	IVL_TS
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		0..1	II
@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	C	0..1	Organization	(USCDI) Author Organization - If the assignedAuthor/id is not referencing a Provenance Author described elsewhere in the document with a representedOrganization populated, this assignedAuthor SHALL contain exactly one [1..1] representedOrganization (See - CONF:4440-64). provenance-org-details: If the author is not a clinician, set nullFlavor='NA'. Otherwise, the taxId, npi, and name are required.
@nullFlavor		0..1	cs	A nullFlavor of "NA" is allowed If the assignedAuthor is not a clinician Binding: CDANullFlavor (required)
realmCode		0..*	CS
typeId		0..1	II
@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
Slices for id		0..*	II	Slice: Unordered, Open by value:root
id:taxId		0..1	II
@nullFlavor		0..1	cs	If Tax ID Number is unknown, set @nullFlavor to UNK Binding: CDANullFlavor (required)
@assigningAuthorityName		0..1	st
@displayable		0..1	bl
@root		1..1	oid, uuid, ruid	Required Pattern: 2.16.840.1.113883.4.2
@extension		0..1	st
id:npi		0..1	II
@nullFlavor		0..1	cs	If NPI is unknown, set @nullFlavor to UNK Binding: CDANullFlavor (required)
@assigningAuthorityName		0..1	st
@displayable		0..1	bl
@root		1..1	oid, uuid, ruid	Required Pattern: 2.16.840.1.113883.4.6
@extension		0..1	st
name		0..1	ON
telecom		0..*	TEL
addr		0..*	AD
standardIndustryClassCode		0..1	CE	Binding: OrganizationIndustryClassNAICS (example)
asOrganizationPartOf		0..1	OrganizationPartOf
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Author.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Author.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Author.templateId:provenance-author.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Author.typeCode	required	Fixed Value: AUT http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType
Author.contextControlCode	required	Fixed Value: OP http://hl7.org/cda/stds/core/ValueSet/CDAContextControl
Author.assignedAuthor.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Author.assignedAuthor.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Author.assignedAuthor.classCode	required	Fixed Value: ASSIGNED http://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity
Author.assignedAuthor.id:npi.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Author.assignedAuthor.code	example	CDARoleCode http://hl7.org/cda/stds/core/ValueSet/CDARoleCode
Author.assignedAuthor.assignedPerson.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Author.assignedAuthor.assignedPerson.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Author.assignedAuthor.assignedPerson.classCode	required	Fixed Value: PSN http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject
Author.assignedAuthor.assignedPerson.determinerCode	required	Fixed Value: INSTANCE http://terminology.hl7.org/ValueSet/v3-EntityDeterminer
Author.assignedAuthor.assignedPerson.name.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Author.assignedAuthor.assignedPerson.name.use	required	CDAEntityNameUse http://hl7.org/cda/stds/core/ValueSet/CDAEntityNameUse
Author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Author.assignedAuthor.representedOrganization.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Author.assignedAuthor.representedOrganization.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Author.assignedAuthor.representedOrganization.classCode	required	Fixed Value: ORG http://terminology.hl7.org/ValueSet/v3-EntityClassOrganization
Author.assignedAuthor.representedOrganization.determinerCode	required	Fixed Value: INSTANCE http://terminology.hl7.org/ValueSet/v3-EntityDeterminer
Author.assignedAuthor.representedOrganization.id:taxId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Author.assignedAuthor.representedOrganization.id:npi.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Author.assignedAuthor.representedOrganization.standardIndustryClassCode	example	OrganizationIndustryClassNAICS http://terminology.hl7.org/ValueSet/v3-OrganizationIndustryClassNAICS

Constraints

Id	Grade	Path(s)	Details	Requirements
4515-64	error	Author.assignedAuthor	If the assignedAuthor/id is not referencing a Provenance Author described elsewhere in the document with a representedOrganization populated, this assignedAuthor SHALL contain exactly one [1..1] representedOrganization (CONF:4515-64). : representedOrganization.exists() or (%resource.descendants().ofType(CDA.Author).where(templateId.exists($this.root = '2.16.840.1.113883.10.20.22.5.6' and $this.extension = '2019-10-01') and assignedAuthor.representedOrganization.exists() and assignedAuthor.id.exists($this.root = %context.id.first().root and $this.extension ~ %context.id.first().extension)))
81-7296	error	Author.assignedAuthor.addr	**SHALL NOT** have mixed content except for white space (CONF:81-7296) : item.xmlText.empty()
81-10024	error	Author.assignedAuthor.addr	If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024). : nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state'))
81-10025	error	Author.assignedAuthor.addr	If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025). : nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?'))
EN-1	error	Author.assignedAuthor.assignedPerson.name.item	Can only have only one of the possible item elements in each choice : (delimiter | family | given | prefix | suffix | xmlText).count() = 1
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())))
provenance-org-details	error	Author.assignedAuthor.representedOrganization	If the author is not a clinician, set nullFlavor='NA'. Otherwise, the taxId, npi, and name are required. : nullFlavor = 'NA' or (id.where(root='2.16.840.1.113883.4.2').exists() and id.where(root='2.16.840.1.113883.4.6').exists() and name.exists())
shall-city	error	Author.assignedAuthor.addr	SHALL contain exactly one [1..1] city (CONF:81-7292). : nullFlavor.exists() or item.city.count() = 1
shall-family	error	Author.assignedAuthor.assignedPerson.name	SHALL contain exactly one [1..1] family (CONF:81-7159). : nullFlavor.exists() or item.family.count() = 1
shall-max-ad-parts	error	Author.assignedAuthor.addr	SHALL have at most one of each: state, city, postalCode, and country : (item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1)
shall-streetAddressLine	error	Author.assignedAuthor.addr	SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). : nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4)
should-code	warning	Author.assignedAuthor	SHOULD contain code : code.exists()
should-country	warning	Author.assignedAuthor.addr	SHOULD contain country : nullFlavor.exists() or item.country.exists()
should-given	warning	Author.assignedAuthor.assignedPerson.name	SHOULD contain given : item.given.exists()
should-use	warning	Author.assignedAuthor.addr	SHOULD contain @use : nullFlavor.exists() or use.exists()

This structure is derived from Author

Summary

Mandatory: 6 elements(3 nested mandatory elements)

Structures

This structure refers to these other structures:

• US Realm Address (http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress)

Slices

This structure defines the following Slices:

• The element 2 is sliced based on the values of Author.templateId
• The element 1 is sliced based on the value of Author.assignedAuthor.id
• The element 1 is sliced based on the value of Author.assignedAuthor.representedOrganization.id

Differential View

This structure is derived from Author

Name	Flags	Card.	Type	Description & Constraints
Author		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 Instances of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class)
Slices for templateId		1..*	II	Slice: Unordered, Open by value:root, value:extension
templateId:provenance-author		1..1	II
@root		1..1	oid, uuid, ruid	Required Pattern: 2.16.840.1.113883.10.20.22.5.6
@extension		1..1	st	Required Pattern: 2019-10-01
time		1..1	TS	(USCDI) Author Time Stamp
assignedAuthor	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. 4515-64: If the assignedAuthor/id is not referencing a Provenance Author described elsewhere in the document with a representedOrganization populated, this assignedAuthor SHALL contain exactly one [1..1] representedOrganization (CONF:4515-64). should-code: SHOULD contain code
Slices for id		1..*	II	Slice: Unordered, Open by value:root
id:npi		1..1	II
@nullFlavor		0..1	cs	If NPI is unknown, set @nullFlavor to UNK
@root		1..1	oid, uuid, ruid	Required Pattern: 2.16.840.1.113883.4.6
@extension		0..1	st
code		0..1	CE	When the author is a person who is not acting in the role of a clinician, this code encodes the personal or legal relationship between author and the patient. Binding: CDARoleCode (example): See additional bindings Additional Bindings Purpose Documentation Healthcare Provider Taxonomy Preferred Binding Providers Personal And Legal Relationship Role Type Preferred Binding Non-clinicians
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	C	1..*	PN	shall-family: SHALL contain exactly one [1..1] family (CONF:81-7159). should-given: SHOULD contain given
item
family		0..*	ENXP	Family required
given		0..*	ENXP	SHOULD contain given
assignedAuthoringDevice		0..1	AuthoringDevice
representedOrganization	C	0..1	Organization	(USCDI) Author Organization - If the assignedAuthor/id is not referencing a Provenance Author described elsewhere in the document with a representedOrganization populated, this assignedAuthor SHALL contain exactly one [1..1] representedOrganization (See - CONF:4440-64). provenance-org-details: If the author is not a clinician, set nullFlavor='NA'. Otherwise, the taxId, npi, and name are required.
@nullFlavor		0..1	cs	A nullFlavor of "NA" is allowed If the assignedAuthor is not a clinician
Slices for id		0..*	II	Slice: Unordered, Open by value:root
id:taxId		0..1	II
@nullFlavor		0..1	cs	If Tax ID Number is unknown, set @nullFlavor to UNK
@root		1..1	oid, uuid, ruid	Required Pattern: 2.16.840.1.113883.4.2
@extension		0..1	st
id:npi		0..1	II
@nullFlavor		0..1	cs	If NPI is unknown, set @nullFlavor to UNK
@root		1..1	oid, uuid, ruid	Required Pattern: 2.16.840.1.113883.4.6
@extension		0..1	st
name		0..1	ON
telecom		0..*	TEL
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Author.assignedAuthor.code	example	CDARoleCode http://hl7.org/cda/stds/core/ValueSet/CDARoleCode

Constraints

Id	Grade	Path(s)	Details	Requirements
4515-64	error	Author.assignedAuthor	If the assignedAuthor/id is not referencing a Provenance Author described elsewhere in the document with a representedOrganization populated, this assignedAuthor SHALL contain exactly one [1..1] representedOrganization (CONF:4515-64). : representedOrganization.exists() or (%resource.descendants().ofType(CDA.Author).where(templateId.exists($this.root = '2.16.840.1.113883.10.20.22.5.6' and $this.extension = '2019-10-01') and assignedAuthor.representedOrganization.exists() and assignedAuthor.id.exists($this.root = %context.id.first().root and $this.extension ~ %context.id.first().extension)))
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())))
provenance-org-details	error	Author.assignedAuthor.representedOrganization	If the author is not a clinician, set nullFlavor='NA'. Otherwise, the taxId, npi, and name are required. : nullFlavor = 'NA' or (id.where(root='2.16.840.1.113883.4.2').exists() and id.where(root='2.16.840.1.113883.4.6').exists() and name.exists())
shall-family	error	Author.assignedAuthor.assignedPerson.name	SHALL contain exactly one [1..1] family (CONF:81-7159). : nullFlavor.exists() or item.family.count() = 1
should-code	warning	Author.assignedAuthor	SHOULD contain code : code.exists()
should-given	warning	Author.assignedAuthor.assignedPerson.name	SHOULD contain given : item.given.exists()

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Author		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 Instances of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class)
Slices for templateId		1..*	II	Slice: Unordered, Open by value:root, value:extension
templateId:provenance-author		1..1	II
@root		1..1	oid, uuid, ruid	Required Pattern: 2.16.840.1.113883.10.20.22.5.6
@extension		1..1	st	Required Pattern: 2019-10-01
time		1..1	TS	(USCDI) Author Time Stamp
assignedAuthor	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. 4515-64: If the assignedAuthor/id is not referencing a Provenance Author described elsewhere in the document with a representedOrganization populated, this assignedAuthor SHALL contain exactly one [1..1] representedOrganization (CONF:4515-64). should-code: SHOULD contain code
Slices for id		1..*	II	Slice: Unordered, Open by value:root
id:npi		1..1	II
@nullFlavor		0..1	cs	If NPI is unknown, set @nullFlavor to UNK Binding: CDANullFlavor (required)
@root		1..1	oid, uuid, ruid	Required Pattern: 2.16.840.1.113883.4.6
@extension		0..1	st
code		0..1	CE	When the author is a person who is not acting in the role of a clinician, this code encodes the personal or legal relationship between author and the patient. Binding: CDARoleCode (example): See additional bindings Additional Bindings Purpose Documentation Healthcare Provider Taxonomy Preferred Binding Providers Personal And Legal Relationship Role Type Preferred Binding Non-clinicians
addr	C	0..*	USRealmAddress	Required on at least one instance of this author in the document shall-city: SHALL contain exactly one [1..1] city (CONF:81-7292). shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). should-use: SHOULD contain @use should-country: SHOULD contain country 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296) 81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024). 81-10025: If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025). shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country
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	C	1..*	PN	shall-family: SHALL contain exactly one [1..1] family (CONF:81-7159). should-given: SHOULD contain given
item	C	1..*	Base	Choice Group: This is a repeating choice group that does not appear directly in the instance EN-1: Can only have only one of the possible item elements in each choice
family		0..*	ENXP	Family required
given		0..*	ENXP	SHOULD contain given
assignedAuthoringDevice		0..1	AuthoringDevice
representedOrganization	C	0..1	Organization	(USCDI) Author Organization - If the assignedAuthor/id is not referencing a Provenance Author described elsewhere in the document with a representedOrganization populated, this assignedAuthor SHALL contain exactly one [1..1] representedOrganization (See - CONF:4440-64). provenance-org-details: If the author is not a clinician, set nullFlavor='NA'. Otherwise, the taxId, npi, and name are required.
@nullFlavor		0..1	cs	A nullFlavor of "NA" is allowed If the assignedAuthor is not a clinician Binding: CDANullFlavor (required)
Slices for id		0..*	II	Slice: Unordered, Open by value:root
id:taxId		0..1	II
@nullFlavor		0..1	cs	If Tax ID Number is unknown, set @nullFlavor to UNK Binding: CDANullFlavor (required)
@root		1..1	oid, uuid, ruid	Required Pattern: 2.16.840.1.113883.4.2
@extension		0..1	st
id:npi		0..1	II
@nullFlavor		0..1	cs	If NPI is unknown, set @nullFlavor to UNK Binding: CDANullFlavor (required)
@root		1..1	oid, uuid, ruid	Required Pattern: 2.16.840.1.113883.4.6
@extension		0..1	st
name		0..1	ON
telecom		0..*	TEL
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Author.assignedAuthor.id:npi.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Author.assignedAuthor.code	example	CDARoleCode http://hl7.org/cda/stds/core/ValueSet/CDARoleCode
Author.assignedAuthor.representedOrganization.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Author.assignedAuthor.representedOrganization.id:taxId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Author.assignedAuthor.representedOrganization.id:npi.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor

Constraints

Id	Grade	Path(s)	Details	Requirements
4515-64	error	Author.assignedAuthor	If the assignedAuthor/id is not referencing a Provenance Author described elsewhere in the document with a representedOrganization populated, this assignedAuthor SHALL contain exactly one [1..1] representedOrganization (CONF:4515-64). : representedOrganization.exists() or (%resource.descendants().ofType(CDA.Author).where(templateId.exists($this.root = '2.16.840.1.113883.10.20.22.5.6' and $this.extension = '2019-10-01') and assignedAuthor.representedOrganization.exists() and assignedAuthor.id.exists($this.root = %context.id.first().root and $this.extension ~ %context.id.first().extension)))
81-7296	error	Author.assignedAuthor.addr	**SHALL NOT** have mixed content except for white space (CONF:81-7296) : item.xmlText.empty()
81-10024	error	Author.assignedAuthor.addr	If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024). : nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state'))
81-10025	error	Author.assignedAuthor.addr	If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025). : nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?'))
EN-1	error	Author.assignedAuthor.assignedPerson.name.item	Can only have only one of the possible item elements in each choice : (delimiter | family | given | prefix | suffix | xmlText).count() = 1
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())))
provenance-org-details	error	Author.assignedAuthor.representedOrganization	If the author is not a clinician, set nullFlavor='NA'. Otherwise, the taxId, npi, and name are required. : nullFlavor = 'NA' or (id.where(root='2.16.840.1.113883.4.2').exists() and id.where(root='2.16.840.1.113883.4.6').exists() and name.exists())
shall-city	error	Author.assignedAuthor.addr	SHALL contain exactly one [1..1] city (CONF:81-7292). : nullFlavor.exists() or item.city.count() = 1
shall-family	error	Author.assignedAuthor.assignedPerson.name	SHALL contain exactly one [1..1] family (CONF:81-7159). : nullFlavor.exists() or item.family.count() = 1
shall-max-ad-parts	error	Author.assignedAuthor.addr	SHALL have at most one of each: state, city, postalCode, and country : (item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1)
shall-streetAddressLine	error	Author.assignedAuthor.addr	SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). : nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4)
should-code	warning	Author.assignedAuthor	SHOULD contain code : code.exists()
should-country	warning	Author.assignedAuthor.addr	SHOULD contain country : nullFlavor.exists() or item.country.exists()
should-given	warning	Author.assignedAuthor.assignedPerson.name	SHOULD contain given : item.given.exists()
should-use	warning	Author.assignedAuthor.addr	SHOULD contain @use : nullFlavor.exists() or use.exists()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Author		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 Instances of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class)
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
realmCode		0..*	CS
typeId		0..1	II
@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, value:extension
templateId:provenance-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.5.6
@extension		1..1	st	Required Pattern: 2019-10-01
@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	(USCDI) Author Time Stamp
assignedAuthor	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. 4515-64: If the assignedAuthor/id is not referencing a Provenance Author described elsewhere in the document with a representedOrganization populated, this assignedAuthor SHALL contain exactly one [1..1] representedOrganization (CONF:4515-64). should-code: SHOULD contain code
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
realmCode		0..*	CS
typeId		0..1	II
@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
Slices for id		1..*	II	Slice: Unordered, Open by value:root
id:npi		1..1	II
@nullFlavor		0..1	cs	If NPI is unknown, set @nullFlavor to UNK Binding: CDANullFlavor (required)
@assigningAuthorityName		0..1	st
@displayable		0..1	bl
@root		1..1	oid, uuid, ruid	Required Pattern: 2.16.840.1.113883.4.6
@extension		0..1	st
sdtcIdentifiedBy		0..*	IdentifiedBy	XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc)
code		0..1	CE	When the author is a person who is not acting in the role of a clinician, this code encodes the personal or legal relationship between author and the patient. Binding: CDARoleCode (example): See additional bindings Additional Bindings Purpose Documentation Healthcare Provider Taxonomy Preferred Binding Providers Personal And Legal Relationship Role Type Preferred Binding Non-clinicians
addr	C	0..*	USRealmAddress	Required on at least one instance of this author in the document shall-city: SHALL contain exactly one [1..1] city (CONF:81-7292). shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). should-use: SHOULD contain @use should-country: SHOULD contain country 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296) 81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024). 81-10025: If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025). shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country
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		0..1	II
@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	C	1..*	PN	shall-family: SHALL contain exactly one [1..1] family (CONF:81-7159). should-given: SHOULD contain given
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
@use		0..*	cs	Binding: CDAEntityNameUse (required)
item	C	1..*	Base	Choice Group: This is a repeating choice group that does not appear directly in the instance EN-1: Can only have only one of the possible item elements in each choice
(Choice of one)		1..1
delimiter		0..*	ENXP
family		0..*	ENXP	Family required
given		0..*	ENXP	SHOULD contain given
prefix		0..*	ENXP
suffix		0..*	ENXP
xmlText		0..1	st	Allows for mixed text content
validTime		0..1	IVL_TS
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		0..1	II
@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	C	0..1	Organization	(USCDI) Author Organization - If the assignedAuthor/id is not referencing a Provenance Author described elsewhere in the document with a representedOrganization populated, this assignedAuthor SHALL contain exactly one [1..1] representedOrganization (See - CONF:4440-64). provenance-org-details: If the author is not a clinician, set nullFlavor='NA'. Otherwise, the taxId, npi, and name are required.
@nullFlavor		0..1	cs	A nullFlavor of "NA" is allowed If the assignedAuthor is not a clinician Binding: CDANullFlavor (required)
realmCode		0..*	CS
typeId		0..1	II
@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
Slices for id		0..*	II	Slice: Unordered, Open by value:root
id:taxId		0..1	II
@nullFlavor		0..1	cs	If Tax ID Number is unknown, set @nullFlavor to UNK Binding: CDANullFlavor (required)
@assigningAuthorityName		0..1	st
@displayable		0..1	bl
@root		1..1	oid, uuid, ruid	Required Pattern: 2.16.840.1.113883.4.2
@extension		0..1	st
id:npi		0..1	II
@nullFlavor		0..1	cs	If NPI is unknown, set @nullFlavor to UNK Binding: CDANullFlavor (required)
@assigningAuthorityName		0..1	st
@displayable		0..1	bl
@root		1..1	oid, uuid, ruid	Required Pattern: 2.16.840.1.113883.4.6
@extension		0..1	st
name		0..1	ON
telecom		0..*	TEL
addr		0..*	AD
standardIndustryClassCode		0..1	CE	Binding: OrganizationIndustryClassNAICS (example)
asOrganizationPartOf		0..1	OrganizationPartOf
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Author.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Author.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Author.templateId:provenance-author.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Author.typeCode	required	Fixed Value: AUT http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType
Author.contextControlCode	required	Fixed Value: OP http://hl7.org/cda/stds/core/ValueSet/CDAContextControl
Author.assignedAuthor.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Author.assignedAuthor.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Author.assignedAuthor.classCode	required	Fixed Value: ASSIGNED http://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity
Author.assignedAuthor.id:npi.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Author.assignedAuthor.code	example	CDARoleCode http://hl7.org/cda/stds/core/ValueSet/CDARoleCode
Author.assignedAuthor.assignedPerson.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Author.assignedAuthor.assignedPerson.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Author.assignedAuthor.assignedPerson.classCode	required	Fixed Value: PSN http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject
Author.assignedAuthor.assignedPerson.determinerCode	required	Fixed Value: INSTANCE http://terminology.hl7.org/ValueSet/v3-EntityDeterminer
Author.assignedAuthor.assignedPerson.name.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Author.assignedAuthor.assignedPerson.name.use	required	CDAEntityNameUse http://hl7.org/cda/stds/core/ValueSet/CDAEntityNameUse
Author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Author.assignedAuthor.representedOrganization.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Author.assignedAuthor.representedOrganization.typeId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Author.assignedAuthor.representedOrganization.classCode	required	Fixed Value: ORG http://terminology.hl7.org/ValueSet/v3-EntityClassOrganization
Author.assignedAuthor.representedOrganization.determinerCode	required	Fixed Value: INSTANCE http://terminology.hl7.org/ValueSet/v3-EntityDeterminer
Author.assignedAuthor.representedOrganization.id:taxId.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Author.assignedAuthor.representedOrganization.id:npi.nullFlavor	required	CDANullFlavor http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Author.assignedAuthor.representedOrganization.standardIndustryClassCode	example	OrganizationIndustryClassNAICS http://terminology.hl7.org/ValueSet/v3-OrganizationIndustryClassNAICS

Constraints

Id	Grade	Path(s)	Details	Requirements
4515-64	error	Author.assignedAuthor	If the assignedAuthor/id is not referencing a Provenance Author described elsewhere in the document with a representedOrganization populated, this assignedAuthor SHALL contain exactly one [1..1] representedOrganization (CONF:4515-64). : representedOrganization.exists() or (%resource.descendants().ofType(CDA.Author).where(templateId.exists($this.root = '2.16.840.1.113883.10.20.22.5.6' and $this.extension = '2019-10-01') and assignedAuthor.representedOrganization.exists() and assignedAuthor.id.exists($this.root = %context.id.first().root and $this.extension ~ %context.id.first().extension)))
81-7296	error	Author.assignedAuthor.addr	**SHALL NOT** have mixed content except for white space (CONF:81-7296) : item.xmlText.empty()
81-10024	error	Author.assignedAuthor.addr	If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024). : nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state'))
81-10025	error	Author.assignedAuthor.addr	If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025). : nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?'))
EN-1	error	Author.assignedAuthor.assignedPerson.name.item	Can only have only one of the possible item elements in each choice : (delimiter | family | given | prefix | suffix | xmlText).count() = 1
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())))
provenance-org-details	error	Author.assignedAuthor.representedOrganization	If the author is not a clinician, set nullFlavor='NA'. Otherwise, the taxId, npi, and name are required. : nullFlavor = 'NA' or (id.where(root='2.16.840.1.113883.4.2').exists() and id.where(root='2.16.840.1.113883.4.6').exists() and name.exists())
shall-city	error	Author.assignedAuthor.addr	SHALL contain exactly one [1..1] city (CONF:81-7292). : nullFlavor.exists() or item.city.count() = 1
shall-family	error	Author.assignedAuthor.assignedPerson.name	SHALL contain exactly one [1..1] family (CONF:81-7159). : nullFlavor.exists() or item.family.count() = 1
shall-max-ad-parts	error	Author.assignedAuthor.addr	SHALL have at most one of each: state, city, postalCode, and country : (item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1)
shall-streetAddressLine	error	Author.assignedAuthor.addr	SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). : nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4)
should-code	warning	Author.assignedAuthor	SHOULD contain code : code.exists()
should-country	warning	Author.assignedAuthor.addr	SHOULD contain country : nullFlavor.exists() or item.country.exists()
should-given	warning	Author.assignedAuthor.assignedPerson.name	SHOULD contain given : item.given.exists()
should-use	warning	Author.assignedAuthor.addr	SHOULD contain @use : nullFlavor.exists() or use.exists()

This structure is derived from Author

Summary

Mandatory: 6 elements(3 nested mandatory elements)

Structures

This structure refers to these other structures:

• US Realm Address (http://hl7.org/cda/us/ccda/StructureDefinition/USRealmAddress)

Slices

This structure defines the following Slices:

• The element 2 is sliced based on the values of Author.templateId
• The element 1 is sliced based on the value of Author.assignedAuthor.id
• The element 1 is sliced based on the value of Author.assignedAuthor.representedOrganization.id

Other representations of profile: CSV, Excel