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
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:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Act
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Act | C | 1..1 | Act | XML 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..* | II | Slice: Unordered, Open by value:root | |
templateId:handoff-comm-participants | 1..1 | II | ||
@root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.141 | |
@extension | 0..0 | |||
@classCode | 1..1 | cs | Fixed Value: ACT | |
@moodCode | 1..1 | cs | Fixed Value: EVN | |
code | 1..1 | CD | ||
@code | 1..1 | cs | Required Pattern: 432138007 | |
@codeSystem | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.6.96 | |
text | 0..1 | ED | SHOULD reference the portion of section narrative text corresponding to this entry | |
reference | C | 0..1 | TEL | value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative |
statusCode | 1..1 | CS | ||
@code | 1..1 | cs | Fixed Value: completed | |
effectiveTime | 1..1 | IVL_TS | 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. | |
author | 1..* | AuthorParticipation | The 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..* | Participant2 | Documentation 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..1 | cs | Fixed Value: IRCP | |
participantRole | C | 1..1 | ParticipantRole | should-code: SHOULD contain code |
id | 1..* | II | ||
code | 0..1 | CE | Binding: Healthcare Provider Taxonomy (preferred) | |
addr | 1..* | USRealmAddress | Base for all types and resources | |
playingEntity | 0..1 | PlayingEntity | ||
name | 1..* | PN | ||
Documentation for this format |
Path | Conformance | ValueSet |
Act.participant:infoRecipient.participantRole.code | preferred | HealthcareProviderTaxonomy (a valid code from http://nucc.org/provider-taxonomy ) |
Id | Grade | Path(s) | Details | Requirements |
should-code | warning | Act.participant:infoRecipient.participantRole | SHOULD contain code : code.exists() | |
should-text-ref-value | warning | Act | SHOULD contain text/reference/@value : text.reference.value.exists() | |
value-starts-octothorpe | error | Act.text.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative : value.exists() implies value.startsWith('#') |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Act | C | 1..1 | Act | XML 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..* | II | Slice: Unordered, Open by value:root | |
templateId:handoff-comm-participants | 1..1 | II | ||
@root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.141 | |
@classCode | 1..1 | cs | Binding: XActClassDocumentEntryAct (2.0.0) (required) Fixed Value: ACT | |
@moodCode | 1..1 | cs | Binding: XDocumentActMood (2.0.0) (required) Fixed Value: EVN | |
code | 1..1 | CD | Binding: v3 Code System ActCode (example) | |
@code | 1..1 | cs | Required Pattern: 432138007 | |
@codeSystem | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.6.96 | |
text | 0..1 | ED | SHOULD reference the portion of section narrative text corresponding to this entry | |
reference | C | 0..1 | TEL | value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative |
statusCode | 1..1 | CS | Binding: ActStatus (required) | |
@code | 1..1 | cs | Fixed Value: completed | |
effectiveTime | 1..1 | IVL_TS | 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. | |
author | 1..* | AuthorParticipation | The 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..* | Participant2 | Documentation 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..1 | cs | Binding: ParticipationType (required) Fixed Value: IRCP | |
participantRole | C | 1..1 | ParticipantRole | should-code: SHOULD contain code |
@classCode | 1..1 | cs | Binding: RoleClassRoot (required) | |
id | 1..* | II | ||
code | 0..1 | CE | Binding: Healthcare Provider Taxonomy (preferred) | |
addr | C | 1..* | USRealmAddress | Base for all types and resources |
playingEntity | 0..1 | PlayingEntity | ||
@classCode | 1..1 | cs | Binding: EntityClassRoot (required) | |
name | 1..* | PN | ||
Documentation for this format |
Path | Conformance | ValueSet / Code |
Act.classCode | required | Fixed Value: ACT |
Act.moodCode | required | Fixed Value: EVN |
Act.code | example | ActCode |
Act.statusCode | required | ActStatus |
Act.participant:infoRecipient.typeCode | required | Fixed Value: IRCP |
Act.participant:infoRecipient.participantRole.classCode | required | RoleClassRoot |
Act.participant:infoRecipient.participantRole.code | preferred | HealthcareProviderTaxonomy (a valid code from http://nucc.org/provider-taxonomy ) |
Act.participant:infoRecipient.participantRole.playingEntity.classCode | required | EntityClassRoot |
Id | Grade | Path(s) | Details | Requirements |
81-7296 | error | Act.participant:infoRecipient.participantRole.addr | **SHALL NOT** have mixed content except for white space (CONF:81-7296) : item.xmlText.empty() | |
81-10024 | error | Act.participant:infoRecipient.participantRole.addr | If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024). : nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state')) | |
81-10025 | error | Act.participant:infoRecipient.participantRole.addr | If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025). : nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?')) | |
shall-city | error | Act.participant:infoRecipient.participantRole.addr | SHALL contain exactly one [1..1] city (CONF:81-7292). : nullFlavor.exists() or item.city.count() = 1 | |
shall-max-ad-parts | error | Act.participant:infoRecipient.participantRole.addr | SHALL have at most one of each: state, city, postalCode, and country : (item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1) | |
shall-streetAddressLine | error | Act.participant:infoRecipient.participantRole.addr | SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). : nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4) | |
should-code | warning | Act.participant:infoRecipient.participantRole | SHOULD contain code : code.exists() | |
should-country | warning | Act.participant:infoRecipient.participantRole.addr | SHOULD contain country : nullFlavor.exists() or item.country.exists() | |
should-text-ref-value | warning | Act | SHOULD contain text/reference/@value : text.reference.value.exists() | |
should-use | warning | Act.participant:infoRecipient.participantRole.addr | SHOULD contain @use : nullFlavor.exists() or use.exists() | |
value-starts-octothorpe | error | Act.text.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative : value.exists() implies value.startsWith('#') |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Act | C | 1..1 | Act | XML 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..1 | cs | Binding: CDANullFlavor (required) | |
realmCode | 0..* | CS | ||
typeId | 0..1 | II | ||
@nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
@assigningAuthorityName | 0..1 | st | ||
@displayable | 0..1 | bl | ||
@root | 1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
@extension | 1..1 | st | ||
Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root | |
templateId:handoff-comm-participants | 1..1 | II | ||
@nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
@assigningAuthorityName | 0..1 | st | ||
@displayable | 0..1 | bl | ||
@root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.141 | |
@classCode | 1..1 | cs | Binding: XActClassDocumentEntryAct (2.0.0) (required) Fixed Value: ACT | |
@moodCode | 1..1 | cs | Binding: XDocumentActMood (2.0.0) (required) Fixed Value: EVN | |
@negationInd | 0..1 | bl | ||
id | 0..* | II | ||
code | 1..1 | CD | Binding: v3 Code System ActCode (example) | |
@nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
@code | 1..1 | cs | Required Pattern: 432138007 | |
@codeSystem | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.6.96 | |
@codeSystemName | 0..1 | st | ||
@codeSystemVersion | 0..1 | st | ||
@displayName | 0..1 | st | ||
@sdtcValueSet | 0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
@sdtcValueSetVersion | 0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
originalText | 0..1 | ED | ||
qualifier | 0..* | CR | ||
translation | 0..* | CD | ||
text | 0..1 | ED | SHOULD reference the portion of section narrative text corresponding to this entry | |
@nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
@compression | 0..1 | cs | Binding: CompressionAlgorithm (required) | |
@integrityCheck | 0..1 | bin | ||
@integrityCheckAlgorithm | 0..1 | cs | Binding: IntegrityCheckAlgorithm (2.0.0) (required) | |
@language | 0..1 | cs | ||
@mediaType | 0..1 | cs | Binding: MediaType (example) | |
@representation | 0..1 | cs | Binding: Binary Data Encoding Value Set (required) | |
xmlText | 0..1 | st | Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string. | |
reference | C | 0..1 | TEL | value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative |
thumbnail | 0..1 | ED | ||
statusCode | 1..1 | CS | Binding: ActStatus (required) | |
@nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
@code | 1..1 | cs | Fixed Value: completed | |
@sdtcValueSet | 0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
@sdtcValueSetVersion | 0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
effectiveTime | 1..1 | IVL_TS | 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. | |
priorityCode | 0..1 | CE | Binding: ActPriority (example) | |
languageCode | 0..1 | CS | Binding: AllLanguages (required) | |
subject | 0..1 | Subject | ||
specimen | 0..* | Specimen | ||
performer | 0..* | Performer2 | ||
author | 1..* | AuthorParticipation | The 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..* | Participant2 | Documentation 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..1 | cs | Binding: CDANullFlavor (required) | |
realmCode | 0..* | CS | ||
typeId | 0..1 | II | ||
@nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
@assigningAuthorityName | 0..1 | st | ||
@displayable | 0..1 | bl | ||
@root | 1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
@extension | 1..1 | st | ||
templateId | 0..* | II | ||
@typeCode | 1..1 | cs | Binding: ParticipationType (required) Fixed Value: IRCP | |
@contextControlCode | 0..1 | cs | Binding: ContextControl (required) Fixed Value: OP | |
sdtcFunctionCode | 0..1 | CE | XML Namespace: urn:hl7-org:sdtc XML: functionCode (urn:hl7-org:sdtc) | |
time | 0..1 | IVL_TS | ||
awarenessCode | 0..1 | CE | ||
participantRole | C | 1..1 | ParticipantRole | should-code: SHOULD contain code |
@nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
realmCode | 0..* | CS | ||
typeId | 0..1 | II | ||
@nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
@assigningAuthorityName | 0..1 | st | ||
@displayable | 0..1 | bl | ||
@root | 1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
@extension | 1..1 | st | ||
templateId | 0..* | II | ||
@classCode | 1..1 | cs | Binding: RoleClassRoot (required) | |
id | 1..* | II | ||
sdtcIdentifiedBy | 0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |
code | 0..1 | CE | Binding: Healthcare Provider Taxonomy (preferred) | |
addr | C | 1..* | USRealmAddress | Base for all types and resources |
telecom | 0..* | TEL | ||
playingDevice | 0..1 | Device | ||
playingEntity | 0..1 | PlayingEntity | ||
@nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
realmCode | 0..* | CS | ||
typeId | 0..1 | II | ||
@nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
@assigningAuthorityName | 0..1 | st | ||
@displayable | 0..1 | bl | ||
@root | 1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
@extension | 1..1 | st | ||
templateId | 0..* | II | ||
@classCode | 1..1 | cs | Binding: EntityClassRoot (required) | |
@determinerCode | 0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
code | 0..1 | CE | Binding: EntityCode (example) | |
quantity | 0..* | PQ | ||
name | 1..* | PN | ||
sdtcBirthTime | 0..1 | TS | XML Namespace: urn:hl7-org:sdtc XML: birthTime (urn:hl7-org:sdtc) | |
desc | 0..1 | ED | ||
scopingEntity | 0..1 | Entity | ||
entryRelationship | 0..* | EntryRelationship | ||
reference | 0..* | Reference | ||
precondition | 0..* | Precondition | ||
sdtcPrecondition2 | 0..* | Precondition2 | XML Namespace: urn:hl7-org:sdtc XML: precondition2 (urn:hl7-org:sdtc) | |
sdtcInFulfillmentOf1 | 0..* | InFulfillmentOf1 | XML Namespace: urn:hl7-org:sdtc XML: inFulfillmentOf1 (urn:hl7-org:sdtc) | |
Documentation for this format |
Path | Conformance | ValueSet / Code |
Act.nullFlavor | required | CDANullFlavor |
Act.typeId.nullFlavor | required | CDANullFlavor |
Act.templateId:handoff-comm-participants.nullFlavor | required | CDANullFlavor |
Act.classCode | required | Fixed Value: ACT |
Act.moodCode | required | Fixed Value: EVN |
Act.code | example | ActCode |
Act.code.nullFlavor | required | CDANullFlavor |
Act.text.nullFlavor | required | CDANullFlavor |
Act.text.compression | required | CDACompressionAlgorithm |
Act.text.integrityCheckAlgorithm | required | IntegrityCheckAlgorithm |
Act.text.mediaType | example | MediaType |
Act.text.representation | required | BinaryDataEncoding |
Act.statusCode | required | ActStatus |
Act.statusCode.nullFlavor | required | CDANullFlavor |
Act.priorityCode | example | ActPriority |
Act.languageCode | required | AllLanguages |
Act.participant:infoRecipient.nullFlavor | required | CDANullFlavor |
Act.participant:infoRecipient.typeId.nullFlavor | required | CDANullFlavor |
Act.participant:infoRecipient.typeCode | required | Fixed Value: IRCP |
Act.participant:infoRecipient.contextControlCode | required | Fixed Value: OP |
Act.participant:infoRecipient.participantRole.nullFlavor | required | CDANullFlavor |
Act.participant:infoRecipient.participantRole.typeId.nullFlavor | required | CDANullFlavor |
Act.participant:infoRecipient.participantRole.classCode | required | RoleClassRoot |
Act.participant:infoRecipient.participantRole.code | preferred | HealthcareProviderTaxonomy (a valid code from http://nucc.org/provider-taxonomy ) |
Act.participant:infoRecipient.participantRole.playingEntity.nullFlavor | required | CDANullFlavor |
Act.participant:infoRecipient.participantRole.playingEntity.typeId.nullFlavor | required | CDANullFlavor |
Act.participant:infoRecipient.participantRole.playingEntity.classCode | required | EntityClassRoot |
Act.participant:infoRecipient.participantRole.playingEntity.determinerCode | required | Fixed Value: INSTANCE |
Act.participant:infoRecipient.participantRole.playingEntity.code | example | EntityCode |
Id | Grade | Path(s) | Details | Requirements |
81-7296 | error | Act.participant:infoRecipient.participantRole.addr | **SHALL NOT** have mixed content except for white space (CONF:81-7296) : item.xmlText.empty() | |
81-10024 | error | Act.participant:infoRecipient.participantRole.addr | If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024). : nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state')) | |
81-10025 | error | Act.participant:infoRecipient.participantRole.addr | If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025). : nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?')) | |
shall-city | error | Act.participant:infoRecipient.participantRole.addr | SHALL contain exactly one [1..1] city (CONF:81-7292). : nullFlavor.exists() or item.city.count() = 1 | |
shall-max-ad-parts | error | Act.participant:infoRecipient.participantRole.addr | SHALL have at most one of each: state, city, postalCode, and country : (item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1) | |
shall-streetAddressLine | error | Act.participant:infoRecipient.participantRole.addr | SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). : nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4) | |
should-code | warning | Act.participant:infoRecipient.participantRole | SHOULD contain code : code.exists() | |
should-country | warning | Act.participant:infoRecipient.participantRole.addr | SHOULD contain country : nullFlavor.exists() or item.country.exists() | |
should-text-ref-value | warning | Act | SHOULD contain text/reference/@value : text.reference.value.exists() | |
should-use | warning | Act.participant:infoRecipient.participantRole.addr | SHOULD contain @use : nullFlavor.exists() or use.exists() | |
value-starts-octothorpe | error | Act.text.reference | If 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:
Differential View
This structure is derived from Act
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Act | C | 1..1 | Act | XML 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..* | II | Slice: Unordered, Open by value:root | |
templateId:handoff-comm-participants | 1..1 | II | ||
@root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.141 | |
@extension | 0..0 | |||
@classCode | 1..1 | cs | Fixed Value: ACT | |
@moodCode | 1..1 | cs | Fixed Value: EVN | |
code | 1..1 | CD | ||
@code | 1..1 | cs | Required Pattern: 432138007 | |
@codeSystem | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.6.96 | |
text | 0..1 | ED | SHOULD reference the portion of section narrative text corresponding to this entry | |
reference | C | 0..1 | TEL | value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative |
statusCode | 1..1 | CS | ||
@code | 1..1 | cs | Fixed Value: completed | |
effectiveTime | 1..1 | IVL_TS | 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. | |
author | 1..* | AuthorParticipation | The 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..* | Participant2 | Documentation 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..1 | cs | Fixed Value: IRCP | |
participantRole | C | 1..1 | ParticipantRole | should-code: SHOULD contain code |
id | 1..* | II | ||
code | 0..1 | CE | Binding: Healthcare Provider Taxonomy (preferred) | |
addr | 1..* | USRealmAddress | Base for all types and resources | |
playingEntity | 0..1 | PlayingEntity | ||
name | 1..* | PN | ||
Documentation for this format |
Path | Conformance | ValueSet |
Act.participant:infoRecipient.participantRole.code | preferred | HealthcareProviderTaxonomy (a valid code from http://nucc.org/provider-taxonomy ) |
Id | Grade | Path(s) | Details | Requirements |
should-code | warning | Act.participant:infoRecipient.participantRole | SHOULD contain code : code.exists() | |
should-text-ref-value | warning | Act | SHOULD contain text/reference/@value : text.reference.value.exists() | |
value-starts-octothorpe | error | Act.text.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative : value.exists() implies value.startsWith('#') |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Act | C | 1..1 | Act | XML 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..* | II | Slice: Unordered, Open by value:root | |
templateId:handoff-comm-participants | 1..1 | II | ||
@root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.141 | |
@classCode | 1..1 | cs | Binding: XActClassDocumentEntryAct (2.0.0) (required) Fixed Value: ACT | |
@moodCode | 1..1 | cs | Binding: XDocumentActMood (2.0.0) (required) Fixed Value: EVN | |
code | 1..1 | CD | Binding: v3 Code System ActCode (example) | |
@code | 1..1 | cs | Required Pattern: 432138007 | |
@codeSystem | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.6.96 | |
text | 0..1 | ED | SHOULD reference the portion of section narrative text corresponding to this entry | |
reference | C | 0..1 | TEL | value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative |
statusCode | 1..1 | CS | Binding: ActStatus (required) | |
@code | 1..1 | cs | Fixed Value: completed | |
effectiveTime | 1..1 | IVL_TS | 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. | |
author | 1..* | AuthorParticipation | The 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..* | Participant2 | Documentation 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..1 | cs | Binding: ParticipationType (required) Fixed Value: IRCP | |
participantRole | C | 1..1 | ParticipantRole | should-code: SHOULD contain code |
@classCode | 1..1 | cs | Binding: RoleClassRoot (required) | |
id | 1..* | II | ||
code | 0..1 | CE | Binding: Healthcare Provider Taxonomy (preferred) | |
addr | C | 1..* | USRealmAddress | Base for all types and resources |
playingEntity | 0..1 | PlayingEntity | ||
@classCode | 1..1 | cs | Binding: EntityClassRoot (required) | |
name | 1..* | PN | ||
Documentation for this format |
Path | Conformance | ValueSet / Code |
Act.classCode | required | Fixed Value: ACT |
Act.moodCode | required | Fixed Value: EVN |
Act.code | example | ActCode |
Act.statusCode | required | ActStatus |
Act.participant:infoRecipient.typeCode | required | Fixed Value: IRCP |
Act.participant:infoRecipient.participantRole.classCode | required | RoleClassRoot |
Act.participant:infoRecipient.participantRole.code | preferred | HealthcareProviderTaxonomy (a valid code from http://nucc.org/provider-taxonomy ) |
Act.participant:infoRecipient.participantRole.playingEntity.classCode | required | EntityClassRoot |
Id | Grade | Path(s) | Details | Requirements |
81-7296 | error | Act.participant:infoRecipient.participantRole.addr | **SHALL NOT** have mixed content except for white space (CONF:81-7296) : item.xmlText.empty() | |
81-10024 | error | Act.participant:infoRecipient.participantRole.addr | If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024). : nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state')) | |
81-10025 | error | Act.participant:infoRecipient.participantRole.addr | If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025). : nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?')) | |
shall-city | error | Act.participant:infoRecipient.participantRole.addr | SHALL contain exactly one [1..1] city (CONF:81-7292). : nullFlavor.exists() or item.city.count() = 1 | |
shall-max-ad-parts | error | Act.participant:infoRecipient.participantRole.addr | SHALL have at most one of each: state, city, postalCode, and country : (item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1) | |
shall-streetAddressLine | error | Act.participant:infoRecipient.participantRole.addr | SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). : nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4) | |
should-code | warning | Act.participant:infoRecipient.participantRole | SHOULD contain code : code.exists() | |
should-country | warning | Act.participant:infoRecipient.participantRole.addr | SHOULD contain country : nullFlavor.exists() or item.country.exists() | |
should-text-ref-value | warning | Act | SHOULD contain text/reference/@value : text.reference.value.exists() | |
should-use | warning | Act.participant:infoRecipient.participantRole.addr | SHOULD contain @use : nullFlavor.exists() or use.exists() | |
value-starts-octothorpe | error | Act.text.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative : value.exists() implies value.startsWith('#') |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Act | C | 1..1 | Act | XML 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..1 | cs | Binding: CDANullFlavor (required) | |
realmCode | 0..* | CS | ||
typeId | 0..1 | II | ||
@nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
@assigningAuthorityName | 0..1 | st | ||
@displayable | 0..1 | bl | ||
@root | 1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
@extension | 1..1 | st | ||
Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root | |
templateId:handoff-comm-participants | 1..1 | II | ||
@nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
@assigningAuthorityName | 0..1 | st | ||
@displayable | 0..1 | bl | ||
@root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.141 | |
@classCode | 1..1 | cs | Binding: XActClassDocumentEntryAct (2.0.0) (required) Fixed Value: ACT | |
@moodCode | 1..1 | cs | Binding: XDocumentActMood (2.0.0) (required) Fixed Value: EVN | |
@negationInd | 0..1 | bl | ||
id | 0..* | II | ||
code | 1..1 | CD | Binding: v3 Code System ActCode (example) | |
@nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
@code | 1..1 | cs | Required Pattern: 432138007 | |
@codeSystem | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.6.96 | |
@codeSystemName | 0..1 | st | ||
@codeSystemVersion | 0..1 | st | ||
@displayName | 0..1 | st | ||
@sdtcValueSet | 0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
@sdtcValueSetVersion | 0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
originalText | 0..1 | ED | ||
qualifier | 0..* | CR | ||
translation | 0..* | CD | ||
text | 0..1 | ED | SHOULD reference the portion of section narrative text corresponding to this entry | |
@nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
@compression | 0..1 | cs | Binding: CompressionAlgorithm (required) | |
@integrityCheck | 0..1 | bin | ||
@integrityCheckAlgorithm | 0..1 | cs | Binding: IntegrityCheckAlgorithm (2.0.0) (required) | |
@language | 0..1 | cs | ||
@mediaType | 0..1 | cs | Binding: MediaType (example) | |
@representation | 0..1 | cs | Binding: Binary Data Encoding Value Set (required) | |
xmlText | 0..1 | st | Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string. | |
reference | C | 0..1 | TEL | value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative |
thumbnail | 0..1 | ED | ||
statusCode | 1..1 | CS | Binding: ActStatus (required) | |
@nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
@code | 1..1 | cs | Fixed Value: completed | |
@sdtcValueSet | 0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
@sdtcValueSetVersion | 0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
effectiveTime | 1..1 | IVL_TS | 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. | |
priorityCode | 0..1 | CE | Binding: ActPriority (example) | |
languageCode | 0..1 | CS | Binding: AllLanguages (required) | |
subject | 0..1 | Subject | ||
specimen | 0..* | Specimen | ||
performer | 0..* | Performer2 | ||
author | 1..* | AuthorParticipation | The 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..* | Participant2 | Documentation 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..1 | cs | Binding: CDANullFlavor (required) | |
realmCode | 0..* | CS | ||
typeId | 0..1 | II | ||
@nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
@assigningAuthorityName | 0..1 | st | ||
@displayable | 0..1 | bl | ||
@root | 1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
@extension | 1..1 | st | ||
templateId | 0..* | II | ||
@typeCode | 1..1 | cs | Binding: ParticipationType (required) Fixed Value: IRCP | |
@contextControlCode | 0..1 | cs | Binding: ContextControl (required) Fixed Value: OP | |
sdtcFunctionCode | 0..1 | CE | XML Namespace: urn:hl7-org:sdtc XML: functionCode (urn:hl7-org:sdtc) | |
time | 0..1 | IVL_TS | ||
awarenessCode | 0..1 | CE | ||
participantRole | C | 1..1 | ParticipantRole | should-code: SHOULD contain code |
@nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
realmCode | 0..* | CS | ||
typeId | 0..1 | II | ||
@nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
@assigningAuthorityName | 0..1 | st | ||
@displayable | 0..1 | bl | ||
@root | 1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
@extension | 1..1 | st | ||
templateId | 0..* | II | ||
@classCode | 1..1 | cs | Binding: RoleClassRoot (required) | |
id | 1..* | II | ||
sdtcIdentifiedBy | 0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |
code | 0..1 | CE | Binding: Healthcare Provider Taxonomy (preferred) | |
addr | C | 1..* | USRealmAddress | Base for all types and resources |
telecom | 0..* | TEL | ||
playingDevice | 0..1 | Device | ||
playingEntity | 0..1 | PlayingEntity | ||
@nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
realmCode | 0..* | CS | ||
typeId | 0..1 | II | ||
@nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
@assigningAuthorityName | 0..1 | st | ||
@displayable | 0..1 | bl | ||
@root | 1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
@extension | 1..1 | st | ||
templateId | 0..* | II | ||
@classCode | 1..1 | cs | Binding: EntityClassRoot (required) | |
@determinerCode | 0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
code | 0..1 | CE | Binding: EntityCode (example) | |
quantity | 0..* | PQ | ||
name | 1..* | PN | ||
sdtcBirthTime | 0..1 | TS | XML Namespace: urn:hl7-org:sdtc XML: birthTime (urn:hl7-org:sdtc) | |
desc | 0..1 | ED | ||
scopingEntity | 0..1 | Entity | ||
entryRelationship | 0..* | EntryRelationship | ||
reference | 0..* | Reference | ||
precondition | 0..* | Precondition | ||
sdtcPrecondition2 | 0..* | Precondition2 | XML Namespace: urn:hl7-org:sdtc XML: precondition2 (urn:hl7-org:sdtc) | |
sdtcInFulfillmentOf1 | 0..* | InFulfillmentOf1 | XML Namespace: urn:hl7-org:sdtc XML: inFulfillmentOf1 (urn:hl7-org:sdtc) | |
Documentation for this format |
Path | Conformance | ValueSet / Code |
Act.nullFlavor | required | CDANullFlavor |
Act.typeId.nullFlavor | required | CDANullFlavor |
Act.templateId:handoff-comm-participants.nullFlavor | required | CDANullFlavor |
Act.classCode | required | Fixed Value: ACT |
Act.moodCode | required | Fixed Value: EVN |
Act.code | example | ActCode |
Act.code.nullFlavor | required | CDANullFlavor |
Act.text.nullFlavor | required | CDANullFlavor |
Act.text.compression | required | CDACompressionAlgorithm |
Act.text.integrityCheckAlgorithm | required | IntegrityCheckAlgorithm |
Act.text.mediaType | example | MediaType |
Act.text.representation | required | BinaryDataEncoding |
Act.statusCode | required | ActStatus |
Act.statusCode.nullFlavor | required | CDANullFlavor |
Act.priorityCode | example | ActPriority |
Act.languageCode | required | AllLanguages |
Act.participant:infoRecipient.nullFlavor | required | CDANullFlavor |
Act.participant:infoRecipient.typeId.nullFlavor | required | CDANullFlavor |
Act.participant:infoRecipient.typeCode | required | Fixed Value: IRCP |
Act.participant:infoRecipient.contextControlCode | required | Fixed Value: OP |
Act.participant:infoRecipient.participantRole.nullFlavor | required | CDANullFlavor |
Act.participant:infoRecipient.participantRole.typeId.nullFlavor | required | CDANullFlavor |
Act.participant:infoRecipient.participantRole.classCode | required | RoleClassRoot |
Act.participant:infoRecipient.participantRole.code | preferred | HealthcareProviderTaxonomy (a valid code from http://nucc.org/provider-taxonomy ) |
Act.participant:infoRecipient.participantRole.playingEntity.nullFlavor | required | CDANullFlavor |
Act.participant:infoRecipient.participantRole.playingEntity.typeId.nullFlavor | required | CDANullFlavor |
Act.participant:infoRecipient.participantRole.playingEntity.classCode | required | EntityClassRoot |
Act.participant:infoRecipient.participantRole.playingEntity.determinerCode | required | Fixed Value: INSTANCE |
Act.participant:infoRecipient.participantRole.playingEntity.code | example | EntityCode |
Id | Grade | Path(s) | Details | Requirements |
81-7296 | error | Act.participant:infoRecipient.participantRole.addr | **SHALL NOT** have mixed content except for white space (CONF:81-7296) : item.xmlText.empty() | |
81-10024 | error | Act.participant:infoRecipient.participantRole.addr | If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024). : nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state')) | |
81-10025 | error | Act.participant:infoRecipient.participantRole.addr | If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025). : nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?')) | |
shall-city | error | Act.participant:infoRecipient.participantRole.addr | SHALL contain exactly one [1..1] city (CONF:81-7292). : nullFlavor.exists() or item.city.count() = 1 | |
shall-max-ad-parts | error | Act.participant:infoRecipient.participantRole.addr | SHALL have at most one of each: state, city, postalCode, and country : (item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1) | |
shall-streetAddressLine | error | Act.participant:infoRecipient.participantRole.addr | SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). : nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4) | |
should-code | warning | Act.participant:infoRecipient.participantRole | SHOULD contain code : code.exists() | |
should-country | warning | Act.participant:infoRecipient.participantRole.addr | SHOULD contain country : nullFlavor.exists() or item.country.exists() | |
should-text-ref-value | warning | Act | SHOULD contain text/reference/@value : text.reference.value.exists() | |
should-use | warning | Act.participant:infoRecipient.participantRole.addr | SHOULD contain @use : nullFlavor.exists() or use.exists() | |
value-starts-octothorpe | error | Act.text.reference | If 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: