Consolidated CDA (C-CDA)
3.0.0 - STU3 United States of America flag

This page is part of the CCDA: Consolidated CDA Release (v3.0.0: CCDA 3.0) generated with FHIR (HL7® FHIR® Standard) v5.0.0. This is the current published version. For a full list of available versions, see the Directory of published versions

Logical Model: Provenance - Assembler Participation

Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/ProvenanceAssemblerParticipation Version: 3.0.0
Draft as of 2024-05-18 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.

Usage:

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

Formal Views of Template Content

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

This structure is derived from Participant1

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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 should-telecom: SHOULD contain telecom
should-addr: SHOULD contain addr
..... id 1..* II
..... name 1..* ON
..... telecom 0..* TEL
..... addr 0..* USRealmAddress Base for all types and resources

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 & Constraintsdoco
.. 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 Binding: CDAParticipationType (required)
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 Binding: CDARoleClassAssociative (required)
Fixed Value: OWN
.... scopingOrganization C 1..1 Organization should-telecom: SHOULD contain telecom
should-addr: SHOULD contain addr
..... id 1..* II
..... name 1..* ON
..... telecom 0..* TEL
..... addr C 0..* USRealmAddress Base for all types and resources
shall-city: SHALL contain exactly one [1..1] city (CONF:81-7292).
shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291).
should-use: SHOULD contain @use
should-country: SHOULD contain country
81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296)
81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024).
81-10025: If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025).
shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Participant1.typeCoderequiredFixed Value: DEV
http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType
Participant1.associatedEntity.classCoderequiredFixed Value: OWN
http://hl7.org/cda/stds/core/ValueSet/CDARoleClassAssociative

Constraints

IdGradePath(s)DetailsRequirements
81-7296errorParticipant1.associatedEntity.scopingOrganization.addr**SHALL NOT** have mixed content except for white space (CONF:81-7296)
: item.xmlText.empty()
81-10024errorParticipant1.associatedEntity.scopingOrganization.addrIf the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024).
: nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state'))
81-10025errorParticipant1.associatedEntity.scopingOrganization.addrIf the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025).
: nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?'))
shall-cityerrorParticipant1.associatedEntity.scopingOrganization.addrSHALL contain exactly one [1..1] city (CONF:81-7292).
: nullFlavor.exists() or item.city.count() = 1
shall-max-ad-partserrorParticipant1.associatedEntity.scopingOrganization.addrSHALL have at most one of each: state, city, postalCode, and country
: (item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1)
shall-streetAddressLineerrorParticipant1.associatedEntity.scopingOrganization.addrSHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291).
: nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4)
should-addrwarningParticipant1.associatedEntity.scopingOrganizationSHOULD contain addr
: addr.exists()
should-countrywarningParticipant1.associatedEntity.scopingOrganization.addrSHOULD contain country
: nullFlavor.exists() or item.country.exists()
should-telecomwarningParticipant1.associatedEntity.scopingOrganizationSHOULD contain telecom
: telecom.exists()
should-usewarningParticipant1.associatedEntity.scopingOrganization.addrSHOULD contain @use
: nullFlavor.exists() or use.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. 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 0..1 II
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @assigningAuthorityName 0..1 st
.... @displayable 0..1 bl
.... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1 st
.... templateId: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 0..1 II
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1 st
..... @displayable 0..1 bl
..... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
..... @extension 1..1 st
.... templateId 0..* II
.... @classCode 1..1 cs 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 should-telecom: SHOULD contain telecom
should-addr: SHOULD contain addr
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... realmCode 0..* CS
..... typeId 0..1 II
...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1 st
...... @displayable 0..1 bl
...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1 st
..... templateId 0..* II
..... @classCode 0..1 cs Binding: EntityClassOrganization (required)
Fixed Value: ORG
..... @determinerCode 0..1 cs Binding: EntityDeterminer (required)
Fixed Value: INSTANCE
..... id 1..* II
..... name 1..* ON
..... telecom 0..* TEL
..... addr C 0..* USRealmAddress Base for all types and resources
shall-city: SHALL contain exactly one [1..1] city (CONF:81-7292).
shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291).
should-use: SHOULD contain @use
should-country: SHOULD contain country
81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296)
81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024).
81-10025: If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025).
shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country
..... 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
81-7296errorParticipant1.associatedEntity.scopingOrganization.addr**SHALL NOT** have mixed content except for white space (CONF:81-7296)
: item.xmlText.empty()
81-10024errorParticipant1.associatedEntity.scopingOrganization.addrIf the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024).
: nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state'))
81-10025errorParticipant1.associatedEntity.scopingOrganization.addrIf the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025).
: nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?'))
shall-cityerrorParticipant1.associatedEntity.scopingOrganization.addrSHALL contain exactly one [1..1] city (CONF:81-7292).
: nullFlavor.exists() or item.city.count() = 1
shall-max-ad-partserrorParticipant1.associatedEntity.scopingOrganization.addrSHALL have at most one of each: state, city, postalCode, and country
: (item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1)
shall-streetAddressLineerrorParticipant1.associatedEntity.scopingOrganization.addrSHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291).
: nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4)
should-addrwarningParticipant1.associatedEntity.scopingOrganizationSHOULD contain addr
: addr.exists()
should-countrywarningParticipant1.associatedEntity.scopingOrganization.addrSHOULD contain country
: nullFlavor.exists() or item.country.exists()
should-telecomwarningParticipant1.associatedEntity.scopingOrganizationSHOULD contain telecom
: telecom.exists()
should-usewarningParticipant1.associatedEntity.scopingOrganization.addrSHOULD contain @use
: nullFlavor.exists() or use.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 & Constraintsdoco
.. 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 should-telecom: SHOULD contain telecom
should-addr: SHOULD contain addr
..... id 1..* II
..... name 1..* ON
..... telecom 0..* TEL
..... addr 0..* USRealmAddress Base for all types and resources

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 & Constraintsdoco
.. 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 Binding: CDAParticipationType (required)
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 Binding: CDARoleClassAssociative (required)
Fixed Value: OWN
.... scopingOrganization C 1..1 Organization should-telecom: SHOULD contain telecom
should-addr: SHOULD contain addr
..... id 1..* II
..... name 1..* ON
..... telecom 0..* TEL
..... addr C 0..* USRealmAddress Base for all types and resources
shall-city: SHALL contain exactly one [1..1] city (CONF:81-7292).
shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291).
should-use: SHOULD contain @use
should-country: SHOULD contain country
81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296)
81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024).
81-10025: If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025).
shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Participant1.typeCoderequiredFixed Value: DEV
http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType
Participant1.associatedEntity.classCoderequiredFixed Value: OWN
http://hl7.org/cda/stds/core/ValueSet/CDARoleClassAssociative

