This page is part of the CCDA: Consolidated CDA Release (v3.0.0-ballot: CCDA 3.0 Ballot 1) based on FHIR (HL7® FHIR® Standard) v5.0.0. . For a full list of available versions, see the Directory of published versions

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

Logical Model: Author Participation

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:

• Use this Logical Model: Advance Directive Observation, Advance Directive Organizer, Allergy Concern Act, Care Team Organizer... Show 38 more, Comment Activity, Functional Status Observation, Functional Status Organizer, Goal Observation, Handoff Communication Participants, Health Concern Act, Immunization Activity, Intervention Act, Medication Activity, Mental Status Observation, Note Activity, Nutrition Assessment, Outcome Observation, Patient Referral Act, Planned Act, Planned Coverage, Planned Encounter, Planned Immunization Activity, Planned Intervention Act, Planned Medication Activity, Planned Observation, Planned Procedure, Planned Supply, Priority Preference, Problem Concern Act, Problem Observation, Procedure Activity Procedure, Result Observation, Result Organizer, Risk Concern Act, Self-Care Activities (ADL and IADL), Sensory Status, Smoking Status - Meaningful Use, Social History Observation, Substance or Device Allergy - Intolerance Observation, Tobacco Use, Vital Sign Observation and Vital Signs Organizer

Formal Views of Profile Content

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

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

This structure is derived from Author

Name	Flags	Card.	Type	Description & Constraints
Author			Author	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @typeCode, @contextControlCode, functionCode, time, assignedAuthor Instances of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class)
Slices for templateId		1..*	II	Slice: Unordered, Open by value:root
templateId:author		1..1	II
@root		1..1	oid, uuid, ruid	Required Pattern: 2.16.840.1.113883.10.20.22.4.119
@extension		0..0
time		1..1	TS
assignedAuthor	C	1..1	AssignedAuthor	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.
id		1..*	II	The first id may be set equal to (a pointer to) an id on a participant elsewhere in the document (header or entries) or a new author participant can be described here. If the id is pointing to a participant already described elsewhere in the document, assignedAuthor/id is sufficient to identify this participant and none of the remaining details of assignedAuthor are required to be set. Application Software must be responsible for resolving the identifier back to its original object and then rendering the information in the correct place in the containing section's narrative text. This id must be a pointer to another author participant.
code		0..1	CE	Binding: Healthcare Provider Taxonomy (preferred) Additional Bindings Purpose Documentation Personal And Legal Relationship Role Type Preferred Binding Patient-authored content
addr		0..*	USRealmAddress	Required on at least one instance of this author in the document
telecom		0..*	TEL	Required on at least one instance of this author in the document
assignedPerson		0..1	Person	assignedPerson/name or assignedAuthoringDevice/manufacturerModelName is required on at least one instance of this author in the document
name		0..*	PN
representedOrganization		0..1	Organization	assignedPerson/name or representedOrganization/name is required on at least one instance of this author in the document
id		0..*	II
name		0..*	ON
telecom		0..*	TEL
addr		0..*	USRealmAddress	Base for all types and resources
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet
Author.assignedAuthor.code	preferred	HealthcareProviderTaxonomy (a valid code from http://nucc.org/provider-taxonomy)

Constraints

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
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
templateId:author		1..1	II
@root		1..1	oid, uuid, ruid	Required Pattern: 2.16.840.1.113883.10.20.22.4.119
time		1..1	TS
assignedAuthor	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.
id		1..*	II	The first id may be set equal to (a pointer to) an id on a participant elsewhere in the document (header or entries) or a new author participant can be described here. If the id is pointing to a participant already described elsewhere in the document, assignedAuthor/id is sufficient to identify this participant and none of the remaining details of assignedAuthor are required to be set. Application Software must be responsible for resolving the identifier back to its original object and then rendering the information in the correct place in the containing section's narrative text. This id must be a pointer to another author participant.
code		0..1	CE	Binding: Healthcare Provider Taxonomy (preferred) Additional Bindings Purpose Documentation Personal And Legal Relationship Role Type Preferred Binding Patient-authored content
addr	C	0..*	USRealmAddress	Required on at least one instance of this author in the document
telecom		0..*	TEL	Required on at least one instance of this author in the document
assignedPerson		0..1	Person	assignedPerson/name or assignedAuthoringDevice/manufacturerModelName is required on at least one instance of this author in the document
name		0..*	PN
representedOrganization		0..1	Organization	assignedPerson/name or representedOrganization/name is required on at least one instance of this author in the document
id		0..*	II
name		0..*	ON
telecom		0..*	TEL
addr	C	0..*	USRealmAddress	Base for all types and resources
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
Author.assignedAuthor.code	preferred	HealthcareProviderTaxonomy (a valid code from http://nucc.org/provider-taxonomy)

Constraints

Id	Grade	Path(s)	Details	Requirements
81-7296	error	Author.assignedAuthor.addr, Author.assignedAuthor.representedOrganization.addr	**SHALL NOT** have mixed content except for white space (CONF:81-7296) : item.xmlText.empty()
81-10024	error	Author.assignedAuthor.addr, Author.assignedAuthor.representedOrganization.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, Author.assignedAuthor.representedOrganization.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})?'))
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())))
shall-city	error	Author.assignedAuthor.addr, Author.assignedAuthor.representedOrganization.addr	SHALL contain exactly one [1..1] city (CONF:81-7292). : nullFlavor.exists() or item.city.count() = 1
shall-max-ad-parts	error	Author.assignedAuthor.addr, Author.assignedAuthor.representedOrganization.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, Author.assignedAuthor.representedOrganization.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-country	warning	Author.assignedAuthor.addr, Author.assignedAuthor.representedOrganization.addr	SHOULD contain country : nullFlavor.exists() or item.country.exists()
should-use	warning	Author.assignedAuthor.addr, Author.assignedAuthor.representedOrganization.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
templateId:author		1..1	II
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
@assigningAuthorityName		0..1	st
@displayable		0..1	bl
@root		1..1	oid, uuid, ruid	Required Pattern: 2.16.840.1.113883.10.20.22.4.119
@typeCode		0..1	cs	Binding: ParticipationType (required) Fixed Value: AUT
@contextControlCode		0..1	cs	Binding: ContextControl (required) Fixed Value: OP
functionCode		0..1	CE
time		1..1	TS
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.
@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
id		1..*	II	The first id may be set equal to (a pointer to) an id on a participant elsewhere in the document (header or entries) or a new author participant can be described here. If the id is pointing to a participant already described elsewhere in the document, assignedAuthor/id is sufficient to identify this participant and none of the remaining details of assignedAuthor are required to be set. Application Software must be responsible for resolving the identifier back to its original object and then rendering the information in the correct place in the containing section's narrative text. This id must be a pointer to another author participant.
sdtcIdentifiedBy		0..*	IdentifiedBy	XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc)
code		0..1	CE	Binding: Healthcare Provider Taxonomy (preferred) Additional Bindings Purpose Documentation Personal And Legal Relationship Role Type Preferred Binding Patient-authored content
addr	C	0..*	USRealmAddress	Required on at least one instance of this author in the document
telecom		0..*	TEL	Required on at least one instance of this author in the document
assignedPerson		0..1	Person	assignedPerson/name or assignedAuthoringDevice/manufacturerModelName is required on at least one instance of this author in the document
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
realmCode		0..*	CS
typeId		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		0..*	PN
sdtcDesc		0..1	ED	XML Namespace: urn:hl7-org:sdtc XML: desc (urn:hl7-org:sdtc)
sdtcAsPatientRelationship		0..*	InfrastructureRoot	XML Namespace: urn:hl7-org:sdtc XML: asPatientRelationship (urn:hl7-org:sdtc)
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
realmCode		0..*	CS
typeId		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		0..1	Organization	assignedPerson/name or representedOrganization/name is required on at least one instance of this author in the document
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
realmCode		0..*	CS
typeId		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
id		0..*	II
name		0..*	ON
telecom		0..*	TEL
addr	C	0..*	USRealmAddress	Base for all types and resources
standardIndustryClassCode		0..1	CE	Binding: OrganizationIndustryClassNAICS (example)
asOrganizationPartOf		0..1	OrganizationPartOf
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code
Author.nullFlavor	required	CDANullFlavor
Author.typeId.nullFlavor	required	CDANullFlavor
Author.templateId:author.nullFlavor	required	CDANullFlavor
Author.typeCode	required	Fixed Value: AUT
Author.contextControlCode	required	Fixed Value: OP
Author.assignedAuthor.nullFlavor	required	CDANullFlavor
Author.assignedAuthor.typeId.nullFlavor	required	CDANullFlavor
Author.assignedAuthor.classCode	required	Fixed Value: ASSIGNED
Author.assignedAuthor.code	preferred	HealthcareProviderTaxonomy (a valid code from http://nucc.org/provider-taxonomy)
Author.assignedAuthor.assignedPerson.nullFlavor	required	CDANullFlavor
Author.assignedAuthor.assignedPerson.typeId.nullFlavor	required	CDANullFlavor
Author.assignedAuthor.assignedPerson.classCode	required	Fixed Value: PSN
Author.assignedAuthor.assignedPerson.determinerCode	required	Fixed Value: INSTANCE
Author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.nullFlavor	required	CDANullFlavor
Author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.typeId.nullFlavor	required	CDANullFlavor
Author.assignedAuthor.representedOrganization.nullFlavor	required	CDANullFlavor
Author.assignedAuthor.representedOrganization.typeId.nullFlavor	required	CDANullFlavor
Author.assignedAuthor.representedOrganization.classCode	required	Fixed Value: ORG
Author.assignedAuthor.representedOrganization.determinerCode	required	Fixed Value: INSTANCE
Author.assignedAuthor.representedOrganization.standardIndustryClassCode	example	OrganizationIndustryClassNAICS

Constraints

Id	Grade	Path(s)	Details	Requirements
81-7296	error	Author.assignedAuthor.addr, Author.assignedAuthor.representedOrganization.addr	**SHALL NOT** have mixed content except for white space (CONF:81-7296) : item.xmlText.empty()
81-10024	error	Author.assignedAuthor.addr, Author.assignedAuthor.representedOrganization.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, Author.assignedAuthor.representedOrganization.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})?'))
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())))
shall-city	error	Author.assignedAuthor.addr, Author.assignedAuthor.representedOrganization.addr	SHALL contain exactly one [1..1] city (CONF:81-7292). : nullFlavor.exists() or item.city.count() = 1
shall-max-ad-parts	error	Author.assignedAuthor.addr, Author.assignedAuthor.representedOrganization.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, Author.assignedAuthor.representedOrganization.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-country	warning	Author.assignedAuthor.addr, Author.assignedAuthor.representedOrganization.addr	SHOULD contain country : nullFlavor.exists() or item.country.exists()
should-use	warning	Author.assignedAuthor.addr, Author.assignedAuthor.representedOrganization.addr	SHOULD contain @use : nullFlavor.exists() or use.exists()

