Consolidated CDA (C-CDA), published by Health Level Seven. This guide is not an authorized publication; it is the continuous build for version 4.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/CDA-ccda/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/EntryReference | Version: 4.0.0-ballot | |||
Draft as of 2024-12-19 | Computable Name: EntryReference | |||
Other Identifiers: OID:2.16.840.1.113883.10.20.22.4.122 |
This template represents the act of referencing another entry in the same CDA document instance. Its purpose is to remove the need to repeat the complete XML representation of the referred entry when relating one entry to another. This template can be used to reference many types of Act class derivations, such as encounters, observations, procedures etc., as it is often necessary when authoring CDA documents to repeatedly reference other Acts of these types. For example, in a Care Plan it is necessary to repeatedly relate Health Concerns, Goals, Activities and Outcomes.
The id is required and must be the same id as the entry/id it is referencing. The id cannot be a null value. Act/Code is set to nullFlavor="NP" (Not Present). This means the value is not present in the message (in act/Code).
Usage:
Description of Template, 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 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:entry-reference | 1..1 | II | ||
@root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.122 | |
@extension | 0..0 | |||
@classCode | 1..1 | cs | Fixed Value: ACT | |
@moodCode | 1..1 | cs | Fixed Value: EVN | |
id | 1..* | II | The ID must equal another entry/id in the same document instance. Application Software must be responsible for resolving the identifier back to its original object and then rendering the information in the correct place in the containing section's narrative text. The ID cannot have Null value (e.g., nullFlavor is not allowed). | |
@nullFlavor | 0..0 | |||
code | 1..1 | CD | ||
@nullFlavor | 1..1 | cs | Fixed Value: NP | |
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 | 0..1 | cs | MAY be set to "completed" | |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
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 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 | C | 0..1 | II | II-1: An II instance must have either a root or an nullFlavor. |
@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:entry-reference | 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.122 | |
@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 | 1..* | II | The ID must equal another entry/id in the same document instance. Application Software must be responsible for resolving the identifier back to its original object and then rendering the information in the correct place in the containing section's narrative text. The ID cannot have Null value (e.g., nullFlavor is not allowed). | |
@assigningAuthorityName | 0..1 | st | ||
@displayable | 0..1 | bl | ||
@root | 0..1 | oid, uuid, ruid | ||
@extension | 0..1 | st | ||
code | 1..1 | CD | Binding: v3 Code System ActCode (example) | |
@nullFlavor | 1..1 | cs | Binding: CDANullFlavor (required) Fixed Value: NP | |
@code | 0..1 | cs | ||
@codeSystem | 0..1 | oid, uuid, ruid | ||
@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 | 0..1 | cs | MAY be set to "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 | 0..1 | IVL_TS | ||
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 | 0..* | Author | ||
informant | 0..* | Informant | ||
participant | 0..* | Participant2 | ||
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 | URI |
Act.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.templateId:entry-reference.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.classCode | required | Fixed Value: ACThttp://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryAct|2.0.0 | |
Act.moodCode | required | Fixed Value: EVNhttp://terminology.hl7.org/ValueSet/v3-xDocumentActMood|2.0.0 | |
Act.code | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | |
Act.code.nullFlavor | required | Fixed Value: NPhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.text.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.text.compression | required | CDACompressionAlgorithmhttp://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm | |
Act.text.integrityCheckAlgorithm | required | IntegrityCheckAlgorithmhttp://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0 | |
Act.text.mediaType | example | MediaTypehttp://terminology.hl7.org/ValueSet/v3-MediaType | |
Act.text.representation | required | BinaryDataEncodinghttp://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding | |
Act.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
Act.statusCode.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.priorityCode | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | |
Act.languageCode | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
II-1 | error | Act.typeId | An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.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 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 | C | 0..1 | II | II-1: An II instance must have either a root or an nullFlavor. |
@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:entry-reference | 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.122 | |
@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 | 1..* | II | The ID must equal another entry/id in the same document instance. Application Software must be responsible for resolving the identifier back to its original object and then rendering the information in the correct place in the containing section's narrative text. The ID cannot have Null value (e.g., nullFlavor is not allowed). | |
@assigningAuthorityName | 0..1 | st | ||
@displayable | 0..1 | bl | ||
@root | 0..1 | oid, uuid, ruid | ||
@extension | 0..1 | st | ||
code | 1..1 | CD | Binding: v3 Code System ActCode (example) | |
@nullFlavor | 1..1 | cs | Binding: CDANullFlavor (required) Fixed Value: NP | |
@code | 0..1 | cs | ||
@codeSystem | 0..1 | oid, uuid, ruid | ||
@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 | 0..1 | cs | MAY be set to "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 | 0..1 | IVL_TS | ||
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 | 0..* | Author | ||
informant | 0..* | Informant | ||
participant | 0..* | Participant2 | ||
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 | URI |
Act.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.templateId:entry-reference.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.classCode | required | Fixed Value: ACThttp://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryAct|2.0.0 | |
Act.moodCode | required | Fixed Value: EVNhttp://terminology.hl7.org/ValueSet/v3-xDocumentActMood|2.0.0 | |
Act.code | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | |
Act.code.nullFlavor | required | Fixed Value: NPhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.text.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.text.compression | required | CDACompressionAlgorithmhttp://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm | |
Act.text.integrityCheckAlgorithm | required | IntegrityCheckAlgorithmhttp://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0 | |
Act.text.mediaType | example | MediaTypehttp://terminology.hl7.org/ValueSet/v3-MediaType | |
Act.text.representation | required | BinaryDataEncodinghttp://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding | |
Act.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
Act.statusCode.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.priorityCode | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | |
Act.languageCode | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
II-1 | error | Act.typeId | An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.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('#') |
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 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:entry-reference | 1..1 | II | ||
@root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.122 | |
@extension | 0..0 | |||
@classCode | 1..1 | cs | Fixed Value: ACT | |
@moodCode | 1..1 | cs | Fixed Value: EVN | |
id | 1..* | II | The ID must equal another entry/id in the same document instance. Application Software must be responsible for resolving the identifier back to its original object and then rendering the information in the correct place in the containing section's narrative text. The ID cannot have Null value (e.g., nullFlavor is not allowed). | |
@nullFlavor | 0..0 | |||
code | 1..1 | CD | ||
@nullFlavor | 1..1 | cs | Fixed Value: NP | |
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 | 0..1 | cs | MAY be set to "completed" | |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
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 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 | C | 0..1 | II | II-1: An II instance must have either a root or an nullFlavor. |
@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:entry-reference | 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.122 | |
@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 | 1..* | II | The ID must equal another entry/id in the same document instance. Application Software must be responsible for resolving the identifier back to its original object and then rendering the information in the correct place in the containing section's narrative text. The ID cannot have Null value (e.g., nullFlavor is not allowed). | |
@assigningAuthorityName | 0..1 | st | ||
@displayable | 0..1 | bl | ||
@root | 0..1 | oid, uuid, ruid | ||
@extension | 0..1 | st | ||
code | 1..1 | CD | Binding: v3 Code System ActCode (example) | |
@nullFlavor | 1..1 | cs | Binding: CDANullFlavor (required) Fixed Value: NP | |
@code | 0..1 | cs | ||
@codeSystem | 0..1 | oid, uuid, ruid | ||
@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 | 0..1 | cs | MAY be set to "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 | 0..1 | IVL_TS | ||
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 | 0..* | Author | ||
informant | 0..* | Informant | ||
participant | 0..* | Participant2 | ||
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 | URI |
Act.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.templateId:entry-reference.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.classCode | required | Fixed Value: ACThttp://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryAct|2.0.0 | |
Act.moodCode | required | Fixed Value: EVNhttp://terminology.hl7.org/ValueSet/v3-xDocumentActMood|2.0.0 | |
Act.code | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | |
Act.code.nullFlavor | required | Fixed Value: NPhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.text.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.text.compression | required | CDACompressionAlgorithmhttp://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm | |
Act.text.integrityCheckAlgorithm | required | IntegrityCheckAlgorithmhttp://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0 | |
Act.text.mediaType | example | MediaTypehttp://terminology.hl7.org/ValueSet/v3-MediaType | |
Act.text.representation | required | BinaryDataEncodinghttp://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding | |
Act.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
Act.statusCode.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.priorityCode | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | |
Act.languageCode | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
II-1 | error | Act.typeId | An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.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('#') |
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 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 | C | 0..1 | II | II-1: An II instance must have either a root or an nullFlavor. |
@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:entry-reference | 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.122 | |
@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 | 1..* | II | The ID must equal another entry/id in the same document instance. Application Software must be responsible for resolving the identifier back to its original object and then rendering the information in the correct place in the containing section's narrative text. The ID cannot have Null value (e.g., nullFlavor is not allowed). | |
@assigningAuthorityName | 0..1 | st | ||
@displayable | 0..1 | bl | ||
@root | 0..1 | oid, uuid, ruid | ||
@extension | 0..1 | st | ||
code | 1..1 | CD | Binding: v3 Code System ActCode (example) | |
@nullFlavor | 1..1 | cs | Binding: CDANullFlavor (required) Fixed Value: NP | |
@code | 0..1 | cs | ||
@codeSystem | 0..1 | oid, uuid, ruid | ||
@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 | 0..1 | cs | MAY be set to "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 | 0..1 | IVL_TS | ||
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 | 0..* | Author | ||
informant | 0..* | Informant | ||
participant | 0..* | Participant2 | ||
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 | URI |
Act.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.templateId:entry-reference.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.classCode | required | Fixed Value: ACThttp://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryAct|2.0.0 | |
Act.moodCode | required | Fixed Value: EVNhttp://terminology.hl7.org/ValueSet/v3-xDocumentActMood|2.0.0 | |
Act.code | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | |
Act.code.nullFlavor | required | Fixed Value: NPhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.text.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.text.compression | required | CDACompressionAlgorithmhttp://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm | |
Act.text.integrityCheckAlgorithm | required | IntegrityCheckAlgorithmhttp://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0 | |
Act.text.mediaType | example | MediaTypehttp://terminology.hl7.org/ValueSet/v3-MediaType | |
Act.text.representation | required | BinaryDataEncodinghttp://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding | |
Act.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
Act.statusCode.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.priorityCode | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | |
Act.languageCode | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
II-1 | error | Act.typeId | An II instance must have either a root or an nullFlavor. : root.exists() or nullFlavor.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('#') |