Consolidated CDA
3.0.0-ballot - ballot United States of America flag

This page is part of the CCDA: Consolidated CDA Release (v3.0.0-ballot: CCDA 3.0 Ballot 1) based on FHIR (HL7® FHIR® Standard) v5.0.0. . For a full list of available versions, see the Directory of published versions

Logical Model: Handoff Communication Participants

Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/HandoffCommunicationParticipants Version: 3.0.0-ballot
Draft as of 2023-12-21 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 Act

NameFlagsCard.TypeDescription & Constraintsdoco
.. Act C1..1ActXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, @negationInd, id, code, text, statusCode, effectiveTime, priorityCode, languageCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, sdtcInFulfillmentOf1
Base for all types and resources
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
should-text-ref-value: SHOULD contain text/reference/@value
... Slices for templateId 1..*IISlice: Unordered, Open by value:root
.... templateId:handoff-comm-participants 1..1II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.141
..... @extension 0..0
... @classCode 1..1csFixed Value: ACT
... @moodCode 1..1csFixed Value: EVN
.... @code 1..1csRequired Pattern: 432138007
.... @codeSystem 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.6.96
... text 0..1EDSHOULD reference the portion of section narrative text corresponding to this entry
.... reference C0..1TELvalue-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
... 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 C1..1ParticipantRoleshould-code: SHOULD contain code
...... id 1..*II
...... code 0..1CEBinding: Healthcare Provider Taxonomy (preferred)
...... addr 1..*USRealmAddressBase for all types and resources
...... playingEntity 0..1PlayingEntity
....... name 1..*PN

doco Documentation for this format

Terminology Bindings (Differential)

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

Constraints

