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
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:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from CDAR2.Participant1
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Participant1 | 1..1 | CDAR2.Participant1 | XML 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..1 | cs | Fixed Value: DEV | |
Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
templateId:templateId1 | 1..1 | II | templateId | |
root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.5.7 | |
extension | 1..1 | st | Required Pattern: 2020-05-19 | |
functionCode | 1..1 | CE | ||
code | 1..1 | cs | Required Pattern: assembler | |
codeSystem | 1..1 | oid, uuid, ruid | ||
time | 1..1 | IVL_TS | ||
associatedEntity | 1..1 | AssociatedEntity | The template does not require any elements from the associatedEntity since the information is recorded in the scopingOrganization. | |
classCode | 1..1 | cs | Fixed Value: OWN | |
scopingOrganization | 1..1 | Organization | ||
id | 1..* | II | ||
name | 1..* | ON | ||
telecom | 0..* | TEL | ||
addr | 0..* | USRealmAddressADUSFIELDED | Base for all types and resources | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Participant1 | 1..1 | CDAR2.Participant1 | XML 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..1 | cs | Binding: ParticipationType (required) Fixed Value: DEV | |
Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
templateId:templateId1 | 1..1 | II | templateId | |
@root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.5.7 | |
@extension | 1..1 | st | Required Pattern: 2020-05-19 | |
functionCode | 1..1 | CE | ||
@code | 1..1 | cs | Required Pattern: assembler | |
@codeSystem | 1..1 | oid, uuid, ruid | ||
time | 1..1 | IVL_TS | ||
associatedEntity | 1..1 | AssociatedEntity | The template does not require any elements from the associatedEntity since the information is recorded in the scopingOrganization. | |
@classCode | 1..1 | cs | Binding: RoleClassAssociative (required) Fixed Value: OWN | |
scopingOrganization | 1..1 | Organization | ||
id | 1..* | II | ||
name | 1..* | ON | ||
telecom | 0..* | TEL | ||
addr | C | 0..* | USRealmAddressADUSFIELDED | Base for all types and resources |
Documentation for this format |
Path | Conformance | ValueSet / Code |
Participant1.typeCode | required | Fixed Value: DEV |
Participant1.associatedEntity.classCode | required | Fixed Value: OWN |
Id | Grade | Path(s) | Details | Requirements |
81-7296 | error | Participant1.associatedEntity.scopingOrganization.addr | **SHALL NOT** have mixed content except for white space (CONF:81-7296). : | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
Path | Conformance | ValueSet / Code |
Participant1.nullFlavor | required | NullFlavor |
Participant1.typeCode | required | Fixed Value: DEV |
Participant1.contextControlCode | required | Fixed Value: OP |
Participant1.templateId:templateId1.nullFlavor | required | NullFlavor |
Participant1.functionCode.nullFlavor | required | NullFlavor |
Participant1.associatedEntity.classCode | required | Fixed Value: OWN |
Participant1.associatedEntity.code | extensible | RoleCode |
Participant1.associatedEntity.scopingOrganization.nullFlavor | required | NullFlavor |
Participant1.associatedEntity.scopingOrganization.classCode | required | Fixed Value: ORG |
Participant1.associatedEntity.scopingOrganization.determinerCode | required | Fixed Value: INSTANCE |
Participant1.associatedEntity.scopingOrganization.standardIndustryClassCode | extensible | OrganizationIndustryClassNAICS |
Id | Grade | Path(s) | Details | Requirements |
81-7296 | error | Participant1.associatedEntity.scopingOrganization.addr | **SHALL NOT** have mixed content except for white space (CONF:81-7296). : | |
ele-1 | error | **ALL** elements | All 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:
Differential View
This structure is derived from CDAR2.Participant1
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Participant1 | 1..1 | CDAR2.Participant1 | XML 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..1 | cs | Fixed Value: DEV | |
Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
templateId:templateId1 | 1..1 | II | templateId | |
root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.5.7 | |
extension | 1..1 | st | Required Pattern: 2020-05-19 | |
functionCode | 1..1 | CE | ||
code | 1..1 | cs | Required Pattern: assembler | |
codeSystem | 1..1 | oid, uuid, ruid | ||
time | 1..1 | IVL_TS | ||
associatedEntity | 1..1 | AssociatedEntity | The template does not require any elements from the associatedEntity since the information is recorded in the scopingOrganization. | |
classCode | 1..1 | cs | Fixed Value: OWN | |
scopingOrganization | 1..1 | Organization | ||
id | 1..* | II | ||
name | 1..* | ON | ||
telecom | 0..* | TEL | ||
addr | 0..* | USRealmAddressADUSFIELDED | Base for all types and resources | |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Participant1 | 1..1 | CDAR2.Participant1 | XML 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..1 | cs | Binding: ParticipationType (required) Fixed Value: DEV | |
Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
templateId:templateId1 | 1..1 | II | templateId | |
@root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.5.7 | |
@extension | 1..1 | st | Required Pattern: 2020-05-19 | |
functionCode | 1..1 | CE | ||
@code | 1..1 | cs | Required Pattern: assembler | |
@codeSystem | 1..1 | oid, uuid, ruid | ||
time | 1..1 | IVL_TS | ||
associatedEntity | 1..1 | AssociatedEntity | The template does not require any elements from the associatedEntity since the information is recorded in the scopingOrganization. | |
@classCode | 1..1 | cs | Binding: RoleClassAssociative (required) Fixed Value: OWN | |
scopingOrganization | 1..1 | Organization | ||
id | 1..* | II | ||
name | 1..* | ON | ||
telecom | 0..* | TEL | ||
addr | C | 0..* | USRealmAddressADUSFIELDED | Base for all types and resources |
Documentation for this format |
Path | Conformance | ValueSet / Code |
Participant1.typeCode | required | Fixed Value: DEV |
Participant1.associatedEntity.classCode | required | Fixed Value: OWN |
Id | Grade | Path(s) | Details | Requirements |
81-7296 | error | Participant1.associatedEntity.scopingOrganization.addr | **SHALL NOT** have mixed content except for white space (CONF:81-7296). : | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
Snapshot View
Path | Conformance | ValueSet / Code |
Participant1.nullFlavor | required | NullFlavor |
Participant1.typeCode | required | Fixed Value: DEV |
Participant1.contextControlCode | required | Fixed Value: OP |
Participant1.templateId:templateId1.nullFlavor | required | NullFlavor |
Participant1.functionCode.nullFlavor | required | NullFlavor |
Participant1.associatedEntity.classCode | required | Fixed Value: OWN |
Participant1.associatedEntity.code | extensible | RoleCode |
Participant1.associatedEntity.scopingOrganization.nullFlavor | required | NullFlavor |
Participant1.associatedEntity.scopingOrganization.classCode | required | Fixed Value: ORG |
Participant1.associatedEntity.scopingOrganization.determinerCode | required | Fixed Value: INSTANCE |
Participant1.associatedEntity.scopingOrganization.standardIndustryClassCode | extensible | OrganizationIndustryClassNAICS |
Id | Grade | Path(s) | Details | Requirements |
81-7296 | error | Participant1.associatedEntity.scopingOrganization.addr | **SHALL NOT** have mixed content except for white space (CONF:81-7296). : | |
ele-1 | error | **ALL** elements | All 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: