Consolidated CDA Release 2.1 StructureDefinition Publication
2.1 - CI Build United States of America flag

Consolidated CDA Release 2.1 StructureDefinition Publication, published by Health Level Seven. This is not an authorized publication; it is the continuous build for version 2.1). This version is based on the current content of https://github.com/HL7/CDA-ccda-2.1-sd/ and changes regularly. See the Directory of published versions

Logical Model: Provenance - Assembler Participation

Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/ProvenanceAssemblerParticipation Version: 2.1
Draft as of 2023-09-29 Computable Name: ProvenanceAssemblerParticipation
Other Identifiers: id: urn:hl7ii:2.16.840.1.113883.10.20.22.5.7:2020-05-19

This template represents the organization that supported generation of a CDA document. The Assembler Organization may be different than the Author Organization, and may be different from the Organization that developed the software used to generate the document.

This Participation is only for use in the CDA Header because it applies to the entire content in the document.

This template is consistent with the prior Assembler Document Participant (2.16.840.1.113883.3.5019.1.1) in the 2016 HL7 Data Provenance guide, however, makes no claim about representing the software organization. All constraints for conformance are defined in this template.

Note: The CDA Participant does not support a software device or the organization that created the software. The Assembler role can only be expressed at the level of organization. This is a known issue with the current CDA R2 model. 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 Profile Content

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

This structure is derived from CDAR2.Participant1

NameFlagsCard.TypeDescription & Constraintsdoco
.. Participant1 1..1CDAR2.Participant1XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, @typeCode, @contextControlCode, realmCode, typeId, templateId, functionCode, time, associatedEntity
Base for all types and resources
... typeCode 1..1csFixed Value: DEV
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:templateId1 1..1IItemplateId
..... root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.5.7
..... extension 1..1stRequired Pattern: 2020-05-19
... functionCode 1..1CE
.... code 1..1csRequired Pattern: assembler
.... codeSystem 1..1oid, uuid, ruid
... associatedEntity 1..1AssociatedEntityThe template does not require any elements from the associatedEntity since the information is recorded in the scopingOrganization.
.... classCode 1..1csFixed Value: OWN
.... scopingOrganization 1..1Organization
..... id 1..*II
..... name 1..*ON
..... telecom 0..*TEL
..... addr 0..*USRealmAddressADUSFIELDEDBase for all types and resources

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Participant1 1..1CDAR2.Participant1XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, @typeCode, @contextControlCode, realmCode, typeId, templateId, functionCode, time, associatedEntity
Base for all types and resources
... @typeCode 1..1csBinding: ParticipationType (required)
Fixed Value: DEV
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:templateId1 1..1IItemplateId
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.5.7
..... @extension 1..1stRequired Pattern: 2020-05-19
... functionCode 1..1CE
.... @code 1..1csRequired Pattern: assembler
.... @codeSystem 1..1oid, uuid, ruid
... associatedEntity 1..1AssociatedEntityThe template does not require any elements from the associatedEntity since the information is recorded in the scopingOrganization.
.... @classCode 1..1csBinding: RoleClassAssociative (required)
Fixed Value: OWN
.... scopingOrganization 1..1Organization
..... id 1..*II
..... name 1..*ON
..... telecom 0..*TEL
..... addr C0..*USRealmAddressADUSFIELDEDBase for all types and resources

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Participant1.typeCoderequiredFixed Value: DEV
Participant1.associatedEntity.classCoderequiredFixed Value: OWN

Constraints

