Consolidated CDA (C-CDA)
4.0.0-ballot - STU4 Ballot United States of America flag

This page is part of the CCDA: Consolidated CDA Release (v4.0.0-ballot: CCDA 4.0 Ballot 1) generated with FHIR (HL7® FHIR® Standard) v5.0.0. The current version which supersedes this version is 3.0.0. For a full list of available versions, see the Directory of published versions

Logical Model: Author Participation

Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/AuthorParticipation Version: 4.0.0-ballot
Draft as of 2024-12-20 Computable Name: AuthorParticipation
Other Identifiers: OID:2.16.840.1.113883.10.20.22.4.119

This template represents the Author Participation (including the author timestamp). CDA R2 requires that Author and Author timestamp be asserted in the document header. From there, authorship propagates to contained sections and contained entries, unless explicitly overridden.

The Author Participation template was added to those templates in scope for analysis in R2. Although it is not explicitly stated in all templates the Author Participation template can be used in any template.

Usage:

Formal Views of Template Content

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

This structure is derived from Author

NameFlagsCard.TypeDescription & Constraintsdoco
.. Author Author XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @typeCode, @contextControlCode, functionCode, time, assignedAuthor
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... 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 BindingsPurposeDocumentation
Personal And Legal Relationship Role Type . Preferred
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

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Author.assignedAuthor.codepreferredHealthcareProviderTaxonomy . (a valid code from http://nucc.org/provider-taxonomy)
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066

Constraints

IdGradePath(s)DetailsRequirements
author-detailserrorAuthor.assignedAuthorAuthors 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())))
NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
... realmCode 0..* CS
... typeId C 0..1 II II-1: An II instance must have either a root or an nullFlavor.
.... @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:author 1..1 II
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1 st
..... @displayable 0..1 bl
..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.4.119
... @typeCode 0..1 cs Binding: CDAParticipationType (required)
Fixed Value: AUT
... @contextControlCode 0..1 cs Binding: CDAContextControl (required)
Fixed Value: OP
... functionCode 0..1 CE
... time 1..1 TS
... assignedAuthor C 1..1 AssignedAuthor 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 C 0..1 II II-1: An II instance must have either a root or an nullFlavor.
..... @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 BindingsPurposeDocumentation
Personal And Legal Relationship Role Type . Preferred
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
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... realmCode 0..* CS
..... typeId C 0..1 II II-1: An II instance must have either a root or an nullFlavor.
...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1 st
...... @displayable 0..1 bl
...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1 st
..... templateId 0..* II
..... @classCode 0..1 cs Binding: EntityClassLivingSubject (required)
Fixed Value: PSN
..... @determinerCode 0..1 cs Binding: EntityDeterminer (required)
Fixed Value: INSTANCE
..... name 0..* PN
..... sdtcDesc 0..1 ED XML Namespace: urn:hl7-org:sdtc
XML: desc (urn:hl7-org:sdtc)
..... sdtcAsPatientRelationship 0..* InfrastructureRoot XML Namespace: urn:hl7-org:sdtc
XML: asPatientRelationship (urn:hl7-org:sdtc)
...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
...... realmCode 0..* CS
...... typeId C 0..1 II II-1: An II instance must have either a root or an nullFlavor.
....... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
....... @assigningAuthorityName 0..1 st
....... @displayable 0..1 bl
....... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
....... @extension 1..1 st
...... templateId 0..* II
...... @classCode 1..1 cs Fixed Value: PRS
...... @determinerCode 0..1 cs Fixed Value: INSTANCE
...... code 1..1 CE XML Namespace: urn:hl7-org:sdtc
XML Namespace: urn:hl7-org:sdtc
.... assignedAuthoringDevice 0..1 AuthoringDevice
.... representedOrganization 0..1 Organization assignedPerson/name or representedOrganization/name is required on at least one instance of this author in the document
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... realmCode 0..* CS
..... typeId C 0..1 II II-1: An II instance must have either a root or an nullFlavor.
...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1 st
...... @displayable 0..1 bl
...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1 st
..... templateId 0..* II
..... @classCode 0..1 cs Binding: EntityClassOrganization (required)
Fixed Value: ORG
..... @determinerCode 0..1 cs Binding: EntityDeterminer (required)
Fixed Value: INSTANCE
..... id 0..* II
..... name 0..* ON
..... telecom 0..* TEL
..... addr 0..* USRealmAddress
..... standardIndustryClassCode 0..1 CE Binding: OrganizationIndustryClassNAICS (example)
..... asOrganizationPartOf 0..1 OrganizationPartOf

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Author.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Author.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Author.templateId:author.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Author.typeCoderequiredFixed Value: AUT
http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType
Author.contextControlCoderequiredFixed Value: OP
http://hl7.org/cda/stds/core/ValueSet/CDAContextControl
Author.assignedAuthor.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Author.assignedAuthor.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Author.assignedAuthor.classCoderequiredFixed Value: ASSIGNED
http://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity
Author.assignedAuthor.codepreferredHealthcareProviderTaxonomy . (a valid code from http://nucc.org/provider-taxonomy)
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066
Author.assignedAuthor.assignedPerson.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Author.assignedAuthor.assignedPerson.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Author.assignedAuthor.assignedPerson.classCoderequiredFixed Value: PSN
http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject
Author.assignedAuthor.assignedPerson.determinerCoderequiredFixed Value: INSTANCE
http://terminology.hl7.org/ValueSet/v3-EntityDeterminer
Author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Author.assignedAuthor.representedOrganization.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Author.assignedAuthor.representedOrganization.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Author.assignedAuthor.representedOrganization.classCoderequiredFixed Value: ORG
http://terminology.hl7.org/ValueSet/v3-EntityClassOrganization
Author.assignedAuthor.representedOrganization.determinerCoderequiredFixed Value: INSTANCE
http://terminology.hl7.org/ValueSet/v3-EntityDeterminer
Author.assignedAuthor.representedOrganization.standardIndustryClassCodeexampleOrganizationIndustryClassNAICS
http://terminology.hl7.org/ValueSet/v3-OrganizationIndustryClassNAICS

Constraints

IdGradePath(s)DetailsRequirements
II-1errorAuthor.typeId, Author.assignedAuthor.typeId, Author.assignedAuthor.assignedPerson.typeId, Author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.typeId, Author.assignedAuthor.representedOrganization.typeIdAn II instance must have either a root or an nullFlavor.
: root.exists() or nullFlavor.exists()
author-detailserrorAuthor.assignedAuthorAuthors 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())))
NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
... realmCode 0..* CS
... typeId C 0..1 II II-1: An II instance must have either a root or an nullFlavor.
.... @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:author 1..1 II
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1 st
..... @displayable 0..1 bl
..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.4.119
... @typeCode 0..1 cs Binding: CDAParticipationType (required)
Fixed Value: AUT
... @contextControlCode 0..1 cs Binding: CDAContextControl (required)
Fixed Value: OP
... functionCode 0..1 CE
... time 1..1 TS
... assignedAuthor C 1..1 AssignedAuthor 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 C 0..1 II II-1: An II instance must have either a root or an nullFlavor.
..... @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 BindingsPurposeDocumentation
Personal And Legal Relationship Role Type . Preferred
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
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... realmCode 0..* CS
..... typeId C 0..1 II II-1: An II instance must have either a root or an nullFlavor.
...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1 st
...... @displayable 0..1 bl
...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1 st
..... templateId 0..* II
..... @classCode 0..1 cs Binding: EntityClassLivingSubject (required)
Fixed Value: PSN
..... @determinerCode 0..1 cs Binding: EntityDeterminer (required)
Fixed Value: INSTANCE
..... name 0..* PN
..... sdtcDesc 0..1 ED XML Namespace: urn:hl7-org:sdtc
XML: desc (urn:hl7-org:sdtc)
..... sdtcAsPatientRelationship 0..* InfrastructureRoot XML Namespace: urn:hl7-org:sdtc
XML: asPatientRelationship (urn:hl7-org:sdtc)
...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
...... realmCode 0..* CS
...... typeId C 0..1 II II-1: An II instance must have either a root or an nullFlavor.
....... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
....... @assigningAuthorityName 0..1 st
....... @displayable 0..1 bl
....... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
....... @extension 1..1 st
...... templateId 0..* II
...... @classCode 1..1 cs Fixed Value: PRS
...... @determinerCode 0..1 cs Fixed Value: INSTANCE
...... code 1..1 CE XML Namespace: urn:hl7-org:sdtc
XML Namespace: urn:hl7-org:sdtc
.... assignedAuthoringDevice 0..1 AuthoringDevice
.... representedOrganization 0..1 Organization assignedPerson/name or representedOrganization/name is required on at least one instance of this author in the document
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... realmCode 0..* CS
..... typeId C 0..1 II II-1: An II instance must have either a root or an nullFlavor.
...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1 st
...... @displayable 0..1 bl
...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1 st
..... templateId 0..* II
..... @classCode 0..1 cs Binding: EntityClassOrganization (required)
Fixed Value: ORG
..... @determinerCode 0..1 cs Binding: EntityDeterminer (required)
Fixed Value: INSTANCE
..... id 0..* II
..... name 0..* ON
..... telecom 0..* TEL
..... addr 0..* USRealmAddress
..... standardIndustryClassCode 0..1 CE Binding: OrganizationIndustryClassNAICS (example)
..... asOrganizationPartOf 0..1 OrganizationPartOf

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Author.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Author.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Author.templateId:author.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Author.typeCoderequiredFixed Value: AUT
http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType
Author.contextControlCoderequiredFixed Value: OP
http://hl7.org/cda/stds/core/ValueSet/CDAContextControl
Author.assignedAuthor.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Author.assignedAuthor.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Author.assignedAuthor.classCoderequiredFixed Value: ASSIGNED
http://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity
Author.assignedAuthor.codepreferredHealthcareProviderTaxonomy . (a valid code from http://nucc.org/provider-taxonomy)
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066
Author.assignedAuthor.assignedPerson.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Author.assignedAuthor.assignedPerson.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Author.assignedAuthor.assignedPerson.classCoderequiredFixed Value: PSN
http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject
Author.assignedAuthor.assignedPerson.determinerCoderequiredFixed Value: INSTANCE
http://terminology.hl7.org/ValueSet/v3-EntityDeterminer
Author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Author.assignedAuthor.representedOrganization.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Author.assignedAuthor.representedOrganization.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Author.assignedAuthor.representedOrganization.classCoderequiredFixed Value: ORG
http://terminology.hl7.org/ValueSet/v3-EntityClassOrganization
Author.assignedAuthor.representedOrganization.determinerCoderequiredFixed Value: INSTANCE
http://terminology.hl7.org/ValueSet/v3-EntityDeterminer
Author.assignedAuthor.representedOrganization.standardIndustryClassCodeexampleOrganizationIndustryClassNAICS
http://terminology.hl7.org/ValueSet/v3-OrganizationIndustryClassNAICS

Constraints

IdGradePath(s)DetailsRequirements
II-1errorAuthor.typeId, Author.assignedAuthor.typeId, Author.assignedAuthor.assignedPerson.typeId, Author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.typeId, Author.assignedAuthor.representedOrganization.typeIdAn II instance must have either a root or an nullFlavor.
: root.exists() or nullFlavor.exists()
author-detailserrorAuthor.assignedAuthorAuthors 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())))