IdGradePath(s)DetailsRequirements
should-codewarningAct.participant:infoRecipient.participantRoleSHOULD contain code
: code.exists()
should-text-ref-valuewarningActSHOULD contain text/reference/@value
: text.reference.value.exists()
value-starts-octothorpeerrorAct.text.referenceIf reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
: value.exists() implies value.startsWith('#')
NameFlagsCard.TypeDescription & Constraintsdoco
.. Act C1..1ActXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, @negationInd, id, code, text, statusCode, effectiveTime, priorityCode, languageCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, sdtcInFulfillmentOf1
Base for all types and resources
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
should-text-ref-value: SHOULD contain text/reference/@value
... Slices for templateId 1..*IISlice: Unordered, Open by value:root
.... templateId:handoff-comm-participants 1..1II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.141
... @classCode 1..1csBinding: XActClassDocumentEntryAct (2.0.0) (required)
Fixed Value: ACT
... @moodCode 1..1csBinding: XDocumentActMood (2.0.0) (required)
Fixed Value: EVN
.... @code 1..1csRequired Pattern: 432138007
.... @codeSystem 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.6.96
... text 0..1EDSHOULD reference the portion of section narrative text corresponding to this entry
.... reference C0..1TELvalue-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
... 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 C1..1ParticipantRoleshould-code: SHOULD contain code
...... @classCode 1..1csBinding: RoleClassRoot (required)
...... id 1..*II
...... code 0..1CEBinding: Healthcare Provider Taxonomy (preferred)
...... addr C1..*USRealmAddressBase for all types and resources
...... playingEntity 0..1PlayingEntity
....... @classCode 1..1csBinding: EntityClassRoot (required)
....... name 1..*PN

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Act.classCoderequiredFixed Value: ACT
Act.moodCoderequiredFixed Value: EVN
Act.codeexampleActCode
Act.statusCoderequiredActStatus
Act.participant:infoRecipient.typeCoderequiredFixed Value: IRCP
Act.participant:infoRecipient.participantRole.classCoderequiredRoleClassRoot
Act.participant:infoRecipient.participantRole.codepreferredHealthcareProviderTaxonomy (a valid code from http://nucc.org/provider-taxonomy)
Act.participant:infoRecipient.participantRole.playingEntity.classCoderequiredEntityClassRoot

Constraints

IdGradePath(s)DetailsRequirements
81-7296errorAct.participant:infoRecipient.participantRole.addr**SHALL NOT** have mixed content except for white space (CONF:81-7296)
: item.xmlText.empty()
81-10024errorAct.participant:infoRecipient.participantRole.addrIf 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-10025errorAct.participant:infoRecipient.participantRole.addrIf 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-cityerrorAct.participant:infoRecipient.participantRole.addrSHALL contain exactly one [1..1] city (CONF:81-7292).
: nullFlavor.exists() or item.city.count() = 1
shall-max-ad-partserrorAct.participant:infoRecipient.participantRole.addrSHALL 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)
shall-streetAddressLineerrorAct.participant:infoRecipient.participantRole.addrSHALL 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-codewarningAct.participant:infoRecipient.participantRoleSHOULD contain code
: code.exists()
should-countrywarningAct.participant:infoRecipient.participantRole.addrSHOULD contain country
: nullFlavor.exists() or item.country.exists()
should-text-ref-valuewarningActSHOULD contain text/reference/@value
: text.reference.value.exists()
should-usewarningAct.participant:infoRecipient.participantRole.addrSHOULD contain @use
: nullFlavor.exists() or use.exists()
value-starts-octothorpeerrorAct.text.referenceIf reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
: value.exists() implies value.startsWith('#')
NameFlagsCard.TypeDescription & Constraintsdoco
.. Act C1..1ActXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, @negationInd, id, code, text, statusCode, effectiveTime, priorityCode, languageCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, sdtcInFulfillmentOf1
Base for all types and resources
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
should-text-ref-value: SHOULD contain text/reference/@value
... @nullFlavor 0..1csBinding: CDANullFlavor (required)
... realmCode 0..*CS
... typeId 0..1II
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @assigningAuthorityName 0..1st
.... @displayable 0..1bl
.... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1st
.... templateId:handoff-comm-participants 1..1II
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.141
... @classCode 1..1csBinding: XActClassDocumentEntryAct (2.0.0) (required)
Fixed Value: ACT
... @moodCode 1..1csBinding: XDocumentActMood (2.0.0) (required)
Fixed Value: EVN
... @negationInd 0..1bl
... id 0..*II
... code 1..1CDBinding: v3 Code System ActCode (example)
.... @nullFlavor 0..1csBinding: CDANullFlavor (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
... text 0..1EDSHOULD reference the portion of section narrative text corresponding to this entry
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @compression 0..1csBinding: CompressionAlgorithm (required)
.... @integrityCheck 0..1bin
.... @integrityCheckAlgorithm 0..1csBinding: IntegrityCheckAlgorithm (2.0.0) (required)
.... @language 0..1cs
.... @mediaType 0..1csBinding: MediaType (example)
.... @representation 0..1csBinding: Binary Data Encoding Value Set (required)
.... xmlText 0..1stAllows for mixed text content. If @representation='B64', this SHALL be a base64binary string.
.... reference C0..1TELvalue-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
.... thumbnail 0..1ED
... statusCode 1..1CSBinding: ActStatus (required)
.... @nullFlavor 0..1csBinding: CDANullFlavor (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 (example)
... languageCode 0..1CSBinding: AllLanguages (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: CDANullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
...... @nullFlavor 0..1csBinding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1st
...... @displayable 0..1bl
...... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1st
..... templateId 0..*II
..... @typeCode 1..1csBinding: ParticipationType (required)
Fixed Value: IRCP
..... @contextControlCode 0..1csBinding: ContextControl (required)
Fixed Value: OP
..... sdtcFunctionCode 0..1CEXML Namespace: urn:hl7-org:sdtc
XML: functionCode (urn:hl7-org:sdtc)
..... time 0..1IVL_TS
..... awarenessCode 0..1CE
..... participantRole C1..1ParticipantRoleshould-code: SHOULD contain code
...... @nullFlavor 0..1csBinding: CDANullFlavor (required)
...... realmCode 0..*CS
...... typeId 0..1II
....... @nullFlavor 0..1csBinding: CDANullFlavor (required)
....... @assigningAuthorityName 0..1st
....... @displayable 0..1bl
....... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
....... @extension 1..1st
...... templateId 0..*II
...... @classCode 1..1csBinding: RoleClassRoot (required)
...... 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 C1..*USRealmAddressBase for all types and resources
...... telecom 0..*TEL
...... playingDevice 0..1Device
...... playingEntity 0..1PlayingEntity
....... @nullFlavor 0..1csBinding: CDANullFlavor (required)
....... realmCode 0..*CS
....... typeId 0..1II
........ @nullFlavor 0..1csBinding: CDANullFlavor (required)
........ @assigningAuthorityName 0..1st
........ @displayable 0..1bl
........ @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
........ @extension 1..1st
....... templateId 0..*II
....... @classCode 1..1csBinding: EntityClassRoot (required)
....... @determinerCode 0..1csBinding: EntityDeterminer (required)
Fixed Value: INSTANCE
....... code 0..1CEBinding: EntityCode (example)
....... 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
... sdtcPrecondition2 0..*Precondition2XML Namespace: urn:hl7-org:sdtc
XML: precondition2 (urn:hl7-org:sdtc)
... sdtcInFulfillmentOf1 0..*InFulfillmentOf1XML Namespace: urn:hl7-org:sdtc
XML: inFulfillmentOf1 (urn:hl7-org:sdtc)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Act.nullFlavorrequiredCDANullFlavor
Act.typeId.nullFlavorrequiredCDANullFlavor
Act.templateId:handoff-comm-participants.nullFlavorrequiredCDANullFlavor
Act.classCoderequiredFixed Value: ACT
Act.moodCoderequiredFixed Value: EVN
Act.codeexampleActCode
Act.code.nullFlavorrequiredCDANullFlavor
Act.text.nullFlavorrequiredCDANullFlavor
Act.text.compressionrequiredCDACompressionAlgorithm
Act.text.integrityCheckAlgorithmrequiredIntegrityCheckAlgorithm
Act.text.mediaTypeexampleMediaType
Act.text.representationrequiredBinaryDataEncoding
Act.statusCoderequiredActStatus
Act.statusCode.nullFlavorrequiredCDANullFlavor
Act.priorityCodeexampleActPriority
Act.languageCoderequiredAllLanguages
Act.participant:infoRecipient.nullFlavorrequiredCDANullFlavor
Act.participant:infoRecipient.typeId.nullFlavorrequiredCDANullFlavor
Act.participant:infoRecipient.typeCoderequiredFixed Value: IRCP
Act.participant:infoRecipient.contextControlCoderequiredFixed Value: OP
Act.participant:infoRecipient.participantRole.nullFlavorrequiredCDANullFlavor
Act.participant:infoRecipient.participantRole.typeId.nullFlavorrequiredCDANullFlavor
Act.participant:infoRecipient.participantRole.classCoderequiredRoleClassRoot
Act.participant:infoRecipient.participantRole.codepreferredHealthcareProviderTaxonomy (a valid code from http://nucc.org/provider-taxonomy)
Act.participant:infoRecipient.participantRole.playingEntity.nullFlavorrequiredCDANullFlavor
Act.participant:infoRecipient.participantRole.playingEntity.typeId.nullFlavorrequiredCDANullFlavor
Act.participant:infoRecipient.participantRole.playingEntity.classCoderequiredEntityClassRoot
Act.participant:infoRecipient.participantRole.playingEntity.determinerCoderequiredFixed Value: INSTANCE
Act.participant:infoRecipient.participantRole.playingEntity.codeexampleEntityCode

Constraints

IdGradePath(s)DetailsRequirements
81-7296errorAct.participant:infoRecipient.participantRole.addr**SHALL NOT** have mixed content except for white space (CONF:81-7296)
: item.xmlText.empty()
81-10024errorAct.participant:infoRecipient.participantRole.addrIf 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-10025errorAct.participant:infoRecipient.participantRole.addrIf 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-cityerrorAct.participant:infoRecipient.participantRole.addrSHALL contain exactly one [1..1] city (CONF:81-7292).
: nullFlavor.exists() or item.city.count() = 1
shall-max-ad-partserrorAct.participant:infoRecipient.participantRole.addrSHALL 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)
shall-streetAddressLineerrorAct.participant:infoRecipient.participantRole.addrSHALL 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-codewarningAct.participant:infoRecipient.participantRoleSHOULD contain code
: code.exists()
should-countrywarningAct.participant:infoRecipient.participantRole.addrSHOULD contain country
: nullFlavor.exists() or item.country.exists()
should-text-ref-valuewarningActSHOULD contain text/reference/@value
: text.reference.value.exists()
should-usewarningAct.participant:infoRecipient.participantRole.addrSHOULD contain @use
: nullFlavor.exists() or use.exists()
value-starts-octothorpeerrorAct.text.referenceIf reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
: value.exists() implies value.startsWith('#')

This structure is derived from Act

Summary

Mandatory: 13 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 Act

NameFlagsCard.TypeDescription & Constraintsdoco
.. Act C1..1ActXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, @negationInd, id, code, text, statusCode, effectiveTime, priorityCode, languageCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, sdtcInFulfillmentOf1
Base for all types and resources
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
should-text-ref-value: SHOULD contain text/reference/@value
... Slices for templateId 1..*IISlice: Unordered, Open by value:root
.... templateId:handoff-comm-participants 1..1II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.141
..... @extension 0..0
... @classCode 1..1csFixed Value: ACT
... @moodCode 1..1csFixed Value: EVN
.... @code 1..1csRequired Pattern: 432138007
.... @codeSystem 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.6.96
... text 0..1EDSHOULD reference the portion of section narrative text corresponding to this entry
.... reference C0..1TELvalue-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
... 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 C1..1ParticipantRoleshould-code: SHOULD contain code
...... id 1..*II
...... code 0..1CEBinding: Healthcare Provider Taxonomy (preferred)
...... addr 1..*USRealmAddressBase for all types and resources
...... playingEntity 0..1PlayingEntity
....... name 1..*PN

doco Documentation for this format

Terminology Bindings (Differential)

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

Constraints

IdGradePath(s)DetailsRequirements
should-codewarningAct.participant:infoRecipient.participantRoleSHOULD contain code
: code.exists()
should-text-ref-valuewarningActSHOULD contain text/reference/@value
: text.reference.value.exists()
value-starts-octothorpeerrorAct.text.referenceIf reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
: value.exists() implies value.startsWith('#')

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Act C1..1ActXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, @negationInd, id, code, text, statusCode, effectiveTime, priorityCode, languageCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, sdtcInFulfillmentOf1
Base for all types and resources
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
should-text-ref-value: SHOULD contain text/reference/@value
... Slices for templateId 1..*IISlice: Unordered, Open by value:root
.... templateId:handoff-comm-participants 1..1II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.141
... @classCode 1..1csBinding: XActClassDocumentEntryAct (2.0.0) (required)
Fixed Value: ACT
... @moodCode 1..1csBinding: XDocumentActMood (2.0.0) (required)
Fixed Value: EVN
.... @code 1..1csRequired Pattern: 432138007
.... @codeSystem 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.6.96
... text 0..1EDSHOULD reference the portion of section narrative text corresponding to this entry
.... reference C0..1TELvalue-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
... 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 C1..1ParticipantRoleshould-code: SHOULD contain code
...... @classCode 1..1csBinding: RoleClassRoot (required)
...... id 1..*II
...... code 0..1CEBinding: Healthcare Provider Taxonomy (preferred)
...... addr C1..*USRealmAddressBase for all types and resources
...... playingEntity 0..1PlayingEntity
....... @classCode 1..1csBinding: EntityClassRoot (required)
....... name 1..*PN

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Act.classCoderequiredFixed Value: ACT
Act.moodCoderequiredFixed Value: EVN
Act.codeexampleActCode
Act.statusCoderequiredActStatus
Act.participant:infoRecipient.typeCoderequiredFixed Value: IRCP
Act.participant:infoRecipient.participantRole.classCoderequiredRoleClassRoot
Act.participant:infoRecipient.participantRole.codepreferredHealthcareProviderTaxonomy (a valid code from http://nucc.org/provider-taxonomy)
Act.participant:infoRecipient.participantRole.playingEntity.classCoderequiredEntityClassRoot

Constraints

IdGradePath(s)DetailsRequirements
81-7296errorAct.participant:infoRecipient.participantRole.addr**SHALL NOT** have mixed content except for white space (CONF:81-7296)
: item.xmlText.empty()
81-10024errorAct.participant:infoRecipient.participantRole.addrIf 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-10025errorAct.participant:infoRecipient.participantRole.addrIf 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-cityerrorAct.participant:infoRecipient.participantRole.addrSHALL contain exactly one [1..1] city (CONF:81-7292).
: nullFlavor.exists() or item.city.count() = 1
shall-max-ad-partserrorAct.participant:infoRecipient.participantRole.addrSHALL 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)
shall-streetAddressLineerrorAct.participant:infoRecipient.participantRole.addrSHALL 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-codewarningAct.participant:infoRecipient.participantRoleSHOULD contain code
: code.exists()
should-countrywarningAct.participant:infoRecipient.participantRole.addrSHOULD contain country
: nullFlavor.exists() or item.country.exists()
should-text-ref-valuewarningActSHOULD contain text/reference/@value
: text.reference.value.exists()
should-usewarningAct.participant:infoRecipient.participantRole.addrSHOULD contain @use
: nullFlavor.exists() or use.exists()
value-starts-octothorpeerrorAct.text.referenceIf reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
: value.exists() implies value.startsWith('#')

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Act C1..1ActXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, @negationInd, id, code, text, statusCode, effectiveTime, priorityCode, languageCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, sdtcInFulfillmentOf1
Base for all types and resources
Instances of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
should-text-ref-value: SHOULD contain text/reference/@value
... @nullFlavor 0..1csBinding: CDANullFlavor (required)
... realmCode 0..*CS
... typeId 0..1II
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @assigningAuthorityName 0..1st
.... @displayable 0..1bl
.... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1st
.... templateId:handoff-comm-participants 1..1II
..... @nullFlavor 0..1csBinding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.141
... @classCode 1..1csBinding: XActClassDocumentEntryAct (2.0.0) (required)
Fixed Value: ACT
... @moodCode 1..1csBinding: XDocumentActMood (2.0.0) (required)
Fixed Value: EVN
... @negationInd 0..1bl
... id 0..*II
... code 1..1CDBinding: v3 Code System ActCode (example)
.... @nullFlavor 0..1csBinding: CDANullFlavor (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
... text 0..1EDSHOULD reference the portion of section narrative text corresponding to this entry
.... @nullFlavor 0..1csBinding: CDANullFlavor (required)
.... @compression 0..1csBinding: CompressionAlgorithm (required)
.... @integrityCheck 0..1bin
.... @integrityCheckAlgorithm 0..1csBinding: IntegrityCheckAlgorithm (2.0.0) (required)
.... @language 0..1cs
.... @mediaType 0..1csBinding: MediaType (example)
.... @representation 0..1csBinding: Binary Data Encoding Value Set (required)
.... xmlText 0..1stAllows for mixed text content. If @representation='B64', this SHALL be a base64binary string.
.... reference C0..1TELvalue-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
.... thumbnail 0..1ED
... statusCode 1..1CSBinding: ActStatus (required)
.... @nullFlavor 0..1csBinding: CDANullFlavor (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 (example)
... languageCode 0..1CSBinding: AllLanguages (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: CDANullFlavor (required)
..... realmCode 0..*CS
..... typeId 0..1II
...... @nullFlavor 0..1csBinding: CDANullFlavor (required)
...... @assigningAuthorityName 0..1st
...... @displayable 0..1bl
...... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
...... @extension 1..1st
..... templateId 0..*II
..... @typeCode 1..1csBinding: ParticipationType (required)
Fixed Value: IRCP
..... @contextControlCode 0..1csBinding: ContextControl (required)
Fixed Value: OP
..... sdtcFunctionCode 0..1CEXML Namespace: urn:hl7-org:sdtc
XML: functionCode (urn:hl7-org:sdtc)
..... time 0..1IVL_TS
..... awarenessCode 0..1CE
..... participantRole C1..1ParticipantRoleshould-code: SHOULD contain code
...... @nullFlavor 0..1csBinding: CDANullFlavor (required)
...... realmCode 0..*CS
...... typeId 0..1II
....... @nullFlavor 0..1csBinding: CDANullFlavor (required)
....... @assigningAuthorityName 0..1st
....... @displayable 0..1bl
....... @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
....... @extension 1..1st
...... templateId 0..*II
...... @classCode 1..1csBinding: RoleClassRoot (required)
...... 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 C1..*USRealmAddressBase for all types and resources
...... telecom 0..*TEL
...... playingDevice 0..1Device
...... playingEntity 0..1PlayingEntity
....... @nullFlavor 0..1csBinding: CDANullFlavor (required)
....... realmCode 0..*CS
....... typeId 0..1II
........ @nullFlavor 0..1csBinding: CDANullFlavor (required)
........ @assigningAuthorityName 0..1st
........ @displayable 0..1bl
........ @root 1..1oid, uuid, ruidFixed Value: 2.16.840.1.113883.1.3
........ @extension 1..1st
....... templateId 0..*II
....... @classCode 1..1csBinding: EntityClassRoot (required)
....... @determinerCode 0..1csBinding: EntityDeterminer (required)
Fixed Value: INSTANCE
....... code 0..1CEBinding: EntityCode (example)
....... 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
... sdtcPrecondition2 0..*Precondition2XML Namespace: urn:hl7-org:sdtc
XML: precondition2 (urn:hl7-org:sdtc)
... sdtcInFulfillmentOf1 0..*InFulfillmentOf1XML Namespace: urn:hl7-org:sdtc
XML: inFulfillmentOf1 (urn:hl7-org:sdtc)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Act.nullFlavorrequiredCDANullFlavor
Act.typeId.nullFlavorrequiredCDANullFlavor
Act.templateId:handoff-comm-participants.nullFlavorrequiredCDANullFlavor
Act.classCoderequiredFixed Value: ACT
Act.moodCoderequiredFixed Value: EVN
Act.codeexampleActCode
Act.code.nullFlavorrequiredCDANullFlavor
Act.text.nullFlavorrequiredCDANullFlavor
Act.text.compressionrequiredCDACompressionAlgorithm
Act.text.integrityCheckAlgorithmrequiredIntegrityCheckAlgorithm
Act.text.mediaTypeexampleMediaType
Act.text.representationrequiredBinaryDataEncoding
Act.statusCoderequiredActStatus
Act.statusCode.nullFlavorrequiredCDANullFlavor
Act.priorityCodeexampleActPriority
Act.languageCoderequiredAllLanguages
Act.participant:infoRecipient.nullFlavorrequiredCDANullFlavor
Act.participant:infoRecipient.typeId.nullFlavorrequiredCDANullFlavor
Act.participant:infoRecipient.typeCoderequiredFixed Value: IRCP
Act.participant:infoRecipient.contextControlCoderequiredFixed Value: OP
Act.participant:infoRecipient.participantRole.nullFlavorrequiredCDANullFlavor
Act.participant:infoRecipient.participantRole.typeId.nullFlavorrequiredCDANullFlavor
Act.participant:infoRecipient.participantRole.classCoderequiredRoleClassRoot
Act.participant:infoRecipient.participantRole.codepreferredHealthcareProviderTaxonomy (a valid code from http://nucc.org/provider-taxonomy)
Act.participant:infoRecipient.participantRole.playingEntity.nullFlavorrequiredCDANullFlavor
Act.participant:infoRecipient.participantRole.playingEntity.typeId.nullFlavorrequiredCDANullFlavor
Act.participant:infoRecipient.participantRole.playingEntity.classCoderequiredEntityClassRoot
Act.participant:infoRecipient.participantRole.playingEntity.determinerCoderequiredFixed Value: INSTANCE
Act.participant:infoRecipient.participantRole.playingEntity.codeexampleEntityCode

Constraints

IdGradePath(s)DetailsRequirements
81-7296errorAct.participant:infoRecipient.participantRole.addr**SHALL NOT** have mixed content except for white space (CONF:81-7296)
: item.xmlText.empty()
81-10024errorAct.participant:infoRecipient.participantRole.addrIf 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-10025errorAct.participant:infoRecipient.participantRole.addrIf 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-cityerrorAct.participant:infoRecipient.participantRole.addrSHALL contain exactly one [1..1] city (CONF:81-7292).
: nullFlavor.exists() or item.city.count() = 1
shall-max-ad-partserrorAct.participant:infoRecipient.participantRole.addrSHALL 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)
shall-streetAddressLineerrorAct.participant:infoRecipient.participantRole.addrSHALL 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-codewarningAct.participant:infoRecipient.participantRoleSHOULD contain code
: code.exists()
should-countrywarningAct.participant:infoRecipient.participantRole.addrSHOULD contain country
: nullFlavor.exists() or item.country.exists()
should-text-ref-valuewarningActSHOULD contain text/reference/@value
: text.reference.value.exists()
should-usewarningAct.participant:infoRecipient.participantRole.addrSHOULD contain @use
: nullFlavor.exists() or use.exists()
value-starts-octothorpeerrorAct.text.referenceIf reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
: value.exists() implies value.startsWith('#')

This structure is derived from Act

Summary

Mandatory: 13 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