Provenance - Assembler Participation - Definitions - Consolidated CDA (C-CDA) v4.0.0-ballot

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-ballot 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: ProvenanceAssemblerParticipation - Detailed Descriptions

Draft as of 2024-12-19

Definitions for the ProvenanceAssemblerParticipation logical model.

Guidance on how to interpret the contents of this table can be found here

0. Participant1
Logical Container	ClinicalDocument (CDA Class)
Validation	Instance of this type are validated by templateId
XML Format	In the XML format, this property has the namespace `urn:hl7-org:v3`.
2. Participant1.templateId
Control	1..?
Slicing	This element introduces a set of slices on `Participant1.templateId`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ root value @ extension
4. Participant1.templateId:provenance-assembler
Slice Name	provenance-assembler
Control	1..1
6. Participant1.templateId:provenance-assembler.root
Control	1..?
Pattern Value	`2.16.840.1.113883.10.20.22.5.7`
8. Participant1.templateId:provenance-assembler.extension
Control	1..?
Pattern Value	`2020-05-19`
10. Participant1.typeCode
Comments	SHALL contain exactly one [1..1] @typeCode="DEV" Device (CONF:4537-55).
Fixed Value	`DEV`
12. Participant1.functionCode
Comments	SHALL contain exactly one [1..1] functionCode (CONF:4537-38).
Control	1..?
14. Participant1.functionCode.code
Comments	This functionCode SHALL contain exactly one [1..1] @code="assembler" Assembler (CONF:4537-32972).
Control	1..?
Pattern Value	`assembler`
16. Participant1.functionCode.codeSystem
Comments	This functionCode SHALL contain exactly one [1..1] @codeSystem (CodeSystem: ProvenanceParticipantType urn:oid:2.16.840.1.113883.4.642.4.1131) (CONF:4537-41).
Control	1..?
Pattern Value	`2.16.840.1.113883.4.642.4.1131`
18. Participant1.time
Comments	SHALL contain exactly one [1..1] time (CONF:4537-42).
Control	1..?
20. Participant1.associatedEntity
Short	The template does not require any elements from the associatedEntity since the information is recorded in the scopingOrganization.
Comments	SHALL contain exactly one [1..1] associatedEntity (CONF:4537-39).
22. Participant1.associatedEntity.classCode
Comments	This associatedEntity SHALL contain exactly one [1..1] @classCode="OWN" Owned Entity (CONF:4537-32973).
Fixed Value	`OWN`
24. Participant1.associatedEntity.scopingOrganization
Comments	This associatedEntity SHALL contain exactly one [1..1] scopingOrganization (CONF:4537-43).
Control	1..?
Invariants	should-telecom: SHOULD contain telecom (`telecom.exists()`) should-addr: SHOULD contain addr (`addr.exists()`)
26. Participant1.associatedEntity.scopingOrganization.id
Comments	This scopingOrganization SHALL contain at least one [1..*] id (CONF:4537-50).
Control	1..?
28. Participant1.associatedEntity.scopingOrganization.name
Comments	This scopingOrganization SHALL contain at least one [1..*] name (CONF:4537-51).
Control	1..?
30. Participant1.associatedEntity.scopingOrganization.telecom
Comments	This scopingOrganization SHOULD contain zero or more [0..*] telecom (CONF:4537-52).
32. Participant1.associatedEntity.scopingOrganization.addr
Comments	This scopingOrganization SHOULD contain zero or more [0..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:4537-47).
Type	http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address)

Guidance on how to interpret the contents of this table can be found here