Constraints

IdGradePath(s)DetailsRequirements
81-7296errorParticipant1.associatedEntity.scopingOrganization.addr**SHALL NOT** have mixed content except for white space (CONF:81-7296)
: item.xmlText.empty()
81-10024errorParticipant1.associatedEntity.scopingOrganization.addrIf the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024).
: nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state'))
81-10025errorParticipant1.associatedEntity.scopingOrganization.addrIf the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025).
: nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?'))
shall-cityerrorParticipant1.associatedEntity.scopingOrganization.addrSHALL contain exactly one [1..1] city (CONF:81-7292).
: nullFlavor.exists() or item.city.count() = 1
shall-max-ad-partserrorParticipant1.associatedEntity.scopingOrganization.addrSHALL have at most one of each: state, city, postalCode, and country
: (item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1)
shall-streetAddressLineerrorParticipant1.associatedEntity.scopingOrganization.addrSHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291).
: nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4)
should-addrwarningParticipant1.associatedEntity.scopingOrganizationSHOULD contain addr
: addr.exists()
should-countrywarningParticipant1.associatedEntity.scopingOrganization.addrSHOULD contain country
: nullFlavor.exists() or item.country.exists()
should-telecomwarningParticipant1.associatedEntity.scopingOrganizationSHOULD contain telecom
: telecom.exists()
should-usewarningParticipant1.associatedEntity.scopingOrganization.addrSHOULD contain @use
: nullFlavor.exists() or use.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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 0..1 II
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @assigningAuthorityName 0..1 st
.... @displayable 0..1 bl
.... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1 st
.... templateId: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 0..1 II
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1 st
..... @displayable 0..1 bl
..... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
..... @extension 1..1 st
.... templateId 0..* II
.... @classCode 1..1 cs 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 should-telecom: SHOULD contain telecom
should-addr: SHOULD contain addr
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... realmCode 0..* CS
..... typeId 0..1 II
...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1 st
...... @displayable 0..1 bl
...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1 st
..... templateId 0..* II
..... @classCode 0..1 cs Binding: EntityClassOrganization (required)
Fixed Value: ORG
..... @determinerCode 0..1 cs Binding: EntityDeterminer (required)
Fixed Value: INSTANCE
..... id 1..* II
..... name 1..* ON
..... telecom 0..* TEL
..... addr C 0..* USRealmAddress Base for all types and resources
shall-city: SHALL contain exactly one [1..1] city (CONF:81-7292).
shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291).
should-use: SHOULD contain @use
should-country: SHOULD contain country
81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296)
81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024).
81-10025: If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025).
shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country
..... 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
81-7296errorParticipant1.associatedEntity.scopingOrganization.addr**SHALL NOT** have mixed content except for white space (CONF:81-7296)
: item.xmlText.empty()
81-10024errorParticipant1.associatedEntity.scopingOrganization.addrIf the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024).
: nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state'))
81-10025errorParticipant1.associatedEntity.scopingOrganization.addrIf the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025).
: nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?'))
shall-cityerrorParticipant1.associatedEntity.scopingOrganization.addrSHALL contain exactly one [1..1] city (CONF:81-7292).
: nullFlavor.exists() or item.city.count() = 1
shall-max-ad-partserrorParticipant1.associatedEntity.scopingOrganization.addrSHALL have at most one of each: state, city, postalCode, and country
: (item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1)
shall-streetAddressLineerrorParticipant1.associatedEntity.scopingOrganization.addrSHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291).
: nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4)
should-addrwarningParticipant1.associatedEntity.scopingOrganizationSHOULD contain addr
: addr.exists()
should-countrywarningParticipant1.associatedEntity.scopingOrganization.addrSHOULD contain country
: nullFlavor.exists() or item.country.exists()
should-telecomwarningParticipant1.associatedEntity.scopingOrganizationSHOULD contain telecom
: telecom.exists()
should-usewarningParticipant1.associatedEntity.scopingOrganization.addrSHOULD contain @use
: nullFlavor.exists() or use.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