This structure is derived from Author

Summary

Mandatory: 3 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Author.templateId

Differential View

This structure is derived from Author

NameFlagsCard.TypeDescription & Constraintsdoco
.. Author Author XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @typeCode, @contextControlCode, functionCode, time, assignedAuthor
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... 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 BindingsPurposeDocumentation
Personal And Legal Relationship Role Type . Preferred
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

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Author.assignedAuthor.codepreferredHealthcareProviderTaxonomy . (a valid code from http://nucc.org/provider-taxonomy)
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066

Constraints

IdGradePath(s)DetailsRequirements
author-detailserrorAuthor.assignedAuthorAuthors 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

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
... realmCode 0..* CS
... typeId C 0..1 II II-1: An II instance must have either a root or an nullFlavor.
.... @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:author 1..1 II
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1 st
..... @displayable 0..1 bl
..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.4.119
... @typeCode 0..1 cs Binding: CDAParticipationType (required)
Fixed Value: AUT
... @contextControlCode 0..1 cs Binding: CDAContextControl (required)
Fixed Value: OP
... functionCode 0..1 CE
... time 1..1 TS
... assignedAuthor C 1..1 AssignedAuthor 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 C 0..1 II II-1: An II instance must have either a root or an nullFlavor.
..... @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 BindingsPurposeDocumentation
Personal And Legal Relationship Role Type . Preferred
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
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... realmCode 0..* CS
..... typeId C 0..1 II II-1: An II instance must have either a root or an nullFlavor.
...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1 st
...... @displayable 0..1 bl
...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1 st
..... templateId 0..* II
..... @classCode 0..1 cs Binding: EntityClassLivingSubject (required)
Fixed Value: PSN
..... @determinerCode 0..1 cs Binding: EntityDeterminer (required)
Fixed Value: INSTANCE
..... name 0..* PN
..... sdtcDesc 0..1 ED XML Namespace: urn:hl7-org:sdtc
XML: desc (urn:hl7-org:sdtc)
..... sdtcAsPatientRelationship 0..* InfrastructureRoot XML Namespace: urn:hl7-org:sdtc
XML: asPatientRelationship (urn:hl7-org:sdtc)
...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
...... realmCode 0..* CS
...... typeId C 0..1 II II-1: An II instance must have either a root or an nullFlavor.
....... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
....... @assigningAuthorityName 0..1 st
....... @displayable 0..1 bl
....... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
....... @extension 1..1 st
...... templateId 0..* II
...... @classCode 1..1 cs Fixed Value: PRS
...... @determinerCode 0..1 cs Fixed Value: INSTANCE
...... code 1..1 CE XML Namespace: urn:hl7-org:sdtc
XML Namespace: urn:hl7-org:sdtc
.... assignedAuthoringDevice 0..1 AuthoringDevice
.... representedOrganization 0..1 Organization assignedPerson/name or representedOrganization/name is required on at least one instance of this author in the document
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... realmCode 0..* CS
..... typeId C 0..1 II II-1: An II instance must have either a root or an nullFlavor.
...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1 st
...... @displayable 0..1 bl
...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1 st
..... templateId 0..* II
..... @classCode 0..1 cs Binding: EntityClassOrganization (required)
Fixed Value: ORG
..... @determinerCode 0..1 cs Binding: EntityDeterminer (required)
Fixed Value: INSTANCE
..... id 0..* II
..... name 0..* ON
..... telecom 0..* TEL
..... addr 0..* USRealmAddress
..... standardIndustryClassCode 0..1 CE Binding: OrganizationIndustryClassNAICS (example)
..... asOrganizationPartOf 0..1 OrganizationPartOf

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Author.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Author.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Author.templateId:author.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Author.typeCoderequiredFixed Value: AUT
http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType
Author.contextControlCoderequiredFixed Value: OP
http://hl7.org/cda/stds/core/ValueSet/CDAContextControl
Author.assignedAuthor.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Author.assignedAuthor.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Author.assignedAuthor.classCoderequiredFixed Value: ASSIGNED
http://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity
Author.assignedAuthor.codepreferredHealthcareProviderTaxonomy . (a valid code from http://nucc.org/provider-taxonomy)
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066
Author.assignedAuthor.assignedPerson.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Author.assignedAuthor.assignedPerson.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Author.assignedAuthor.assignedPerson.classCoderequiredFixed Value: PSN
http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject
Author.assignedAuthor.assignedPerson.determinerCoderequiredFixed Value: INSTANCE
http://terminology.hl7.org/ValueSet/v3-EntityDeterminer
Author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Author.assignedAuthor.representedOrganization.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Author.assignedAuthor.representedOrganization.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Author.assignedAuthor.representedOrganization.classCoderequiredFixed Value: ORG
http://terminology.hl7.org/ValueSet/v3-EntityClassOrganization
Author.assignedAuthor.representedOrganization.determinerCoderequiredFixed Value: INSTANCE
http://terminology.hl7.org/ValueSet/v3-EntityDeterminer
Author.assignedAuthor.representedOrganization.standardIndustryClassCodeexampleOrganizationIndustryClassNAICS
http://terminology.hl7.org/ValueSet/v3-OrganizationIndustryClassNAICS

Constraints

IdGradePath(s)DetailsRequirements
II-1errorAuthor.typeId, Author.assignedAuthor.typeId, Author.assignedAuthor.assignedPerson.typeId, Author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.typeId, Author.assignedAuthor.representedOrganization.typeIdAn II instance must have either a root or an nullFlavor.
: root.exists() or nullFlavor.exists()
author-detailserrorAuthor.assignedAuthorAuthors require addr, telecom, and either assignedPerson/name or assignedAuthoringDevice/manufacturerModelName. These may be present on this author or on another instance of an Author Participation in the document that has an id that matches the first id of this author.
: nullFlavor.exists() or (addr.exists() and telecom.exists() and (assignedPerson.name.exists() or assignedAuthoringDevice.manufacturerModelName.exists())) or (%resource.descendants().ofType(CDA.AssignedAuthor).where(id.exists($this.root = %context.id.first().root and $this.extension ~ %context.id.first().extension) and addr.exists() and telecom.exists() and (assignedPerson.name.exists() or assignedAuthoringDevice.manufacturerModelName.exists())))

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
... realmCode 0..* CS
... typeId C 0..1 II II-1: An II instance must have either a root or an nullFlavor.
.... @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:author 1..1 II
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1 st
..... @displayable 0..1 bl
..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.4.119
... @typeCode 0..1 cs Binding: CDAParticipationType (required)
Fixed Value: AUT
... @contextControlCode 0..1 cs Binding: CDAContextControl (required)
Fixed Value: OP
... functionCode 0..1 CE
... time 1..1 TS
... assignedAuthor C 1..1 AssignedAuthor 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 C 0..1 II II-1: An II instance must have either a root or an nullFlavor.
..... @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 BindingsPurposeDocumentation
Personal And Legal Relationship Role Type . Preferred
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
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... realmCode 0..* CS
..... typeId C 0..1 II II-1: An II instance must have either a root or an nullFlavor.
...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1 st
...... @displayable 0..1 bl
...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1 st
..... templateId 0..* II
..... @classCode 0..1 cs Binding: EntityClassLivingSubject (required)
Fixed Value: PSN
..... @determinerCode 0..1 cs Binding: EntityDeterminer (required)
Fixed Value: INSTANCE
..... name 0..* PN
..... sdtcDesc 0..1 ED XML Namespace: urn:hl7-org:sdtc
XML: desc (urn:hl7-org:sdtc)
..... sdtcAsPatientRelationship 0..* InfrastructureRoot XML Namespace: urn:hl7-org:sdtc
XML: asPatientRelationship (urn:hl7-org:sdtc)
...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
...... realmCode 0..* CS
...... typeId C 0..1 II II-1: An II instance must have either a root or an nullFlavor.
....... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
....... @assigningAuthorityName 0..1 st
....... @displayable 0..1 bl
....... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
....... @extension 1..1 st
...... templateId 0..* II
...... @classCode 1..1 cs Fixed Value: PRS
...... @determinerCode 0..1 cs Fixed Value: INSTANCE
...... code 1..1 CE XML Namespace: urn:hl7-org:sdtc
XML Namespace: urn:hl7-org:sdtc
.... assignedAuthoringDevice 0..1 AuthoringDevice
.... representedOrganization 0..1 Organization assignedPerson/name or representedOrganization/name is required on at least one instance of this author in the document
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... realmCode 0..* CS
..... typeId C 0..1 II II-1: An II instance must have either a root or an nullFlavor.
...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1 st
...... @displayable 0..1 bl
...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1 st
..... templateId 0..* II
..... @classCode 0..1 cs Binding: EntityClassOrganization (required)
Fixed Value: ORG
..... @determinerCode 0..1 cs Binding: EntityDeterminer (required)
Fixed Value: INSTANCE
..... id 0..* II
..... name 0..* ON
..... telecom 0..* TEL
..... addr 0..* USRealmAddress
..... standardIndustryClassCode 0..1 CE Binding: OrganizationIndustryClassNAICS (example)
..... asOrganizationPartOf 0..1 OrganizationPartOf

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Author.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Author.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Author.templateId:author.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Author.typeCoderequiredFixed Value: AUT
http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType
Author.contextControlCoderequiredFixed Value: OP
http://hl7.org/cda/stds/core/ValueSet/CDAContextControl
Author.assignedAuthor.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Author.assignedAuthor.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Author.assignedAuthor.classCoderequiredFixed Value: ASSIGNED
http://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity
Author.assignedAuthor.codepreferredHealthcareProviderTaxonomy . (a valid code from http://nucc.org/provider-taxonomy)
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066
Author.assignedAuthor.assignedPerson.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Author.assignedAuthor.assignedPerson.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Author.assignedAuthor.assignedPerson.classCoderequiredFixed Value: PSN
http://terminology.hl7.org/ValueSet/v3-EntityClassLivingSubject
Author.assignedAuthor.assignedPerson.determinerCoderequiredFixed Value: INSTANCE
http://terminology.hl7.org/ValueSet/v3-EntityDeterminer
Author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Author.assignedAuthor.representedOrganization.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Author.assignedAuthor.representedOrganization.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Author.assignedAuthor.representedOrganization.classCoderequiredFixed Value: ORG
http://terminology.hl7.org/ValueSet/v3-EntityClassOrganization
Author.assignedAuthor.representedOrganization.determinerCoderequiredFixed Value: INSTANCE
http://terminology.hl7.org/ValueSet/v3-EntityDeterminer
Author.assignedAuthor.representedOrganization.standardIndustryClassCodeexampleOrganizationIndustryClassNAICS
http://terminology.hl7.org/ValueSet/v3-OrganizationIndustryClassNAICS

Constraints

IdGradePath(s)DetailsRequirements
II-1errorAuthor.typeId, Author.assignedAuthor.typeId, Author.assignedAuthor.assignedPerson.typeId, Author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.typeId, Author.assignedAuthor.representedOrganization.typeIdAn II instance must have either a root or an nullFlavor.
: root.exists() or nullFlavor.exists()
author-detailserrorAuthor.assignedAuthorAuthors 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())))

This structure is derived from Author

Summary

Mandatory: 3 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Author.templateId

 

Other representations of profile: CSV, Excel