0. Participant1
Definition	Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type. Base definition for all types defined in FHIR type system.
Short	Base for all types and resources
Control	10..1*
Is Modifier	false
Logical Container	ClinicalDocument (CDA Class)
Validation	Instance of this type are validated by templateId
XML Format	In the XML format, this property has the namespace `urn:hl7-org:v3`.
2. Participant1.nullFlavor
Definition	If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control	0..1
Binding	The codes SHALL be taken from CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`)
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Exceptional Value Detail
4. Participant1.realmCode
Definition	When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/CS
6. Participant1.typeId
Definition	When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
Invariants	II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
8. Participant1.typeId.nullFlavor
Definition	If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control	0..1
Binding	The codes SHALL be taken from CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`)
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Exceptional Value Detail
10. Participant1.typeId.assigningAuthorityName
Definition	A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
Control	0..1
Type	string(st: Character String)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Assigning Authority Name
12. Participant1.typeId.displayable
Definition	Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
Control	0..1
Type	boolean(bl: Boolean)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Displayable
14. Participant1.typeId.root
Definition	Identifies the type as an HL7 Registered model
Control	1..1
Type	string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Root
Fixed Value	`2.16.840.1.113883.1.3`
16. Participant1.typeId.extension
Definition	A character string as a unique identifier within the scope of the identifier root.
Control	1..1
Type	string(st: Character String)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Extension
18. Participant1.templateId
Definition	When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question
Control	1..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
Slicing	This element introduces a set of slices on `Participant1.templateId`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ root value @ extension
20. Participant1.templateId:provenance-assembler
Slice Name	provenance-assembler
Definition	When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question
Control	1..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
22. Participant1.templateId:provenance-assembler.nullFlavor
Definition	If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control	0..1
Binding	The codes SHALL be taken from CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`)
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Exceptional Value Detail
24. Participant1.templateId:provenance-assembler.assigningAuthorityName
Definition	A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
Control	0..1
Type	string(st: Character String)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Assigning Authority Name
26. Participant1.templateId:provenance-assembler.displayable
Definition	Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
Control	0..1
Type	boolean(bl: Boolean)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Displayable
28. Participant1.templateId:provenance-assembler.root
Definition	A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.
Control	1..1
Type	string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Root
Pattern Value	`2.16.840.1.113883.10.20.22.5.7`
30. Participant1.templateId:provenance-assembler.extension
Definition	A character string as a unique identifier within the scope of the identifier root.
Control	1..1
Type	string(st: Character String)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Extension
Pattern Value	`2020-05-19`
32. Participant1.typeCode
Comments	SHALL contain exactly one [1..1] @typeCode="DEV" Device (CONF:4537-55).
Control	1..1
Binding	The codes SHALL be taken from CDAParticipationType (required to `http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType`)
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Fixed Value	`DEV`
34. Participant1.contextControlCode
Control	0..1
Binding	The codes SHALL be taken from CDAContextControl (required to `http://hl7.org/cda/stds/core/ValueSet/CDAContextControl`)
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Fixed Value	`OP`
36. Participant1.functionCode
Comments	SHALL contain exactly one [1..1] functionCode (CONF:4537-38).
Control	1..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/CE
38. Participant1.functionCode.nullFlavor
Definition	If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control	0..1
Binding	The codes SHALL be taken from CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`)
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Exceptional Value Detail
40. Participant1.functionCode.code
Definition	The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache.
Comments	This functionCode SHALL contain exactly one [1..1] @code="assembler" Assembler (CONF:4537-32972).
Control	1..1
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Code
Pattern Value	`assembler`
42. Participant1.functionCode.codeSystem
Definition	Specifies the code system that defines the code.
Comments	This functionCode SHALL contain exactly one [1..1] @codeSystem (CodeSystem: ProvenanceParticipantType urn:oid:2.16.840.1.113883.4.642.4.1131) (CONF:4537-41).
Control	1..1
Type	string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Code System
Pattern Value	`2.16.840.1.113883.4.642.4.1131`
44. Participant1.functionCode.codeSystemName
Definition	The common name of the coding system.
Control	0..1
Type	string(st: Character String)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Code System Name
46. Participant1.functionCode.codeSystemVersion
Definition	If applicable, a version descriptor defined specifically for the given code system.
Control	0..1
Type	string(st: Character String)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Code System Version
48. Participant1.functionCode.displayName
Definition	A name or title for the code, under which the sending system shows the code value to its users.
Control	0..1
Type	string(st: Character String)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Display Name
50. Participant1.functionCode.sdtcValueSet
Definition	The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.
Control	0..1
Type	string(oid: ISO Object Identifier)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`valueSet`.
52. Participant1.functionCode.sdtcValueSetVersion
Definition	The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept.
Control	0..1
Type	string(st: Character String)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`valueSetVersion`.
54. Participant1.functionCode.originalText
Definition	The text or phrase used as the basis for the coding.
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/ED
Label	Original Text
56. Participant1.functionCode.qualifier
Definition	Specifies additional codes that increase the specificity of the the primary code.
Control	0..0
Type	http://hl7.org/cda/stds/core/StructureDefinition/CR
Label	Qualifier
58. Participant1.functionCode.translation
Definition	A set of other concept descriptors that translate this concept descriptor into other code systems.
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/CD
XML Format	The type of this property is determined using the `xsi:type`attribute.
Label	Translation
60. Participant1.time
Comments	SHALL contain exactly one [1..1] time (CONF:4537-42).
Control	1..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
62. Participant1.associatedEntity
Short	The template does not require any elements from the associatedEntity since the information is recorded in the scopingOrganization.
Comments	SHALL contain exactly one [1..1] associatedEntity (CONF:4537-39).
Control	1..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/AssociatedEntity
64. Participant1.associatedEntity.nullFlavor
Definition	If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control	0..1
Binding	The codes SHALL be taken from CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`)
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Exceptional Value Detail
66. Participant1.associatedEntity.realmCode
Definition	When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/CS
68. Participant1.associatedEntity.typeId
Definition	When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
Invariants	II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
70. Participant1.associatedEntity.typeId.nullFlavor
Definition	If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control	0..1
Binding	The codes SHALL be taken from CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`)
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Exceptional Value Detail
72. Participant1.associatedEntity.typeId.assigningAuthorityName
Definition	A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
Control	0..1
Type	string(st: Character String)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Assigning Authority Name
74. Participant1.associatedEntity.typeId.displayable
Definition	Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
Control	0..1
Type	boolean(bl: Boolean)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Displayable
76. Participant1.associatedEntity.typeId.root
Definition	Identifies the type as an HL7 Registered model
Control	1..1
Type	string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Root
Fixed Value	`2.16.840.1.113883.1.3`
78. Participant1.associatedEntity.typeId.extension
Definition	A character string as a unique identifier within the scope of the identifier root.
Control	1..1
Type	string(st: Character String)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Extension
80. Participant1.associatedEntity.templateId
Definition	When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
82. Participant1.associatedEntity.classCode
Comments	This associatedEntity SHALL contain exactly one [1..1] @classCode="OWN" Owned Entity (CONF:4537-32973).
Control	1..1
Binding	The codes SHALL be taken from CDARoleClassAssociative (required to `http://hl7.org/cda/stds/core/ValueSet/CDARoleClassAssociative`)
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Fixed Value	`OWN`
84. Participant1.associatedEntity.id
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
86. Participant1.associatedEntity.sdtcIdentifiedBy
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy
XML Format	In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`identifiedBy`.
88. Participant1.associatedEntity.code
Control	0..1
Binding	For example codes, see CDARoleCode (example to `http://hl7.org/cda/stds/core/ValueSet/CDARoleCode`)
Type	http://hl7.org/cda/stds/core/StructureDefinition/CE
90. Participant1.associatedEntity.addr
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/AD
92. Participant1.associatedEntity.telecom
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/TEL
94. Participant1.associatedEntity.associatedPerson
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/Person
96. Participant1.associatedEntity.scopingOrganization
Comments	This associatedEntity SHALL contain exactly one [1..1] scopingOrganization (CONF:4537-43).
Control	1..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/Organization
Invariants	should-telecom: SHOULD contain telecom (`telecom.exists()`) should-addr: SHOULD contain addr (`addr.exists()`)
98. Participant1.associatedEntity.scopingOrganization.nullFlavor
Definition	If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control	0..1
Binding	The codes SHALL be taken from CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`)
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Exceptional Value Detail
100. Participant1.associatedEntity.scopingOrganization.realmCode
Definition	When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/CS
102. Participant1.associatedEntity.scopingOrganization.typeId
Definition	When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
Invariants	II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
104. Participant1.associatedEntity.scopingOrganization.typeId.nullFlavor
Definition	If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control	0..1
Binding	The codes SHALL be taken from CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`)
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Exceptional Value Detail
106. Participant1.associatedEntity.scopingOrganization.typeId.assigningAuthorityName
Definition	A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
Control	0..1
Type	string(st: Character String)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Assigning Authority Name
108. Participant1.associatedEntity.scopingOrganization.typeId.displayable
Definition	Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
Control	0..1
Type	boolean(bl: Boolean)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Displayable
110. Participant1.associatedEntity.scopingOrganization.typeId.root
Definition	Identifies the type as an HL7 Registered model
Control	1..1
Type	string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Root
Fixed Value	`2.16.840.1.113883.1.3`
112. Participant1.associatedEntity.scopingOrganization.typeId.extension
Definition	A character string as a unique identifier within the scope of the identifier root.
Control	1..1
Type	string(st: Character String)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Extension
114. Participant1.associatedEntity.scopingOrganization.templateId
Definition	When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
116. Participant1.associatedEntity.scopingOrganization.classCode
Control	0..1
Binding	The codes SHALL be taken from EntityClassOrganization (required to `http://terminology.hl7.org/ValueSet/v3-EntityClassOrganization`)
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Fixed Value	`ORG`
118. Participant1.associatedEntity.scopingOrganization.determinerCode
Control	0..1
Binding	The codes SHALL be taken from EntityDeterminer (required to `http://terminology.hl7.org/ValueSet/v3-EntityDeterminer`)
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Fixed Value	`INSTANCE`
120. Participant1.associatedEntity.scopingOrganization.id
Definition	The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Short	Logical id of this artifact
Comments	This scopingOrganization SHALL contain at least one [1..*] id (CONF:4537-50). Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.
Control	10..*1
Type	http://hl7.org/cda/stds/core/StructureDefinition/IIid
Is Modifier	false
122. Participant1.associatedEntity.scopingOrganization.name
Definition	A name associated with the organization.
Short	Name used for the organization
Comments	This scopingOrganization SHALL contain at least one [1..*] name (CONF:4537-51). If the name of an organization changes, consider putting the old name in the alias column so that it can still be located through searches.
Control	10..*1 This element is affected by the following invariants: org-1
Type	http://hl7.org/cda/stds/core/StructureDefinition/ONstring
Is Modifier	false
Requirements	Need to use the name as the label of the organization.
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
124. Participant1.associatedEntity.scopingOrganization.telecom
Comments	This scopingOrganization SHOULD contain zero or more [0..*] telecom (CONF:4537-52).
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/TEL
126. Participant1.associatedEntity.scopingOrganization.addr
Definition	Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc.
Short	Base for all types and resources
Comments	This scopingOrganization SHOULD contain zero or more [0..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:4537-47).
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address)
Is Modifier	false
Invariants	shall-city: SHALL contain exactly one [1..1] city (CONF:81-7292). (`nullFlavor.exists() or item.city.count() = 1`) shall-streetAddressLine: SHALL 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-use: SHOULD contain @use (`nullFlavor.exists() or use.exists()`) should-country: SHOULD contain country (`nullFlavor.exists() or item.country.exists()`) 81-7296: SHALL NOT have mixed content except for white space (CONF:81-7296) (`item.xmlText.empty()`) 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). (`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-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). (`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-max-ad-parts: SHALL 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)`)
128. Participant1.associatedEntity.scopingOrganization.standardIndustryClassCode
Control	0..1
Binding	For example codes, see OrganizationIndustryClassNAICS (example to `http://terminology.hl7.org/ValueSet/v3-OrganizationIndustryClassNAICS`)
Type	http://hl7.org/cda/stds/core/StructureDefinition/CE
130. Participant1.associatedEntity.scopingOrganization.asOrganizationPartOf
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/OrganizationPartOf