This structure is derived from Author

Summary

Mandatory: 3 elements
Prohibited: 1 element

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 Author.templateId is sliced based on the value of value:root

Differential View

This structure is derived from Author

Name	Flags	Card.	Type	Description & Constraints
Author			Author	XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @typeCode, @contextControlCode, functionCode, time, assignedAuthor Instances of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class)
Slices for templateId		1..*	II	Slice: Unordered, Open by value:root
templateId:author		1..1	II
@root		1..1	oid, uuid, ruid	Required Pattern: 2.16.840.1.113883.10.20.22.4.119
@extension		0..0
time		1..1	TS
assignedAuthor	C	1..1	AssignedAuthor	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.
id		1..*	II	The first id may be set equal to (a pointer to) an id on a participant elsewhere in the document (header or entries) or a new author participant can be described here. If the id is pointing to a participant already described elsewhere in the document, assignedAuthor/id is sufficient to identify this participant and none of the remaining details of assignedAuthor are required to be set. Application Software must be responsible for resolving the identifier back to its original object and then rendering the information in the correct place in the containing section's narrative text. This id must be a pointer to another author participant.
code		0..1	CE	Binding: Healthcare Provider Taxonomy (preferred) Additional Bindings Purpose Documentation Personal And Legal Relationship Role Type Preferred Binding Patient-authored content
addr		0..*	USRealmAddress	Required on at least one instance of this author in the document
telecom		0..*	TEL	Required on at least one instance of this author in the document
assignedPerson		0..1	Person	assignedPerson/name or assignedAuthoringDevice/manufacturerModelName is required on at least one instance of this author in the document
name		0..*	PN
representedOrganization		0..1	Organization	assignedPerson/name or representedOrganization/name is required on at least one instance of this author in the document
id		0..*	II
name		0..*	ON
telecom		0..*	TEL
addr		0..*	USRealmAddress	Base for all types and resources
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet
Author.assignedAuthor.code	preferred	HealthcareProviderTaxonomy (a valid code from http://nucc.org/provider-taxonomy)

Constraints

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
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
templateId:author		1..1	II
@root		1..1	oid, uuid, ruid	Required Pattern: 2.16.840.1.113883.10.20.22.4.119
time		1..1	TS
assignedAuthor	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.
id		1..*	II	The first id may be set equal to (a pointer to) an id on a participant elsewhere in the document (header or entries) or a new author participant can be described here. If the id is pointing to a participant already described elsewhere in the document, assignedAuthor/id is sufficient to identify this participant and none of the remaining details of assignedAuthor are required to be set. Application Software must be responsible for resolving the identifier back to its original object and then rendering the information in the correct place in the containing section's narrative text. This id must be a pointer to another author participant.
code		0..1	CE	Binding: Healthcare Provider Taxonomy (preferred) Additional Bindings Purpose Documentation Personal And Legal Relationship Role Type Preferred Binding Patient-authored content
addr	C	0..*	USRealmAddress	Required on at least one instance of this author in the document
telecom		0..*	TEL	Required on at least one instance of this author in the document
assignedPerson		0..1	Person	assignedPerson/name or assignedAuthoringDevice/manufacturerModelName is required on at least one instance of this author in the document
name		0..*	PN
representedOrganization		0..1	Organization	assignedPerson/name or representedOrganization/name is required on at least one instance of this author in the document
id		0..*	II
name		0..*	ON
telecom		0..*	TEL
addr	C	0..*	USRealmAddress	Base for all types and resources
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
Author.assignedAuthor.code	preferred	HealthcareProviderTaxonomy (a valid code from http://nucc.org/provider-taxonomy)

Constraints

Id	Grade	Path(s)	Details	Requirements
81-7296	error	Author.assignedAuthor.addr, Author.assignedAuthor.representedOrganization.addr	**SHALL NOT** have mixed content except for white space (CONF:81-7296) : item.xmlText.empty()
81-10024	error	Author.assignedAuthor.addr, Author.assignedAuthor.representedOrganization.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, Author.assignedAuthor.representedOrganization.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})?'))
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())))
shall-city	error	Author.assignedAuthor.addr, Author.assignedAuthor.representedOrganization.addr	SHALL contain exactly one [1..1] city (CONF:81-7292). : nullFlavor.exists() or item.city.count() = 1
shall-max-ad-parts	error	Author.assignedAuthor.addr, Author.assignedAuthor.representedOrganization.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, Author.assignedAuthor.representedOrganization.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-country	warning	Author.assignedAuthor.addr, Author.assignedAuthor.representedOrganization.addr	SHOULD contain country : nullFlavor.exists() or item.country.exists()
should-use	warning	Author.assignedAuthor.addr, Author.assignedAuthor.representedOrganization.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
templateId:author		1..1	II
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
@assigningAuthorityName		0..1	st
@displayable		0..1	bl
@root		1..1	oid, uuid, ruid	Required Pattern: 2.16.840.1.113883.10.20.22.4.119
@typeCode		0..1	cs	Binding: ParticipationType (required) Fixed Value: AUT
@contextControlCode		0..1	cs	Binding: ContextControl (required) Fixed Value: OP
functionCode		0..1	CE
time		1..1	TS
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.
@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
id		1..*	II	The first id may be set equal to (a pointer to) an id on a participant elsewhere in the document (header or entries) or a new author participant can be described here. If the id is pointing to a participant already described elsewhere in the document, assignedAuthor/id is sufficient to identify this participant and none of the remaining details of assignedAuthor are required to be set. Application Software must be responsible for resolving the identifier back to its original object and then rendering the information in the correct place in the containing section's narrative text. This id must be a pointer to another author participant.
sdtcIdentifiedBy		0..*	IdentifiedBy	XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc)
code		0..1	CE	Binding: Healthcare Provider Taxonomy (preferred) Additional Bindings Purpose Documentation Personal And Legal Relationship Role Type Preferred Binding Patient-authored content
addr	C	0..*	USRealmAddress	Required on at least one instance of this author in the document
telecom		0..*	TEL	Required on at least one instance of this author in the document
assignedPerson		0..1	Person	assignedPerson/name or assignedAuthoringDevice/manufacturerModelName is required on at least one instance of this author in the document
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
realmCode		0..*	CS
typeId		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		0..*	PN
sdtcDesc		0..1	ED	XML Namespace: urn:hl7-org:sdtc XML: desc (urn:hl7-org:sdtc)
sdtcAsPatientRelationship		0..*	InfrastructureRoot	XML Namespace: urn:hl7-org:sdtc XML: asPatientRelationship (urn:hl7-org:sdtc)
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
realmCode		0..*	CS
typeId		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		0..1	Organization	assignedPerson/name or representedOrganization/name is required on at least one instance of this author in the document
@nullFlavor		0..1	cs	Binding: CDANullFlavor (required)
realmCode		0..*	CS
typeId		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
id		0..*	II
name		0..*	ON
telecom		0..*	TEL
addr	C	0..*	USRealmAddress	Base for all types and resources
standardIndustryClassCode		0..1	CE	Binding: OrganizationIndustryClassNAICS (example)
asOrganizationPartOf		0..1	OrganizationPartOf
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code
Author.nullFlavor	required	CDANullFlavor
Author.typeId.nullFlavor	required	CDANullFlavor
Author.templateId:author.nullFlavor	required	CDANullFlavor
Author.typeCode	required	Fixed Value: AUT
Author.contextControlCode	required	Fixed Value: OP
Author.assignedAuthor.nullFlavor	required	CDANullFlavor
Author.assignedAuthor.typeId.nullFlavor	required	CDANullFlavor
Author.assignedAuthor.classCode	required	Fixed Value: ASSIGNED
Author.assignedAuthor.code	preferred	HealthcareProviderTaxonomy (a valid code from http://nucc.org/provider-taxonomy)
Author.assignedAuthor.assignedPerson.nullFlavor	required	CDANullFlavor
Author.assignedAuthor.assignedPerson.typeId.nullFlavor	required	CDANullFlavor
Author.assignedAuthor.assignedPerson.classCode	required	Fixed Value: PSN
Author.assignedAuthor.assignedPerson.determinerCode	required	Fixed Value: INSTANCE
Author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.nullFlavor	required	CDANullFlavor
Author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.typeId.nullFlavor	required	CDANullFlavor
Author.assignedAuthor.representedOrganization.nullFlavor	required	CDANullFlavor
Author.assignedAuthor.representedOrganization.typeId.nullFlavor	required	CDANullFlavor
Author.assignedAuthor.representedOrganization.classCode	required	Fixed Value: ORG
Author.assignedAuthor.representedOrganization.determinerCode	required	Fixed Value: INSTANCE
Author.assignedAuthor.representedOrganization.standardIndustryClassCode	example	OrganizationIndustryClassNAICS

Constraints

Id	Grade	Path(s)	Details	Requirements
81-7296	error	Author.assignedAuthor.addr, Author.assignedAuthor.representedOrganization.addr	**SHALL NOT** have mixed content except for white space (CONF:81-7296) : item.xmlText.empty()
81-10024	error	Author.assignedAuthor.addr, Author.assignedAuthor.representedOrganization.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, Author.assignedAuthor.representedOrganization.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})?'))
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())))
shall-city	error	Author.assignedAuthor.addr, Author.assignedAuthor.representedOrganization.addr	SHALL contain exactly one [1..1] city (CONF:81-7292). : nullFlavor.exists() or item.city.count() = 1
shall-max-ad-parts	error	Author.assignedAuthor.addr, Author.assignedAuthor.representedOrganization.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, Author.assignedAuthor.representedOrganization.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-country	warning	Author.assignedAuthor.addr, Author.assignedAuthor.representedOrganization.addr	SHOULD contain country : nullFlavor.exists() or item.country.exists()
should-use	warning	Author.assignedAuthor.addr, Author.assignedAuthor.representedOrganization.addr	SHOULD contain @use : nullFlavor.exists() or use.exists()

This structure is derived from Author

Summary

Mandatory: 3 elements
Prohibited: 1 element

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 Author.templateId is sliced based on the value of value:root

Other representations of profile: CSV, Excel