Paramedicine Summary Of Care CDA
0.0.1-current - ci-build

Paramedicine Summary Of Care CDA, published by IHE Patient Care Coordination Technical Committee. This guide is not an authorized publication; it is the continuous build for version 0.0.1-current built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/IHE/PCC.PCSc/ and changes regularly. See the Directory of published versions

## Logical Model: IHE_PCC_CDA_Payers_Entry - Detailed Descriptions

Draft as of 2025-11-04

Definitions for the IHE.PCC.CDA.Payers.Entry logical model.

- Key Elements Table
- Differential Elements Table
- Snapshot Elements Table

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

0. Act
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`.
Invariants | should-text-ref-value: SHOULD contain text/reference/@value (`text.reference.value.exists()`) should-effectiveTime: SHOULD contain effectiveTime (`effectiveTime.exists()`)
2. Act.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. Act.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. Act.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. Act.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. Act.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. Act.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. Act.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. Act.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. Act.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 | 2..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
Slicing | This element introduces a set of slices on `Act.templateId`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ root value @ extension
20. Act.templateId:payer-act
Slice Name | payer-act
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. Act.templateId:payer-act.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. Act.templateId:payer-act.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. Act.templateId:payer-act.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. Act.templateId:payer-act.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.1.26`
30. Act.templateId:payer-act.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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 | Extension
32. Act.templateId:payers-entry
Slice Name | payers-entry
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
34. Act.templateId:payers-entry.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
36. Act.templateId:payers-entry.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
38. Act.templateId:payers-entry.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
40. Act.templateId:payers-entry.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 | `1.3.6.1.4.1.19376.1.5.3.1.4.18`
42. Act.templateId:payers-entry.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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 | Extension
44. Act.classCode
Comments | SHALL contain exactly one [1..1] @classCode="ACT" Act (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:4537-8872).
Control | 1..1
Binding | The codes SHALL be taken from XActClassDocumentEntryAct (2.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryAct|2.0.0` )
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 | `ACT`
46. Act.moodCode
Comments | SHALL contain exactly one [1..1] @moodCode="EVN" Event (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001 STATIC) (CONF:4537-8873).
Control | 1..1
Binding | The codes SHALL be taken from XDocumentActMood (2.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-xDocumentActMood|2.0.0` )
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 | `EVN`
48. Act.negationInd
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.
50. Act.id
Comments | If the root OID of Payer that assigned the identifier is unknown, a local OID can be assigned or a nullFlavor of UNK
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
52. Act.code
Comments | The <code> element should be present, and represents the type of coverage provided by the payer. Potential vocabularies to use include: HL7 ActCoverageType (2.16.840.1.113883.5.4) and X12 Data Element 1336 (2.16.840.1.113883.6.255.1336)
Control | 1..1
Binding | The codes SHOULD be taken from ActCoverageTypeCode (preferred to `http://terminology.hl7.org/ValueSet/v3-ActCoverageTypeCode` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD
Must Support | true
54. Act.text
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED
56. Act.text.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
58. Act.text.compression
Definition | Indicates whether the raw byte data is compressed, and what compression algorithm was used.
Control | 0..1
Binding | The codes SHALL be taken from CDACompressionAlgorithm (required to `http://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm` )
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 | Compression
60. Act.text.integrityCheck
Definition | The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created.
Control | 0..1
Type | base64Binary(bin: Binary Data)
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 | Integrity Check
62. Act.text.integrityCheckAlgorithm
Definition | Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage.
Control | 0..1
Binding | The codes SHALL be taken from IntegrityCheckAlgorithm (2.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0` )
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 | Integrity Check Algorithm
64. Act.text.language
Definition | For character based information the language property specifies the human language of the text.
Control | 0..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 | Language
66. Act.text.mediaType
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data.
Control | 0..1
Binding | For example codes, see MediaType (example to `http://terminology.hl7.org/ValueSet/v3-MediaType` )
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 | Media Type
68. Act.text.representation
Control | 0..1
Binding | The codes SHALL be taken from CDABinaryDataEncoding (required to `http://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding` )
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.
70. Act.text.xmlText
Definition | Data that is primarily intended for human interpretation or for further machine processing is outside the scope of HL7. This includes unformatted or formatted written language, multimedia data, or structured information as defined by a different standard (e.g., XML-signatures.)
Short | Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string.
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.
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 unadorned text.
72. Act.text.reference
Definition | A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
Label | Reference
Invariants | value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative (`value.exists() implies value.startsWith('#')`)
74. Act.text.thumbnail
Definition | An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED
Label | Thumbnail
76. Act.statusCode
Control | 1..1
Binding | The codes SHALL be taken from ActStatus (required to `http://terminology.hl7.org/ValueSet/v3-ActStatus` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
78. Act.statusCode.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
80. Act.statusCode.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.
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
Fixed Value | `completed`
82. Act.statusCode.codeSystem
Definition | Specifies the code system that defines the code.
Control | 0..0
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
84. Act.statusCode.codeSystemName
Definition | The common name of the coding system.
Control | 0..0
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
86. Act.statusCode.codeSystemVersion
Definition | If applicable, a version descriptor defined specifically for the given code system.
Control | 0..0
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
88. Act.statusCode.displayName
Definition | A name or title for the code, under which the sending system shows the code value to its users.
Control | 0..0
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
90. Act.statusCode.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`.
92. Act.statusCode.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`.
94. Act.statusCode.originalText
Definition | The text or phrase used as the basis for the coding.
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED
Label | Original Text
96. Act.statusCode.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
98. Act.statusCode.translation
Definition | A set of other concept descriptors that translate this concept descriptor into other code systems.
Control | 0..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
100. Act.effectiveTime
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
102. Act.priorityCode
Control | 0..1
Binding | For example codes, see ActPriority (example to `http://terminology.hl7.org/ValueSet/v3-ActPriority` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
104. Act.languageCode
Control | 0..1
Binding | The codes SHALL be taken from AllLanguages (required to `http://hl7.org/fhir/ValueSet/all-languages` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
106. Act.subject
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Subject
108. Act.specimen
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Specimen
110. Act.performer
Comments | The <performer> element shall be present to represent the payer of the coverage.
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Performer2
Slicing | This element introduces a set of slices on `Act.performer`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ templateId.root
112. Act.performer:payer
Slice Name | payer
Short | This performer represents the Payer.
Comments | SHALL contain exactly one [1..1] performer (CONF:4537-8906) such that it
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Performer2
114. Act.performer:payer.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
116. Act.performer:payer.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
118. Act.performer:payer.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()`)
120. Act.performer:payer.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
122. Act.performer:payer.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
124. Act.performer:payer.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
126. Act.performer:payer.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`
128. Act.performer:payer.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
130. Act.performer:payer.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
132. Act.performer:payer.typeCode
Control | 1..1
Binding | The codes SHALL be taken from ParticipationPhysicalPerformer (required to `http://terminology.hl7.org/ValueSet/v3-ParticipationPhysicalPerformer` )
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 | `PRF`
134. Act.performer:payer.sdtcFunctionCode
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
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`functionCode`.
136. Act.performer:payer.time
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
138. Act.performer:payer.modeCode
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
140. Act.performer:payer.assignedEntity
Comments | SHALL contain exactly one [1..1] assignedEntity (CONF:4537-8908).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
Invariants | should-code: SHOULD contain code (`code.exists()`) should-representedOrganization: SHOULD contain representedOrganization (`representedOrganization.exists()`)
142. Act.performer:payer.assignedEntity.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
144. Act.performer:payer.assignedEntity.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
146. Act.performer:payer.assignedEntity.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()`)
148. Act.performer:payer.assignedEntity.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
150. Act.performer:payer.assignedEntity.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
152. Act.performer:payer.assignedEntity.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
154. Act.performer:payer.assignedEntity.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`
156. Act.performer:payer.assignedEntity.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
158. Act.performer:payer.assignedEntity.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
160. Act.performer:payer.assignedEntity.classCode
Control | 1..1
Binding | The codes SHALL be taken from RoleClassAssignedEntity (required to `http://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `ASSIGNED`
162. Act.performer:payer.assignedEntity.id
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
Must Support | true
164. Act.performer:payer.assignedEntity.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`.
166. Act.performer:payer.assignedEntity.code
Comments | This assignedEntity SHOULD contain zero or one [0..1] code (CONF:4537-8914).
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
168. Act.performer:payer.assignedEntity.code.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..0
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
170. Act.performer:payer.assignedEntity.code.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.
Control | 1..1
Binding | Unless not suitable, these codes SHALL be taken from Payer Role Codes (extensible to `https://profiles.ihe.net/PCC/PSCc/ValueSet/Payer.Role.Codes.VS` )
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
172. Act.performer:payer.assignedEntity.code.codeSystem
Definition | Specifies the code system that defines the code.
Control | 0..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
174. Act.performer:payer.assignedEntity.code.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
176. Act.performer:payer.assignedEntity.code.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
178. Act.performer:payer.assignedEntity.code.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
180. Act.performer:payer.assignedEntity.code.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`.
182. Act.performer:payer.assignedEntity.code.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`.
184. Act.performer:payer.assignedEntity.code.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
186. Act.performer:payer.assignedEntity.code.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
188. Act.performer:payer.assignedEntity.code.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
190. Act.performer:payer.assignedEntity.addr
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD
Invariants | should-country: SHOULD contain country ()
192. Act.performer:payer.assignedEntity.telecom
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
Invariants | should-use: SHOULD contain @use (`nullFlavor.exists() or use.exists()`)
194. Act.performer:payer.assignedEntity.telecom.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
196. Act.performer:payer.assignedEntity.telecom.value
Control | 0..1
Type | url(url: Universal Resource Locator)
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.
198. Act.performer:payer.assignedEntity.telecom.useablePeriod
Definition | Specifies the periods of time during which the telecommunication address can be used. For a telephone number, this can indicate the time of day in which the party can be reached on that telephone. For a web address, it may specify a time range in which the web content is promised to be available under the given address.
Control | 0..*
Type | Choice of: http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
Default Type | http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
XML Format | The type of this property is determined using the `xsi:type`attribute.
Label | Useable Period
200. Act.performer:payer.assignedEntity.telecom.use
Definition | One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need.
Control | 1..*
Binding | The codes SHALL be taken from TelecommunicationAddressUse (2.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-TelecommunicationAddressUse|2.0.0` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
XML Format | In the XML format, this property is represented as an attribute.
Label | Use Code
202. Act.performer:payer.assignedEntity.assignedPerson
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Person
204. Act.performer:payer.assignedEntity.representedOrganization
Comments | This assignedEntity SHOULD contain zero or one [0..1] representedOrganization (CONF:4537-8912).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization
Invariants | should-name: SHOULD contain name (`name.exists()`)
206. Act.performer:payer.assignedEntity.representedOrganization.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
208. Act.performer:payer.assignedEntity.representedOrganization.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
210. Act.performer:payer.assignedEntity.representedOrganization.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()`)
212. Act.performer:payer.assignedEntity.representedOrganization.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
214. Act.performer:payer.assignedEntity.representedOrganization.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
216. Act.performer:payer.assignedEntity.representedOrganization.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
218. Act.performer:payer.assignedEntity.representedOrganization.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`
220. Act.performer:payer.assignedEntity.representedOrganization.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
222. Act.performer:payer.assignedEntity.representedOrganization.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
224. Act.performer:payer.assignedEntity.representedOrganization.classCode
Control | 1..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`
226. Act.performer:payer.assignedEntity.representedOrganization.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`
228. Act.performer:payer.assignedEntity.representedOrganization.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 | 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 | 0..*1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II id
Is Modifier | false
230. Act.performer:payer.assignedEntity.representedOrganization.name
Definition | A name associated with the organization.
Short | Name used for the organization
Comments | The representedOrganization, if present, SHOULD contain zero or one [0..1] name (CONF:4537-8913). 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/ON string
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()))
232. Act.performer:payer.assignedEntity.representedOrganization.telecom
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
234. Act.performer:payer.assignedEntity.representedOrganization.addr
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD
236. Act.performer:payer.assignedEntity.representedOrganization.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
238. Act.performer:payer.assignedEntity.representedOrganization.asOrganizationPartOf
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/OrganizationPartOf
240. Act.performer:payer.assignedEntity.sdtcPatient
Control | 0..1
Type | http://hl7.org/fhir/StructureDefinition/Base
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`patient`.
242. Act.performer:payer.assignedEntity.sdtcPatient.id
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.
244. Act.performer:guarantor
Slice Name | guarantor
Short | This performer represents the Guarantor.
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Performer2
Invariants | should-time: SHOULD contain time (`time.exists()`)
246. Act.performer:guarantor.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
248. Act.performer:guarantor.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
250. Act.performer:guarantor.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()`)
252. Act.performer:guarantor.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
254. Act.performer:guarantor.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
256. Act.performer:guarantor.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
258. Act.performer:guarantor.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`
260. Act.performer:guarantor.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
262. Act.performer:guarantor.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
264. Act.performer:guarantor.typeCode
Control | 1..1
Binding | The codes SHALL be taken from ParticipationPhysicalPerformer (required to `http://terminology.hl7.org/ValueSet/v3-ParticipationPhysicalPerformer` )
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 | `PRF`
266. Act.performer:guarantor.sdtcFunctionCode
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
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`functionCode`.
268. Act.performer:guarantor.time
Comments | SHOULD contain zero or one [0..1] time (CONF:4537-8963).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
270. Act.performer:guarantor.modeCode
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
272. Act.performer:guarantor.assignedEntity
Comments | SHALL contain exactly one [1..1] assignedEntity (CONF:4537-8962).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
Invariants | 4537-8967: **SHOULD** include assignedEntity/assignedPerson/name AND/OR assignedEntity/representedOrganization/name (CONF:4537-8967). (`assignedPerson.name.exists() or representedOrganization.name.exists()`) should-addr: SHOULD contain addr (`addr.exists()`) should-telecom: SHOULD contain telecom (`telecom.exists()`)
274. Act.performer:guarantor.assignedEntity.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
276. Act.performer:guarantor.assignedEntity.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
278. Act.performer:guarantor.assignedEntity.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()`)
280. Act.performer:guarantor.assignedEntity.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
282. Act.performer:guarantor.assignedEntity.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
284. Act.performer:guarantor.assignedEntity.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
286. Act.performer:guarantor.assignedEntity.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`
288. Act.performer:guarantor.assignedEntity.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
290. Act.performer:guarantor.assignedEntity.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
292. Act.performer:guarantor.assignedEntity.classCode
Control | 0..1
Binding | The codes SHALL be taken from RoleClassAssignedEntity (required to `http://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity` )
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 | `ASSIGNED`
294. Act.performer:guarantor.assignedEntity.id
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
296. Act.performer:guarantor.assignedEntity.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`.
298. Act.performer:guarantor.assignedEntity.code
Comments | This assignedEntity SHALL contain exactly one [1..1] code (CONF:4537-8968).
Control | 1..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
300. Act.performer:guarantor.assignedEntity.code.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
302. Act.performer:guarantor.assignedEntity.code.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 code SHALL contain exactly one [1..1] @code="GUAR" Guarantor (CONF:4537-16096).
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 | `GUAR`
304. Act.performer:guarantor.assignedEntity.code.codeSystem
Definition | Specifies the code system that defines the code.
Comments | This code SHALL contain exactly one [1..1] @codeSystem="2.16.840.1.113883.5.110" (CONF:4537-32165).
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.5.110`
306. Act.performer:guarantor.assignedEntity.code.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
308. Act.performer:guarantor.assignedEntity.code.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
310. Act.performer:guarantor.assignedEntity.code.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
312. Act.performer:guarantor.assignedEntity.code.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`.
314. Act.performer:guarantor.assignedEntity.code.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`.
316. Act.performer:guarantor.assignedEntity.code.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
318. Act.performer:guarantor.assignedEntity.code.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
320. Act.performer:guarantor.assignedEntity.code.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
322. Act.performer:guarantor.assignedEntity.addr
Comments | This assignedEntity SHOULD contain zero or one [0..1] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:4537-8964).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD
Invariants | should-country: SHOULD contain country ()
324. Act.performer:guarantor.assignedEntity.telecom
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
Invariants | should-use: SHOULD contain @use (`nullFlavor.exists() or use.exists()`)
326. Act.performer:guarantor.assignedEntity.telecom.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
328. Act.performer:guarantor.assignedEntity.telecom.value
Control | 0..1
Type | url(url: Universal Resource Locator)
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.
330. Act.performer:guarantor.assignedEntity.telecom.useablePeriod
Definition | Specifies the periods of time during which the telecommunication address can be used. For a telephone number, this can indicate the time of day in which the party can be reached on that telephone. For a web address, it may specify a time range in which the web content is promised to be available under the given address.
Control | 0..*
Type | Choice of: http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
Default Type | http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
XML Format | The type of this property is determined using the `xsi:type`attribute.
Label | Useable Period
332. Act.performer:guarantor.assignedEntity.telecom.use
Definition | One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need.
Control | 1..*
Binding | The codes SHALL be taken from TelecommunicationAddressUse (2.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-TelecommunicationAddressUse|2.0.0` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
XML Format | In the XML format, this property is represented as an attribute.
Label | Use Code
334. Act.performer:guarantor.assignedEntity.assignedPerson
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Person
336. Act.performer:guarantor.assignedEntity.representedOrganization
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization
338. Act.performer:guarantor.assignedEntity.sdtcPatient
Control | 0..1
Type | http://hl7.org/fhir/StructureDefinition/Base
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`patient`.
340. Act.performer:guarantor.assignedEntity.sdtcPatient.id
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.
342. Act.author
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Author
344. Act.informant
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Informant
346. Act.participant
Comments | SHOULD contain zero or one [0..1] participant (CONF:4537-8934) such that it
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Participant2
Slicing | This element introduces a set of slices on `Act.participant`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ typeCode
348. Act.participant:member
Slice Name | member
Short | participant
Comments | SHALL contain exactly one [1..1] participant (CONF:4537-8916) such that it
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Participant2
Invariants | should-time: SHOULD contain time (`time.exists()`)
350. Act.participant:member.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
352. Act.participant:member.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
354. Act.participant:member.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()`)
356. Act.participant:member.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
358. Act.participant:member.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
360. Act.participant:member.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
362. Act.participant:member.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`
364. Act.participant:member.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
366. Act.participant:member.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
368. Act.participant:member.typeCode
Comments | SHALL contain exactly one [1..1] @typeCode="COV" Coverage target (CodeSystem: HL7ParticipationType urn:oid:2.16.840.1.113883.5.90 STATIC) (CONF:4537-8917).
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 | `COV`
370. Act.participant:member.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`
372. Act.participant:member.sdtcFunctionCode
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
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`functionCode`.
374. Act.participant:member.time
Short | This records the policy coverage period or self-pay period.
Comments | SHOULD contain zero or one [0..1] time (CONF:4537-8918).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
Invariants | should-low: SHOULD contain low (`low.exists()`) should-high: SHOULD contain high (`high.exists()`)
376. Act.participant:member.time.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
378. Act.participant:member.time.value
Definition | A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression.
Control | 0..1
Type | dateTime(ts: Point in Time)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Date Format | YYYYMMDDHHMMSS.UUUU[+|-ZZzz]
XML Format | In the XML format, this property is represented as an attribute.
380. Act.participant:member.time.operator
Definition | A code specifying whether the set component is included (union) or excluded (set-difference) from the set, or other set operations with the current set component and the set as constructed from the representation stream up to the current point.
Control | 0..1
Binding | The codes SHALL be taken from CDASetOperator (required to `http://hl7.org/cda/stds/core/ValueSet/CDASetOperator` )
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.
Default Value | `I`
382. Act.participant:member.time.low
Definition | This is the low limit of the interval.
Comments | The time, if present, SHOULD contain zero or one [0..1] low (CONF:4537-8919).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS
Label | Low Boundary
384. Act.participant:member.time.center
Definition | The arithmetic mean of the interval (low plus high divided by 2). The purpose of distinguishing the center as a semantic property is for conversions of intervals from and to point values.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/TS
Label | Central Value
386. Act.participant:member.time.width
Definition | The difference between high and low boundary. The purpose of distinguishing a width property is to handle all cases of incomplete information symmetrically. In any interval representation only two of the three properties high, low, and width need to be stated and the third can be derived.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/PQ
Label | Width
388. Act.participant:member.time.high
Definition | This is the high limit of the interval.
Short | SHOULD contain high
Comments | The time, if present, SHOULD contain zero or one [0..1] high (CONF:4537-8920).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS
Label | High Boundary
390. Act.participant:member.awarenessCode
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
392. Act.participant:member.participantRole
Comments | SHALL contain exactly one [1..1] participantRole (CONF:4537-8921).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ParticipantRole
Invariants | should-addr: SHOULD contain addr (`addr.exists()`) should-playingEntity: SHOULD contain playingEntity (`playingEntity.exists()`)
394. Act.participant:member.participantRole.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
396. Act.participant:member.participantRole.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
398. Act.participant:member.participantRole.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()`)
400. Act.participant:member.participantRole.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
402. Act.participant:member.participantRole.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
404. Act.participant:member.participantRole.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
406. Act.participant:member.participantRole.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`
408. Act.participant:member.participantRole.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
410. Act.participant:member.participantRole.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
412. Act.participant:member.participantRole.classCode
Control | 0..1
Binding | The codes SHALL be taken from CDARoleClassRoot (required to `http://hl7.org/cda/stds/core/ValueSet/CDARoleClassRoot` )
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.
Default Value | `ROL`
414. Act.participant:member.participantRole.id
Comments | This participantRole SHALL contain at least one [1..*] id (CONF:4537-8922).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
Must Support | true
416. Act.participant:member.participantRole.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`.
418. Act.participant:member.participantRole.code
Control | 1..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
Must Support | true
Invariants | should-code-attr: SHOULD contain @code (`code.exists()`)
420. Act.participant:member.participantRole.code.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
422. Act.participant:member.participantRole.code.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.
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from Payer Role Codes (extensible to `https://profiles.ihe.net/PCC/PSCc/ValueSet/Payer.Role.Codes.VS` )
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
424. Act.participant:member.participantRole.code.codeSystem
Definition | Specifies the code system that defines the code.
Control | 0..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
426. Act.participant:member.participantRole.code.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
428. Act.participant:member.participantRole.code.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
430. Act.participant:member.participantRole.code.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
432. Act.participant:member.participantRole.code.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`.
434. Act.participant:member.participantRole.code.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`.
436. Act.participant:member.participantRole.code.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
438. Act.participant:member.participantRole.code.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
440. Act.participant:member.participantRole.code.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
442. Act.participant:member.participantRole.addr
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD
Must Support | true
Invariants | should-country: SHOULD contain country ()
444. Act.participant:member.participantRole.telecom
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
Invariants | should-use: SHOULD contain @use (`nullFlavor.exists() or use.exists()`)
446. Act.participant:member.participantRole.telecom.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
448. Act.participant:member.participantRole.telecom.value
Control | 0..1
Type | url(url: Universal Resource Locator)
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.
450. Act.participant:member.participantRole.telecom.useablePeriod
Definition | Specifies the periods of time during which the telecommunication address can be used. For a telephone number, this can indicate the time of day in which the party can be reached on that telephone. For a web address, it may specify a time range in which the web content is promised to be available under the given address.
Control | 0..*
Type | Choice of: http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
Default Type | http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
XML Format | The type of this property is determined using the `xsi:type`attribute.
Label | Useable Period
452. Act.participant:member.participantRole.telecom.use
Definition | One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need.
Control | 1..*
Binding | The codes SHALL be taken from TelecommunicationAddressUse (2.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-TelecommunicationAddressUse|2.0.0` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
XML Format | In the XML format, this property is represented as an attribute.
Label | Use Code
454. Act.participant:member.participantRole.playingDevice
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Device
456. Act.participant:member.participantRole.playingEntity
Short | This playingEntity records the covered party name and birthTime as represented by the health plan. This could match the information in recordTarget, or be different due to marriage or other reasons.
Comments | This participantRole SHOULD contain zero or one [0..1] playingEntity (CONF:4537-8932).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/PlayingEntity
458. Act.participant:member.participantRole.playingEntity.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
460. Act.participant:member.participantRole.playingEntity.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
462. Act.participant:member.participantRole.playingEntity.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()`)
464. Act.participant:member.participantRole.playingEntity.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
466. Act.participant:member.participantRole.playingEntity.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
468. Act.participant:member.participantRole.playingEntity.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
470. Act.participant:member.participantRole.playingEntity.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`
472. Act.participant:member.participantRole.playingEntity.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
474. Act.participant:member.participantRole.playingEntity.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
476. Act.participant:member.participantRole.playingEntity.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassRoot (required to `http://terminology.hl7.org/ValueSet/v3-EntityClassRoot` )
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.
Default Value | `ENT`
478. Act.participant:member.participantRole.playingEntity.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`
480. Act.participant:member.participantRole.playingEntity.code
Control | 0..1
Binding | For example codes, see CDAEntityCode (example to `http://hl7.org/cda/stds/core/ValueSet/CDAEntityCode` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
482. Act.participant:member.participantRole.playingEntity.quantity
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/PQ
484. Act.participant:member.participantRole.playingEntity.name
Comments | The playingEntity, if present, SHALL contain exactly one [1..1] name (CONF:4537-8930).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/PN
486. Act.participant:member.participantRole.playingEntity.sdtcBirthTime
Definition | The purpose of this extension is to allow the recording of the subscriber or member of a health plan in cases where the health plan eligibility system has different information on file than the provider does for the patient.
Short | sdtc:birthTime
Comments | The playingEntity, if present, SHALL contain exactly one [1..1] sdtc:birthTime (CONF:4537-31344).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/TS
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`birthTime`.
488. Act.participant:member.participantRole.playingEntity.desc
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED
490. Act.participant:member.participantRole.scopingEntity
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Entity
492. Act.participant:subscriber
Slice Name | subscriber
Short | When the Subscriber is the patient, the participant element describing the subscriber *SHALL NOT* be present. This information will be recorded instead in the data elements used to record member information.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Participant2
494. Act.participant:subscriber.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
496. Act.participant:subscriber.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
498. Act.participant:subscriber.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()`)
500. Act.participant:subscriber.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
502. Act.participant:subscriber.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
504. Act.participant:subscriber.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
506. Act.participant:subscriber.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`
508. Act.participant:subscriber.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
510. Act.participant:subscriber.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
512. Act.participant:subscriber.typeCode
Comments | SHALL contain exactly one [1..1] @typeCode="HLD" Holder (CodeSystem: HL7ParticipationType urn:oid:2.16.840.1.113883.5.90 STATIC) (CONF:4537-8935).
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 | `HLD`
514. Act.participant:subscriber.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`
516. Act.participant:subscriber.sdtcFunctionCode
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
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`functionCode`.
518. Act.participant:subscriber.time
Comments | MAY contain zero or one [0..1] time (CONF:4537-8938).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
520. Act.participant:subscriber.awarenessCode
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
522. Act.participant:subscriber.participantRole
Comments | SHALL contain exactly one [1..1] participantRole (CONF:4537-8936).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ParticipantRole
Invariants | should-addr: SHOULD contain addr (`addr.exists()`)
524. Act.participant:subscriber.participantRole.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
526. Act.participant:subscriber.participantRole.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
528. Act.participant:subscriber.participantRole.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()`)
530. Act.participant:subscriber.participantRole.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
532. Act.participant:subscriber.participantRole.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
534. Act.participant:subscriber.participantRole.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
536. Act.participant:subscriber.participantRole.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`
538. Act.participant:subscriber.participantRole.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
540. Act.participant:subscriber.participantRole.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
542. Act.participant:subscriber.participantRole.classCode
Control | 0..1
Binding | The codes SHALL be taken from CDARoleClassRoot (required to `http://hl7.org/cda/stds/core/ValueSet/CDARoleClassRoot` )
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.
Default Value | `ROL`
544. Act.participant:subscriber.participantRole.id
Comments | This participantRole SHALL contain at least one [1..*] id (CONF:4537-8937).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
Must Support | true
546. Act.participant:subscriber.participantRole.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`.
548. Act.participant:subscriber.participantRole.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
550. Act.participant:subscriber.participantRole.addr
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD
Invariants | should-country: SHOULD contain country ()
552. Act.participant:subscriber.participantRole.telecom
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
Invariants | should-use: SHOULD contain @use (`nullFlavor.exists() or use.exists()`)
554. Act.participant:subscriber.participantRole.telecom.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
556. Act.participant:subscriber.participantRole.telecom.value
Control | 0..1
Type | url(url: Universal Resource Locator)
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.
558. Act.participant:subscriber.participantRole.telecom.useablePeriod
Definition | Specifies the periods of time during which the telecommunication address can be used. For a telephone number, this can indicate the time of day in which the party can be reached on that telephone. For a web address, it may specify a time range in which the web content is promised to be available under the given address.
Control | 0..*
Type | Choice of: http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
Default Type | http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
XML Format | The type of this property is determined using the `xsi:type`attribute.
Label | Useable Period
560. Act.participant:subscriber.participantRole.telecom.use
Definition | One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need.
Control | 1..*
Binding | The codes SHALL be taken from TelecommunicationAddressUse (2.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-TelecommunicationAddressUse|2.0.0` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
XML Format | In the XML format, this property is represented as an attribute.
Label | Use Code
562. Act.participant:subscriber.participantRole.playingDevice
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Device
564. Act.participant:subscriber.participantRole.playingEntity
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/PlayingEntity
566. Act.participant:subscriber.participantRole.scopingEntity
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Entity
568. Act.entryRelationship
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
Slicing | This element introduces a set of slices on `Act.entryRelationship`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ act.moodCode
570. Act.entryRelationship:plan
Slice Name | plan
Short | Represents the Coverage Plan
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
572. Act.entryRelationship:plan.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
574. Act.entryRelationship:plan.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
576. Act.entryRelationship:plan.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()`)
578. Act.entryRelationship:plan.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
580. Act.entryRelationship:plan.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
582. Act.entryRelationship:plan.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
584. Act.entryRelationship:plan.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`
586. Act.entryRelationship:plan.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
588. Act.entryRelationship:plan.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
590. Act.entryRelationship:plan.typeCode
Control | 1..1
Binding | The codes SHALL be taken from x_ActRelationshipEntryRelationship (required to `http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship` )
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 | `REFR`
592. Act.entryRelationship:plan.inversionInd
Definition | The entryRelationship.inversionInd can be set to "true" to indicate that the relationship should be interpreted as if the roles of the source and target entries were reversed.
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.
594. Act.entryRelationship:plan.contextConductionInd
Definition | The entryRelationship.contextConductionInd differs from the otherwise common use of this attribute in that in all other cases where this attribute is used, the value is fixed at "true", whereas here the value is defaulted to "true", and can be changed to "false" when referencing an entry in the same document. Setting the context conduction to false when referencing an entry in the same document keeps clear the fact that the referenced object retains its original context.
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.
Default Value | `true`
596. Act.entryRelationship:plan.negationInd
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.
598. Act.entryRelationship:plan.sequenceNumber
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/INT
600. Act.entryRelationship:plan.seperatableInd
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/BL
602. Act.entryRelationship:plan.act
Comments | A description of the coverage plan SHALL contain one or more act/id, to represent the plan identifier, and an act/text with the name of the plan (CONF:4537-8943).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Act
604. Act.entryRelationship:plan.act.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
606. Act.entryRelationship:plan.act.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
608. Act.entryRelationship:plan.act.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()`)
610. Act.entryRelationship:plan.act.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
612. Act.entryRelationship:plan.act.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
614. Act.entryRelationship:plan.act.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
616. Act.entryRelationship:plan.act.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`
618. Act.entryRelationship:plan.act.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
620. Act.entryRelationship:plan.act.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
622. Act.entryRelationship:plan.act.classCode
Control | 1..1
Binding | The codes SHALL be taken from XActClassDocumentEntryAct (2.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryAct|2.0.0` )
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 | `ACT`
624. Act.entryRelationship:plan.act.moodCode
Control | 1..1
Binding | The codes SHALL be taken from XDocumentActMood (2.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-xDocumentActMood|2.0.0` )
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 | `DEF`
626. Act.entryRelationship:plan.act.negationInd
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.
628. Act.entryRelationship:plan.act.id
Short | Plan identifier
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
630. Act.entryRelationship:plan.act.code
Control | 1..1
Binding | For example codes, see v3 Code System ActCode (example to `http://terminology.hl7.org/ValueSet/v3-ActCode` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD
632. Act.entryRelationship:plan.act.text
Short | Name of the plan
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED
634. Act.entryRelationship:plan.act.statusCode
Control | 0..1
Binding | The codes SHALL be taken from ActStatus (required to `http://terminology.hl7.org/ValueSet/v3-ActStatus` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
636. Act.entryRelationship:plan.act.effectiveTime
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
638. Act.entryRelationship:plan.act.priorityCode
Control | 0..1
Binding | For example codes, see ActPriority (example to `http://terminology.hl7.org/ValueSet/v3-ActPriority` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
640. Act.entryRelationship:plan.act.languageCode
Control | 0..1
Binding | The codes SHALL be taken from AllLanguages (required to `http://hl7.org/fhir/ValueSet/all-languages` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
642. Act.entryRelationship:plan.act.subject
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Subject
644. Act.entryRelationship:plan.act.specimen
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Specimen
646. Act.entryRelationship:plan.act.performer
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Performer2
648. Act.entryRelationship:plan.act.author
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Author
650. Act.entryRelationship:plan.act.informant
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Informant
652. Act.entryRelationship:plan.act.participant
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Participant2
654. Act.entryRelationship:plan.act.entryRelationship
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
656. Act.entryRelationship:plan.act.reference
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Reference
658. Act.entryRelationship:plan.act.precondition
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Precondition
660. Act.entryRelationship:plan.act.sdtcPrecondition2
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Precondition2
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`precondition2`.
662. Act.entryRelationship:plan.act.sdtcInFulfillmentOf1
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/InFulfillmentOf1
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`inFulfillmentOf1`.
664. Act.entryRelationship:plan.encounter
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Encounter
666. Act.entryRelationship:plan.observation
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Observation
668. Act.entryRelationship:plan.observationMedia
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
670. Act.entryRelationship:plan.organizer
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organizer
672. Act.entryRelationship:plan.procedure
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Procedure
674. Act.entryRelationship:plan.regionOfInterest
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
676. Act.entryRelationship:plan.substanceAdministration
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
678. Act.entryRelationship:plan.supply
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Supply
680. Act.reference
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Reference
682. Act.precondition
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Precondition
684. Act.sdtcPrecondition2
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Precondition2
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`precondition2`.
686. Act.sdtcInFulfillmentOf1
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/InFulfillmentOf1
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`inFulfillmentOf1`.

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

0. Act
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`.
Invariants | should-text-ref-value: SHOULD contain text/reference/@value (`text.reference.value.exists()`) should-effectiveTime: SHOULD contain effectiveTime (`effectiveTime.exists()`)
2. Act.templateId
Control | 2..?
Slicing | This element introduces a set of slices on `Act.templateId`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ root value @ extension
4. Act.templateId:payer-act
Slice Name | payer-act
Control | 1..1
6. Act.templateId:payer-act.root
Control | 1..?
Pattern Value | `2.16.840.1.113883.10.20.1.26`
8. Act.templateId:payers-entry
Slice Name | payers-entry
Control | 1..1
10. Act.templateId:payers-entry.root
Control | 1..?
Pattern Value | `1.3.6.1.4.1.19376.1.5.3.1.4.18`
12. Act.classCode
Comments | SHALL contain exactly one [1..1] @classCode="ACT" Act (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:4537-8872).
Fixed Value | `ACT`
14. Act.moodCode
Comments | SHALL contain exactly one [1..1] @moodCode="EVN" Event (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001 STATIC) (CONF:4537-8873).
Fixed Value | `EVN`
16. Act.id
Comments | If the root OID of Payer that assigned the identifier is unknown, a local OID can be assigned or a nullFlavor of UNK
Control | 1..1
18. Act.code
Comments | The <code> element should be present, and represents the type of coverage provided by the payer. Potential vocabularies to use include: HL7 ActCoverageType (2.16.840.1.113883.5.4) and X12 Data Element 1336 (2.16.840.1.113883.6.255.1336)
Binding | The codes SHOULD be taken from ActCoverageTypeCode (preferred to `http://terminology.hl7.org/ValueSet/v3-ActCoverageTypeCode` )
Must Support | true
20. Act.text
22. Act.text.reference
Invariants | value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative (`value.exists() implies value.startsWith('#')`)
24. Act.statusCode
Control | 1..?
26. Act.statusCode.code
Control | 1..?
Fixed Value | `completed`
28. Act.performer
Comments | The <performer> element shall be present to represent the payer of the coverage.
Control | 1..?
Slicing | This element introduces a set of slices on `Act.performer`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ templateId.root
30. Act.performer:payer
Slice Name | payer
Short | This performer represents the Payer.
Comments | SHALL contain exactly one [1..1] performer (CONF:4537-8906) such that it
Control | 1..1
32. Act.performer:payer.typeCode
Control | 1..?
34. Act.performer:payer.assignedEntity
Comments | SHALL contain exactly one [1..1] assignedEntity (CONF:4537-8908).
Invariants | should-code: SHOULD contain code (`code.exists()`) should-representedOrganization: SHOULD contain representedOrganization (`representedOrganization.exists()`)
36. Act.performer:payer.assignedEntity.classCode
Control | 1..?
Must Support | true
38. Act.performer:payer.assignedEntity.id
Must Support | true
40. Act.performer:payer.assignedEntity.code
Comments | This assignedEntity SHOULD contain zero or one [0..1] code (CONF:4537-8914).
42. Act.performer:payer.assignedEntity.code.nullFlavor
Control | 0..0
44. Act.performer:payer.assignedEntity.code.code
Control | 1..?
Binding | Unless not suitable, these codes SHALL be taken from Payer Role Codes (extensible to `https://profiles.ihe.net/PCC/PSCc/ValueSet/Payer.Role.Codes.VS` )
46. Act.performer:payer.assignedEntity.addr
Control | 1..1
Invariants | should-country: SHOULD contain country ()
48. Act.performer:payer.assignedEntity.telecom
Invariants | should-use: SHOULD contain @use (`nullFlavor.exists() or use.exists()`)
50. Act.performer:payer.assignedEntity.telecom.use
Control | 1..?
Must Support | true
52. Act.performer:payer.assignedEntity.representedOrganization
Comments | This assignedEntity SHOULD contain zero or one [0..1] representedOrganization (CONF:4537-8912).
Invariants | should-name: SHOULD contain name (`name.exists()`)
54. Act.performer:payer.assignedEntity.representedOrganization.classCode
Control | 1..?
56. Act.performer:payer.assignedEntity.representedOrganization.name
Comments | The representedOrganization, if present, SHOULD contain zero or one [0..1] name (CONF:4537-8913).
Control | 1..1
58. Act.performer:guarantor
Slice Name | guarantor
Short | This performer represents the Guarantor.
Control | 0..*
Invariants | should-time: SHOULD contain time (`time.exists()`)
60. Act.performer:guarantor.typeCode
Control | 1..?
62. Act.performer:guarantor.time
Comments | SHOULD contain zero or one [0..1] time (CONF:4537-8963).
64. Act.performer:guarantor.assignedEntity
Comments | SHALL contain exactly one [1..1] assignedEntity (CONF:4537-8962).
Invariants | 4537-8967: **SHOULD** include assignedEntity/assignedPerson/name AND/OR assignedEntity/representedOrganization/name (CONF:4537-8967). (`assignedPerson.name.exists() or representedOrganization.name.exists()`) should-addr: SHOULD contain addr (`addr.exists()`) should-telecom: SHOULD contain telecom (`telecom.exists()`)
66. Act.performer:guarantor.assignedEntity.code
Comments | This assignedEntity SHALL contain exactly one [1..1] code (CONF:4537-8968).
Control | 1..?
68. Act.performer:guarantor.assignedEntity.code.code
Comments | This code SHALL contain exactly one [1..1] @code="GUAR" Guarantor (CONF:4537-16096).
Control | 1..?
Pattern Value | `GUAR`
70. Act.performer:guarantor.assignedEntity.code.codeSystem
Comments | This code SHALL contain exactly one [1..1] @codeSystem="2.16.840.1.113883.5.110" (CONF:4537-32165).
Control | 1..?
Pattern Value | `2.16.840.1.113883.5.110`
72. Act.performer:guarantor.assignedEntity.addr
Comments | This assignedEntity SHOULD contain zero or one [0..1] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:4537-8964).
Control | 0..1
Invariants | should-country: SHOULD contain country ()
74. Act.performer:guarantor.assignedEntity.telecom
Invariants | should-use: SHOULD contain @use (`nullFlavor.exists() or use.exists()`)
76. Act.performer:guarantor.assignedEntity.telecom.use
Control | 1..?
Must Support | true
78. Act.participant
Comments | SHOULD contain zero or one [0..1] participant (CONF:4537-8934) such that it
Control | 1..?
Slicing | This element introduces a set of slices on `Act.participant`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ typeCode
80. Act.participant:member
Slice Name | member
Short | participant
Comments | SHALL contain exactly one [1..1] participant (CONF:4537-8916) such that it
Control | 1..1
Invariants | should-time: SHOULD contain time (`time.exists()`)
82. Act.participant:member.typeCode
Comments | SHALL contain exactly one [1..1] @typeCode="COV" Coverage target (CodeSystem: HL7ParticipationType urn:oid:2.16.840.1.113883.5.90 STATIC) (CONF:4537-8917).
Fixed Value | `COV`
84. Act.participant:member.time
Short | This records the policy coverage period or self-pay period.
Comments | SHOULD contain zero or one [0..1] time (CONF:4537-8918).
Invariants | should-low: SHOULD contain low (`low.exists()`) should-high: SHOULD contain high (`high.exists()`)
86. Act.participant:member.time.low
Comments | The time, if present, SHOULD contain zero or one [0..1] low (CONF:4537-8919).
88. Act.participant:member.time.high
Short | SHOULD contain high
Comments | The time, if present, SHOULD contain zero or one [0..1] high (CONF:4537-8920).
90. Act.participant:member.participantRole
Comments | SHALL contain exactly one [1..1] participantRole (CONF:4537-8921).
Invariants | should-addr: SHOULD contain addr (`addr.exists()`) should-playingEntity: SHOULD contain playingEntity (`playingEntity.exists()`)
92. Act.participant:member.participantRole.id
Comments | This participantRole SHALL contain at least one [1..*] id (CONF:4537-8922).
Control | 1..?
Must Support | true
94. Act.participant:member.participantRole.code
Control | 1..?
Must Support | true
Invariants | should-code-attr: SHOULD contain @code (`code.exists()`)
96. Act.participant:member.participantRole.code.code
Binding | Unless not suitable, these codes SHALL be taken from Payer Role Codes (extensible to `https://profiles.ihe.net/PCC/PSCc/ValueSet/Payer.Role.Codes.VS` )
98. Act.participant:member.participantRole.addr
Control | 1..1
Must Support | true
Invariants | should-country: SHOULD contain country ()
100. Act.participant:member.participantRole.telecom
Invariants | should-use: SHOULD contain @use (`nullFlavor.exists() or use.exists()`)
102. Act.participant:member.participantRole.telecom.use
Control | 1..?
Must Support | true
104. Act.participant:member.participantRole.playingEntity
Short | This playingEntity records the covered party name and birthTime as represented by the health plan. This could match the information in recordTarget, or be different due to marriage or other reasons.
Comments | This participantRole SHOULD contain zero or one [0..1] playingEntity (CONF:4537-8932).
106. Act.participant:member.participantRole.playingEntity.name
Comments | The playingEntity, if present, SHALL contain exactly one [1..1] name (CONF:4537-8930).
Control | 1..1
108. Act.participant:member.participantRole.playingEntity.sdtcBirthTime
Short | sdtc:birthTime
Comments | The playingEntity, if present, SHALL contain exactly one [1..1] sdtc:birthTime (CONF:4537-31344).
Control | 1..?
110. Act.participant:subscriber
Slice Name | subscriber
Short | When the Subscriber is the patient, the participant element describing the subscriber *SHALL NOT* be present. This information will be recorded instead in the data elements used to record member information.
Control | 0..1
112. Act.participant:subscriber.typeCode
Comments | SHALL contain exactly one [1..1] @typeCode="HLD" Holder (CodeSystem: HL7ParticipationType urn:oid:2.16.840.1.113883.5.90 STATIC) (CONF:4537-8935).
Fixed Value | `HLD`
114. Act.participant:subscriber.time
Comments | MAY contain zero or one [0..1] time (CONF:4537-8938).
116. Act.participant:subscriber.participantRole
Comments | SHALL contain exactly one [1..1] participantRole (CONF:4537-8936).
Invariants | should-addr: SHOULD contain addr (`addr.exists()`)
118. Act.participant:subscriber.participantRole.id
Comments | This participantRole SHALL contain at least one [1..*] id (CONF:4537-8937).
Control | 1..1
Must Support | true
120. Act.participant:subscriber.participantRole.addr
Control | 1..1
Invariants | should-country: SHOULD contain country ()
122. Act.participant:subscriber.participantRole.telecom
Invariants | should-use: SHOULD contain @use (`nullFlavor.exists() or use.exists()`)
124. Act.participant:subscriber.participantRole.telecom.use
Control | 1..?
Must Support | true
126. Act.entryRelationship
Slicing | This element introduces a set of slices on `Act.entryRelationship`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ act.moodCode
128. Act.entryRelationship:plan
Slice Name | plan
Short | Represents the Coverage Plan
Control | 0..*
130. Act.entryRelationship:plan.typeCode
Fixed Value | `REFR`
132. Act.entryRelationship:plan.act
Comments | A description of the coverage plan SHALL contain one or more act/id, to represent the plan identifier, and an act/text with the name of the plan (CONF:4537-8943).
Control | 1..?
134. Act.entryRelationship:plan.act.classCode
Fixed Value | `ACT`
136. Act.entryRelationship:plan.act.moodCode
Fixed Value | `DEF`
138. Act.entryRelationship:plan.act.id
Short | Plan identifier
Control | 1..1
140. Act.entryRelationship:plan.act.text
Short | Name of the plan
Control | 1..?

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

0. Act
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`.
Invariants | should-text-ref-value: SHOULD contain text/reference/@value (`text.reference.value.exists()`) should-effectiveTime: SHOULD contain effectiveTime (`effectiveTime.exists()`)
2. Act.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. Act.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. Act.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. Act.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. Act.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. Act.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. Act.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. Act.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. Act.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 | 2..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
Slicing | This element introduces a set of slices on `Act.templateId`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ root value @ extension
20. Act.templateId:payer-act
Slice Name | payer-act
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. Act.templateId:payer-act.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. Act.templateId:payer-act.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. Act.templateId:payer-act.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. Act.templateId:payer-act.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.1.26`
30. Act.templateId:payer-act.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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 | Extension
32. Act.templateId:payers-entry
Slice Name | payers-entry
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
34. Act.templateId:payers-entry.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
36. Act.templateId:payers-entry.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
38. Act.templateId:payers-entry.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
40. Act.templateId:payers-entry.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 | `1.3.6.1.4.1.19376.1.5.3.1.4.18`
42. Act.templateId:payers-entry.extension
Definition | A character string as a unique identifier within the scope of the identifier root.
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 | Extension
44. Act.classCode
Comments | SHALL contain exactly one [1..1] @classCode="ACT" Act (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:4537-8872).
Control | 1..1
Binding | The codes SHALL be taken from XActClassDocumentEntryAct (2.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryAct|2.0.0` )
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 | `ACT`
46. Act.moodCode
Comments | SHALL contain exactly one [1..1] @moodCode="EVN" Event (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001 STATIC) (CONF:4537-8873).
Control | 1..1
Binding | The codes SHALL be taken from XDocumentActMood (2.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-xDocumentActMood|2.0.0` )
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 | `EVN`
48. Act.negationInd
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.
50. Act.id
Comments | If the root OID of Payer that assigned the identifier is unknown, a local OID can be assigned or a nullFlavor of UNK
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
52. Act.code
Comments | The <code> element should be present, and represents the type of coverage provided by the payer. Potential vocabularies to use include: HL7 ActCoverageType (2.16.840.1.113883.5.4) and X12 Data Element 1336 (2.16.840.1.113883.6.255.1336)
Control | 1..1
Binding | The codes SHOULD be taken from ActCoverageTypeCode (preferred to `http://terminology.hl7.org/ValueSet/v3-ActCoverageTypeCode` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD
Must Support | true
54. Act.text
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED
56. Act.text.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
58. Act.text.compression
Definition | Indicates whether the raw byte data is compressed, and what compression algorithm was used.
Control | 0..1
Binding | The codes SHALL be taken from CDACompressionAlgorithm (required to `http://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm` )
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 | Compression
60. Act.text.integrityCheck
Definition | The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created.
Control | 0..1
Type | base64Binary(bin: Binary Data)
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 | Integrity Check
62. Act.text.integrityCheckAlgorithm
Definition | Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage.
Control | 0..1
Binding | The codes SHALL be taken from IntegrityCheckAlgorithm (2.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0` )
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 | Integrity Check Algorithm
64. Act.text.language
Definition | For character based information the language property specifies the human language of the text.
Control | 0..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 | Language
66. Act.text.mediaType
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data.
Control | 0..1
Binding | For example codes, see MediaType (example to `http://terminology.hl7.org/ValueSet/v3-MediaType` )
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 | Media Type
68. Act.text.representation
Control | 0..1
Binding | The codes SHALL be taken from CDABinaryDataEncoding (required to `http://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding` )
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.
70. Act.text.xmlText
Definition | Data that is primarily intended for human interpretation or for further machine processing is outside the scope of HL7. This includes unformatted or formatted written language, multimedia data, or structured information as defined by a different standard (e.g., XML-signatures.)
Short | Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string.
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.
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 unadorned text.
72. Act.text.reference
Definition | A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
Label | Reference
Invariants | value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative (`value.exists() implies value.startsWith('#')`)
74. Act.text.thumbnail
Definition | An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED
Label | Thumbnail
76. Act.statusCode
Control | 1..1
Binding | The codes SHALL be taken from ActStatus (required to `http://terminology.hl7.org/ValueSet/v3-ActStatus` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
78. Act.statusCode.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
80. Act.statusCode.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.
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
Fixed Value | `completed`
82. Act.statusCode.codeSystem
Definition | Specifies the code system that defines the code.
Control | 0..0
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
84. Act.statusCode.codeSystemName
Definition | The common name of the coding system.
Control | 0..0
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
86. Act.statusCode.codeSystemVersion
Definition | If applicable, a version descriptor defined specifically for the given code system.
Control | 0..0
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
88. Act.statusCode.displayName
Definition | A name or title for the code, under which the sending system shows the code value to its users.
Control | 0..0
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
90. Act.statusCode.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`.
92. Act.statusCode.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`.
94. Act.statusCode.originalText
Definition | The text or phrase used as the basis for the coding.
Control | 0..0
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED
Label | Original Text
96. Act.statusCode.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
98. Act.statusCode.translation
Definition | A set of other concept descriptors that translate this concept descriptor into other code systems.
Control | 0..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
100. Act.effectiveTime
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
102. Act.priorityCode
Control | 0..1
Binding | For example codes, see ActPriority (example to `http://terminology.hl7.org/ValueSet/v3-ActPriority` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
104. Act.languageCode
Control | 0..1
Binding | The codes SHALL be taken from AllLanguages (required to `http://hl7.org/fhir/ValueSet/all-languages` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
106. Act.subject
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Subject
108. Act.specimen
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Specimen
110. Act.performer
Comments | The <performer> element shall be present to represent the payer of the coverage.
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Performer2
Slicing | This element introduces a set of slices on `Act.performer`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ templateId.root
112. Act.performer:payer
Slice Name | payer
Short | This performer represents the Payer.
Comments | SHALL contain exactly one [1..1] performer (CONF:4537-8906) such that it
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Performer2
114. Act.performer:payer.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
116. Act.performer:payer.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
118. Act.performer:payer.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()`)
120. Act.performer:payer.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
122. Act.performer:payer.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
124. Act.performer:payer.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
126. Act.performer:payer.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`
128. Act.performer:payer.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
130. Act.performer:payer.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
132. Act.performer:payer.typeCode
Control | 1..1
Binding | The codes SHALL be taken from ParticipationPhysicalPerformer (required to `http://terminology.hl7.org/ValueSet/v3-ParticipationPhysicalPerformer` )
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 | `PRF`
134. Act.performer:payer.sdtcFunctionCode
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
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`functionCode`.
136. Act.performer:payer.time
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
138. Act.performer:payer.modeCode
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
140. Act.performer:payer.assignedEntity
Comments | SHALL contain exactly one [1..1] assignedEntity (CONF:4537-8908).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
Invariants | should-code: SHOULD contain code (`code.exists()`) should-representedOrganization: SHOULD contain representedOrganization (`representedOrganization.exists()`)
142. Act.performer:payer.assignedEntity.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
144. Act.performer:payer.assignedEntity.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
146. Act.performer:payer.assignedEntity.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()`)
148. Act.performer:payer.assignedEntity.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
150. Act.performer:payer.assignedEntity.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
152. Act.performer:payer.assignedEntity.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
154. Act.performer:payer.assignedEntity.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`
156. Act.performer:payer.assignedEntity.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
158. Act.performer:payer.assignedEntity.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
160. Act.performer:payer.assignedEntity.classCode
Control | 1..1
Binding | The codes SHALL be taken from RoleClassAssignedEntity (required to `http://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
XML Format | In the XML format, this property is represented as an attribute.
Fixed Value | `ASSIGNED`
162. Act.performer:payer.assignedEntity.id
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
Must Support | true
164. Act.performer:payer.assignedEntity.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`.
166. Act.performer:payer.assignedEntity.code
Comments | This assignedEntity SHOULD contain zero or one [0..1] code (CONF:4537-8914).
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
168. Act.performer:payer.assignedEntity.code.nullFlavor
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
Control | 0..0
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
170. Act.performer:payer.assignedEntity.code.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.
Control | 1..1
Binding | Unless not suitable, these codes SHALL be taken from Payer Role Codes (extensible to `https://profiles.ihe.net/PCC/PSCc/ValueSet/Payer.Role.Codes.VS` )
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
172. Act.performer:payer.assignedEntity.code.codeSystem
Definition | Specifies the code system that defines the code.
Control | 0..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
174. Act.performer:payer.assignedEntity.code.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
176. Act.performer:payer.assignedEntity.code.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
178. Act.performer:payer.assignedEntity.code.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
180. Act.performer:payer.assignedEntity.code.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`.
182. Act.performer:payer.assignedEntity.code.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`.
184. Act.performer:payer.assignedEntity.code.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
186. Act.performer:payer.assignedEntity.code.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
188. Act.performer:payer.assignedEntity.code.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
190. Act.performer:payer.assignedEntity.addr
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD
Invariants | should-country: SHOULD contain country ()
192. Act.performer:payer.assignedEntity.telecom
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
Invariants | should-use: SHOULD contain @use (`nullFlavor.exists() or use.exists()`)
194. Act.performer:payer.assignedEntity.telecom.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
196. Act.performer:payer.assignedEntity.telecom.value
Control | 0..1
Type | url(url: Universal Resource Locator)
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.
198. Act.performer:payer.assignedEntity.telecom.useablePeriod
Definition | Specifies the periods of time during which the telecommunication address can be used. For a telephone number, this can indicate the time of day in which the party can be reached on that telephone. For a web address, it may specify a time range in which the web content is promised to be available under the given address.
Control | 0..*
Type | Choice of: http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
Default Type | http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
XML Format | The type of this property is determined using the `xsi:type`attribute.
Label | Useable Period
200. Act.performer:payer.assignedEntity.telecom.use
Definition | One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need.
Control | 1..*
Binding | The codes SHALL be taken from TelecommunicationAddressUse (2.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-TelecommunicationAddressUse|2.0.0` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
XML Format | In the XML format, this property is represented as an attribute.
Label | Use Code
202. Act.performer:payer.assignedEntity.assignedPerson
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Person
204. Act.performer:payer.assignedEntity.representedOrganization
Comments | This assignedEntity SHOULD contain zero or one [0..1] representedOrganization (CONF:4537-8912).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization
Invariants | should-name: SHOULD contain name (`name.exists()`)
206. Act.performer:payer.assignedEntity.representedOrganization.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
208. Act.performer:payer.assignedEntity.representedOrganization.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
210. Act.performer:payer.assignedEntity.representedOrganization.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()`)
212. Act.performer:payer.assignedEntity.representedOrganization.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
214. Act.performer:payer.assignedEntity.representedOrganization.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
216. Act.performer:payer.assignedEntity.representedOrganization.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
218. Act.performer:payer.assignedEntity.representedOrganization.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`
220. Act.performer:payer.assignedEntity.representedOrganization.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
222. Act.performer:payer.assignedEntity.representedOrganization.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
224. Act.performer:payer.assignedEntity.representedOrganization.classCode
Control | 1..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`
226. Act.performer:payer.assignedEntity.representedOrganization.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`
228. Act.performer:payer.assignedEntity.representedOrganization.id
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
230. Act.performer:payer.assignedEntity.representedOrganization.name
Comments | The representedOrganization, if present, SHOULD contain zero or one [0..1] name (CONF:4537-8913).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ON
232. Act.performer:payer.assignedEntity.representedOrganization.telecom
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
234. Act.performer:payer.assignedEntity.representedOrganization.addr
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD
236. Act.performer:payer.assignedEntity.representedOrganization.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
238. Act.performer:payer.assignedEntity.representedOrganization.asOrganizationPartOf
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/OrganizationPartOf
240. Act.performer:payer.assignedEntity.sdtcPatient
Control | 0..1
Type | http://hl7.org/fhir/StructureDefinition/Base
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`patient`.
242. Act.performer:payer.assignedEntity.sdtcPatient.id
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.
244. Act.performer:guarantor
Slice Name | guarantor
Short | This performer represents the Guarantor.
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Performer2
Invariants | should-time: SHOULD contain time (`time.exists()`)
246. Act.performer:guarantor.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
248. Act.performer:guarantor.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
250. Act.performer:guarantor.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()`)
252. Act.performer:guarantor.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
254. Act.performer:guarantor.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
256. Act.performer:guarantor.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
258. Act.performer:guarantor.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`
260. Act.performer:guarantor.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
262. Act.performer:guarantor.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
264. Act.performer:guarantor.typeCode
Control | 1..1
Binding | The codes SHALL be taken from ParticipationPhysicalPerformer (required to `http://terminology.hl7.org/ValueSet/v3-ParticipationPhysicalPerformer` )
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 | `PRF`
266. Act.performer:guarantor.sdtcFunctionCode
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
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`functionCode`.
268. Act.performer:guarantor.time
Comments | SHOULD contain zero or one [0..1] time (CONF:4537-8963).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
270. Act.performer:guarantor.modeCode
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
272. Act.performer:guarantor.assignedEntity
Comments | SHALL contain exactly one [1..1] assignedEntity (CONF:4537-8962).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity
Invariants | 4537-8967: **SHOULD** include assignedEntity/assignedPerson/name AND/OR assignedEntity/representedOrganization/name (CONF:4537-8967). (`assignedPerson.name.exists() or representedOrganization.name.exists()`) should-addr: SHOULD contain addr (`addr.exists()`) should-telecom: SHOULD contain telecom (`telecom.exists()`)
274. Act.performer:guarantor.assignedEntity.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
276. Act.performer:guarantor.assignedEntity.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
278. Act.performer:guarantor.assignedEntity.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()`)
280. Act.performer:guarantor.assignedEntity.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
282. Act.performer:guarantor.assignedEntity.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
284. Act.performer:guarantor.assignedEntity.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
286. Act.performer:guarantor.assignedEntity.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`
288. Act.performer:guarantor.assignedEntity.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
290. Act.performer:guarantor.assignedEntity.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
292. Act.performer:guarantor.assignedEntity.classCode
Control | 0..1
Binding | The codes SHALL be taken from RoleClassAssignedEntity (required to `http://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity` )
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 | `ASSIGNED`
294. Act.performer:guarantor.assignedEntity.id
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
296. Act.performer:guarantor.assignedEntity.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`.
298. Act.performer:guarantor.assignedEntity.code
Comments | This assignedEntity SHALL contain exactly one [1..1] code (CONF:4537-8968).
Control | 1..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
300. Act.performer:guarantor.assignedEntity.code.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
302. Act.performer:guarantor.assignedEntity.code.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 code SHALL contain exactly one [1..1] @code="GUAR" Guarantor (CONF:4537-16096).
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 | `GUAR`
304. Act.performer:guarantor.assignedEntity.code.codeSystem
Definition | Specifies the code system that defines the code.
Comments | This code SHALL contain exactly one [1..1] @codeSystem="2.16.840.1.113883.5.110" (CONF:4537-32165).
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.5.110`
306. Act.performer:guarantor.assignedEntity.code.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
308. Act.performer:guarantor.assignedEntity.code.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
310. Act.performer:guarantor.assignedEntity.code.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
312. Act.performer:guarantor.assignedEntity.code.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`.
314. Act.performer:guarantor.assignedEntity.code.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`.
316. Act.performer:guarantor.assignedEntity.code.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
318. Act.performer:guarantor.assignedEntity.code.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
320. Act.performer:guarantor.assignedEntity.code.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
322. Act.performer:guarantor.assignedEntity.addr
Comments | This assignedEntity SHOULD contain zero or one [0..1] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:4537-8964).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD
Invariants | should-country: SHOULD contain country ()
324. Act.performer:guarantor.assignedEntity.telecom
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
Invariants | should-use: SHOULD contain @use (`nullFlavor.exists() or use.exists()`)
326. Act.performer:guarantor.assignedEntity.telecom.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
328. Act.performer:guarantor.assignedEntity.telecom.value
Control | 0..1
Type | url(url: Universal Resource Locator)
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.
330. Act.performer:guarantor.assignedEntity.telecom.useablePeriod
Definition | Specifies the periods of time during which the telecommunication address can be used. For a telephone number, this can indicate the time of day in which the party can be reached on that telephone. For a web address, it may specify a time range in which the web content is promised to be available under the given address.
Control | 0..*
Type | Choice of: http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
Default Type | http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
XML Format | The type of this property is determined using the `xsi:type`attribute.
Label | Useable Period
332. Act.performer:guarantor.assignedEntity.telecom.use
Definition | One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need.
Control | 1..*
Binding | The codes SHALL be taken from TelecommunicationAddressUse (2.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-TelecommunicationAddressUse|2.0.0` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
XML Format | In the XML format, this property is represented as an attribute.
Label | Use Code
334. Act.performer:guarantor.assignedEntity.assignedPerson
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Person
336. Act.performer:guarantor.assignedEntity.representedOrganization
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization
338. Act.performer:guarantor.assignedEntity.sdtcPatient
Control | 0..1
Type | http://hl7.org/fhir/StructureDefinition/Base
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`patient`.
340. Act.performer:guarantor.assignedEntity.sdtcPatient.id
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
XML Format | In the XML format, this property has the namespace `urn:hl7-org:sdtc`.
342. Act.author
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Author
344. Act.informant
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Informant
346. Act.participant
Comments | SHOULD contain zero or one [0..1] participant (CONF:4537-8934) such that it
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Participant2
Slicing | This element introduces a set of slices on `Act.participant`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ typeCode
348. Act.participant:member
Slice Name | member
Short | participant
Comments | SHALL contain exactly one [1..1] participant (CONF:4537-8916) such that it
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Participant2
Invariants | should-time: SHOULD contain time (`time.exists()`)
350. Act.participant:member.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
352. Act.participant:member.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
354. Act.participant:member.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()`)
356. Act.participant:member.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
358. Act.participant:member.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
360. Act.participant:member.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
362. Act.participant:member.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`
364. Act.participant:member.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
366. Act.participant:member.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
368. Act.participant:member.typeCode
Comments | SHALL contain exactly one [1..1] @typeCode="COV" Coverage target (CodeSystem: HL7ParticipationType urn:oid:2.16.840.1.113883.5.90 STATIC) (CONF:4537-8917).
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 | `COV`
370. Act.participant:member.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`
372. Act.participant:member.sdtcFunctionCode
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
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`functionCode`.
374. Act.participant:member.time
Short | This records the policy coverage period or self-pay period.
Comments | SHOULD contain zero or one [0..1] time (CONF:4537-8918).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
Invariants | should-low: SHOULD contain low (`low.exists()`) should-high: SHOULD contain high (`high.exists()`)
376. Act.participant:member.time.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
378. Act.participant:member.time.value
Definition | A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression.
Control | 0..1
Type | dateTime(ts: Point in Time)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Date Format | YYYYMMDDHHMMSS.UUUU[+|-ZZzz]
XML Format | In the XML format, this property is represented as an attribute.
380. Act.participant:member.time.operator
Definition | A code specifying whether the set component is included (union) or excluded (set-difference) from the set, or other set operations with the current set component and the set as constructed from the representation stream up to the current point.
Control | 0..1
Binding | The codes SHALL be taken from CDASetOperator (required to `http://hl7.org/cda/stds/core/ValueSet/CDASetOperator` )
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.
Default Value | `I`
382. Act.participant:member.time.low
Definition | This is the low limit of the interval.
Comments | The time, if present, SHOULD contain zero or one [0..1] low (CONF:4537-8919).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS
Label | Low Boundary
384. Act.participant:member.time.center
Definition | The arithmetic mean of the interval (low plus high divided by 2). The purpose of distinguishing the center as a semantic property is for conversions of intervals from and to point values.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/TS
Label | Central Value
386. Act.participant:member.time.width
Definition | The difference between high and low boundary. The purpose of distinguishing a width property is to handle all cases of incomplete information symmetrically. In any interval representation only two of the three properties high, low, and width need to be stated and the third can be derived.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/PQ
Label | Width
388. Act.participant:member.time.high
Definition | This is the high limit of the interval.
Short | SHOULD contain high
Comments | The time, if present, SHOULD contain zero or one [0..1] high (CONF:4537-8920).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVXB-TS
Label | High Boundary
390. Act.participant:member.awarenessCode
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
392. Act.participant:member.participantRole
Comments | SHALL contain exactly one [1..1] participantRole (CONF:4537-8921).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ParticipantRole
Invariants | should-addr: SHOULD contain addr (`addr.exists()`) should-playingEntity: SHOULD contain playingEntity (`playingEntity.exists()`)
394. Act.participant:member.participantRole.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
396. Act.participant:member.participantRole.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
398. Act.participant:member.participantRole.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()`)
400. Act.participant:member.participantRole.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
402. Act.participant:member.participantRole.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
404. Act.participant:member.participantRole.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
406. Act.participant:member.participantRole.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`
408. Act.participant:member.participantRole.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
410. Act.participant:member.participantRole.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
412. Act.participant:member.participantRole.classCode
Control | 0..1
Binding | The codes SHALL be taken from CDARoleClassRoot (required to `http://hl7.org/cda/stds/core/ValueSet/CDARoleClassRoot` )
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.
Default Value | `ROL`
414. Act.participant:member.participantRole.id
Comments | This participantRole SHALL contain at least one [1..*] id (CONF:4537-8922).
Control | 1..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
Must Support | true
416. Act.participant:member.participantRole.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`.
418. Act.participant:member.participantRole.code
Control | 1..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
Must Support | true
Invariants | should-code-attr: SHOULD contain @code (`code.exists()`)
420. Act.participant:member.participantRole.code.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
422. Act.participant:member.participantRole.code.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.
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from Payer Role Codes (extensible to `https://profiles.ihe.net/PCC/PSCc/ValueSet/Payer.Role.Codes.VS` )
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
424. Act.participant:member.participantRole.code.codeSystem
Definition | Specifies the code system that defines the code.
Control | 0..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
426. Act.participant:member.participantRole.code.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
428. Act.participant:member.participantRole.code.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
430. Act.participant:member.participantRole.code.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
432. Act.participant:member.participantRole.code.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`.
434. Act.participant:member.participantRole.code.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`.
436. Act.participant:member.participantRole.code.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
438. Act.participant:member.participantRole.code.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
440. Act.participant:member.participantRole.code.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
442. Act.participant:member.participantRole.addr
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD
Must Support | true
Invariants | should-country: SHOULD contain country ()
444. Act.participant:member.participantRole.telecom
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
Invariants | should-use: SHOULD contain @use (`nullFlavor.exists() or use.exists()`)
446. Act.participant:member.participantRole.telecom.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
448. Act.participant:member.participantRole.telecom.value
Control | 0..1
Type | url(url: Universal Resource Locator)
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.
450. Act.participant:member.participantRole.telecom.useablePeriod
Definition | Specifies the periods of time during which the telecommunication address can be used. For a telephone number, this can indicate the time of day in which the party can be reached on that telephone. For a web address, it may specify a time range in which the web content is promised to be available under the given address.
Control | 0..*
Type | Choice of: http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
Default Type | http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
XML Format | The type of this property is determined using the `xsi:type`attribute.
Label | Useable Period
452. Act.participant:member.participantRole.telecom.use
Definition | One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need.
Control | 1..*
Binding | The codes SHALL be taken from TelecommunicationAddressUse (2.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-TelecommunicationAddressUse|2.0.0` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
XML Format | In the XML format, this property is represented as an attribute.
Label | Use Code
454. Act.participant:member.participantRole.playingDevice
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Device
456. Act.participant:member.participantRole.playingEntity
Short | This playingEntity records the covered party name and birthTime as represented by the health plan. This could match the information in recordTarget, or be different due to marriage or other reasons.
Comments | This participantRole SHOULD contain zero or one [0..1] playingEntity (CONF:4537-8932).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/PlayingEntity
458. Act.participant:member.participantRole.playingEntity.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
460. Act.participant:member.participantRole.playingEntity.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
462. Act.participant:member.participantRole.playingEntity.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()`)
464. Act.participant:member.participantRole.playingEntity.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
466. Act.participant:member.participantRole.playingEntity.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
468. Act.participant:member.participantRole.playingEntity.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
470. Act.participant:member.participantRole.playingEntity.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`
472. Act.participant:member.participantRole.playingEntity.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
474. Act.participant:member.participantRole.playingEntity.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
476. Act.participant:member.participantRole.playingEntity.classCode
Control | 0..1
Binding | The codes SHALL be taken from EntityClassRoot (required to `http://terminology.hl7.org/ValueSet/v3-EntityClassRoot` )
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.
Default Value | `ENT`
478. Act.participant:member.participantRole.playingEntity.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`
480. Act.participant:member.participantRole.playingEntity.code
Control | 0..1
Binding | For example codes, see CDAEntityCode (example to `http://hl7.org/cda/stds/core/ValueSet/CDAEntityCode` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
482. Act.participant:member.participantRole.playingEntity.quantity
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/PQ
484. Act.participant:member.participantRole.playingEntity.name
Comments | The playingEntity, if present, SHALL contain exactly one [1..1] name (CONF:4537-8930).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/PN
486. Act.participant:member.participantRole.playingEntity.sdtcBirthTime
Definition | The purpose of this extension is to allow the recording of the subscriber or member of a health plan in cases where the health plan eligibility system has different information on file than the provider does for the patient.
Short | sdtc:birthTime
Comments | The playingEntity, if present, SHALL contain exactly one [1..1] sdtc:birthTime (CONF:4537-31344).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/TS
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`birthTime`.
488. Act.participant:member.participantRole.playingEntity.desc
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED
490. Act.participant:member.participantRole.scopingEntity
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Entity
492. Act.participant:subscriber
Slice Name | subscriber
Short | When the Subscriber is the patient, the participant element describing the subscriber *SHALL NOT* be present. This information will be recorded instead in the data elements used to record member information.
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Participant2
494. Act.participant:subscriber.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
496. Act.participant:subscriber.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
498. Act.participant:subscriber.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()`)
500. Act.participant:subscriber.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
502. Act.participant:subscriber.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
504. Act.participant:subscriber.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
506. Act.participant:subscriber.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`
508. Act.participant:subscriber.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
510. Act.participant:subscriber.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
512. Act.participant:subscriber.typeCode
Comments | SHALL contain exactly one [1..1] @typeCode="HLD" Holder (CodeSystem: HL7ParticipationType urn:oid:2.16.840.1.113883.5.90 STATIC) (CONF:4537-8935).
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 | `HLD`
514. Act.participant:subscriber.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`
516. Act.participant:subscriber.sdtcFunctionCode
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
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`functionCode`.
518. Act.participant:subscriber.time
Comments | MAY contain zero or one [0..1] time (CONF:4537-8938).
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
520. Act.participant:subscriber.awarenessCode
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
522. Act.participant:subscriber.participantRole
Comments | SHALL contain exactly one [1..1] participantRole (CONF:4537-8936).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ParticipantRole
Invariants | should-addr: SHOULD contain addr (`addr.exists()`)
524. Act.participant:subscriber.participantRole.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
526. Act.participant:subscriber.participantRole.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
528. Act.participant:subscriber.participantRole.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()`)
530. Act.participant:subscriber.participantRole.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
532. Act.participant:subscriber.participantRole.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
534. Act.participant:subscriber.participantRole.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
536. Act.participant:subscriber.participantRole.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`
538. Act.participant:subscriber.participantRole.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
540. Act.participant:subscriber.participantRole.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
542. Act.participant:subscriber.participantRole.classCode
Control | 0..1
Binding | The codes SHALL be taken from CDARoleClassRoot (required to `http://hl7.org/cda/stds/core/ValueSet/CDARoleClassRoot` )
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.
Default Value | `ROL`
544. Act.participant:subscriber.participantRole.id
Comments | This participantRole SHALL contain at least one [1..*] id (CONF:4537-8937).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
Must Support | true
546. Act.participant:subscriber.participantRole.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`.
548. Act.participant:subscriber.participantRole.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
550. Act.participant:subscriber.participantRole.addr
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD
Invariants | should-country: SHOULD contain country ()
552. Act.participant:subscriber.participantRole.telecom
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL
Invariants | should-use: SHOULD contain @use (`nullFlavor.exists() or use.exists()`)
554. Act.participant:subscriber.participantRole.telecom.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
556. Act.participant:subscriber.participantRole.telecom.value
Control | 0..1
Type | url(url: Universal Resource Locator)
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.
558. Act.participant:subscriber.participantRole.telecom.useablePeriod
Definition | Specifies the periods of time during which the telecommunication address can be used. For a telephone number, this can indicate the time of day in which the party can be reached on that telephone. For a web address, it may specify a time range in which the web content is promised to be available under the given address.
Control | 0..*
Type | Choice of: http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
Default Type | http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS
XML Format | The type of this property is determined using the `xsi:type`attribute.
Label | Useable Period
560. Act.participant:subscriber.participantRole.telecom.use
Definition | One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need.
Control | 1..*
Binding | The codes SHALL be taken from TelecommunicationAddressUse (2.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-TelecommunicationAddressUse|2.0.0` )
Type | code(cs: Coded Simple Value)
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
XML Format | In the XML format, this property is represented as an attribute.
Label | Use Code
562. Act.participant:subscriber.participantRole.playingDevice
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Device
564. Act.participant:subscriber.participantRole.playingEntity
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/PlayingEntity
566. Act.participant:subscriber.participantRole.scopingEntity
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Entity
568. Act.entryRelationship
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
Slicing | This element introduces a set of slices on `Act.entryRelationship`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ act.moodCode
570. Act.entryRelationship:plan
Slice Name | plan
Short | Represents the Coverage Plan
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
572. Act.entryRelationship:plan.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
574. Act.entryRelationship:plan.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
576. Act.entryRelationship:plan.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()`)
578. Act.entryRelationship:plan.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
580. Act.entryRelationship:plan.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
582. Act.entryRelationship:plan.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
584. Act.entryRelationship:plan.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`
586. Act.entryRelationship:plan.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
588. Act.entryRelationship:plan.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
590. Act.entryRelationship:plan.typeCode
Control | 1..1
Binding | The codes SHALL be taken from x_ActRelationshipEntryRelationship (required to `http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship` )
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 | `REFR`
592. Act.entryRelationship:plan.inversionInd
Definition | The entryRelationship.inversionInd can be set to "true" to indicate that the relationship should be interpreted as if the roles of the source and target entries were reversed.
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.
594. Act.entryRelationship:plan.contextConductionInd
Definition | The entryRelationship.contextConductionInd differs from the otherwise common use of this attribute in that in all other cases where this attribute is used, the value is fixed at "true", whereas here the value is defaulted to "true", and can be changed to "false" when referencing an entry in the same document. Setting the context conduction to false when referencing an entry in the same document keeps clear the fact that the referenced object retains its original context.
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.
Default Value | `true`
596. Act.entryRelationship:plan.negationInd
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.
598. Act.entryRelationship:plan.sequenceNumber
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/INT
600. Act.entryRelationship:plan.seperatableInd
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/BL
602. Act.entryRelationship:plan.act
Comments | A description of the coverage plan SHALL contain one or more act/id, to represent the plan identifier, and an act/text with the name of the plan (CONF:4537-8943).
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Act
604. Act.entryRelationship:plan.act.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
606. Act.entryRelationship:plan.act.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
608. Act.entryRelationship:plan.act.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()`)
610. Act.entryRelationship:plan.act.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
612. Act.entryRelationship:plan.act.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
614. Act.entryRelationship:plan.act.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
616. Act.entryRelationship:plan.act.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`
618. Act.entryRelationship:plan.act.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
620. Act.entryRelationship:plan.act.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
622. Act.entryRelationship:plan.act.classCode
Control | 1..1
Binding | The codes SHALL be taken from XActClassDocumentEntryAct (2.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryAct|2.0.0` )
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 | `ACT`
624. Act.entryRelationship:plan.act.moodCode
Control | 1..1
Binding | The codes SHALL be taken from XDocumentActMood (2.0.0) (required to `http://terminology.hl7.org/ValueSet/v3-xDocumentActMood|2.0.0` )
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 | `DEF`
626. Act.entryRelationship:plan.act.negationInd
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.
628. Act.entryRelationship:plan.act.id
Short | Plan identifier
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/II
630. Act.entryRelationship:plan.act.code
Control | 1..1
Binding | For example codes, see v3 Code System ActCode (example to `http://terminology.hl7.org/ValueSet/v3-ActCode` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD
632. Act.entryRelationship:plan.act.text
Short | Name of the plan
Control | 1..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED
634. Act.entryRelationship:plan.act.statusCode
Control | 0..1
Binding | The codes SHALL be taken from ActStatus (required to `http://terminology.hl7.org/ValueSet/v3-ActStatus` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
636. Act.entryRelationship:plan.act.effectiveTime
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
638. Act.entryRelationship:plan.act.priorityCode
Control | 0..1
Binding | For example codes, see ActPriority (example to `http://terminology.hl7.org/ValueSet/v3-ActPriority` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE
640. Act.entryRelationship:plan.act.languageCode
Control | 0..1
Binding | The codes SHALL be taken from AllLanguages (required to `http://hl7.org/fhir/ValueSet/all-languages` )
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS
642. Act.entryRelationship:plan.act.subject
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Subject
644. Act.entryRelationship:plan.act.specimen
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Specimen
646. Act.entryRelationship:plan.act.performer
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Performer2
648. Act.entryRelationship:plan.act.author
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Author
650. Act.entryRelationship:plan.act.informant
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Informant
652. Act.entryRelationship:plan.act.participant
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Participant2
654. Act.entryRelationship:plan.act.entryRelationship
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
656. Act.entryRelationship:plan.act.reference
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Reference
658. Act.entryRelationship:plan.act.precondition
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Precondition
660. Act.entryRelationship:plan.act.sdtcPrecondition2
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Precondition2
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`precondition2`.
662. Act.entryRelationship:plan.act.sdtcInFulfillmentOf1
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/InFulfillmentOf1
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`inFulfillmentOf1`.
664. Act.entryRelationship:plan.encounter
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Encounter
666. Act.entryRelationship:plan.observation
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Observation
668. Act.entryRelationship:plan.observationMedia
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
670. Act.entryRelationship:plan.organizer
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organizer
672. Act.entryRelationship:plan.procedure
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Procedure
674. Act.entryRelationship:plan.regionOfInterest
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
676. Act.entryRelationship:plan.substanceAdministration
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
678. Act.entryRelationship:plan.supply
Control | 0..1
Type | http://hl7.org/cda/stds/core/StructureDefinition/Supply
680. Act.reference
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Reference
682. Act.precondition
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Precondition
684. Act.sdtcPrecondition2
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/Precondition2
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`precondition2`.
686. Act.sdtcInFulfillmentOf1
Control | 0..*
Type | http://hl7.org/cda/stds/core/StructureDefinition/InFulfillmentOf1
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`inFulfillmentOf1`.