Consolidated CDA Release 2.1 StructureDefinition Publication, published by Health Level Seven. This is not an authorized publication; it is the continuous build for version 2.1). This version is based on the current content of https://github.com/HL7/CDA-ccda-2.1-sd/ and changes regularly. See the Directory of published versions
Draft as of 2023-09-29 |
Definitions for the HandoffCommunicationParticipants logical model.
Guidance on how to interpret the contents of this table can be found here
0. Act | |
XML Format | In the XML format, this property has the namespace urn:hl7-org:v3 . |
2. 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:1098-30832). |
Fixed Value | ACT |
4. Act.moodCode | |
Comments | SHALL contain exactly one [1..1] @moodCode="EVN" (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001) (CONF:1098-30833). |
Fixed Value | EVN |
6. Act.templateId | |
Control | 1..? |
Slicing | This element introduces a set of slices on Act.templateId . The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: |
8. Act.templateId:primary | |
Slice Name | primary |
Comments | SHALL contain exactly one [1..1] templateId (CONF:1098-30834) such that it, SHALL not contain [0..0] extension. |
Control | 1..1 |
10. Act.templateId:primary.root | |
Comments | SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.141" (CONF:1098-30835). |
Control | 1..? |
Pattern Value | 2.16.840.1.113883.10.20.22.4.141 |
12. Act.templateId:primary.extension | |
Control | 0..0 |
14. Act.code | |
Comments | SHALL contain exactly one [1..1] code (CONF:1098-30836). |
16. Act.code.code | |
Comments | This code SHALL contain exactly one [1..1] @code="432138007" handoff communication (procedure) (CONF:1098-30837). |
Control | 1..? |
Pattern Value | 432138007 |
18. Act.code.codeSystem | |
Comments | This code SHALL contain exactly one [1..1] @codeSystem="2.16.840.1.113883.6.96" (CodeSystem: SNOMED CT urn:oid:2.16.840.1.113883.6.96) (CONF:1098-30838). |
Control | 1..? |
Pattern Value | 2.16.840.1.113883.6.96 |
20. Act.statusCode | |
Comments | SHALL contain exactly one [1..1] statusCode (CONF:1098-31668). |
Control | 1..? |
22. 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) (CONF:1098-31669). |
Control | 1..? |
Fixed Value | completed |
24. Act.effectiveTime | |
Short | The effective time is the time when the handoff process took place between the sender and receiver of the patient information. This could be the time the information was transmitted, released, or verbally communicated to the next clinician. |
Comments | SHALL contain exactly one [1..1] effectiveTime (CONF:1098-31670). |
Control | 1..? |
26. Act.author | |
Short | The Author Participant contains the sender's contact information and is a resource for the Information Recipient for any follow-up questions. |
Comments | SHALL contain at least one [1..*] Author Participation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.119) (CONF:1098-31672). |
Control | 1..? |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Author(Author Participation) |
28. Act.participant | |
Short | Documentation of the Information Recipient's name and address verifies that the information was exchanged. |
Control | 1..? |
Slicing | This element introduces a set of slices on Act.participant . The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: |
30. Act.participant:infoRecipient | |
Slice Name | infoRecipient |
Comments | SHALL contain at least one [1..*] participant (CONF:1098-31673) such that it |
Control | 1..* |
32. Act.participant:infoRecipient.typeCode | |
Comments | SHALL contain exactly one [1..1] @typeCode="IRCP" Information Recipient (CodeSystem: HL7RoleClass urn:oid:2.16.840.1.113883.5.110) (CONF:1098-31674). |
Control | 1..? |
Fixed Value | IRCP |
34. Act.participant:infoRecipient.participantRole | |
Comments | SHALL contain exactly one [1..1] participantRole (CONF:1098-31675). |
36. Act.participant:infoRecipient.participantRole.id | |
Comments | This participantRole SHALL contain at least one [1..*] id (CONF:1098-32422). |
Control | 1..? |
38. Act.participant:infoRecipient.participantRole.code | |
Comments | This participantRole SHOULD contain zero or one [0..1] code, which SHOULD be selected from ValueSet Healthcare Provider Taxonomy urn:oid:2.16.840.1.114222.4.11.1066 DYNAMIC (CONF:1098-31676). |
Binding | The codes SHOULD be taken from Healthcare Provider Taxonomy |
40. Act.participant:infoRecipient.participantRole.addr | |
Comments | This participantRole SHALL contain at least one [1..*] addr (CONF:1098-32392). |
Control | 1..? |
42. Act.participant:infoRecipient.participantRole.playingEntity | |
Comments | This participantRole MAY contain zero or one [0..1] playingEntity (CONF:1098-32393). |
44. Act.participant:infoRecipient.participantRole.playingEntity.name | |
Comments | The playingEntity, if present, SHALL contain at least one [1..*] name (CONF:1098-32394). |
Control | 1..? |
Guidance on how to interpret the contents of this table can be found here
0. Act | |
Definition | Base definition for all types defined in FHIR type system. |
Short | Base for all types and resources |
Control | 10..1* |
Is Modifier | false |
XML Format | In the XML format, this property has the namespace urn:hl7-org:v3 . |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
2. Act.classCode | |
Definition | Element 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:1098-30832). |
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. |
Fixed Value | ACT |
4. Act.moodCode | |
Comments | SHALL contain exactly one [1..1] @moodCode="EVN" (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001) (CONF:1098-30833). |
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. |
Fixed Value | EVN |
6. 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 are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: |
8. Act.templateId:primary | |
Slice Name | primary |
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:1098-30834) such that it, SHALL not contain [0..0] extension. |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
10. Act.templateId:primary.root | |
Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier. |
Comments | SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.141" (CONF:1098-30835). |
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.141 |
12. Act.templateId:primary.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 |
14. Act.code | |
Comments | SHALL contain exactly one [1..1] code (CONF:1098-30836). |
Control | 1..1 |
Binding | Unless not suitable, these codes SHALL be taken from v3 Code System ActCode |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD |
16. 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. |
Comments | This code SHALL contain exactly one [1..1] @code="432138007" handoff communication (procedure) (CONF:1098-30837). |
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 | 432138007 |
18. Act.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.6.96" (CodeSystem: SNOMED CT urn:oid:2.16.840.1.113883.6.96) (CONF:1098-30838). |
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.6.96 |
20. Act.statusCode | |
Comments | SHALL contain exactly one [1..1] statusCode (CONF:1098-31668). |
Control | 1..1 |
Binding | The codes SHALL be taken from ActStatus |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
22. 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) (CONF:1098-31669). |
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 |
24. 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 |
26. 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 |
28. 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 |
30. 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 |
32. 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 |
34. 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 |
36. Act.statusCode.translation | |
Definition | A set of other concept descriptors that translate this concept descriptor into other code systems. |
Control | 0..0 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD |
XML Format | The type of this property is determined using the xsi:type attribute. |
Label | Translation |
38. Act.effectiveTime | |
Short | The effective time is the time when the handoff process took place between the sender and receiver of the patient information. This could be the time the information was transmitted, released, or verbally communicated to the next clinician. |
Comments | SHALL contain exactly one [1..1] effectiveTime (CONF:1098-31670). |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS |
40. Act.author | |
Definition | Base definition for all types defined in FHIR type system. |
Short | The Author Participant contains the sender's contact information and is a resource for the Information Recipient for any follow-up questions. |
Comments | SHALL contain at least one [1..*] Author Participation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.119) (CONF:1098-31672). |
Control | 1..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Author(Author Participation) |
Is Modifier | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
42. Act.participant | |
Short | Documentation of the Information Recipient's name and address verifies that the information was exchanged. |
Control | 1..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Participant2 |
Slicing | This element introduces a set of slices on Act.participant . The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: |
44. Act.participant:infoRecipient | |
Slice Name | infoRecipient |
Comments | SHALL contain at least one [1..*] participant (CONF:1098-31673) such that it |
Control | 1..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Participant2 |
46. Act.participant:infoRecipient.typeCode | |
Comments | SHALL contain exactly one [1..1] @typeCode="IRCP" Information Recipient (CodeSystem: HL7RoleClass urn:oid:2.16.840.1.113883.5.110) (CONF:1098-31674). |
Control | 1..1 |
Binding | The codes SHALL be taken from ParticipationType |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive 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 | IRCP |
48. Act.participant:infoRecipient.participantRole | |
Comments | SHALL contain exactly one [1..1] participantRole (CONF:1098-31675). |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ParticipantRole |
50. Act.participant:infoRecipient.participantRole.classCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from RoleClassRoot |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive 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 |
52. Act.participant:infoRecipient.participantRole.id | |
Comments | This participantRole SHALL contain at least one [1..*] id (CONF:1098-32422). |
Control | 1..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
54. Act.participant:infoRecipient.participantRole.code | |
Comments | This participantRole SHOULD contain zero or one [0..1] code, which SHOULD be selected from ValueSet Healthcare Provider Taxonomy urn:oid:2.16.840.1.114222.4.11.1066 DYNAMIC (CONF:1098-31676). |
Control | 0..1 |
Binding | The codes SHOULD be taken from Healthcare Provider Taxonomy |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
56. Act.participant:infoRecipient.participantRole.addr | |
Comments | This participantRole SHALL contain at least one [1..*] addr (CONF:1098-32392). |
Control | 1..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD |
58. Act.participant:infoRecipient.participantRole.playingEntity | |
Comments | This participantRole MAY contain zero or one [0..1] playingEntity (CONF:1098-32393). |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/PlayingEntity |
60. Act.participant:infoRecipient.participantRole.playingEntity.classCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from 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 |
62. Act.participant:infoRecipient.participantRole.playingEntity.name | |
Comments | The playingEntity, if present, SHALL contain at least one [1..*] name (CONF:1098-32394). |
Control | 1..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/PN |
Guidance on how to interpret the contents of this table can be found here
0. Act | |
Definition | Base definition for all types defined in FHIR type system. |
Short | Base for all types and resources |
Control | 1..1 |
Is Modifier | false |
XML Format | In the XML format, this property has the namespace urn:hl7-org:v3 . |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
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 NullFlavor |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element 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.classCode | |
Definition | Element 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:1098-30832). |
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. |
Fixed Value | ACT |
6. Act.moodCode | |
Comments | SHALL contain exactly one [1..1] @moodCode="EVN" (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001) (CONF:1098-30833). |
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. |
Fixed Value | EVN |
8. Act.realmCode | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
10. Act.typeId | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
12. 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 are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: |
14. Act.templateId:primary | |
Slice Name | primary |
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:1098-30834) such that it, SHALL not contain [0..0] extension. |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
16. Act.templateId:primary.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 NullFlavor |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element 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 |
18. Act.templateId:primary.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 |
20. Act.templateId:primary.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 |
22. Act.templateId:primary.root | |
Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier. |
Comments | SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.4.141" (CONF:1098-30835). |
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.141 |
24. Act.templateId:primary.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 |
26. Act.id | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
28. Act.code | |
Comments | SHALL contain exactly one [1..1] code (CONF:1098-30836). |
Control | 1..1 |
Binding | Unless not suitable, these codes SHALL be taken from v3 Code System ActCode |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD |
30. 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 NullFlavor |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element 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 |
32. 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. |
Comments | This code SHALL contain exactly one [1..1] @code="432138007" handoff communication (procedure) (CONF:1098-30837). |
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 | 432138007 |
34. Act.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.6.96" (CodeSystem: SNOMED CT urn:oid:2.16.840.1.113883.6.96) (CONF:1098-30838). |
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.6.96 |
36. 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 |
38. 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 |
40. 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 |
42. 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 . |
44. 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 . |
46. 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 |
48. 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 |
50. 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:type attribute. |
Label | Translation |
52. 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. |
54. Act.text | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED |
56. Act.statusCode | |
Comments | SHALL contain exactly one [1..1] statusCode (CONF:1098-31668). |
Control | 1..1 |
Binding | The codes SHALL be taken from ActStatus |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
58. 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 NullFlavor |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element 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 |
60. 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) (CONF:1098-31669). |
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 |
62. 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 |
64. 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 |
66. 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 |
68. 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 |
70. 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 . |
72. 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 . |
74. 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 |
76. 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 |
78. Act.statusCode.translation | |
Definition | A set of other concept descriptors that translate this concept descriptor into other code systems. |
Control | 0..0 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD |
XML Format | The type of this property is determined using the xsi:type attribute. |
Label | Translation |
80. Act.effectiveTime | |
Short | The effective time is the time when the handoff process took place between the sender and receiver of the patient information. This could be the time the information was transmitted, released, or verbally communicated to the next clinician. |
Comments | SHALL contain exactly one [1..1] effectiveTime (CONF:1098-31670). |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS |
82. Act.priorityCode | |
Control | 0..1 |
Binding | Unless not suitable, these codes SHALL be taken from ActPriority |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
84. Act.languageCode | |
Control | 0..1 |
Binding | The codes SHALL be taken from HumanLanguage |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
86. Act.subject | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Subject |
88. Act.specimen | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Specimen |
90. Act.performer | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Performer2 |
92. Act.author | |
Definition | Base definition for all types defined in FHIR type system. |
Short | The Author Participant contains the sender's contact information and is a resource for the Information Recipient for any follow-up questions. |
Comments | SHALL contain at least one [1..*] Author Participation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.119) (CONF:1098-31672). |
Control | 1..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Author(Author Participation) |
Is Modifier | false |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
94. Act.informant | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Informant |
96. Act.participant | |
Short | Documentation of the Information Recipient's name and address verifies that the information was exchanged. |
Control | 1..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Participant2 |
Slicing | This element introduces a set of slices on Act.participant . The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: |
98. Act.participant:infoRecipient | |
Slice Name | infoRecipient |
Comments | SHALL contain at least one [1..*] participant (CONF:1098-31673) such that it |
Control | 1..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Participant2 |
100. Act.participant:infoRecipient.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 NullFlavor |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element 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 |
102. Act.participant:infoRecipient.typeCode | |
Comments | SHALL contain exactly one [1..1] @typeCode="IRCP" Information Recipient (CodeSystem: HL7RoleClass urn:oid:2.16.840.1.113883.5.110) (CONF:1098-31674). |
Control | 1..1 |
Binding | The codes SHALL be taken from ParticipationType |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive 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 | IRCP |
104. Act.participant:infoRecipient.contextControlCode | |
Control | 0..1 |
Binding | The codes SHALL be taken from ContextControl |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive 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 |
106. Act.participant:infoRecipient.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 |
108. Act.participant:infoRecipient.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 |
110. Act.participant:infoRecipient.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 |
112. Act.participant:infoRecipient.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 . |
114. Act.participant:infoRecipient.time | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS |
116. Act.participant:infoRecipient.awarenessCode | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
118. Act.participant:infoRecipient.participantRole | |
Comments | SHALL contain exactly one [1..1] participantRole (CONF:1098-31675). |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ParticipantRole |
120. Act.participant:infoRecipient.participantRole.classCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from RoleClassRoot |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive 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 |
122. Act.participant:infoRecipient.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 |
124. Act.participant:infoRecipient.participantRole.id | |
Comments | This participantRole SHALL contain at least one [1..*] id (CONF:1098-32422). |
Control | 1..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
126. Act.participant:infoRecipient.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 . |
128. Act.participant:infoRecipient.participantRole.code | |
Comments | This participantRole SHOULD contain zero or one [0..1] code, which SHOULD be selected from ValueSet Healthcare Provider Taxonomy urn:oid:2.16.840.1.114222.4.11.1066 DYNAMIC (CONF:1098-31676). |
Control | 0..1 |
Binding | The codes SHOULD be taken from Healthcare Provider Taxonomy |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
130. Act.participant:infoRecipient.participantRole.addr | |
Comments | This participantRole SHALL contain at least one [1..*] addr (CONF:1098-32392). |
Control | 1..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD |
132. Act.participant:infoRecipient.participantRole.telecom | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL |
134. Act.participant:infoRecipient.participantRole.playingDevice | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Device |
136. Act.participant:infoRecipient.participantRole.playingEntity | |
Comments | This participantRole MAY contain zero or one [0..1] playingEntity (CONF:1098-32393). |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/PlayingEntity |
138. Act.participant:infoRecipient.participantRole.playingEntity.classCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from 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 |
140. Act.participant:infoRecipient.participantRole.playingEntity.determinerCode | |
Control | 0..1 |
Binding | The codes SHALL be taken from 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 |
142. Act.participant:infoRecipient.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 |
144. Act.participant:infoRecipient.participantRole.playingEntity.code | |
Control | 0..1 |
Binding | Unless not suitable, these codes SHALL be taken from EntityCode |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
146. Act.participant:infoRecipient.participantRole.playingEntity.quantity | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/PQ |
148. Act.participant:infoRecipient.participantRole.playingEntity.name | |
Comments | The playingEntity, if present, SHALL contain at least one [1..*] name (CONF:1098-32394). |
Control | 1..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/PN |
150. Act.participant:infoRecipient.participantRole.playingEntity.sdtcBirthTime | |
Control | 0..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 . |
152. Act.participant:infoRecipient.participantRole.playingEntity.desc | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED |
154. Act.participant:infoRecipient.participantRole.scopingEntity | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Entity |
156. Act.entryRelationship | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship |
158. Act.reference | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Reference |
160. Act.precondition | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Precondition |