Consolidated CDA (C-CDA)
3.0.0 - STU3
Consolidated CDA (C-CDA)
3.0.0 - STU3
This page is part of the CCDA: Consolidated CDA Release (v3.0.0: CCDA 3.0) generated with FHIR (HL7® FHIR® Standard) v5.0.0. This is the current published version. For a full list of available versions, see the Directory of published versions
| Draft as of 2024-05-18 |
Definitions for the PolicyActivity logical model.
Guidance on how to interpret the contents of this table can be found here
| 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())4537-17139: When the Subscriber is the patient (COV participant code = 'SELF'), 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 (CONF:4537-17139). ( participant.where(typeCode='COV').participantRole.code.where(code = 'SELF').exists() implies participant.where(typeCode='HLD').empty()) |
| 2. Act.templateId | |
| Control | 1..? |
| Slicing | This element introduces a set of slices on Act.templateId. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 4. Act.templateId:policy-activity | |
| Slice Name | policy-activity |
| Control | 1..1 |
| 6. Act.templateId:policy-activity.root | |
| Control | 1..? |
| Pattern Value | 2.16.840.1.113883.10.20.22.4.61 |
| 8. Act.templateId:policy-activity.extension | |
| Control | 1..? |
| Pattern Value | 2024-05-01 |
| 10. 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-8898). |
| Fixed Value | ACT |
| 12. 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-8899). |
| Fixed Value | EVN |
| 14. Act.id | |
| Short | (USCDI) **GROUP NUMBER**: This is the identifier used to uniquely refer to a specific health insurance plan. |
| Comments | SHALL contain at least one [1..*] id (CONF:4537-8901). |
| Control | 1..? |
| 16. Act.code | |
| 18. Act.code.code | |
| Binding | The codes SHOULD be taken from Payer Type  (preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.3591) |
| 20. Act.text | |
| Short | SHOULD reference the portion of section narrative text corresponding to this entry |
| 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 | |
| Comments | SHALL contain exactly one [1..1] statusCode (CONF:4537-8902). |
| Control | 1..? |
| 26. Act.statusCode.code | |
| Comments | This statusCode SHALL contain exactly one [1..1] @code="completed" Completed (CodeSystem: HL7ActStatus urn:oid:2.16.840.1.113883.5.14 STATIC) (CONF:4537-19109). |
| Control | 1..? |
| Fixed Value | completed |
| 28. Act.performer | |
| Comments | SHOULD contain zero or more [0..*] performer (CONF:4537-8961) such that it |
| 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: |
| 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.templateId | |
| Comments | SHALL contain exactly one [1..1] templateId (CONF:4537-16808), SHALL not contain [0..0] extension.. |
| Control | 1..1 |
| 34. Act.performer:payer.templateId.root | |
| Comments | This templateId SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.87" Payer Performer (CONF:4537-16809). |
| Control | 1..? |
| Pattern Value | 2.16.840.1.113883.10.20.22.4.87 |
| 36. Act.performer:payer.templateId.extension | |
| Control | 0..0 |
| 38. Act.performer:payer.typeCode | |
| Control | 1..? |
| 40. 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()) |
| 42. Act.performer:payer.assignedEntity.id | |
| Short | (USCDI) **PAYER IDENTIFIER**: This is the Payer id. The root is a unique identifier to an openly available assigning authority, such as National Association of Insurance Commissioners (NAIC) (2.16.840.1.113883.6.300), and the extension identifiers the payer within that authority. |
| Comments | This assignedEntity SHALL contain at least one [1..*] id (CONF:4537-8909). |
| 44. Act.performer:payer.assignedEntity.code | |
| Comments | This assignedEntity SHOULD contain zero or one [0..1] code (CONF:4537-8914). |
| 46. Act.performer:payer.assignedEntity.code.nullFlavor | |
| Control | 0..0 |
| 48. Act.performer:payer.assignedEntity.code.code | |
| Control | 1..? |
| Binding | The codes SHOULD be taken from Financially Responsible Party Type Value Set (preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.10416) |
| 50. Act.performer:payer.assignedEntity.addr | |
| Comments | This assignedEntity MAY 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-8910). |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address) |
| 52. Act.performer:payer.assignedEntity.telecom | |
| Comments | This assignedEntity MAY contain zero or more [0..*] telecom (CONF:4537-8911). |
| 54. 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()) |
| 56. Act.performer:payer.assignedEntity.representedOrganization.name | |
| Comments | The representedOrganization, if present, SHOULD contain zero or one [0..1] name (CONF:4537-8913). |
| Control | 0..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.templateId | |
| Comments | SHALL contain exactly one [1..1] templateId (CONF:4537-16810), SHALL not contain [0..0] extension. |
| Control | 1..1 |
| 62. Act.performer:guarantor.templateId.root | |
| Comments | This templateId SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.88" Guarantor Performer (CONF:4537-16811). |
| Control | 1..? |
| Pattern Value | 2.16.840.1.113883.10.20.22.4.88 |
| 64. Act.performer:guarantor.templateId.extension | |
| Control | 0..0 |
| 66. Act.performer:guarantor.typeCode | |
| Control | 1..? |
| 68. Act.performer:guarantor.time | |
| Comments | SHOULD contain zero or one [0..1] time (CONF:4537-8963). |
| 70. 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()) |
| 72. Act.performer:guarantor.assignedEntity.code | |
| Comments | This assignedEntity SHALL contain exactly one [1..1] code (CONF:4537-8968). |
| Control | 1..? |
| 74. 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 |
| 76. 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 |
| 78. 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(US Realm Address) |
| 80. Act.performer:guarantor.assignedEntity.telecom | |
| Comments | This assignedEntity SHOULD contain zero or more [0..*] telecom (CONF:4537-8965). |
| 82. 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: |
| 84. Act.participant:coverage-target | |
| Slice Name | coverage-target |
| 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()) |
| 86. Act.participant:coverage-target.templateId | |
| Comments | SHALL contain exactly one [1..1] templateId (CONF:4537-16812), SHALL not contain [0..0] extension. |
| Control | 1..1 |
| 88. Act.participant:coverage-target.templateId.root | |
| Comments | This templateId SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.89" Covered Party Participant (CONF:4537-16814). |
| Control | 1..? |
| Pattern Value | 2.16.840.1.113883.10.20.22.4.89 |
| 90. Act.participant:coverage-target.templateId.extension | |
| Control | 0..0 |
| 92. Act.participant:coverage-target.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 |
| 94. Act.participant:coverage-target.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()) |
| 96. Act.participant:coverage-target.time.low | |
| Comments | The time, if present, SHOULD contain zero or one [0..1] low (CONF:4537-8919). |
| 98. Act.participant:coverage-target.time.high | |
| Comments | The time, if present, SHOULD contain zero or one [0..1] high (CONF:4537-8920). |
| 100. Act.participant:coverage-target.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()) |
| 102. Act.participant:coverage-target.participantRole.id | |
| Short | (USCDI) **MEMBER IDENTIFIER**: This id is a unique identifier for the covered party member. Implementers **SHOULD** use the same GUID for each instance of a member identifier from the same health plan (CONF:4537-8984). |
| Comments | This participantRole SHALL contain at least one [1..*] id (CONF:4537-8922). |
| Control | 1..? |
| 104. Act.participant:coverage-target.participantRole.code | |
| Short | (USCDI) **RELATIONSHIP TO SUBSCRIBER**: Records the relationship of a patient to the primary insured person. |
| Comments | This participantRole SHALL contain exactly one [1..1] code (CONF:4537-8923). |
| Control | 1..? |
| Invariants | should-code-attr: SHOULD contain @code (code.exists()) |
| 106. Act.participant:coverage-target.participantRole.code.code | |
| Comments | This code SHOULD contain zero or one [0..1] @code, which SHOULD be selected from ValueSet Coverage Role Type Value Set urn:oid:2.16.840.1.113883.1.11.18877 DYNAMIC (CONF:4537-16078). |
| Binding | The codes SHOULD be taken from Coverage Role Type Value Set (preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.18877) |
| 108. Act.participant:coverage-target.participantRole.addr | |
| Comments | This participantRole 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-8956). |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address) |
| 110. Act.participant:coverage-target.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). |
| 112. Act.participant:coverage-target.participantRole.playingEntity.name | |
| Comments | The playingEntity, if present, SHALL contain exactly one [1..1] name (CONF:4537-8930). |
| Control | 1..1 |
| 114. Act.participant:coverage-target.participantRole.playingEntity.sdtcBirthTime | |
| Short | sdtc:birthTime |
| Comments | The playingEntity, if present, SHALL contain exactly one [1..1] sdtc:birthTime (CONF:4537-31344). |
| Control | 1..? |
| 116. 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 |
| 118. Act.participant:subscriber.templateId | |
| Comments | SHALL contain exactly one [1..1] templateId (CONF:4537-16813), SHALL not contain [0..0] extension. |
| Control | 1..1 |
| 120. Act.participant:subscriber.templateId.root | |
| Comments | This templateId SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.90" Policy Holder Participant (CONF:4537-16815). |
| Control | 1..? |
| Pattern Value | 2.16.840.1.113883.10.20.22.4.90 |
| 122. Act.participant:subscriber.templateId.extension | |
| Control | 0..0 |
| 124. 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 |
| 126. Act.participant:subscriber.time | |
| Comments | MAY contain zero or one [0..1] time (CONF:4537-8938). |
| 128. Act.participant:subscriber.participantRole | |
| Comments | SHALL contain exactly one [1..1] participantRole (CONF:4537-8936). |
| Invariants | should-addr: SHOULD contain addr (addr.exists()) |
| 130. Act.participant:subscriber.participantRole.id | |
| Short | (USCDI) **SUBSCRIBER ID**: This id is a unique identifier for the subscriber of the coverage (CONF:4537-10120). |
| Comments | This participantRole SHALL contain at least one [1..*] id (CONF:4537-8937). |
| Control | 1..? |
| 132. Act.participant:subscriber.participantRole.addr | |
| Comments | This participantRole 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-8925). |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address) |
| 134. 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: |
| 136. Act.entryRelationship:authorization | |
| Slice Name | authorization |
| Short | entryRelationship |
| Comments | MAY contain one [0..*] entryRelationship (CONF:4537-8939) such that it |
| Control | 0..* |
| 138. Act.entryRelationship:authorization.typeCode | |
| Comments | SHALL contain exactly one [1..1] @typeCode="REFR" Refers to (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:4537-8940). |
| Fixed Value | REFR |
| 140. Act.entryRelationship:authorization.act | |
| Control | 1..? |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Act(Authorization Activity) |
| 142. Act.entryRelationship:authorization.act.moodCode | |
| Short | EVN |
| 144. Act.entryRelationship:plan | |
| Slice Name | plan |
| Short | Represents the Coverage Plan |
| Control | 0..* |
| 146. Act.entryRelationship:plan.typeCode | |
| Fixed Value | REFR |
| 148. 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..? |
| 150. Act.entryRelationship:plan.act.classCode | |
| Fixed Value | ACT |
| 152. Act.entryRelationship:plan.act.moodCode | |
| Fixed Value | DEF |
| 154. Act.entryRelationship:plan.act.id | |
| Short | Plan identifier |
| Control | 1..? |
| 156. Act.entryRelationship:plan.act.text | |
| Short | Name of the plan |
| Control | 1..? |
Guidance on how to interpret the contents of this table can be found here
| 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())4537-17139: When the Subscriber is the patient (COV participant code = 'SELF'), 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 (CONF:4537-17139). ( participant.where(typeCode='COV').participantRole.code.where(code = 'SELF').exists() implies participant.where(typeCode='HLD').empty()) |
| 2. 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 | 1..* |
| 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: |
| 4. Act.templateId:policy-activity | |
| Slice Name | policy-activity |
| 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 |
| 6. Act.templateId:policy-activity.root | |
| Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier. |
| Control | 1..1 |
| Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Root |
| Pattern Value | 2.16.840.1.113883.10.20.22.4.61 |
| 8. Act.templateId:policy-activity.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| Control | 1..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Extension |
| Pattern Value | 2024-05-01 |
| 10. 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-8898). |
| 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 |
| 12. 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-8899). |
| 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 |
| 14. Act.id | |
| Short | (USCDI) **GROUP NUMBER**: This is the identifier used to uniquely refer to a specific health insurance plan. |
| Comments | SHALL contain at least one [1..*] id (CONF:4537-8901). |
| Control | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 16. 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 |
| 18. Act.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 | The codes SHOULD be taken from Payer Type (preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.3591) |
| 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 |
| 20. Act.text | |
| Short | SHOULD reference the portion of section narrative text corresponding to this entry |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ED |
| 22. 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('#')) |
| 24. Act.statusCode | |
| Comments | SHALL contain exactly one [1..1] statusCode (CONF:4537-8902). |
| 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 |
| 26. 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. |
| Comments | This statusCode SHALL contain exactly one [1..1] @code="completed" Completed (CodeSystem: HL7ActStatus urn:oid:2.16.840.1.113883.5.14 STATIC) (CONF:4537-19109). |
| 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 |
| 28. 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 |
| 30. 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 |
| 32. 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 |
| 34. 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 |
| 36. 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 |
| 38. 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 |
| 40. 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:typeattribute. |
| Label | Translation |
| 42. Act.performer | |
| Comments | SHOULD contain zero or more [0..*] performer (CONF:4537-8961) such that it |
| 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: |
| 44. 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 |
| 46. 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 |
| Comments | SHALL contain exactly one [1..1] templateId (CONF:4537-16808), SHALL not contain [0..0] extension.. |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 48. Act.performer:payer.templateId.root | |
| Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier. |
| Comments | This templateId SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.87" Payer Performer (CONF:4537-16809). |
| Control | 1..1 |
| Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Root |
| Pattern Value | 2.16.840.1.113883.10.20.22.4.87 |
| 50. Act.performer:payer.templateId.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| 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 | Extension |
| 52. 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 |
| 54. 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()) |
| 56. Act.performer:payer.assignedEntity.id | |
| Short | (USCDI) **PAYER IDENTIFIER**: This is the Payer id. The root is a unique identifier to an openly available assigning authority, such as National Association of Insurance Commissioners (NAIC) (2.16.840.1.113883.6.300), and the extension identifiers the payer within that authority. |
| Comments | This assignedEntity SHALL contain at least one [1..*] id (CONF:4537-8909). |
| Control | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 58. 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 |
| 60. 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 |
| 62. 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 | The codes SHOULD be taken from Financially Responsible Party Type Value Set (preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.10416) |
| 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 |
| 64. 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 |
| 66. Act.performer:payer.assignedEntity.addr | |
| Definition | Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc. |
| Short | Base for all types and resources |
| Comments | This assignedEntity MAY 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-8910). |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address) |
| Is Modifier | false |
| Invariants | shall-city: SHALL contain exactly one [1..1] city (CONF:81-7292). (nullFlavor.exists() or item.city.count() = 1)shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). ( nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4))should-use: SHOULD contain @use ( nullFlavor.exists() or use.exists())should-country: SHOULD contain country ( nullFlavor.exists() or item.country.exists())81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296) ( item.xmlText.empty())81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024). ( nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state')))81-10025: If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025). ( nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?')))shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country ( (item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1)) |
| 68. Act.performer:payer.assignedEntity.telecom | |
| Comments | This assignedEntity MAY contain zero or more [0..*] telecom (CONF:4537-8911). |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL |
| 70. 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()) |
| 72. 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 | 0..1 This element is affected by the following invariants: org-1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ONstring |
| Is Modifier | false |
| Requirements | Need to use the name as the label of the organization. |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 74. 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()) |
| 76. 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 |
| Comments | SHALL contain exactly one [1..1] templateId (CONF:4537-16810), SHALL not contain [0..0] extension. |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 78. Act.performer:guarantor.templateId.root | |
| Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier. |
| Comments | This templateId SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.88" Guarantor Performer (CONF:4537-16811). |
| Control | 1..1 |
| Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Root |
| Pattern Value | 2.16.840.1.113883.10.20.22.4.88 |
| 80. Act.performer:guarantor.templateId.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| 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 | Extension |
| 82. 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 |
| 84. 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 |
| 86. 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()) |
| 88. Act.performer:guarantor.assignedEntity.id | |
| Control | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 90. 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 |
| 92. 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 |
| 94. 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 |
| 96. 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 |
| 98. Act.performer:guarantor.assignedEntity.addr | |
| Definition | Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc. |
| Short | Base for all types and resources |
| Comments | This 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(US Realm Address) |
| Is Modifier | false |
| Invariants | shall-city: SHALL contain exactly one [1..1] city (CONF:81-7292). (nullFlavor.exists() or item.city.count() = 1)shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). ( nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4))should-use: SHOULD contain @use ( nullFlavor.exists() or use.exists())should-country: SHOULD contain country ( nullFlavor.exists() or item.country.exists())81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296) ( item.xmlText.empty())81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024). ( nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state')))81-10025: If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025). ( nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?')))shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country ( (item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1)) |
| 100. Act.performer:guarantor.assignedEntity.telecom | |
| Comments | This assignedEntity SHOULD contain zero or more [0..*] telecom (CONF:4537-8965). |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL |
| 102. 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: |
| 104. Act.participant:coverage-target | |
| Slice Name | coverage-target |
| 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()) |
| 106. Act.participant:coverage-target.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 |
| Comments | SHALL contain exactly one [1..1] templateId (CONF:4537-16812), SHALL not contain [0..0] extension. |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 108. Act.participant:coverage-target.templateId.root | |
| Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier. |
| Comments | This templateId SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.89" Covered Party Participant (CONF:4537-16814). |
| Control | 1..1 |
| Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Root |
| Pattern Value | 2.16.840.1.113883.10.20.22.4.89 |
| 110. Act.participant:coverage-target.templateId.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| 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 | Extension |
| 112. Act.participant:coverage-target.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 |
| 114. Act.participant:coverage-target.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()) |
| 116. Act.participant:coverage-target.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 |
| 118. Act.participant:coverage-target.time.high | |
| Definition | This is the high limit of the interval. |
| 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 |
| 120. Act.participant:coverage-target.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()) |
| 122. Act.participant:coverage-target.participantRole.id | |
| Short | (USCDI) **MEMBER IDENTIFIER**: This id is a unique identifier for the covered party member. Implementers **SHOULD** use the same GUID for each instance of a member identifier from the same health plan (CONF:4537-8984). |
| Comments | This participantRole SHALL contain at least one [1..*] id (CONF:4537-8922). |
| Control | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 124. Act.participant:coverage-target.participantRole.code | |
| Short | (USCDI) **RELATIONSHIP TO SUBSCRIBER**: Records the relationship of a patient to the primary insured person. |
| Comments | This participantRole SHALL contain exactly one [1..1] code (CONF:4537-8923). |
| 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 |
| Invariants | should-code-attr: SHOULD contain @code (code.exists()) |
| 126. Act.participant:coverage-target.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. |
| Comments | This code SHOULD contain zero or one [0..1] @code, which SHOULD be selected from ValueSet Coverage Role Type Value Set urn:oid:2.16.840.1.113883.1.11.18877 DYNAMIC (CONF:4537-16078). |
| Control | 0..1 |
| Binding | The codes SHOULD be taken from Coverage Role Type Value Set (preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.18877) |
| 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 |
| 128. Act.participant:coverage-target.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 |
| 130. Act.participant:coverage-target.participantRole.addr | |
| Definition | Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc. |
| Short | Base for all types and resources |
| Comments | This participantRole 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-8956). |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address) |
| Is Modifier | false |
| Invariants | shall-city: SHALL contain exactly one [1..1] city (CONF:81-7292). (nullFlavor.exists() or item.city.count() = 1)shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). ( nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4))should-use: SHOULD contain @use ( nullFlavor.exists() or use.exists())should-country: SHOULD contain country ( nullFlavor.exists() or item.country.exists())81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296) ( item.xmlText.empty())81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024). ( nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state')))81-10025: If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025). ( nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?')))shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country ( (item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1)) |
| 132. Act.participant:coverage-target.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 |
| 134. Act.participant:coverage-target.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 |
| 136. Act.participant:coverage-target.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 namebirthTime. |
| 138. 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 |
| 140. 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 |
| Comments | SHALL contain exactly one [1..1] templateId (CONF:4537-16813), SHALL not contain [0..0] extension. |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 142. Act.participant:subscriber.templateId.root | |
| Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier. |
| Comments | This templateId SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.90" Policy Holder Participant (CONF:4537-16815). |
| Control | 1..1 |
| Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Root |
| Pattern Value | 2.16.840.1.113883.10.20.22.4.90 |
| 144. Act.participant:subscriber.templateId.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| 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 | Extension |
| 146. 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 |
| 148. 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 |
| 150. 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()) |
| 152. Act.participant:subscriber.participantRole.id | |
| Short | (USCDI) **SUBSCRIBER ID**: This id is a unique identifier for the subscriber of the coverage (CONF:4537-10120). |
| Comments | This participantRole SHALL contain at least one [1..*] id (CONF:4537-8937). |
| Control | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 154. Act.participant:subscriber.participantRole.addr | |
| Definition | Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc. |
| Short | Base for all types and resources |
| Comments | This participantRole 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-8925). |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address) |
| Is Modifier | false |
| Invariants | shall-city: SHALL contain exactly one [1..1] city (CONF:81-7292). (nullFlavor.exists() or item.city.count() = 1)shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). ( nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4))should-use: SHOULD contain @use ( nullFlavor.exists() or use.exists())should-country: SHOULD contain country ( nullFlavor.exists() or item.country.exists())81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296) ( item.xmlText.empty())81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024). ( nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state')))81-10025: If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025). ( nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?')))shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country ( (item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1)) |
| 156. 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: |
| 158. Act.entryRelationship:authorization | |
| Slice Name | authorization |
| Short | entryRelationship |
| Comments | MAY contain one [0..*] entryRelationship (CONF:4537-8939) such that it |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship |
| 160. Act.entryRelationship:authorization.typeCode | |
| Comments | SHALL contain exactly one [1..1] @typeCode="REFR" Refers to (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:4537-8940). |
| 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 |
| 162. Act.entryRelationship:authorization.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 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Act(Authorization Activity) |
| Is Modifier | false |
| Invariants | should-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists()) |
| 164. Act.entryRelationship:authorization.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 | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| Slicing | This element introduces a set of slices on Act.entryRelationship.act.templateId. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 166. Act.entryRelationship:authorization.act.templateId:authorization-activity | |
| Slice Name | authorization-activity |
| 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 |
| 168. Act.entryRelationship:authorization.act.templateId:authorization-activity.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.19 |
| 170. Act.entryRelationship:authorization.act.templateId:authorization-activity.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| 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 | Extension |
| 172. Act.entryRelationship:authorization.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:81-8944). |
| 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 |
| 174. Act.entryRelationship:authorization.act.moodCode | |
| Short | EVN |
| Comments | SHALL contain exactly one [1..1] @moodCode="EVN" Event (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:81-8945). |
| 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 |
| 176. Act.entryRelationship:authorization.act.id | |
| Comments | SHALL contain exactly one [1..1] id (CONF:81-8947). |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 178. Act.entryRelationship:authorization.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 |
| 180. Act.entryRelationship:authorization.act.entryRelationship | |
| Control | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship |
| Slicing | This element introduces a set of slices on Act.entryRelationship.act.entryRelationship. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 182. Act.entryRelationship:authorization.act.entryRelationship:target | |
| Slice Name | target |
| Short | The target of an authorization activity MAY contain one or more performer, to indicate the providers that have been authorized to provide treatment (CONF:81-8952). |
| Comments | SHALL contain at least one [1..*] entryRelationship (CONF:81-8948) such that it |
| Control | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship |
| Invariants | 81-8951: The target of an authorization activity with act/entryRelationship/@typeCode="SUBJ" SHALL be a clinical statement with moodCode="PRMS" Promise (CONF:81-8951). ((act | encounter | observation | observationMedia | organizer | procedure | regionOfInterest | substanceAdministration | supply).where(moodCode='PRMS').exists()) |
| 184. Act.entryRelationship:authorization.act.entryRelationship:target.typeCode | |
| Comments | SHALL contain exactly one [1..1] @typeCode="SUBJ" Has Subject (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:81-8949). |
| 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 | SUBJ |
| 186. Act.entryRelationship:plan | |
| Slice Name | plan |
| Short | Represents the Coverage Plan |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship |
| 188. 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 |
| 190. 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 |
| 192. 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 |
| 194. 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 |
| 196. Act.entryRelationship:plan.act.id | |
| Short | Plan identifier |
| Control | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 198. 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 |
| 200. Act.entryRelationship:plan.act.text | |
| Short | Name of the plan |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ED |
Guidance on how to interpret the contents of this table can be found here
| 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())4537-17139: When the Subscriber is the patient (COV participant code = 'SELF'), 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 (CONF:4537-17139). ( participant.where(typeCode='COV').participantRole.code.where(code = 'SELF').exists() implies participant.where(typeCode='HLD').empty()) |
| 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 |
| 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 | 1..* |
| 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: |
| 20. Act.templateId:policy-activity | |
| Slice Name | policy-activity |
| 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:policy-activity.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:policy-activity.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:policy-activity.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:policy-activity.root | |
| Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier. |
| Control | 1..1 |
| Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Root |
| Pattern Value | 2.16.840.1.113883.10.20.22.4.61 |
| 30. Act.templateId:policy-activity.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| Control | 1..1 |
| Type | string(st: Character String) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Extension |
| Pattern Value | 2024-05-01 |
| 32. 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-8898). |
| 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 |
| 34. 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-8899). |
| 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 |
| 36. 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. |
| 38. Act.id | |
| Short | (USCDI) **GROUP NUMBER**: This is the identifier used to uniquely refer to a specific health insurance plan. |
| Comments | SHALL contain at least one [1..*] id (CONF:4537-8901). |
| Control | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 40. 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 |
| 42. Act.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 |
| 44. Act.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 | The codes SHOULD be taken from Payer Type (preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.3591) |
| 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 |
| 46. Act.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 |
| 48. Act.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 |
| 50. Act.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 |
| 52. Act.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 |
| 54. Act.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 namevalueSet. |
| 56. Act.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 namevalueSetVersion. |
| 58. Act.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 |
| 60. Act.code.qualifier | |
| Definition | Specifies additional codes that increase the specificity of the the primary code. |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CR |
| Label | Qualifier |
| 62. Act.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:typeattribute. |
| Label | Translation |
| 64. Act.text | |
| Short | SHOULD reference the portion of section narrative text corresponding to this entry |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ED |
| 66. 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 |
| 68. 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 |
| 70. 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 |
| 72. 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 |
| 74. 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 |
| 76. 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 |
| 78. 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. |
| 80. 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. |
| 82. 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('#')) |
| 84. 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 |
| 86. Act.statusCode | |
| Comments | SHALL contain exactly one [1..1] statusCode (CONF:4537-8902). |
| 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 |
| 88. 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 |
| 90. 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. |
| Comments | This statusCode SHALL contain exactly one [1..1] @code="completed" Completed (CodeSystem: HL7ActStatus urn:oid:2.16.840.1.113883.5.14 STATIC) (CONF:4537-19109). |
| 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 |
| 92. 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 |
| 94. 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 |
| 96. 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 |
| 98. 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 |
| 100. 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 namevalueSet. |
| 102. 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 namevalueSetVersion. |
| 104. 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 |
| 106. 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 |
| 108. 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:typeattribute. |
| Label | Translation |
| 110. Act.effectiveTime | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS |
| 112. 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 |
| 114. 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 |
| 116. Act.subject | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Subject |
| 118. Act.specimen | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Specimen |
| 120. Act.performer | |
| Comments | SHOULD contain zero or more [0..*] performer (CONF:4537-8961) such that it |
| 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: |
| 122. 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 |
| 124. 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 |
| 126. 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 |
| 128. 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 |
| 130. 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 |
| 132. 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 |
| 134. 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 |
| 136. 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 |
| 138. 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 |
| 140. 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 |
| Comments | SHALL contain exactly one [1..1] templateId (CONF:4537-16808), SHALL not contain [0..0] extension.. |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 142. Act.performer:payer.templateId.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.templateId.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 |
| 146. Act.performer:payer.templateId.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 |
| 148. Act.performer:payer.templateId.root | |
| Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier. |
| Comments | This templateId SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.87" Payer Performer (CONF:4537-16809). |
| Control | 1..1 |
| Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Root |
| Pattern Value | 2.16.840.1.113883.10.20.22.4.87 |
| 150. Act.performer:payer.templateId.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| 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 | Extension |
| 152. 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 |
| 154. 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 namefunctionCode. |
| 156. Act.performer:payer.time | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS |
| 158. Act.performer:payer.modeCode | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 160. 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()) |
| 162. 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 |
| 164. 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 |
| 166. 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 |
| 168. 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 |
| 170. 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 |
| 172. 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 |
| 174. 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 |
| 176. 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 |
| 178. 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 |
| 180. Act.performer:payer.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 |
| 182. Act.performer:payer.assignedEntity.id | |
| Short | (USCDI) **PAYER IDENTIFIER**: This is the Payer id. The root is a unique identifier to an openly available assigning authority, such as National Association of Insurance Commissioners (NAIC) (2.16.840.1.113883.6.300), and the extension identifiers the payer within that authority. |
| Comments | This assignedEntity SHALL contain at least one [1..*] id (CONF:4537-8909). |
| Control | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 184. 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 nameidentifiedBy. |
| 186. 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 |
| 188. 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 |
| 190. 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 | The codes SHOULD be taken from Financially Responsible Party Type Value Set (preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.10416) |
| 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 |
| 192. 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 |
| 194. 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 |
| 196. 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 |
| 198. 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 |
| 200. 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 namevalueSet. |
| 202. 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 namevalueSetVersion. |
| 204. 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 |
| 206. 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 |
| 208. 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:typeattribute. |
| Label | Translation |
| 210. Act.performer:payer.assignedEntity.addr | |
| Definition | Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc. |
| Short | Base for all types and resources |
| Comments | This assignedEntity MAY 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-8910). |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address) |
| Is Modifier | false |
| Invariants | shall-city: SHALL contain exactly one [1..1] city (CONF:81-7292). (nullFlavor.exists() or item.city.count() = 1)shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). ( nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4))should-use: SHOULD contain @use ( nullFlavor.exists() or use.exists())should-country: SHOULD contain country ( nullFlavor.exists() or item.country.exists())81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296) ( item.xmlText.empty())81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024). ( nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state')))81-10025: If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025). ( nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?')))shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country ( (item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1)) |
| 212. Act.performer:payer.assignedEntity.telecom | |
| Comments | This assignedEntity MAY contain zero or more [0..*] telecom (CONF:4537-8911). |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL |
| 214. Act.performer:payer.assignedEntity.assignedPerson | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Person |
| 216. 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()) |
| 218. 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 |
| 220. 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 |
| 222. 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 |
| 224. 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 |
| 226. 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 |
| 228. 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 |
| 230. 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 |
| 232. 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 |
| 234. 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 |
| 236. Act.performer:payer.assignedEntity.representedOrganization.classCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from EntityClassOrganization (required to http://terminology.hl7.org/ValueSet/v3-EntityClassOrganization) |
| Type | code(cs: Coded Simple Value) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | ORG |
| 238. 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 |
| 240. Act.performer:payer.assignedEntity.representedOrganization.id | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 242. Act.performer:payer.assignedEntity.representedOrganization.name | |
| Comments | The representedOrganization, if present, SHOULD contain zero or one [0..1] name (CONF:4537-8913). |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ON |
| 244. Act.performer:payer.assignedEntity.representedOrganization.telecom | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL |
| 246. Act.performer:payer.assignedEntity.representedOrganization.addr | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/AD |
| 248. 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 |
| 250. Act.performer:payer.assignedEntity.representedOrganization.asOrganizationPartOf | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/OrganizationPartOf |
| 252. 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 namepatient. |
| 254. 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. |
| 256. 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()) |
| 258. 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 |
| 260. 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 |
| 262. 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 |
| 264. 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 |
| 266. 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 |
| 268. 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 |
| 270. 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 |
| 272. 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 |
| 274. 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 |
| Comments | SHALL contain exactly one [1..1] templateId (CONF:4537-16810), SHALL not contain [0..0] extension. |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 276. Act.performer:guarantor.templateId.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 |
| 278. Act.performer:guarantor.templateId.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 |
| 280. Act.performer:guarantor.templateId.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 |
| 282. Act.performer:guarantor.templateId.root | |
| Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier. |
| Comments | This templateId SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.88" Guarantor Performer (CONF:4537-16811). |
| Control | 1..1 |
| Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Root |
| Pattern Value | 2.16.840.1.113883.10.20.22.4.88 |
| 284. Act.performer:guarantor.templateId.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| 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 | Extension |
| 286. 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 |
| 288. 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 namefunctionCode. |
| 290. 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 |
| 292. Act.performer:guarantor.modeCode | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 294. 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()) |
| 296. 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 |
| 298. 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 |
| 300. 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 |
| 302. 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 |
| 304. 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 |
| 306. 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 |
| 308. 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 |
| 310. 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 |
| 312. 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 |
| 314. 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 |
| 316. Act.performer:guarantor.assignedEntity.id | |
| Control | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 318. 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 nameidentifiedBy. |
| 320. 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 |
| 322. 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 |
| 324. 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 |
| 326. 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 |
| 328. 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 |
| 330. 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 |
| 332. 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 |
| 334. 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 namevalueSet. |
| 336. 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 namevalueSetVersion. |
| 338. 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 |
| 340. 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 |
| 342. 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:typeattribute. |
| Label | Translation |
| 344. Act.performer:guarantor.assignedEntity.addr | |
| Definition | Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc. |
| Short | Base for all types and resources |
| Comments | This 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(US Realm Address) |
| Is Modifier | false |
| Invariants | shall-city: SHALL contain exactly one [1..1] city (CONF:81-7292). (nullFlavor.exists() or item.city.count() = 1)shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). ( nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4))should-use: SHOULD contain @use ( nullFlavor.exists() or use.exists())should-country: SHOULD contain country ( nullFlavor.exists() or item.country.exists())81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296) ( item.xmlText.empty())81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024). ( nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state')))81-10025: If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025). ( nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?')))shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country ( (item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1)) |
| 346. Act.performer:guarantor.assignedEntity.telecom | |
| Comments | This assignedEntity SHOULD contain zero or more [0..*] telecom (CONF:4537-8965). |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL |
| 348. Act.performer:guarantor.assignedEntity.assignedPerson | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Person |
| 350. Act.performer:guarantor.assignedEntity.representedOrganization | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Organization |
| 352. 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 namepatient. |
| 354. 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. |
| 356. Act.author | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Author |
| 358. Act.informant | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Informant |
| 360. 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: |
| 362. Act.participant:coverage-target | |
| Slice Name | coverage-target |
| 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()) |
| 364. Act.participant:coverage-target.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 |
| 366. Act.participant:coverage-target.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 |
| 368. Act.participant:coverage-target.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 |
| 370. Act.participant:coverage-target.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 |
| 372. Act.participant:coverage-target.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 |
| 374. Act.participant:coverage-target.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 |
| 376. Act.participant:coverage-target.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 |
| 378. Act.participant:coverage-target.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 |
| 380. Act.participant:coverage-target.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 |
| Comments | SHALL contain exactly one [1..1] templateId (CONF:4537-16812), SHALL not contain [0..0] extension. |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 382. Act.participant:coverage-target.templateId.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 |
| 384. Act.participant:coverage-target.templateId.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 |
| 386. Act.participant:coverage-target.templateId.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 |
| 388. Act.participant:coverage-target.templateId.root | |
| Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier. |
| Comments | This templateId SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.89" Covered Party Participant (CONF:4537-16814). |
| Control | 1..1 |
| Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Root |
| Pattern Value | 2.16.840.1.113883.10.20.22.4.89 |
| 390. Act.participant:coverage-target.templateId.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| 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 | Extension |
| 392. Act.participant:coverage-target.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 |
| 394. Act.participant:coverage-target.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 |
| 396. Act.participant:coverage-target.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 namefunctionCode. |
| 398. Act.participant:coverage-target.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()) |
| 400. Act.participant:coverage-target.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 |
| 402. Act.participant:coverage-target.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. |
| 404. Act.participant:coverage-target.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 |
| 406. Act.participant:coverage-target.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 |
| 408. Act.participant:coverage-target.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 |
| 410. Act.participant:coverage-target.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 |
| 412. Act.participant:coverage-target.time.high | |
| Definition | This is the high limit of the interval. |
| 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 |
| 414. Act.participant:coverage-target.awarenessCode | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 416. Act.participant:coverage-target.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()) |
| 418. Act.participant:coverage-target.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 |
| 420. Act.participant:coverage-target.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 |
| 422. Act.participant:coverage-target.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 |
| 424. Act.participant:coverage-target.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 |
| 426. Act.participant:coverage-target.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 |
| 428. Act.participant:coverage-target.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 |
| 430. Act.participant:coverage-target.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 |
| 432. Act.participant:coverage-target.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 |
| 434. Act.participant:coverage-target.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 |
| 436. Act.participant:coverage-target.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 |
| 438. Act.participant:coverage-target.participantRole.id | |
| Short | (USCDI) **MEMBER IDENTIFIER**: This id is a unique identifier for the covered party member. Implementers **SHOULD** use the same GUID for each instance of a member identifier from the same health plan (CONF:4537-8984). |
| Comments | This participantRole SHALL contain at least one [1..*] id (CONF:4537-8922). |
| Control | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 440. Act.participant:coverage-target.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 nameidentifiedBy. |
| 442. Act.participant:coverage-target.participantRole.code | |
| Short | (USCDI) **RELATIONSHIP TO SUBSCRIBER**: Records the relationship of a patient to the primary insured person. |
| Comments | This participantRole SHALL contain exactly one [1..1] code (CONF:4537-8923). |
| 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 |
| Invariants | should-code-attr: SHOULD contain @code (code.exists()) |
| 444. Act.participant:coverage-target.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 |
| 446. Act.participant:coverage-target.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. |
| Comments | This code SHOULD contain zero or one [0..1] @code, which SHOULD be selected from ValueSet Coverage Role Type Value Set urn:oid:2.16.840.1.113883.1.11.18877 DYNAMIC (CONF:4537-16078). |
| Control | 0..1 |
| Binding | The codes SHOULD be taken from Coverage Role Type Value Set (preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.1.11.18877) |
| 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 |
| 448. Act.participant:coverage-target.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 |
| 450. Act.participant:coverage-target.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 |
| 452. Act.participant:coverage-target.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 |
| 454. Act.participant:coverage-target.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 |
| 456. Act.participant:coverage-target.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 namevalueSet. |
| 458. Act.participant:coverage-target.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 namevalueSetVersion. |
| 460. Act.participant:coverage-target.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 |
| 462. Act.participant:coverage-target.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 |
| 464. Act.participant:coverage-target.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:typeattribute. |
| Label | Translation |
| 466. Act.participant:coverage-target.participantRole.addr | |
| Definition | Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc. |
| Short | Base for all types and resources |
| Comments | This participantRole 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-8956). |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address) |
| Is Modifier | false |
| Invariants | shall-city: SHALL contain exactly one [1..1] city (CONF:81-7292). (nullFlavor.exists() or item.city.count() = 1)shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). ( nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4))should-use: SHOULD contain @use ( nullFlavor.exists() or use.exists())should-country: SHOULD contain country ( nullFlavor.exists() or item.country.exists())81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296) ( item.xmlText.empty())81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024). ( nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state')))81-10025: If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025). ( nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?')))shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country ( (item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1)) |
| 468. Act.participant:coverage-target.participantRole.telecom | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL |
| 470. Act.participant:coverage-target.participantRole.playingDevice | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Device |
| 472. Act.participant:coverage-target.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 |
| 474. Act.participant:coverage-target.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 |
| 476. Act.participant:coverage-target.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 |
| 478. Act.participant:coverage-target.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 |
| 480. Act.participant:coverage-target.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 |
| 482. Act.participant:coverage-target.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 |
| 484. Act.participant:coverage-target.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 |
| 486. Act.participant:coverage-target.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 |
| 488. Act.participant:coverage-target.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 |
| 490. Act.participant:coverage-target.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 |
| 492. Act.participant:coverage-target.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 |
| 494. Act.participant:coverage-target.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 |
| 496. Act.participant:coverage-target.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 |
| 498. Act.participant:coverage-target.participantRole.playingEntity.quantity | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/PQ |
| 500. Act.participant:coverage-target.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 |
| 502. Act.participant:coverage-target.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 namebirthTime. |
| 504. Act.participant:coverage-target.participantRole.playingEntity.desc | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ED |
| 506. Act.participant:coverage-target.participantRole.scopingEntity | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Entity |
| 508. 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 |
| 510. 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 |
| 512. 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 |
| 514. 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 |
| 516. 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 |
| 518. 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 |
| 520. 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 |
| 522. 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 |
| 524. 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 |
| 526. 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 |
| Comments | SHALL contain exactly one [1..1] templateId (CONF:4537-16813), SHALL not contain [0..0] extension. |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 528. Act.participant:subscriber.templateId.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 |
| 530. Act.participant:subscriber.templateId.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 |
| 532. Act.participant:subscriber.templateId.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 |
| 534. Act.participant:subscriber.templateId.root | |
| Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier. |
| Comments | This templateId SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.90" Policy Holder Participant (CONF:4537-16815). |
| Control | 1..1 |
| Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| XML Format | In the XML format, this property is represented as an attribute. |
| Label | Root |
| Pattern Value | 2.16.840.1.113883.10.20.22.4.90 |
| 536. Act.participant:subscriber.templateId.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| 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 | Extension |
| 538. 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 |
| 540. 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 |
| 542. 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 namefunctionCode. |
| 544. 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 |
| 546. Act.participant:subscriber.awarenessCode | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 548. 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()) |
| 550. 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 |
| 552. 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 |
| 554. 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 |
| 556. 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 |
| 558. 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 |
| 560. 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 |
| 562. 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 |
| 564. 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 |
| 566. 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 |
| 568. 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 |
| 570. Act.participant:subscriber.participantRole.id | |
| Short | (USCDI) **SUBSCRIBER ID**: This id is a unique identifier for the subscriber of the coverage (CONF:4537-10120). |
| Comments | This participantRole SHALL contain at least one [1..*] id (CONF:4537-8937). |
| Control | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 572. 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 nameidentifiedBy. |
| 574. 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 |
| 576. Act.participant:subscriber.participantRole.addr | |
| Definition | Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc. |
| Short | Base for all types and resources |
| Comments | This participantRole 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-8925). |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/AD(US Realm Address) |
| Is Modifier | false |
| Invariants | shall-city: SHALL contain exactly one [1..1] city (CONF:81-7292). (nullFlavor.exists() or item.city.count() = 1)shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). ( nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4))should-use: SHOULD contain @use ( nullFlavor.exists() or use.exists())should-country: SHOULD contain country ( nullFlavor.exists() or item.country.exists())81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296) ( item.xmlText.empty())81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024). ( nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state')))81-10025: If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025). ( nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?')))shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country ( (item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1)) |
| 578. Act.participant:subscriber.participantRole.telecom | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL |
| 580. Act.participant:subscriber.participantRole.playingDevice | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Device |
| 582. Act.participant:subscriber.participantRole.playingEntity | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/PlayingEntity |
| 584. Act.participant:subscriber.participantRole.scopingEntity | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Entity |
| 586. 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: |
| 588. Act.entryRelationship:authorization | |
| Slice Name | authorization |
| Short | entryRelationship |
| Comments | MAY contain one [0..*] entryRelationship (CONF:4537-8939) such that it |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship |
| 590. Act.entryRelationship:authorization.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 |
| 592. Act.entryRelationship:authorization.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 |
| 594. Act.entryRelationship:authorization.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 |
| 596. Act.entryRelationship:authorization.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 |
| 598. Act.entryRelationship:authorization.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 |
| 600. Act.entryRelationship:authorization.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 |
| 602. Act.entryRelationship:authorization.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 |
| 604. Act.entryRelationship:authorization.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 |
| 606. Act.entryRelationship:authorization.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 |
| 608. Act.entryRelationship:authorization.typeCode | |
| Comments | SHALL contain exactly one [1..1] @typeCode="REFR" Refers to (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:4537-8940). |
| 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 |
| 610. Act.entryRelationship:authorization.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. |
| 612. Act.entryRelationship:authorization.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 |
| 614. Act.entryRelationship:authorization.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. |
| 616. Act.entryRelationship:authorization.sequenceNumber | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/INT |
| 618. Act.entryRelationship:authorization.seperatableInd | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/BL |
| 620. Act.entryRelationship:authorization.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 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Act(Authorization Activity) |
| Is Modifier | false |
| Invariants | should-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists()) |
| 622. Act.entryRelationship:authorization.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 |
| 624. Act.entryRelationship:authorization.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 |
| 626. Act.entryRelationship:authorization.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 |
| 628. Act.entryRelationship:authorization.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 |
| 630. Act.entryRelationship:authorization.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 |
| 632. Act.entryRelationship:authorization.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 |
| 634. Act.entryRelationship:authorization.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 |
| 636. Act.entryRelationship:authorization.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 |
| 638. Act.entryRelationship:authorization.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 | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| Slicing | This element introduces a set of slices on Act.entryRelationship.act.templateId. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 640. Act.entryRelationship:authorization.act.templateId:authorization-activity | |
| Slice Name | authorization-activity |
| 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 |
| 642. Act.entryRelationship:authorization.act.templateId:authorization-activity.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 |
| 644. Act.entryRelationship:authorization.act.templateId:authorization-activity.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 |
| 646. Act.entryRelationship:authorization.act.templateId:authorization-activity.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 |
| 648. Act.entryRelationship:authorization.act.templateId:authorization-activity.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.19 |
| 650. Act.entryRelationship:authorization.act.templateId:authorization-activity.extension | |
| Definition | A character string as a unique identifier within the scope of the identifier root. |
| 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 | Extension |
| 652. Act.entryRelationship:authorization.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:81-8944). |
| 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 |
| 654. Act.entryRelationship:authorization.act.moodCode | |
| Short | EVN |
| Comments | SHALL contain exactly one [1..1] @moodCode="EVN" Event (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:81-8945). |
| 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 |
| 656. Act.entryRelationship:authorization.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. |
| 658. Act.entryRelationship:authorization.act.id | |
| Comments | SHALL contain exactly one [1..1] id (CONF:81-8947). |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 660. Act.entryRelationship:authorization.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 |
| 662. Act.entryRelationship:authorization.act.text | |
| Short | SHOULD reference the portion of section narrative text corresponding to this entry |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ED |
| 664. Act.entryRelationship:authorization.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 |
| 666. Act.entryRelationship:authorization.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 |
| 668. Act.entryRelationship:authorization.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 |
| 670. Act.entryRelationship:authorization.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 |
| 672. Act.entryRelationship:authorization.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 |
| 674. Act.entryRelationship:authorization.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 |
| 676. Act.entryRelationship:authorization.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. |
| 678. Act.entryRelationship:authorization.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. |
| 680. Act.entryRelationship:authorization.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('#')) |
| 682. Act.entryRelationship:authorization.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 |
| 684. Act.entryRelationship:authorization.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 |
| 686. Act.entryRelationship:authorization.act.effectiveTime | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS |
| 688. Act.entryRelationship:authorization.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 |
| 690. Act.entryRelationship:authorization.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 |
| 692. Act.entryRelationship:authorization.act.subject | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Subject |
| 694. Act.entryRelationship:authorization.act.specimen | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Specimen |
| 696. Act.entryRelationship:authorization.act.performer | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Performer2 |
| 698. Act.entryRelationship:authorization.act.author | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Author |
| 700. Act.entryRelationship:authorization.act.informant | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Informant |
| 702. Act.entryRelationship:authorization.act.participant | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Participant2 |
| 704. Act.entryRelationship:authorization.act.entryRelationship | |
| Control | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship |
| Slicing | This element introduces a set of slices on Act.entryRelationship.act.entryRelationship. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 706. Act.entryRelationship:authorization.act.entryRelationship:target | |
| Slice Name | target |
| Short | The target of an authorization activity MAY contain one or more performer, to indicate the providers that have been authorized to provide treatment (CONF:81-8952). |
| Comments | SHALL contain at least one [1..*] entryRelationship (CONF:81-8948) such that it |
| Control | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship |
| Invariants | 81-8951: The target of an authorization activity with act/entryRelationship/@typeCode="SUBJ" SHALL be a clinical statement with moodCode="PRMS" Promise (CONF:81-8951). ((act | encounter | observation | observationMedia | organizer | procedure | regionOfInterest | substanceAdministration | supply).where(moodCode='PRMS').exists()) |
| 708. Act.entryRelationship:authorization.act.entryRelationship:target.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 |
| 710. Act.entryRelationship:authorization.act.entryRelationship:target.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 |
| 712. Act.entryRelationship:authorization.act.entryRelationship:target.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 |
| 714. Act.entryRelationship:authorization.act.entryRelationship:target.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 |
| 716. Act.entryRelationship:authorization.act.entryRelationship:target.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 |
| 718. Act.entryRelationship:authorization.act.entryRelationship:target.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 |
| 720. Act.entryRelationship:authorization.act.entryRelationship:target.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 |
| 722. Act.entryRelationship:authorization.act.entryRelationship:target.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 |
| 724. Act.entryRelationship:authorization.act.entryRelationship:target.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 |
| 726. Act.entryRelationship:authorization.act.entryRelationship:target.typeCode | |
| Comments | SHALL contain exactly one [1..1] @typeCode="SUBJ" Has Subject (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:81-8949). |
| 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 | SUBJ |
| 728. Act.entryRelationship:authorization.act.entryRelationship:target.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. |
| 730. Act.entryRelationship:authorization.act.entryRelationship:target.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 |
| 732. Act.entryRelationship:authorization.act.entryRelationship:target.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. |
| 734. Act.entryRelationship:authorization.act.entryRelationship:target.sequenceNumber | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/INT |
| 736. Act.entryRelationship:authorization.act.entryRelationship:target.seperatableInd | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/BL |
| 738. Act.entryRelationship:authorization.act.entryRelationship:target.act | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Act |
| 740. Act.entryRelationship:authorization.act.entryRelationship:target.encounter | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Encounter |
| 742. Act.entryRelationship:authorization.act.entryRelationship:target.observation | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Observation |
| 744. Act.entryRelationship:authorization.act.entryRelationship:target.observationMedia | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia |
| 746. Act.entryRelationship:authorization.act.entryRelationship:target.organizer | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Organizer |
| 748. Act.entryRelationship:authorization.act.entryRelationship:target.procedure | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Procedure |
| 750. Act.entryRelationship:authorization.act.entryRelationship:target.regionOfInterest | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest |
| 752. Act.entryRelationship:authorization.act.entryRelationship:target.substanceAdministration | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration |
| 754. Act.entryRelationship:authorization.act.entryRelationship:target.supply | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Supply |
| 756. Act.entryRelationship:authorization.act.reference | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Reference |
| 758. Act.entryRelationship:authorization.act.precondition | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Precondition |
| 760. Act.entryRelationship:authorization.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 nameprecondition2. |
| 762. Act.entryRelationship:authorization.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 nameinFulfillmentOf1. |
| 764. Act.entryRelationship:authorization.encounter | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Encounter |
| 766. Act.entryRelationship:authorization.observation | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Observation |
| 768. Act.entryRelationship:authorization.observationMedia | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia |
| 770. Act.entryRelationship:authorization.organizer | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Organizer |
| 772. Act.entryRelationship:authorization.procedure | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Procedure |
| 774. Act.entryRelationship:authorization.regionOfInterest | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest |
| 776. Act.entryRelationship:authorization.substanceAdministration | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration |
| 778. Act.entryRelationship:authorization.supply | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Supply |
| 780. Act.entryRelationship:plan | |
| Slice Name | plan |
| Short | Represents the Coverage Plan |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship |
| 782. 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 |
| 784. 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 |
| 786. 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 |
| 788. 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 |
| 790. 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 |
| 792. 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 |
| 794. 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 |
| 796. 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 |
| 798. 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 |
| 800. 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 |
| 802. 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. |
| 804. 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 |
| 806. 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. |
| 808. Act.entryRelationship:plan.sequenceNumber | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/INT |
| 810. Act.entryRelationship:plan.seperatableInd | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/BL |
| 812. 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 |
| 814. 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 |
| 816. 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 |
| 818. 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 |
| 820. 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 |
| 822. 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 |
| 824. 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 |
| 826. 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 |
| 828. 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 |
| 830. 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 |
| 832. 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 |
| 834. 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 |
| 836. 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. |
| 838. Act.entryRelationship:plan.act.id | |
| Short | Plan identifier |
| Control | 1..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 840. 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 |
| 842. Act.entryRelationship:plan.act.text | |
| Short | Name of the plan |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ED |
| 844. 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 |
| 846. Act.entryRelationship:plan.act.effectiveTime | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS |
| 848. 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 |
| 850. 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 |
| 852. Act.entryRelationship:plan.act.subject | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Subject |
| 854. Act.entryRelationship:plan.act.specimen | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Specimen |
| 856. Act.entryRelationship:plan.act.performer | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Performer2 |
| 858. Act.entryRelationship:plan.act.author | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Author |
| 860. Act.entryRelationship:plan.act.informant | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Informant |
| 862. Act.entryRelationship:plan.act.participant | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Participant2 |
| 864. Act.entryRelationship:plan.act.entryRelationship | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship |
| 866. Act.entryRelationship:plan.act.reference | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Reference |
| 868. Act.entryRelationship:plan.act.precondition | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Precondition |
| 870. 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 nameprecondition2. |
| 872. 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 nameinFulfillmentOf1. |
| 874. Act.entryRelationship:plan.encounter | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Encounter |
| 876. Act.entryRelationship:plan.observation | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Observation |
| 878. Act.entryRelationship:plan.observationMedia | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia |
| 880. Act.entryRelationship:plan.organizer | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Organizer |
| 882. Act.entryRelationship:plan.procedure | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Procedure |
| 884. Act.entryRelationship:plan.regionOfInterest | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest |
| 886. Act.entryRelationship:plan.substanceAdministration | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration |
| 888. Act.entryRelationship:plan.supply | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Supply |
| 890. Act.reference | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Reference |
| 892. Act.precondition | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Precondition |
| 894. 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 nameprecondition2. |
| 896. 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 nameinFulfillmentOf1. |
IG © 2019+ Health Level Seven. Package hl7.cda.us.ccda#3.0.0 based on FHIR 5.0.0. Generated 2024-05-18
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change