Guidance on how to interpret the contents of this table can be found here

0. Participant1
Definition	Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.
Short	Base for all types and resources
Control	1..1
Is Modifier	false
Logical Container	ClinicalDocument (CDA Class)
Validation	Instance of this type are validated by templateId
XML Format	In the XML format, this property has the namespace `urn:hl7-org:v3`.
2. Participant1.nullFlavor
Definition	If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control	0..1
Binding	The codes SHALL be taken from CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`)
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Exceptional Value Detail
4. Participant1.realmCode
Definition	When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/CS
6. Participant1.typeId
Definition	When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
Invariants	II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
8. Participant1.typeId.nullFlavor
Definition	If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control	0..1
Binding	The codes SHALL be taken from CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`)
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Exceptional Value Detail
10. Participant1.typeId.assigningAuthorityName
Definition	A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
Control	0..1
Type	string(st: Character String)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Assigning Authority Name
12. Participant1.typeId.displayable
Definition	Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
Control	0..1
Type	boolean(bl: Boolean)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Displayable
14. Participant1.typeId.root
Definition	Identifies the type as an HL7 Registered model
Control	1..1
Type	string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Root
Fixed Value	`2.16.840.1.113883.1.3`
16. Participant1.typeId.extension
Definition	A character string as a unique identifier within the scope of the identifier root.
Control	1..1
Type	string(st: Character String)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Extension
18. Participant1.templateId
Definition	When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question
Control	1..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
Slicing	This element introduces a set of slices on `Participant1.templateId`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ root value @ extension
20. Participant1.templateId:provenance-assembler
Slice Name	provenance-assembler
Definition	When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question
Control	1..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
22. Participant1.templateId:provenance-assembler.nullFlavor
Definition	If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control	0..1
Binding	The codes SHALL be taken from CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`)
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Exceptional Value Detail
24. Participant1.templateId:provenance-assembler.assigningAuthorityName
Definition	A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
Control	0..1
Type	string(st: Character String)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Assigning Authority Name
26. Participant1.templateId:provenance-assembler.displayable
Definition	Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
Control	0..1
Type	boolean(bl: Boolean)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Displayable
28. Participant1.templateId:provenance-assembler.root
Definition	A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.
Control	1..1
Type	string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Root
Pattern Value	`2.16.840.1.113883.10.20.22.5.7`
30. Participant1.templateId:provenance-assembler.extension
Definition	A character string as a unique identifier within the scope of the identifier root.
Control	1..1
Type	string(st: Character String)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Extension
Pattern Value	`2020-05-19`
32. Participant1.typeCode
Comments	SHALL contain exactly one [1..1] @typeCode="DEV" Device (CONF:4537-55).
Control	1..1
Binding	The codes SHALL be taken from CDAParticipationType (required to `http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType`)
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Fixed Value	`DEV`
34. Participant1.contextControlCode
Control	0..1
Binding	The codes SHALL be taken from CDAContextControl (required to `http://hl7.org/cda/stds/core/ValueSet/CDAContextControl`)
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Fixed Value	`OP`
36. Participant1.functionCode
Comments	SHALL contain exactly one [1..1] functionCode (CONF:4537-38).
Control	1..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/CE
38. Participant1.functionCode.nullFlavor
Definition	If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control	0..1
Binding	The codes SHALL be taken from CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`)
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Exceptional Value Detail
40. Participant1.functionCode.code
Definition	The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache.
Comments	This functionCode SHALL contain exactly one [1..1] @code="assembler" Assembler (CONF:4537-32972).
Control	1..1
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Code
Pattern Value	`assembler`
42. Participant1.functionCode.codeSystem
Definition	Specifies the code system that defines the code.
Comments	This functionCode SHALL contain exactly one [1..1] @codeSystem (CodeSystem: ProvenanceParticipantType urn:oid:2.16.840.1.113883.4.642.4.1131) (CONF:4537-41).
Control	1..1
Type	string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Code System
Pattern Value	`2.16.840.1.113883.4.642.4.1131`
44. Participant1.functionCode.codeSystemName
Definition	The common name of the coding system.
Control	0..1
Type	string(st: Character String)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Code System Name
46. Participant1.functionCode.codeSystemVersion
Definition	If applicable, a version descriptor defined specifically for the given code system.
Control	0..1
Type	string(st: Character String)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Code System Version
48. Participant1.functionCode.displayName
Definition	A name or title for the code, under which the sending system shows the code value to its users.
Control	0..1
Type	string(st: Character String)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Display Name
50. Participant1.functionCode.sdtcValueSet
Definition	The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.
Control	0..1
Type	string(oid: ISO Object Identifier)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`valueSet`.
52. Participant1.functionCode.sdtcValueSetVersion
Definition	The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept.
Control	0..1
Type	string(st: Character String)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`valueSetVersion`.
54. Participant1.functionCode.originalText
Definition	The text or phrase used as the basis for the coding.
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/ED
Label	Original Text
56. Participant1.functionCode.qualifier
Definition	Specifies additional codes that increase the specificity of the the primary code.
Control	0..0
Type	http://hl7.org/cda/stds/core/StructureDefinition/CR
Label	Qualifier
58. Participant1.functionCode.translation
Definition	A set of other concept descriptors that translate this concept descriptor into other code systems.
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/CD
XML Format	The type of this property is determined using the `xsi:type`attribute.
Label	Translation
60. Participant1.time
Comments	SHALL contain exactly one [1..1] time (CONF:4537-42).
Control	1..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
62. Participant1.associatedEntity
Short	The template does not require any elements from the associatedEntity since the information is recorded in the scopingOrganization.
Comments	SHALL contain exactly one [1..1] associatedEntity (CONF:4537-39).
Control	1..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/AssociatedEntity
64. Participant1.associatedEntity.nullFlavor
Definition	If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control	0..1
Binding	The codes SHALL be taken from CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`)
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Exceptional Value Detail
66. Participant1.associatedEntity.realmCode
Definition	When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/CS
68. Participant1.associatedEntity.typeId
Definition	When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
Invariants	II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
70. Participant1.associatedEntity.typeId.nullFlavor
Definition	If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control	0..1
Binding	The codes SHALL be taken from CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`)
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Exceptional Value Detail
72. Participant1.associatedEntity.typeId.assigningAuthorityName
Definition	A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
Control	0..1
Type	string(st: Character String)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Assigning Authority Name
74. Participant1.associatedEntity.typeId.displayable
Definition	Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
Control	0..1
Type	boolean(bl: Boolean)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Displayable
76. Participant1.associatedEntity.typeId.root
Definition	Identifies the type as an HL7 Registered model
Control	1..1
Type	string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Root
Fixed Value	`2.16.840.1.113883.1.3`
78. Participant1.associatedEntity.typeId.extension
Definition	A character string as a unique identifier within the scope of the identifier root.
Control	1..1
Type	string(st: Character String)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Extension
80. Participant1.associatedEntity.templateId
Definition	When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
82. Participant1.associatedEntity.classCode
Comments	This associatedEntity SHALL contain exactly one [1..1] @classCode="OWN" Owned Entity (CONF:4537-32973).
Control	1..1
Binding	The codes SHALL be taken from CDARoleClassAssociative (required to `http://hl7.org/cda/stds/core/ValueSet/CDARoleClassAssociative`)
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Fixed Value	`OWN`
84. Participant1.associatedEntity.id
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
86. Participant1.associatedEntity.sdtcIdentifiedBy
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy
XML Format	In the XML format, this property has the namespace `urn:hl7-org:sdtc`.In the XML format, this property has the actual name`identifiedBy`.
88. Participant1.associatedEntity.code
Control	0..1
Binding	For example codes, see CDARoleCode (example to `http://hl7.org/cda/stds/core/ValueSet/CDARoleCode`)
Type	http://hl7.org/cda/stds/core/StructureDefinition/CE
90. Participant1.associatedEntity.addr
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/AD
92. Participant1.associatedEntity.telecom
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/TEL
94. Participant1.associatedEntity.associatedPerson
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/Person
96. Participant1.associatedEntity.scopingOrganization
Comments	This associatedEntity SHALL contain exactly one [1..1] scopingOrganization (CONF:4537-43).
Control	1..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/Organization
Invariants	should-telecom: SHOULD contain telecom (`telecom.exists()`) should-addr: SHOULD contain addr (`addr.exists()`)
98. Participant1.associatedEntity.scopingOrganization.nullFlavor
Definition	If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control	0..1
Binding	The codes SHALL be taken from CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`)
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Exceptional Value Detail
100. Participant1.associatedEntity.scopingOrganization.realmCode
Definition	When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/CS
102. Participant1.associatedEntity.scopingOrganization.typeId
Definition	When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
Invariants	II-1: An II instance must have either a root or an nullFlavor. (`root.exists() or nullFlavor.exists()`)
104. Participant1.associatedEntity.scopingOrganization.typeId.nullFlavor
Definition	If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control	0..1
Binding	The codes SHALL be taken from CDANullFlavor (required to `http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor`)
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Exceptional Value Detail
106. Participant1.associatedEntity.scopingOrganization.typeId.assigningAuthorityName
Definition	A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
Control	0..1
Type	string(st: Character String)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Assigning Authority Name
108. Participant1.associatedEntity.scopingOrganization.typeId.displayable
Definition	Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
Control	0..1
Type	boolean(bl: Boolean)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Displayable
110. Participant1.associatedEntity.scopingOrganization.typeId.root
Definition	Identifies the type as an HL7 Registered model
Control	1..1
Type	string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Root
Fixed Value	`2.16.840.1.113883.1.3`
112. Participant1.associatedEntity.scopingOrganization.typeId.extension
Definition	A character string as a unique identifier within the scope of the identifier root.
Control	1..1
Type	string(st: Character String)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Label	Extension
114. Participant1.associatedEntity.scopingOrganization.templateId
Definition	When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
116. Participant1.associatedEntity.scopingOrganization.classCode
Control	0..1
Binding	The codes SHALL be taken from EntityClassOrganization (required to `http://terminology.hl7.org/ValueSet/v3-EntityClassOrganization`)
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Fixed Value	`ORG`
118. Participant1.associatedEntity.scopingOrganization.determinerCode
Control	0..1
Binding	The codes SHALL be taken from EntityDeterminer (required to `http://terminology.hl7.org/ValueSet/v3-EntityDeterminer`)
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
Fixed Value	`INSTANCE`
120. Participant1.associatedEntity.scopingOrganization.id
Comments	This scopingOrganization SHALL contain at least one [1..*] id (CONF:4537-50).
Control	1..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
122. Participant1.associatedEntity.scopingOrganization.name
Comments	This scopingOrganization SHALL contain at least one [1..*] name (CONF:4537-51).
Control	1..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/ON
124. Participant1.associatedEntity.scopingOrganization.telecom
Comments	This scopingOrganization SHOULD contain zero or more [0..*] telecom (CONF:4537-52).
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/TEL
126. Participant1.associatedEntity.scopingOrganization.addr
Definition	Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc.
Short	Base for all types and resources
Comments	This scopingOrganization SHOULD contain zero or more [0..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:4537-47).
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address)
Is Modifier	false
Invariants	shall-city: SHALL contain exactly one [1..1] city (CONF:81-7292). (`nullFlavor.exists() or item.city.count() = 1`) shall-streetAddressLine: SHALL 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-use: SHOULD contain @use (`nullFlavor.exists() or use.exists()`) should-country: SHOULD contain country (`nullFlavor.exists() or item.country.exists()`) 81-7296: SHALL NOT have mixed content except for white space (CONF:81-7296) (`item.xmlText.empty()`) 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). (`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-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). (`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-max-ad-parts: SHALL 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)`)
128. Participant1.associatedEntity.scopingOrganization.standardIndustryClassCode
Control	0..1
Binding	For example codes, see OrganizationIndustryClassNAICS (example to `http://terminology.hl7.org/ValueSet/v3-OrganizationIndustryClassNAICS`)
Type	http://hl7.org/cda/stds/core/StructureDefinition/CE
130. Participant1.associatedEntity.scopingOrganization.asOrganizationPartOf
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/OrganizationPartOf