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

Consolidated CDA (C-CDA), published by Health Level Seven. This guide is not an authorized publication; it is the continuous build for version 4.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/CDA-ccda/ and changes regularly. See the Directory of published versions

Logical Model: Provenance - Assembler Participation

Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/ProvenanceAssemblerParticipation Version: 4.0.0
Draft as of 2025-06-16 Computable Name: ProvenanceAssemblerParticipation
Other Identifiers: urn:ietf:rfc:3986#Uniform Resource Identifier (URI)#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.

Usages:

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

Changes since version 3.0.0:

  • No changes

    • Formal Views of Template Content

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

    This structure is derived from Participant1

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Participant1 1..1 Participant1 XML Namespace: urn:hl7-org:v3
    Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @typeCode, @contextControlCode, functionCode, time, associatedEntity
    Base for all types and resources
    Instance of this type are validated by templateId
    Logical Container: ClinicalDocument (CDA Class)
    ... Slices for templateId 1..* II Slice: Unordered, Open by value:root, value:extension
    .... templateId:provenance-assembler 1..1 II
    ..... @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
    ... @typeCode 1..1 cs Fixed Value: DEV
    ... functionCode 1..1 CE
    .... @code 1..1 cs Required Pattern: assembler
    .... @codeSystem 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.4.642.4.1131
    ... 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 C 1..1 Organization Constraints: should-telecom, should-addr
    ..... id 1..* II
    ..... name 1..* ON
    ..... telecom 0..* TEL
    ..... addr 0..* USRealmAddress

    doco Documentation for this format

    Constraints

    IdGradePath(s)DetailsRequirements
    should-addrwarningParticipant1.associatedEntity.scopingOrganizationSHOULD contain addr
    : addr.exists()
    should-telecomwarningParticipant1.associatedEntity.scopingOrganizationSHOULD contain telecom
    : telecom.exists()
    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Participant1 1..1 Participant1 XML Namespace: urn:hl7-org:v3
    Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @typeCode, @contextControlCode, functionCode, time, associatedEntity
    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 Constraints: II-1
    .... @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:provenance-assembler 1..1 II
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... @assigningAuthorityName 0..1 st
    ..... @displayable 0..1 bl
    ..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.5.7
    ..... @extension 1..1 st Required Pattern: 2020-05-19
    ... @typeCode 1..1 cs Binding: CDAParticipationType (required)
    Fixed Value: DEV
    ... @contextControlCode 0..1 cs Binding: CDAContextControl (required)
    Fixed Value: OP
    ... functionCode 1..1 CE
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... @code 1..1 cs Required Pattern: assembler
    .... @codeSystem 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.4.642.4.1131
    .... @codeSystemName 0..1 st
    .... @codeSystemVersion 0..1 st
    .... @displayName 0..1 st
    .... @sdtcValueSet 0..1 oid XML Namespace: urn:hl7-org:sdtc
    XML: valueSet (urn:hl7-org:sdtc)
    .... @sdtcValueSetVersion 0..1 st XML Namespace: urn:hl7-org:sdtc
    XML: valueSetVersion (urn:hl7-org:sdtc)
    .... originalText 0..1 ED
    .... translation 0..* CD
    ... 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.
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... realmCode 0..* CS
    .... typeId C 0..1 II Constraints: II-1
    ..... @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 Binding: CDARoleClassAssociative (required)
    Fixed Value: OWN
    .... id 0..* II
    .... sdtcIdentifiedBy 0..* IdentifiedBy XML Namespace: urn:hl7-org:sdtc
    XML: identifiedBy (urn:hl7-org:sdtc)
    .... code 0..1 CE Binding: CDARoleCode (example)
    .... addr 0..* AD
    .... telecom 0..* TEL
    .... associatedPerson 0..1 Person
    .... scopingOrganization C 1..1 Organization Constraints: should-telecom, should-addr
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @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 1..* II
    ..... name 1..* 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
    Participant1.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Participant1.typeId.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Participant1.templateId:provenance-assembler.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Participant1.typeCoderequiredFixed Value: DEV
    http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType
    Participant1.contextControlCoderequiredFixed Value: OP
    http://hl7.org/cda/stds/core/ValueSet/CDAContextControl
    Participant1.functionCode.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Participant1.associatedEntity.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Participant1.associatedEntity.typeId.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Participant1.associatedEntity.classCoderequiredFixed Value: OWN
    http://hl7.org/cda/stds/core/ValueSet/CDARoleClassAssociative
    Participant1.associatedEntity.codeexampleCDARoleCode
    http://hl7.org/cda/stds/core/ValueSet/CDARoleCode
    Participant1.associatedEntity.scopingOrganization.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Participant1.associatedEntity.scopingOrganization.typeId.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Participant1.associatedEntity.scopingOrganization.classCoderequiredFixed Value: ORG
    http://terminology.hl7.org/ValueSet/v3-EntityClassOrganization
    Participant1.associatedEntity.scopingOrganization.determinerCoderequiredFixed Value: INSTANCE
    http://terminology.hl7.org/ValueSet/v3-EntityDeterminer
    Participant1.associatedEntity.scopingOrganization.standardIndustryClassCodeexampleOrganizationIndustryClassNAICS
    http://terminology.hl7.org/ValueSet/v3-OrganizationIndustryClassNAICS

    Constraints

    IdGradePath(s)DetailsRequirements
    II-1errorParticipant1.typeId, Participant1.associatedEntity.typeId, Participant1.associatedEntity.scopingOrganization.typeIdAn II instance must have either a root or an nullFlavor.
    : root.exists() or nullFlavor.exists()
    should-addrwarningParticipant1.associatedEntity.scopingOrganizationSHOULD contain addr
    : addr.exists()
    should-telecomwarningParticipant1.associatedEntity.scopingOrganizationSHOULD contain telecom
    : telecom.exists()
    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Participant1 1..1 Participant1 XML Namespace: urn:hl7-org:v3
    Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @typeCode, @contextControlCode, functionCode, time, associatedEntity
    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 Constraints: II-1
    .... @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:provenance-assembler 1..1 II
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... @assigningAuthorityName 0..1 st
    ..... @displayable 0..1 bl
    ..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.5.7
    ..... @extension 1..1 st Required Pattern: 2020-05-19
    ... @typeCode 1..1 cs Binding: CDAParticipationType (required)
    Fixed Value: DEV
    ... @contextControlCode 0..1 cs Binding: CDAContextControl (required)
    Fixed Value: OP
    ... functionCode 1..1 CE
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... @code 1..1 cs Required Pattern: assembler
    .... @codeSystem 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.4.642.4.1131
    .... @codeSystemName 0..1 st
    .... @codeSystemVersion 0..1 st
    .... @displayName 0..1 st
    .... @sdtcValueSet 0..1 oid XML Namespace: urn:hl7-org:sdtc
    XML: valueSet (urn:hl7-org:sdtc)
    .... @sdtcValueSetVersion 0..1 st XML Namespace: urn:hl7-org:sdtc
    XML: valueSetVersion (urn:hl7-org:sdtc)
    .... originalText 0..1 ED
    .... translation 0..* CD
    ... 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.
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... realmCode 0..* CS
    .... typeId C 0..1 II Constraints: II-1
    ..... @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 Binding: CDARoleClassAssociative (required)
    Fixed Value: OWN
    .... id 0..* II
    .... sdtcIdentifiedBy 0..* IdentifiedBy XML Namespace: urn:hl7-org:sdtc
    XML: identifiedBy (urn:hl7-org:sdtc)
    .... code 0..1 CE Binding: CDARoleCode (example)
    .... addr 0..* AD
    .... telecom 0..* TEL
    .... associatedPerson 0..1 Person
    .... scopingOrganization C 1..1 Organization Constraints: should-telecom, should-addr
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @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 1..* II
    ..... name 1..* 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
    Participant1.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Participant1.typeId.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Participant1.templateId:provenance-assembler.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Participant1.typeCoderequiredFixed Value: DEV
    http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType
    Participant1.contextControlCoderequiredFixed Value: OP
    http://hl7.org/cda/stds/core/ValueSet/CDAContextControl
    Participant1.functionCode.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Participant1.associatedEntity.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Participant1.associatedEntity.typeId.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Participant1.associatedEntity.classCoderequiredFixed Value: OWN
    http://hl7.org/cda/stds/core/ValueSet/CDARoleClassAssociative
    Participant1.associatedEntity.codeexampleCDARoleCode
    http://hl7.org/cda/stds/core/ValueSet/CDARoleCode
    Participant1.associatedEntity.scopingOrganization.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Participant1.associatedEntity.scopingOrganization.typeId.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Participant1.associatedEntity.scopingOrganization.classCoderequiredFixed Value: ORG
    http://terminology.hl7.org/ValueSet/v3-EntityClassOrganization
    Participant1.associatedEntity.scopingOrganization.determinerCoderequiredFixed Value: INSTANCE
    http://terminology.hl7.org/ValueSet/v3-EntityDeterminer
    Participant1.associatedEntity.scopingOrganization.standardIndustryClassCodeexampleOrganizationIndustryClassNAICS
    http://terminology.hl7.org/ValueSet/v3-OrganizationIndustryClassNAICS

    Constraints

    IdGradePath(s)DetailsRequirements
    II-1errorParticipant1.typeId, Participant1.associatedEntity.typeId, Participant1.associatedEntity.scopingOrganization.typeIdAn II instance must have either a root or an nullFlavor.
    : root.exists() or nullFlavor.exists()
    should-addrwarningParticipant1.associatedEntity.scopingOrganizationSHOULD contain addr
    : addr.exists()
    should-telecomwarningParticipant1.associatedEntity.scopingOrganizationSHOULD contain telecom
    : telecom.exists()

    This structure is derived from Participant1

    Summary

    Mandatory: 11 elements
    Fixed: 2 elements

    Structures

    This structure refers to these other structures:

    Slices

    This structure defines the following Slices:

    • The element 2 is sliced based on the values of Participant1.templateId

    Differential View

    This structure is derived from Participant1

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Participant1 1..1 Participant1 XML Namespace: urn:hl7-org:v3
    Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @typeCode, @contextControlCode, functionCode, time, associatedEntity
    Base for all types and resources
    Instance of this type are validated by templateId
    Logical Container: ClinicalDocument (CDA Class)
    ... Slices for templateId 1..* II Slice: Unordered, Open by value:root, value:extension
    .... templateId:provenance-assembler 1..1 II
    ..... @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
    ... @typeCode 1..1 cs Fixed Value: DEV
    ... functionCode 1..1 CE
    .... @code 1..1 cs Required Pattern: assembler
    .... @codeSystem 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.4.642.4.1131
    ... 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 C 1..1 Organization Constraints: should-telecom, should-addr
    ..... id 1..* II
    ..... name 1..* ON
    ..... telecom 0..* TEL
    ..... addr 0..* USRealmAddress

    doco Documentation for this format

    Constraints

    IdGradePath(s)DetailsRequirements
    should-addrwarningParticipant1.associatedEntity.scopingOrganizationSHOULD contain addr
    : addr.exists()
    should-telecomwarningParticipant1.associatedEntity.scopingOrganizationSHOULD contain telecom
    : telecom.exists()

    Key Elements View

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Participant1 1..1 Participant1 XML Namespace: urn:hl7-org:v3
    Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @typeCode, @contextControlCode, functionCode, time, associatedEntity
    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 Constraints: II-1
    .... @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:provenance-assembler 1..1 II
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... @assigningAuthorityName 0..1 st
    ..... @displayable 0..1 bl
    ..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.5.7
    ..... @extension 1..1 st Required Pattern: 2020-05-19
    ... @typeCode 1..1 cs Binding: CDAParticipationType (required)
    Fixed Value: DEV
    ... @contextControlCode 0..1 cs Binding: CDAContextControl (required)
    Fixed Value: OP
    ... functionCode 1..1 CE
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... @code 1..1 cs Required Pattern: assembler
    .... @codeSystem 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.4.642.4.1131
    .... @codeSystemName 0..1 st
    .... @codeSystemVersion 0..1 st
    .... @displayName 0..1 st
    .... @sdtcValueSet 0..1 oid XML Namespace: urn:hl7-org:sdtc
    XML: valueSet (urn:hl7-org:sdtc)
    .... @sdtcValueSetVersion 0..1 st XML Namespace: urn:hl7-org:sdtc
    XML: valueSetVersion (urn:hl7-org:sdtc)
    .... originalText 0..1 ED
    .... translation 0..* CD
    ... 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.
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... realmCode 0..* CS
    .... typeId C 0..1 II Constraints: II-1
    ..... @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 Binding: CDARoleClassAssociative (required)
    Fixed Value: OWN
    .... id 0..* II
    .... sdtcIdentifiedBy 0..* IdentifiedBy XML Namespace: urn:hl7-org:sdtc
    XML: identifiedBy (urn:hl7-org:sdtc)
    .... code 0..1 CE Binding: CDARoleCode (example)
    .... addr 0..* AD
    .... telecom 0..* TEL
    .... associatedPerson 0..1 Person
    .... scopingOrganization C 1..1 Organization Constraints: should-telecom, should-addr
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @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 1..* II
    ..... name 1..* 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
    Participant1.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Participant1.typeId.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Participant1.templateId:provenance-assembler.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Participant1.typeCoderequiredFixed Value: DEV
    http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType
    Participant1.contextControlCoderequiredFixed Value: OP
    http://hl7.org/cda/stds/core/ValueSet/CDAContextControl
    Participant1.functionCode.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Participant1.associatedEntity.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Participant1.associatedEntity.typeId.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Participant1.associatedEntity.classCoderequiredFixed Value: OWN
    http://hl7.org/cda/stds/core/ValueSet/CDARoleClassAssociative
    Participant1.associatedEntity.codeexampleCDARoleCode
    http://hl7.org/cda/stds/core/ValueSet/CDARoleCode
    Participant1.associatedEntity.scopingOrganization.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Participant1.associatedEntity.scopingOrganization.typeId.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Participant1.associatedEntity.scopingOrganization.classCoderequiredFixed Value: ORG
    http://terminology.hl7.org/ValueSet/v3-EntityClassOrganization
    Participant1.associatedEntity.scopingOrganization.determinerCoderequiredFixed Value: INSTANCE
    http://terminology.hl7.org/ValueSet/v3-EntityDeterminer
    Participant1.associatedEntity.scopingOrganization.standardIndustryClassCodeexampleOrganizationIndustryClassNAICS
    http://terminology.hl7.org/ValueSet/v3-OrganizationIndustryClassNAICS

    Constraints

    IdGradePath(s)DetailsRequirements
    II-1errorParticipant1.typeId, Participant1.associatedEntity.typeId, Participant1.associatedEntity.scopingOrganization.typeIdAn II instance must have either a root or an nullFlavor.
    : root.exists() or nullFlavor.exists()
    should-addrwarningParticipant1.associatedEntity.scopingOrganizationSHOULD contain addr
    : addr.exists()
    should-telecomwarningParticipant1.associatedEntity.scopingOrganizationSHOULD contain telecom
    : telecom.exists()

    Snapshot View

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Participant1 1..1 Participant1 XML Namespace: urn:hl7-org:v3
    Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @typeCode, @contextControlCode, functionCode, time, associatedEntity
    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 Constraints: II-1
    .... @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:provenance-assembler 1..1 II
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... @assigningAuthorityName 0..1 st
    ..... @displayable 0..1 bl
    ..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.5.7
    ..... @extension 1..1 st Required Pattern: 2020-05-19
    ... @typeCode 1..1 cs Binding: CDAParticipationType (required)
    Fixed Value: DEV
    ... @contextControlCode 0..1 cs Binding: CDAContextControl (required)
    Fixed Value: OP
    ... functionCode 1..1 CE
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... @code 1..1 cs Required Pattern: assembler
    .... @codeSystem 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.4.642.4.1131
    .... @codeSystemName 0..1 st
    .... @codeSystemVersion 0..1 st
    .... @displayName 0..1 st
    .... @sdtcValueSet 0..1 oid XML Namespace: urn:hl7-org:sdtc
    XML: valueSet (urn:hl7-org:sdtc)
    .... @sdtcValueSetVersion 0..1 st XML Namespace: urn:hl7-org:sdtc
    XML: valueSetVersion (urn:hl7-org:sdtc)
    .... originalText 0..1 ED
    .... translation 0..* CD
    ... 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.
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... realmCode 0..* CS
    .... typeId C 0..1 II Constraints: II-1
    ..... @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 Binding: CDARoleClassAssociative (required)
    Fixed Value: OWN
    .... id 0..* II
    .... sdtcIdentifiedBy 0..* IdentifiedBy XML Namespace: urn:hl7-org:sdtc
    XML: identifiedBy (urn:hl7-org:sdtc)
    .... code 0..1 CE Binding: CDARoleCode (example)
    .... addr 0..* AD
    .... telecom 0..* TEL
    .... associatedPerson 0..1 Person
    .... scopingOrganization C 1..1 Organization Constraints: should-telecom, should-addr
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @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 1..* II
    ..... name 1..* 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
    Participant1.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Participant1.typeId.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Participant1.templateId:provenance-assembler.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Participant1.typeCoderequiredFixed Value: DEV
    http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType
    Participant1.contextControlCoderequiredFixed Value: OP
    http://hl7.org/cda/stds/core/ValueSet/CDAContextControl
    Participant1.functionCode.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Participant1.associatedEntity.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Participant1.associatedEntity.typeId.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Participant1.associatedEntity.classCoderequiredFixed Value: OWN
    http://hl7.org/cda/stds/core/ValueSet/CDARoleClassAssociative
    Participant1.associatedEntity.codeexampleCDARoleCode
    http://hl7.org/cda/stds/core/ValueSet/CDARoleCode
    Participant1.associatedEntity.scopingOrganization.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Participant1.associatedEntity.scopingOrganization.typeId.nullFlavorrequiredCDANullFlavor
    http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
    Participant1.associatedEntity.scopingOrganization.classCoderequiredFixed Value: ORG
    http://terminology.hl7.org/ValueSet/v3-EntityClassOrganization
    Participant1.associatedEntity.scopingOrganization.determinerCoderequiredFixed Value: INSTANCE
    http://terminology.hl7.org/ValueSet/v3-EntityDeterminer
    Participant1.associatedEntity.scopingOrganization.standardIndustryClassCodeexampleOrganizationIndustryClassNAICS
    http://terminology.hl7.org/ValueSet/v3-OrganizationIndustryClassNAICS

    Constraints

    IdGradePath(s)DetailsRequirements
    II-1errorParticipant1.typeId, Participant1.associatedEntity.typeId, Participant1.associatedEntity.scopingOrganization.typeIdAn II instance must have either a root or an nullFlavor.
    : root.exists() or nullFlavor.exists()
    should-addrwarningParticipant1.associatedEntity.scopingOrganizationSHOULD contain addr
    : addr.exists()
    should-telecomwarningParticipant1.associatedEntity.scopingOrganizationSHOULD contain telecom
    : telecom.exists()

    This structure is derived from Participant1

    Summary

    Mandatory: 11 elements
    Fixed: 2 elements

    Structures

    This structure refers to these other structures:

    Slices

    This structure defines the following Slices:

    • The element 2 is sliced based on the values of Participant1.templateId

     

    Other representations of profile: CSV, Excel