IdGradePath(s)DetailsRequirements
81-7296errorParticipant1.associatedEntity.scopingOrganization.addr**SHALL NOT** have mixed content except for white space (CONF:81-7296).
:
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
NameFlagsCard.TypeDescription & Constraintsdoco
.. Participant1 1..1CDAR2.Participant1XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, @typeCode, @contextControlCode, realmCode, typeId, templateId, functionCode, time, associatedEntity
Base for all types and resources
... @nullFlavor 0..1csBinding: NullFlavor (required)
... @typeCode 1..1csBinding: ParticipationType (required)
Fixed Value: DEV
... @contextControlCode 0..1csBinding: ContextControl (required)
Fixed Value: OP
... typeId 0..1II
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:templateId1 1..1IItemplateId
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.5.7
..... @extension 1..1stRequired Pattern: 2020-05-19
... functionCode 1..1CE
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... @code 1..1csRequired Pattern: assembler
.... @codeSystem 1..1oid, uuid, ruid
.... @codeSystemName 0..1st
.... @codeSystemVersion 0..1st
.... @displayName 0..1st
.... @sdtcValueSet 0..1oidXML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
.... @sdtcValueSetVersion 0..1stXML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
.... originalText 0..1ED
.... translation 0..*CD
... time 1..1IVL_TS
... associatedEntity 1..1AssociatedEntityThe template does not require any elements from the associatedEntity since the information is recorded in the scopingOrganization.
.... @classCode 1..1csBinding: RoleClassAssociative (required)
Fixed Value: OWN
.... templateId 0..*II
.... id 0..*II
.... sdtcIdentifiedBy 0..*IdentifiedByXML Namespace: urn:hl7-org:sdtc
XML: identifiedBy (urn:hl7-org:sdtc)
.... code 0..1CEBinding: v3 Code System RoleCode (extensible)
.... addr 0..*AD
.... telecom 0..*TEL
.... associatedPerson 0..1Person
.... scopingOrganization 1..1Organization
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... @classCode 0..1csBinding: EntityClassOrganization (required)
Fixed Value: ORG
..... @determinerCode 0..1csBinding: EntityDeterminer (required)
Fixed Value: INSTANCE
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... id 1..*II
..... name 1..*ON
..... telecom 0..*TEL
..... addr C0..*USRealmAddressADUSFIELDEDBase for all types and resources
..... standardIndustryClassCode 0..1CEBinding: OrganizationIndustryClassNAICS (extensible)
..... asOrganizationPartOf 0..1OrganizationPartOf

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Participant1.nullFlavorrequiredNullFlavor
Participant1.typeCoderequiredFixed Value: DEV
Participant1.contextControlCoderequiredFixed Value: OP
Participant1.templateId:templateId1.nullFlavorrequiredNullFlavor
Participant1.functionCode.nullFlavorrequiredNullFlavor
Participant1.associatedEntity.classCoderequiredFixed Value: OWN
Participant1.associatedEntity.codeextensibleRoleCode
Participant1.associatedEntity.scopingOrganization.nullFlavorrequiredNullFlavor
Participant1.associatedEntity.scopingOrganization.classCoderequiredFixed Value: ORG
Participant1.associatedEntity.scopingOrganization.determinerCoderequiredFixed Value: INSTANCE
Participant1.associatedEntity.scopingOrganization.standardIndustryClassCodeextensibleOrganizationIndustryClassNAICS

Constraints

IdGradePath(s)DetailsRequirements
81-7296errorParticipant1.associatedEntity.scopingOrganization.addr**SHALL NOT** have mixed content except for white space (CONF:81-7296).
:
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())

This structure is derived from CDAR2.Participant1

Summary

Mandatory: 12 elements
Fixed Value: 2 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Participant1.templateId is sliced based on the values of value:root, value:extension

Differential View

This structure is derived from CDAR2.Participant1

NameFlagsCard.TypeDescription & Constraintsdoco
.. Participant1 1..1CDAR2.Participant1XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, @typeCode, @contextControlCode, realmCode, typeId, templateId, functionCode, time, associatedEntity
Base for all types and resources
... typeCode 1..1csFixed Value: DEV
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:templateId1 1..1IItemplateId
..... root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.5.7
..... extension 1..1stRequired Pattern: 2020-05-19
... functionCode 1..1CE
.... code 1..1csRequired Pattern: assembler
.... codeSystem 1..1oid, uuid, ruid
... associatedEntity 1..1AssociatedEntityThe template does not require any elements from the associatedEntity since the information is recorded in the scopingOrganization.
.... classCode 1..1csFixed Value: OWN
.... scopingOrganization 1..1Organization
..... id 1..*II
..... name 1..*ON
..... telecom 0..*TEL
..... addr 0..*USRealmAddressADUSFIELDEDBase for all types and resources

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Participant1 1..1CDAR2.Participant1XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, @typeCode, @contextControlCode, realmCode, typeId, templateId, functionCode, time, associatedEntity
Base for all types and resources
... @typeCode 1..1csBinding: ParticipationType (required)
Fixed Value: DEV
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:templateId1 1..1IItemplateId
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.5.7
..... @extension 1..1stRequired Pattern: 2020-05-19
... functionCode 1..1CE
.... @code 1..1csRequired Pattern: assembler
.... @codeSystem 1..1oid, uuid, ruid
... associatedEntity 1..1AssociatedEntityThe template does not require any elements from the associatedEntity since the information is recorded in the scopingOrganization.
.... @classCode 1..1csBinding: RoleClassAssociative (required)
Fixed Value: OWN
.... scopingOrganization 1..1Organization
..... id 1..*II
..... name 1..*ON
..... telecom 0..*TEL
..... addr C0..*USRealmAddressADUSFIELDEDBase for all types and resources

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Participant1.typeCoderequiredFixed Value: DEV
Participant1.associatedEntity.classCoderequiredFixed Value: OWN

Constraints

IdGradePath(s)DetailsRequirements
81-7296errorParticipant1.associatedEntity.scopingOrganization.addr**SHALL NOT** have mixed content except for white space (CONF:81-7296).
:
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Participant1 1..1CDAR2.Participant1XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, @typeCode, @contextControlCode, realmCode, typeId, templateId, functionCode, time, associatedEntity
Base for all types and resources
... @nullFlavor 0..1csBinding: NullFlavor (required)
... @typeCode 1..1csBinding: ParticipationType (required)
Fixed Value: DEV
... @contextControlCode 0..1csBinding: ContextControl (required)
Fixed Value: OP
... typeId 0..1II
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:templateId1 1..1IItemplateId
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.5.7
..... @extension 1..1stRequired Pattern: 2020-05-19
... functionCode 1..1CE
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... @code 1..1csRequired Pattern: assembler
.... @codeSystem 1..1oid, uuid, ruid
.... @codeSystemName 0..1st
.... @codeSystemVersion 0..1st
.... @displayName 0..1st
.... @sdtcValueSet 0..1oidXML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
.... @sdtcValueSetVersion 0..1stXML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
.... originalText 0..1ED
.... translation 0..*CD
... time 1..1IVL_TS
... associatedEntity 1..1AssociatedEntityThe template does not require any elements from the associatedEntity since the information is recorded in the scopingOrganization.
.... @classCode 1..1csBinding: RoleClassAssociative (required)
Fixed Value: OWN
.... templateId 0..*II
.... id 0..*II
.... sdtcIdentifiedBy 0..*IdentifiedByXML Namespace: urn:hl7-org:sdtc
XML: identifiedBy (urn:hl7-org:sdtc)
.... code 0..1CEBinding: v3 Code System RoleCode (extensible)
.... addr 0..*AD
.... telecom 0..*TEL
.... associatedPerson 0..1Person
.... scopingOrganization 1..1Organization
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... @classCode 0..1csBinding: EntityClassOrganization (required)
Fixed Value: ORG
..... @determinerCode 0..1csBinding: EntityDeterminer (required)
Fixed Value: INSTANCE
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... id 1..*II
..... name 1..*ON
..... telecom 0..*TEL
..... addr C0..*USRealmAddressADUSFIELDEDBase for all types and resources
..... standardIndustryClassCode 0..1CEBinding: OrganizationIndustryClassNAICS (extensible)
..... asOrganizationPartOf 0..1OrganizationPartOf

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Participant1.nullFlavorrequiredNullFlavor
Participant1.typeCoderequiredFixed Value: DEV
Participant1.contextControlCoderequiredFixed Value: OP
Participant1.templateId:templateId1.nullFlavorrequiredNullFlavor
Participant1.functionCode.nullFlavorrequiredNullFlavor
Participant1.associatedEntity.classCoderequiredFixed Value: OWN
Participant1.associatedEntity.codeextensibleRoleCode
Participant1.associatedEntity.scopingOrganization.nullFlavorrequiredNullFlavor
Participant1.associatedEntity.scopingOrganization.classCoderequiredFixed Value: ORG
Participant1.associatedEntity.scopingOrganization.determinerCoderequiredFixed Value: INSTANCE
Participant1.associatedEntity.scopingOrganization.standardIndustryClassCodeextensibleOrganizationIndustryClassNAICS

Constraints

IdGradePath(s)DetailsRequirements
81-7296errorParticipant1.associatedEntity.scopingOrganization.addr**SHALL NOT** have mixed content except for white space (CONF:81-7296).
:
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())

This structure is derived from CDAR2.Participant1

Summary

Mandatory: 12 elements
Fixed Value: 2 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Participant1.templateId is sliced based on the values of value:root, value:extension

 

Other representations of profile: CSV, Excel