Consolidated CDA Release 2.1 StructureDefinition Publication
2.1 - CI Build United States of America flag

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

Logical Model: Handoff Communication Participants

Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/HandoffCommunicationParticipants Version: 2.1
Draft as of 2023-09-29 Computable Name: HandoffCommunicationParticipants
Other Identifiers: id: urn:oid:2.16.840.1.113883.10.20.22.4.141

This template represents the sender (author) and receivers (participants) of a handoff communication in a plan of treatment. It does not convey details about the communication. The “handoff” process involves senders, those transmitting the patient’s information and releasing the care of that patient to the next clinician, and receivers, those who accept the patient information and care of that patient.

Usage:

Formal Views of Profile Content

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

This structure is derived from CDAR2.Act

NameFlagsCard.TypeDescription & Constraintsdoco
.. Act CDAR2.ActXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, @classCode, @moodCode, realmCode, typeId, templateId, id, code, @negationInd, text, statusCode, effectiveTime, priorityCode, languageCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition
... classCode 1..1csFixed Value: ACT
... moodCode 1..1csFixed Value: EVN
... Slices for templateId 1..*IISlice: Unordered, Open by value:root
.... templateId:primary 1..1II
..... root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.141
..... extension 0..0
.... code 1..1csRequired Pattern: 432138007
.... codeSystem 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.6.96
... statusCode 1..1CS
.... code 1..1csFixed Value: completed
... effectiveTime 1..1IVL_TSThe 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.
... author 1..*AuthorParticipationThe Author Participant contains the sender's contact information and is a resource for the Information Recipient for any follow-up questions.
... Slices for participant 1..*Participant2Documentation of the Information Recipient's name and address verifies that the information was exchanged.
Slice: Unordered, Open by value:typeCode
.... participant:infoRecipient 1..*Participant2
..... typeCode 1..1csFixed Value: IRCP
..... participantRole 1..1ParticipantRole
...... id 1..*II
...... code 0..1CEBinding: Healthcare Provider Taxonomy (preferred)
...... addr 1..*AD
...... playingEntity 0..1PlayingEntity
....... name 1..*PN

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Act.participant:infoRecipient.participantRole.codepreferredHealthcare Provider Taxonomy (a valid code from http://nucc.org/provider-taxonomy)
NameFlagsCard.TypeDescription & Constraintsdoco
.. Act 1..1CDAR2.ActXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, @classCode, @moodCode, realmCode, typeId, templateId, id, code, @negationInd, text, statusCode, effectiveTime, priorityCode, languageCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition
Base for all types and resources
... @classCode 1..1csFixed Value: ACT
... @moodCode 1..1csFixed Value: EVN
... Slices for templateId 1..*IISlice: Unordered, Open by value:root
.... templateId:primary 1..1II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.141
.... @code 1..1csRequired Pattern: 432138007
.... @codeSystem 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.6.96
... statusCode 1..1CSBinding: ActStatus (required)
.... @code 1..1csFixed Value: completed
... effectiveTime 1..1IVL_TSThe 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.
... author 1..*AuthorParticipationThe Author Participant contains the sender's contact information and is a resource for the Information Recipient for any follow-up questions.
... Slices for participant 1..*Participant2Documentation of the Information Recipient's name and address verifies that the information was exchanged.
Slice: Unordered, Open by value:typeCode
.... participant:infoRecipient 1..*Participant2
..... @typeCode 1..1csBinding: ParticipationType (required)
Fixed Value: IRCP
..... participantRole 1..1ParticipantRole
...... @classCode 1..1csBinding: RoleClassRoot (required)
...... id 1..*II
...... code 0..1CEBinding: Healthcare Provider Taxonomy (preferred)
...... addr 1..*AD
...... playingEntity 0..1PlayingEntity
....... @classCode 1..1csBinding: EntityClassRoot (required)
....... name 1..*PN

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Act.codeextensibleActCode
Act.statusCoderequiredActStatus
Act.participant:infoRecipient.typeCoderequiredFixed Value: IRCP
Act.participant:infoRecipient.participantRole.classCoderequiredRoleClassRoot
Act.participant:infoRecipient.participantRole.codepreferredHealthcare Provider Taxonomy (a valid code from http://nucc.org/provider-taxonomy)
Act.participant:infoRecipient.participantRole.playingEntity.classCoderequiredEntityClassRoot

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
NameFlagsCard.TypeDescription & Constraintsdoco
.. Act 1..1CDAR2.ActXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, @classCode, @moodCode, realmCode, typeId, templateId, id, code, @negationInd, text, statusCode, effectiveTime, priorityCode, languageCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition
Base for all types and resources
... @nullFlavor 0..1csBinding: NullFlavor (required)
... @classCode 1..1csFixed Value: ACT
... @moodCode 1..1csFixed Value: EVN
... typeId 0..1II
... Slices for templateId 1..*IISlice: Unordered, Open by value:root
.... templateId:primary 1..1II
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.141
... id 0..*II
... code 1..1CDBinding: v3 Code System ActCode (extensible)
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... @code 1..1csRequired Pattern: 432138007
.... @codeSystem 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.6.96
.... @codeSystemName 0..1st
.... @codeSystemVersion 0..1st
.... @displayName 0..1st
.... @sdtcValueSet 0..1oidXML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
.... @sdtcValueSetVersion 0..1stXML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
.... originalText 0..1ED
.... qualifier 0..*CR
.... translation 0..*CD
... @negationInd 0..1bl
... text 0..1ED
... statusCode 1..1CSBinding: ActStatus (required)
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... @code 1..1csFixed Value: completed
.... @sdtcValueSet 0..1oidXML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
.... @sdtcValueSetVersion 0..1stXML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
... effectiveTime 1..1IVL_TSThe 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.
... priorityCode 0..1CEBinding: ActPriority (extensible)
... languageCode 0..1CSBinding: HumanLanguage (required)
... subject 0..1Subject
... specimen 0..*Specimen
... performer 0..*Performer2
... author 1..*AuthorParticipationThe Author Participant contains the sender's contact information and is a resource for the Information Recipient for any follow-up questions.
... informant 0..*Informant
... Slices for participant 1..*Participant2Documentation of the Information Recipient's name and address verifies that the information was exchanged.
Slice: Unordered, Open by value:typeCode
.... participant:infoRecipient 1..*Participant2
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... @typeCode 1..1csBinding: ParticipationType (required)
Fixed Value: IRCP
..... @contextControlCode 0..1csBinding: ContextControl (required)
Fixed Value: OP
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... sdtcFunctionCode 0..1CEXML Namespace: urn:hl7-org:sdtc
XML: functionCode (urn:hl7-org:sdtc)
..... time 0..1IVL_TS
..... awarenessCode 0..1CE
..... participantRole 1..1ParticipantRole
...... @classCode 1..1csBinding: RoleClassRoot (required)
...... templateId 0..*II
...... id 1..*II
...... sdtcIdentifiedBy 0..*IdentifiedByXML Namespace: urn:hl7-org:sdtc
XML: identifiedBy (urn:hl7-org:sdtc)
...... code 0..1CEBinding: Healthcare Provider Taxonomy (preferred)
...... addr 1..*AD
...... telecom 0..*TEL
...... playingDevice 0..1Device
...... playingEntity 0..1PlayingEntity
....... @classCode 1..1csBinding: EntityClassRoot (required)
....... @determinerCode 0..1csBinding: EntityDeterminer (required)
Fixed Value: INSTANCE
....... templateId 0..*II
....... code 0..1CEBinding: EntityCode (extensible)
....... quantity 0..*PQ
....... name 1..*PN
....... sdtcBirthTime 0..1TSXML Namespace: urn:hl7-org:sdtc
XML: birthTime (urn:hl7-org:sdtc)
....... desc 0..1ED
...... scopingEntity 0..1Entity
... entryRelationship 0..*EntryRelationship
... reference 0..*Reference
... precondition 0..*Precondition

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Act.nullFlavorrequiredNullFlavor
Act.templateId:primary.nullFlavorrequiredNullFlavor
Act.codeextensibleActCode
Act.code.nullFlavorrequiredNullFlavor
Act.statusCoderequiredActStatus
Act.statusCode.nullFlavorrequiredNullFlavor
Act.priorityCodeextensibleActPriority
Act.languageCoderequiredHumanLanguage (a valid code from http://terminology.hl7.org/CodeSystem/ietf3066)
Act.participant:infoRecipient.nullFlavorrequiredNullFlavor
Act.participant:infoRecipient.typeCoderequiredFixed Value: IRCP
Act.participant:infoRecipient.contextControlCoderequiredFixed Value: OP
Act.participant:infoRecipient.participantRole.classCoderequiredRoleClassRoot
Act.participant:infoRecipient.participantRole.codepreferredHealthcare Provider Taxonomy (a valid code from http://nucc.org/provider-taxonomy)
Act.participant:infoRecipient.participantRole.playingEntity.classCoderequiredEntityClassRoot
Act.participant:infoRecipient.participantRole.playingEntity.determinerCoderequiredFixed Value: INSTANCE
Act.participant:infoRecipient.participantRole.playingEntity.codeextensibleEntityCode

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())

This structure is derived from CDAR2.Act

Summary

Mandatory: 14 elements (1 nested mandatory element)
Fixed Value: 4 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Act.templateId is sliced based on the value of value:root
  • The element Act.participant is sliced based on the value of value:typeCode

Differential View

This structure is derived from CDAR2.Act

NameFlagsCard.TypeDescription & Constraintsdoco
.. Act CDAR2.ActXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, @classCode, @moodCode, realmCode, typeId, templateId, id, code, @negationInd, text, statusCode, effectiveTime, priorityCode, languageCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition
... classCode 1..1csFixed Value: ACT
... moodCode 1..1csFixed Value: EVN
... Slices for templateId 1..*IISlice: Unordered, Open by value:root
.... templateId:primary 1..1II
..... root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.141
..... extension 0..0
.... code 1..1csRequired Pattern: 432138007
.... codeSystem 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.6.96
... statusCode 1..1CS
.... code 1..1csFixed Value: completed
... effectiveTime 1..1IVL_TSThe 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.
... author 1..*AuthorParticipationThe Author Participant contains the sender's contact information and is a resource for the Information Recipient for any follow-up questions.
... Slices for participant 1..*Participant2Documentation of the Information Recipient's name and address verifies that the information was exchanged.
Slice: Unordered, Open by value:typeCode
.... participant:infoRecipient 1..*Participant2
..... typeCode 1..1csFixed Value: IRCP
..... participantRole 1..1ParticipantRole
...... id 1..*II
...... code 0..1CEBinding: Healthcare Provider Taxonomy (preferred)
...... addr 1..*AD
...... playingEntity 0..1PlayingEntity
....... name 1..*PN

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Act.participant:infoRecipient.participantRole.codepreferredHealthcare Provider Taxonomy (a valid code from http://nucc.org/provider-taxonomy)

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Act 1..1CDAR2.ActXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, @classCode, @moodCode, realmCode, typeId, templateId, id, code, @negationInd, text, statusCode, effectiveTime, priorityCode, languageCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition
Base for all types and resources
... @classCode 1..1csFixed Value: ACT
... @moodCode 1..1csFixed Value: EVN
... Slices for templateId 1..*IISlice: Unordered, Open by value:root
.... templateId:primary 1..1II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.141
.... @code 1..1csRequired Pattern: 432138007
.... @codeSystem 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.6.96
... statusCode 1..1CSBinding: ActStatus (required)
.... @code 1..1csFixed Value: completed
... effectiveTime 1..1IVL_TSThe 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.
... author 1..*AuthorParticipationThe Author Participant contains the sender's contact information and is a resource for the Information Recipient for any follow-up questions.
... Slices for participant 1..*Participant2Documentation of the Information Recipient's name and address verifies that the information was exchanged.
Slice: Unordered, Open by value:typeCode
.... participant:infoRecipient 1..*Participant2
..... @typeCode 1..1csBinding: ParticipationType (required)
Fixed Value: IRCP
..... participantRole 1..1ParticipantRole
...... @classCode 1..1csBinding: RoleClassRoot (required)
...... id 1..*II
...... code 0..1CEBinding: Healthcare Provider Taxonomy (preferred)
...... addr 1..*AD
...... playingEntity 0..1PlayingEntity
....... @classCode 1..1csBinding: EntityClassRoot (required)
....... name 1..*PN

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Act.codeextensibleActCode
Act.statusCoderequiredActStatus
Act.participant:infoRecipient.typeCoderequiredFixed Value: IRCP
Act.participant:infoRecipient.participantRole.classCoderequiredRoleClassRoot
Act.participant:infoRecipient.participantRole.codepreferredHealthcare Provider Taxonomy (a valid code from http://nucc.org/provider-taxonomy)
Act.participant:infoRecipient.participantRole.playingEntity.classCoderequiredEntityClassRoot

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Act 1..1CDAR2.ActXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, @classCode, @moodCode, realmCode, typeId, templateId, id, code, @negationInd, text, statusCode, effectiveTime, priorityCode, languageCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition
Base for all types and resources
... @nullFlavor 0..1csBinding: NullFlavor (required)
... @classCode 1..1csFixed Value: ACT
... @moodCode 1..1csFixed Value: EVN
... typeId 0..1II
... Slices for templateId 1..*IISlice: Unordered, Open by value:root
.... templateId:primary 1..1II
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.141
... id 0..*II
... code 1..1CDBinding: v3 Code System ActCode (extensible)
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... @code 1..1csRequired Pattern: 432138007
.... @codeSystem 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.6.96
.... @codeSystemName 0..1st
.... @codeSystemVersion 0..1st
.... @displayName 0..1st
.... @sdtcValueSet 0..1oidXML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
.... @sdtcValueSetVersion 0..1stXML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
.... originalText 0..1ED
.... qualifier 0..*CR
.... translation 0..*CD
... @negationInd 0..1bl
... text 0..1ED
... statusCode 1..1CSBinding: ActStatus (required)
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... @code 1..1csFixed Value: completed
.... @sdtcValueSet 0..1oidXML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
.... @sdtcValueSetVersion 0..1stXML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
... effectiveTime 1..1IVL_TSThe 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.
... priorityCode 0..1CEBinding: ActPriority (extensible)
... languageCode 0..1CSBinding: HumanLanguage (required)
... subject 0..1Subject
... specimen 0..*Specimen
... performer 0..*Performer2
... author 1..*AuthorParticipationThe Author Participant contains the sender's contact information and is a resource for the Information Recipient for any follow-up questions.
... informant 0..*Informant
... Slices for participant 1..*Participant2Documentation of the Information Recipient's name and address verifies that the information was exchanged.
Slice: Unordered, Open by value:typeCode
.... participant:infoRecipient 1..*Participant2
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... @typeCode 1..1csBinding: ParticipationType (required)
Fixed Value: IRCP
..... @contextControlCode 0..1csBinding: ContextControl (required)
Fixed Value: OP
..... realmCode 0..*CS
..... typeId 0..1II
..... templateId 0..*II
..... sdtcFunctionCode 0..1CEXML Namespace: urn:hl7-org:sdtc
XML: functionCode (urn:hl7-org:sdtc)
..... time 0..1IVL_TS
..... awarenessCode 0..1CE
..... participantRole 1..1ParticipantRole
...... @classCode 1..1csBinding: RoleClassRoot (required)
...... templateId 0..*II
...... id 1..*II
...... sdtcIdentifiedBy 0..*IdentifiedByXML Namespace: urn:hl7-org:sdtc
XML: identifiedBy (urn:hl7-org:sdtc)
...... code 0..1CEBinding: Healthcare Provider Taxonomy (preferred)
...... addr 1..*AD
...... telecom 0..*TEL
...... playingDevice 0..1Device
...... playingEntity 0..1PlayingEntity
....... @classCode 1..1csBinding: EntityClassRoot (required)
....... @determinerCode 0..1csBinding: EntityDeterminer (required)
Fixed Value: INSTANCE
....... templateId 0..*II
....... code 0..1CEBinding: EntityCode (extensible)
....... quantity 0..*PQ
....... name 1..*PN
....... sdtcBirthTime 0..1TSXML Namespace: urn:hl7-org:sdtc
XML: birthTime (urn:hl7-org:sdtc)
....... desc 0..1ED
...... scopingEntity 0..1Entity
... entryRelationship 0..*EntryRelationship
... reference 0..*Reference
... precondition 0..*Precondition

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Act.nullFlavorrequiredNullFlavor
Act.templateId:primary.nullFlavorrequiredNullFlavor
Act.codeextensibleActCode
Act.code.nullFlavorrequiredNullFlavor
Act.statusCoderequiredActStatus
Act.statusCode.nullFlavorrequiredNullFlavor
Act.priorityCodeextensibleActPriority
Act.languageCoderequiredHumanLanguage (a valid code from http://terminology.hl7.org/CodeSystem/ietf3066)
Act.participant:infoRecipient.nullFlavorrequiredNullFlavor
Act.participant:infoRecipient.typeCoderequiredFixed Value: IRCP
Act.participant:infoRecipient.contextControlCoderequiredFixed Value: OP
Act.participant:infoRecipient.participantRole.classCoderequiredRoleClassRoot
Act.participant:infoRecipient.participantRole.codepreferredHealthcare Provider Taxonomy (a valid code from http://nucc.org/provider-taxonomy)
Act.participant:infoRecipient.participantRole.playingEntity.classCoderequiredEntityClassRoot
Act.participant:infoRecipient.participantRole.playingEntity.determinerCoderequiredFixed Value: INSTANCE
Act.participant:infoRecipient.participantRole.playingEntity.codeextensibleEntityCode

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())

This structure is derived from CDAR2.Act

Summary

Mandatory: 14 elements (1 nested mandatory element)
Fixed Value: 4 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Act.templateId is sliced based on the value of value:root
  • The element Act.participant is sliced based on the value of value:typeCode

 

Other representations of profile: CSV, Excel