Consolidated CDA (C-CDA)
3.0.0 - STU3 United States of America flag

This page is part of the CCDA: Consolidated CDA Release (v3.0.0: CCDA 3.0) generated with FHIR (HL7® FHIR® Standard) v5.0.0. This is the current published version. For a full list of available versions, see the Directory of published versions

Logical Model: Handoff Communication Participants

Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/HandoffCommunicationParticipants Version: 3.0.0
Draft as of 2024-05-18 Computable Name: HandoffCommunicationParticipants
Other Identifiers: 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 Template Content

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

This structure is derived from Act

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
Instance 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 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

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Act.participant:infoRecipient.participantRole.codepreferredHealthcareProviderTaxonomy . (a valid code from http://nucc.org/provider-taxonomy)
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066

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 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
Instance 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 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: CDAParticipationType (required)
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 C 1..* USRealmAddress Base for all types and resources
shall-city: SHALL contain exactly one [1..1] city (CONF:81-7292).
shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291).
should-use: SHOULD contain @use
should-country: SHOULD contain country
81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296)
81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024).
81-10025: If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025).
shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country
...... playingEntity 0..1 PlayingEntity
....... name 1..* PN

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Act.classCoderequiredFixed Value: ACT
http://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryAct|2.0.0
Act.moodCoderequiredFixed Value: EVN
http://terminology.hl7.org/ValueSet/v3-xDocumentActMood|2.0.0
Act.codeexampleActCode
http://terminology.hl7.org/ValueSet/v3-ActCode
Act.statusCoderequiredActStatus
http://terminology.hl7.org/ValueSet/v3-ActStatus
Act.participant:infoRecipient.typeCoderequiredFixed Value: IRCP
http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType
Act.participant:infoRecipient.participantRole.codepreferredHealthcareProviderTaxonomy . (a valid code from http://nucc.org/provider-taxonomy)
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066

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 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
Instance 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
.... 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: CDACompressionAlgorithm (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: CDABinaryDataEncoding (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: CDAParticipationType (required)
Fixed Value: IRCP
..... @contextControlCode 0..1 cs Binding: CDAContextControl (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 0..1 cs Binding: CDARoleClassRoot (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
shall-city: SHALL contain exactly one [1..1] city (CONF:81-7292).
shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291).
should-use: SHOULD contain @use
should-country: SHOULD contain country
81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296)
81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024).
81-10025: If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025).
shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country
...... 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 0..1 cs Binding: EntityClassRoot (required)
....... @determinerCode 0..1 cs Binding: EntityDeterminer (required)
Fixed Value: INSTANCE
....... code 0..1 CE Binding: CDAEntityCode (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)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Act.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.templateId:handoff-comm-participants.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.classCoderequiredFixed Value: ACT
http://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryAct|2.0.0
Act.moodCoderequiredFixed Value: EVN
http://terminology.hl7.org/ValueSet/v3-xDocumentActMood|2.0.0
Act.codeexampleActCode
http://terminology.hl7.org/ValueSet/v3-ActCode
Act.code.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.text.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.text.compressionrequiredCDACompressionAlgorithm
http://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm
Act.text.integrityCheckAlgorithmrequiredIntegrityCheckAlgorithm
http://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0
Act.text.mediaTypeexampleMediaType
http://terminology.hl7.org/ValueSet/v3-MediaType
Act.text.representationrequiredBinaryDataEncoding
http://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding
Act.statusCoderequiredActStatus
http://terminology.hl7.org/ValueSet/v3-ActStatus
Act.statusCode.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.priorityCodeexampleActPriority
http://terminology.hl7.org/ValueSet/v3-ActPriority
Act.languageCoderequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages
from the FHIR Standard
Act.participant:infoRecipient.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.participant:infoRecipient.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.participant:infoRecipient.typeCoderequiredFixed Value: IRCP
http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType
Act.participant:infoRecipient.contextControlCoderequiredFixed Value: OP
http://hl7.org/cda/stds/core/ValueSet/CDAContextControl
Act.participant:infoRecipient.participantRole.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.participant:infoRecipient.participantRole.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.participant:infoRecipient.participantRole.classCoderequiredCDARoleClassRoot
http://hl7.org/cda/stds/core/ValueSet/CDARoleClassRoot
Act.participant:infoRecipient.participantRole.codepreferredHealthcareProviderTaxonomy . (a valid code from http://nucc.org/provider-taxonomy)
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066
Act.participant:infoRecipient.participantRole.playingEntity.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.participant:infoRecipient.participantRole.playingEntity.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.participant:infoRecipient.participantRole.playingEntity.classCoderequiredEntityClassRoot
http://terminology.hl7.org/ValueSet/v3-EntityClassRoot
Act.participant:infoRecipient.participantRole.playingEntity.determinerCoderequiredFixed Value: INSTANCE
http://terminology.hl7.org/ValueSet/v3-EntityDeterminer
Act.participant:infoRecipient.participantRole.playingEntity.codeexampleCDAEntityCode
http://hl7.org/cda/stds/core/ValueSet/CDAEntityCode

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: 4 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Act.templateId
  • The element 1 is sliced based on the value of Act.participant

Differential View

This structure is derived from Act

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
Instance 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 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

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Act.participant:infoRecipient.participantRole.codepreferredHealthcareProviderTaxonomy . (a valid code from http://nucc.org/provider-taxonomy)
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066

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 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
Instance 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 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: CDAParticipationType (required)
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 C 1..* USRealmAddress Base for all types and resources
shall-city: SHALL contain exactly one [1..1] city (CONF:81-7292).
shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291).
should-use: SHOULD contain @use
should-country: SHOULD contain country
81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296)
81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024).
81-10025: If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025).
shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country
...... playingEntity 0..1 PlayingEntity
....... name 1..* PN

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Act.classCoderequiredFixed Value: ACT
http://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryAct|2.0.0
Act.moodCoderequiredFixed Value: EVN
http://terminology.hl7.org/ValueSet/v3-xDocumentActMood|2.0.0
Act.codeexampleActCode
http://terminology.hl7.org/ValueSet/v3-ActCode
Act.statusCoderequiredActStatus
http://terminology.hl7.org/ValueSet/v3-ActStatus
Act.participant:infoRecipient.typeCoderequiredFixed Value: IRCP
http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType
Act.participant:infoRecipient.participantRole.codepreferredHealthcareProviderTaxonomy . (a valid code from http://nucc.org/provider-taxonomy)
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066

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 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
Instance 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
.... 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: CDACompressionAlgorithm (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: CDABinaryDataEncoding (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: CDAParticipationType (required)
Fixed Value: IRCP
..... @contextControlCode 0..1 cs Binding: CDAContextControl (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 0..1 cs Binding: CDARoleClassRoot (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
shall-city: SHALL contain exactly one [1..1] city (CONF:81-7292).
shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291).
should-use: SHOULD contain @use
should-country: SHOULD contain country
81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296)
81-10024: If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024).
81-10025: If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025).
shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country
...... 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 0..1 cs Binding: EntityClassRoot (required)
....... @determinerCode 0..1 cs Binding: EntityDeterminer (required)
Fixed Value: INSTANCE
....... code 0..1 CE Binding: CDAEntityCode (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)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Act.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.templateId:handoff-comm-participants.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.classCoderequiredFixed Value: ACT
http://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryAct|2.0.0
Act.moodCoderequiredFixed Value: EVN
http://terminology.hl7.org/ValueSet/v3-xDocumentActMood|2.0.0
Act.codeexampleActCode
http://terminology.hl7.org/ValueSet/v3-ActCode
Act.code.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.text.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.text.compressionrequiredCDACompressionAlgorithm
http://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm
Act.text.integrityCheckAlgorithmrequiredIntegrityCheckAlgorithm
http://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0
Act.text.mediaTypeexampleMediaType
http://terminology.hl7.org/ValueSet/v3-MediaType
Act.text.representationrequiredBinaryDataEncoding
http://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding
Act.statusCoderequiredActStatus
http://terminology.hl7.org/ValueSet/v3-ActStatus
Act.statusCode.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.priorityCodeexampleActPriority
http://terminology.hl7.org/ValueSet/v3-ActPriority
Act.languageCoderequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages
from the FHIR Standard
Act.participant:infoRecipient.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.participant:infoRecipient.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.participant:infoRecipient.typeCoderequiredFixed Value: IRCP
http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType
Act.participant:infoRecipient.contextControlCoderequiredFixed Value: OP
http://hl7.org/cda/stds/core/ValueSet/CDAContextControl
Act.participant:infoRecipient.participantRole.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.participant:infoRecipient.participantRole.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.participant:infoRecipient.participantRole.classCoderequiredCDARoleClassRoot
http://hl7.org/cda/stds/core/ValueSet/CDARoleClassRoot
Act.participant:infoRecipient.participantRole.codepreferredHealthcareProviderTaxonomy . (a valid code from http://nucc.org/provider-taxonomy)
http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066
Act.participant:infoRecipient.participantRole.playingEntity.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.participant:infoRecipient.participantRole.playingEntity.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Act.participant:infoRecipient.participantRole.playingEntity.classCoderequiredEntityClassRoot
http://terminology.hl7.org/ValueSet/v3-EntityClassRoot
Act.participant:infoRecipient.participantRole.playingEntity.determinerCoderequiredFixed Value: INSTANCE
http://terminology.hl7.org/ValueSet/v3-EntityDeterminer
Act.participant:infoRecipient.participantRole.playingEntity.codeexampleCDAEntityCode
http://hl7.org/cda/stds/core/ValueSet/CDAEntityCode

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: 4 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Act.templateId
  • The element 1 is sliced based on the value of Act.participant

 

Other representations of profile: CSV, Excel