Paramedicine Summary Of Care CDA
0.0.1-current - ci-build
Paramedicine Summary Of Care CDA
0.0.1-current - ci-build
Paramedicine Summary Of Care CDA, published by IHE Patient Care Coordination Technical Committee. This guide is not an authorized publication; it is the continuous build for version 0.0.1-current built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/IHE/PCC.PCSc/ and changes regularly. See the Directory of published versions
| Official URL: https://profiles.ihe.net/PCC/PSCc/StructureDefinition/IHE.PCC.Comment.Entry | Version: 0.0.1-current | |||
| Draft as of 2025-11-04 | Computable Name: IHE_PCC_Comment_Entry | |||
This entry allows for a comment to be supplied with each entry. For CDA this structure is usually included in the target act using the
Any condition or allergy may be the subject of a comment.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  Act |
C | 1..1 | Act | XML Namespace: urn:hl7-org:v3 Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) Constraints: should-text-ref-value, should-author |
  @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
 realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
 @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 |
S | 2..* | II | Slice: Unordered, Open by value:root, value:extension |
  templateId:comment-activity |
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.1.40 | |
 @extension |
0..1 | st | ||
 templateId:comment-entry |
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: 1.3.6.1.4.1.19376.1.5.3.1.4.2 | |
| @extension |
0..1 | st | ||
| @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: 48767-8 | |
| @codeSystem |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.6.1 | |
| @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 |
S | 1..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 |
SC | 1..1 | TEL | Constraints: value-starts-octothorpe |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @value |
1..1 | url | ||
 useablePeriod |
0..* | |||
 useablePeriod |
IVL_TS | |||
| useablePeriod |
EIVL_TS | |||
| useablePeriod |
PIVL_TS | |||
| useablePeriod |
SXPR_TS | |||
| @use |
0..* | cs | Binding: TelecommunicationAddressUse (2.0.0) (required) | |
| thumbnail |
0..1 | ED | ||
| statusCode |
0..1 | CS | Binding: ActStatus (required) | |
| 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 | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 |
0..1 | cs | Binding: CDAParticipationType (required) Fixed Value: AUT | |
| @contextControlCode |
0..1 | cs | Binding: CDAContextControl (required) Fixed Value: OP | |
| functionCode |
0..1 | CE | ||
| time |
S | 1..1 | TS | |
| assignedAuthor |
S | 1..1 | AssignedAuthor | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: RoleClassAssignedEntity (required) Fixed Value: ASSIGNED | |
| id |
S | 1..* | II | |
| sdtcIdentifiedBy |
0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |
| code |
0..1 | CE | Binding: CDARoleCode (example) | |
| addr |
S | 1..* | AD | |
| telecom |
S | 1..* | TEL | |
| assignedPerson |
S | 0..1 | Person | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: EntityClassLivingSubject (required) Fixed Value: PSN | |
| @determinerCode |
0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
| name |
S | 1..* | PN | |
| sdtcDesc |
0..1 | ED | XML Namespace: urn:hl7-org:sdtc XML: desc (urn:hl7-org:sdtc) | |
| sdtcAsPatientRelationship |
0..* | InfrastructureRoot | XML Namespace: urn:hl7-org:sdtc XML: asPatientRelationship (urn:hl7-org:sdtc) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | Fixed Value: PRS | |
| @determinerCode |
0..1 | cs | Fixed Value: INSTANCE | |
| code |
1..1 | CE | XML Namespace: urn:hl7-org:sdtc XML Namespace: urn:hl7-org:sdtc | |
| assignedAuthoringDevice |
0..1 | AuthoringDevice | ||
| representedOrganization |
S | 0..1 | Organization | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: EntityClassOrganization (required) Fixed Value: ORG | |
| @determinerCode |
0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
| id |
0..* | II | ||
| name |
S | 1..* | ON | |
| telecom |
0..* | TEL | ||
| addr |
0..* | AD | ||
| standardIndustryClassCode |
0..1 | CE | Binding: OrganizationIndustryClassNAICS (example) | |
| asOrganizationPartOf |
0..1 | OrganizationPartOf | ||
| 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 | Status | Usage | ValueSet | Version | Source |
| Act.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.templateId:comment-activity.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.templateId:comment-entry.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.classCode | Base | required | x_ActClassDocumentEntryAct | 📍2.0.0 | THO v5.2 |
| Act.moodCode | Base | required | x_DocumentActMood | 📍2.0.0 | THO v5.2 |
| Act.code | Base | example | v3 Code System ActCode | 📦3.0.0 | THO v6.5 |
| Act.code.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.text.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.text.compression | Base | required | CDACompressionAlgorithm | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.text.integrityCheckAlgorithm | Base | required | IntegrityCheckAlgorithm | 📍2.0.0 | THO v5.2 |
| Act.text.mediaType | Base | example | MediaType | 📦3.0.0 | THO v6.5 |
| Act.text.representation | Base | required | CDABinaryDataEncoding | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.text.reference.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.text.reference.use | Base | required | TelecommunicationAddressUse | 📍2.0.0 | THO v5.2 |
| Act.statusCode | Base | required | ActStatus | 📦3.0.0 | THO v6.5 |
| Act.priorityCode | Base | example | ActPriority | 📦3.0.0 | THO v6.5 |
| Act.languageCode | Base | required | All Languages | 📦5.0.0 | FHIR Std. |
| Act.author.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.author.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.author.typeCode | Base | required | CDAParticipationType | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.author.contextControlCode | Base | required | CDAContextControl | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.author.assignedAuthor.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.author.assignedAuthor.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.author.assignedAuthor.​classCode | Base | required | RoleClassAssignedEntity | 📦3.0.0 | THO v6.5 |
| Act.author.assignedAuthor.​code | Base | example | CDARoleCode | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.author.assignedAuthor.​assignedPerson.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.author.assignedAuthor.​assignedPerson.typeId.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.author.assignedAuthor.​assignedPerson.classCode | Base | required | EntityClassLivingSubject | 📦3.0.0 | THO v6.5 |
| Act.author.assignedAuthor.​assignedPerson.determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
| Act.author.assignedAuthor.​assignedPerson.sdtcAsPatientRelationship.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.author.assignedAuthor.​assignedPerson.sdtcAsPatientRelationship.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.author.assignedAuthor.​representedOrganization.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.author.assignedAuthor.​representedOrganization.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.author.assignedAuthor.​representedOrganization.​classCode | Base | required | EntityClassOrganization | 📦3.0.0 | THO v6.5 |
| Act.author.assignedAuthor.​representedOrganization.​determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
| Act.author.assignedAuthor.​representedOrganization.​standardIndustryClassCode | Base | example | OrganizationIndustryClassNAICS | 📦3.0.0 | THO v6.5 |
| Id | Grade | Path(s) | Description | Expression |
| II-1 | error | Act.typeId, Act.author.typeId, Act.author.assignedAuthor.typeId, Act.author.assignedAuthor.assignedPerson.typeId, Act.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.typeId, Act.author.assignedAuthor.representedOrganization.typeId | An II instance must have either a root or an nullFlavor. |
root.exists() or nullFlavor.exists()
|
| should-author | warning | Act | SHOULD contain author |
author.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('#')
|
This structure is derived from Act
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Act |
C | 1..1 | Act | XML Namespace: urn:hl7-org:v3 Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) Constraints: should-text-ref-value, should-author |
| Slices for templateId |
S | 2..* | II | Slice: Unordered, Open by value:root, value:extension |
| templateId:comment-activity |
1..1 | II | ||
| @root |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.1.40 | |
| templateId:comment-entry |
1..1 | II | ||
| @root |
1..1 | oid, uuid, ruid | Required Pattern: 1.3.6.1.4.1.19376.1.5.3.1.4.2 | |
| @classCode |
1..1 | cs | Fixed Value: ACT | |
| @moodCode |
1..1 | cs | Fixed Value: EVN | |
| code |
1..1 | CD | ||
| @code |
1..1 | cs | Required Pattern: 48767-8 | |
| @codeSystem |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.6.1 | |
| text |
S | 1..1 | ED | SHOULD reference the portion of section narrative text corresponding to this entry |
| reference |
SC | 1..1 | TEL | Constraints: value-starts-octothorpe |
| @value |
1..1 | url | ||
| author |
||||
| time |
S | 1..1 | TS | |
| assignedAuthor |
S | 1..1 | AssignedAuthor | |
| id |
S | 1..* | II | |
| addr |
S | 1..* | AD | |
| telecom |
S | 1..* | TEL | |
| assignedPerson |
S | 0..1 | Person | |
| name |
S | 1..* | PN | |
| representedOrganization |
S | 0..1 | Organization | |
| name |
S | 1..* | ON | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
| should-author | warning | Act | SHOULD contain author |
author.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 Filter: |
|---|---|---|---|---|
| Act |
C | 1..1 | Act | XML Namespace: urn:hl7-org:v3 Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) Constraints: should-text-ref-value, should-author |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 |
S | 2..* | II | Slice: Unordered, Open by value:root, value:extension |
| templateId:comment-activity |
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.1.40 | |
| @extension |
0..1 | st | ||
| templateId:comment-entry |
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: 1.3.6.1.4.1.19376.1.5.3.1.4.2 | |
| @extension |
0..1 | st | ||
| @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: 48767-8 | |
| @codeSystem |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.6.1 | |
| @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 |
S | 1..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 |
SC | 1..1 | TEL | Constraints: value-starts-octothorpe |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @value |
1..1 | url | ||
| useablePeriod |
0..* | |||
| useablePeriod |
IVL_TS | |||
| useablePeriod |
EIVL_TS | |||
| useablePeriod |
PIVL_TS | |||
| useablePeriod |
SXPR_TS | |||
| @use |
0..* | cs | Binding: TelecommunicationAddressUse (2.0.0) (required) | |
| thumbnail |
0..1 | ED | ||
| statusCode |
0..1 | CS | Binding: ActStatus (required) | |
| 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 | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 |
0..1 | cs | Binding: CDAParticipationType (required) Fixed Value: AUT | |
| @contextControlCode |
0..1 | cs | Binding: CDAContextControl (required) Fixed Value: OP | |
| functionCode |
0..1 | CE | ||
| time |
S | 1..1 | TS | |
| assignedAuthor |
S | 1..1 | AssignedAuthor | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: RoleClassAssignedEntity (required) Fixed Value: ASSIGNED | |
| id |
S | 1..* | II | |
| sdtcIdentifiedBy |
0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |
| code |
0..1 | CE | Binding: CDARoleCode (example) | |
| addr |
S | 1..* | AD | |
| telecom |
S | 1..* | TEL | |
| assignedPerson |
S | 0..1 | Person | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: EntityClassLivingSubject (required) Fixed Value: PSN | |
| @determinerCode |
0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
| name |
S | 1..* | PN | |
| sdtcDesc |
0..1 | ED | XML Namespace: urn:hl7-org:sdtc XML: desc (urn:hl7-org:sdtc) | |
| sdtcAsPatientRelationship |
0..* | InfrastructureRoot | XML Namespace: urn:hl7-org:sdtc XML: asPatientRelationship (urn:hl7-org:sdtc) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | Fixed Value: PRS | |
| @determinerCode |
0..1 | cs | Fixed Value: INSTANCE | |
| code |
1..1 | CE | XML Namespace: urn:hl7-org:sdtc XML Namespace: urn:hl7-org:sdtc | |
| assignedAuthoringDevice |
0..1 | AuthoringDevice | ||
| representedOrganization |
S | 0..1 | Organization | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: EntityClassOrganization (required) Fixed Value: ORG | |
| @determinerCode |
0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
| id |
0..* | II | ||
| name |
S | 1..* | ON | |
| telecom |
0..* | TEL | ||
| addr |
0..* | AD | ||
| standardIndustryClassCode |
0..1 | CE | Binding: OrganizationIndustryClassNAICS (example) | |
| asOrganizationPartOf |
0..1 | OrganizationPartOf | ||
| 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 | Status | Usage | ValueSet | Version | Source |
| Act.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.templateId:comment-activity.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.templateId:comment-entry.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.classCode | Base | required | x_ActClassDocumentEntryAct | 📍2.0.0 | THO v5.2 |
| Act.moodCode | Base | required | x_DocumentActMood | 📍2.0.0 | THO v5.2 |
| Act.code | Base | example | v3 Code System ActCode | 📦3.0.0 | THO v6.5 |
| Act.code.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.text.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.text.compression | Base | required | CDACompressionAlgorithm | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.text.integrityCheckAlgorithm | Base | required | IntegrityCheckAlgorithm | 📍2.0.0 | THO v5.2 |
| Act.text.mediaType | Base | example | MediaType | 📦3.0.0 | THO v6.5 |
| Act.text.representation | Base | required | CDABinaryDataEncoding | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.text.reference.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.text.reference.use | Base | required | TelecommunicationAddressUse | 📍2.0.0 | THO v5.2 |
| Act.statusCode | Base | required | ActStatus | 📦3.0.0 | THO v6.5 |
| Act.priorityCode | Base | example | ActPriority | 📦3.0.0 | THO v6.5 |
| Act.languageCode | Base | required | All Languages | 📦5.0.0 | FHIR Std. |
| Act.author.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.author.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.author.typeCode | Base | required | CDAParticipationType | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.author.contextControlCode | Base | required | CDAContextControl | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.author.assignedAuthor.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.author.assignedAuthor.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.author.assignedAuthor.​classCode | Base | required | RoleClassAssignedEntity | 📦3.0.0 | THO v6.5 |
| Act.author.assignedAuthor.​code | Base | example | CDARoleCode | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.author.assignedAuthor.​assignedPerson.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.author.assignedAuthor.​assignedPerson.typeId.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.author.assignedAuthor.​assignedPerson.classCode | Base | required | EntityClassLivingSubject | 📦3.0.0 | THO v6.5 |
| Act.author.assignedAuthor.​assignedPerson.determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
| Act.author.assignedAuthor.​assignedPerson.sdtcAsPatientRelationship.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.author.assignedAuthor.​assignedPerson.sdtcAsPatientRelationship.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.author.assignedAuthor.​representedOrganization.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.author.assignedAuthor.​representedOrganization.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.author.assignedAuthor.​representedOrganization.​classCode | Base | required | EntityClassOrganization | 📦3.0.0 | THO v6.5 |
| Act.author.assignedAuthor.​representedOrganization.​determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
| Act.author.assignedAuthor.​representedOrganization.​standardIndustryClassCode | Base | example | OrganizationIndustryClassNAICS | 📦3.0.0 | THO v6.5 |
| Id | Grade | Path(s) | Description | Expression |
| II-1 | error | Act.typeId, Act.author.typeId, Act.author.assignedAuthor.typeId, Act.author.assignedAuthor.assignedPerson.typeId, Act.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.typeId, Act.author.assignedAuthor.representedOrganization.typeId | An II instance must have either a root or an nullFlavor. |
root.exists() or nullFlavor.exists()
|
| should-author | warning | Act | SHOULD contain author |
author.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 Filter: |
|---|---|---|---|---|
| Act |
C | 1..1 | Act | XML Namespace: urn:hl7-org:v3 Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) Constraints: should-text-ref-value, should-author |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 |
S | 2..* | II | Slice: Unordered, Open by value:root, value:extension |
| templateId:comment-activity |
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.1.40 | |
| @extension |
0..1 | st | ||
| templateId:comment-entry |
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: 1.3.6.1.4.1.19376.1.5.3.1.4.2 | |
| @extension |
0..1 | st | ||
| @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: 48767-8 | |
| @codeSystem |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.6.1 | |
| @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 |
S | 1..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 |
SC | 1..1 | TEL | Constraints: value-starts-octothorpe |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @value |
1..1 | url | ||
| useablePeriod |
0..* | |||
| useablePeriod |
IVL_TS | |||
| useablePeriod |
EIVL_TS | |||
| useablePeriod |
PIVL_TS | |||
| useablePeriod |
SXPR_TS | |||
| @use |
0..* | cs | Binding: TelecommunicationAddressUse (2.0.0) (required) | |
| thumbnail |
0..1 | ED | ||
| statusCode |
0..1 | CS | Binding: ActStatus (required) | |
| 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 | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 |
0..1 | cs | Binding: CDAParticipationType (required) Fixed Value: AUT | |
| @contextControlCode |
0..1 | cs | Binding: CDAContextControl (required) Fixed Value: OP | |
| functionCode |
0..1 | CE | ||
| time |
S | 1..1 | TS | |
| assignedAuthor |
S | 1..1 | AssignedAuthor | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: RoleClassAssignedEntity (required) Fixed Value: ASSIGNED | |
| id |
S | 1..* | II | |
| sdtcIdentifiedBy |
0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |
| code |
0..1 | CE | Binding: CDARoleCode (example) | |
| addr |
S | 1..* | AD | |
| telecom |
S | 1..* | TEL | |
| assignedPerson |
S | 0..1 | Person | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: EntityClassLivingSubject (required) Fixed Value: PSN | |
| @determinerCode |
0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
| name |
S | 1..* | PN | |
| sdtcDesc |
0..1 | ED | XML Namespace: urn:hl7-org:sdtc XML: desc (urn:hl7-org:sdtc) | |
| sdtcAsPatientRelationship |
0..* | InfrastructureRoot | XML Namespace: urn:hl7-org:sdtc XML: asPatientRelationship (urn:hl7-org:sdtc) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | Fixed Value: PRS | |
| @determinerCode |
0..1 | cs | Fixed Value: INSTANCE | |
| code |
1..1 | CE | XML Namespace: urn:hl7-org:sdtc XML Namespace: urn:hl7-org:sdtc | |
| assignedAuthoringDevice |
0..1 | AuthoringDevice | ||
| representedOrganization |
S | 0..1 | Organization | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: EntityClassOrganization (required) Fixed Value: ORG | |
| @determinerCode |
0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
| id |
0..* | II | ||
| name |
S | 1..* | ON | |
| telecom |
0..* | TEL | ||
| addr |
0..* | AD | ||
| standardIndustryClassCode |
0..1 | CE | Binding: OrganizationIndustryClassNAICS (example) | |
| asOrganizationPartOf |
0..1 | OrganizationPartOf | ||
| 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 | Status | Usage | ValueSet | Version | Source |
| Act.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.templateId:comment-activity.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.templateId:comment-entry.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.classCode | Base | required | x_ActClassDocumentEntryAct | 📍2.0.0 | THO v5.2 |
| Act.moodCode | Base | required | x_DocumentActMood | 📍2.0.0 | THO v5.2 |
| Act.code | Base | example | v3 Code System ActCode | 📦3.0.0 | THO v6.5 |
| Act.code.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.text.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.text.compression | Base | required | CDACompressionAlgorithm | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.text.integrityCheckAlgorithm | Base | required | IntegrityCheckAlgorithm | 📍2.0.0 | THO v5.2 |
| Act.text.mediaType | Base | example | MediaType | 📦3.0.0 | THO v6.5 |
| Act.text.representation | Base | required | CDABinaryDataEncoding | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.text.reference.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.text.reference.use | Base | required | TelecommunicationAddressUse | 📍2.0.0 | THO v5.2 |
| Act.statusCode | Base | required | ActStatus | 📦3.0.0 | THO v6.5 |
| Act.priorityCode | Base | example | ActPriority | 📦3.0.0 | THO v6.5 |
| Act.languageCode | Base | required | All Languages | 📦5.0.0 | FHIR Std. |
| Act.author.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.author.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.author.typeCode | Base | required | CDAParticipationType | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.author.contextControlCode | Base | required | CDAContextControl | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.author.assignedAuthor.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.author.assignedAuthor.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.author.assignedAuthor.​classCode | Base | required | RoleClassAssignedEntity | 📦3.0.0 | THO v6.5 |
| Act.author.assignedAuthor.​code | Base | example | CDARoleCode | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.author.assignedAuthor.​assignedPerson.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.author.assignedAuthor.​assignedPerson.typeId.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.author.assignedAuthor.​assignedPerson.classCode | Base | required | EntityClassLivingSubject | 📦3.0.0 | THO v6.5 |
| Act.author.assignedAuthor.​assignedPerson.determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
| Act.author.assignedAuthor.​assignedPerson.sdtcAsPatientRelationship.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.author.assignedAuthor.​assignedPerson.sdtcAsPatientRelationship.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.author.assignedAuthor.​representedOrganization.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.author.assignedAuthor.​representedOrganization.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.author.assignedAuthor.​representedOrganization.​classCode | Base | required | EntityClassOrganization | 📦3.0.0 | THO v6.5 |
| Act.author.assignedAuthor.​representedOrganization.​determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
| Act.author.assignedAuthor.​representedOrganization.​standardIndustryClassCode | Base | example | OrganizationIndustryClassNAICS | 📦3.0.0 | THO v6.5 |
| Id | Grade | Path(s) | Description | Expression |
| II-1 | error | Act.typeId, Act.author.typeId, Act.author.assignedAuthor.typeId, Act.author.assignedAuthor.assignedPerson.typeId, Act.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.typeId, Act.author.assignedAuthor.representedOrganization.typeId | An II instance must have either a root or an nullFlavor. |
root.exists() or nullFlavor.exists()
|
| should-author | warning | Act | SHOULD contain author |
author.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 Filter: |
|---|---|---|---|---|
| Act |
C | 1..1 | Act | XML Namespace: urn:hl7-org:v3 Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) Constraints: should-text-ref-value, should-author |
| Slices for templateId |
S | 2..* | II | Slice: Unordered, Open by value:root, value:extension |
| templateId:comment-activity |
1..1 | II | ||
| @root |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.1.40 | |
| templateId:comment-entry |
1..1 | II | ||
| @root |
1..1 | oid, uuid, ruid | Required Pattern: 1.3.6.1.4.1.19376.1.5.3.1.4.2 | |
| @classCode |
1..1 | cs | Fixed Value: ACT | |
| @moodCode |
1..1 | cs | Fixed Value: EVN | |
| code |
1..1 | CD | ||
| @code |
1..1 | cs | Required Pattern: 48767-8 | |
| @codeSystem |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.6.1 | |
| text |
S | 1..1 | ED | SHOULD reference the portion of section narrative text corresponding to this entry |
| reference |
SC | 1..1 | TEL | Constraints: value-starts-octothorpe |
| @value |
1..1 | url | ||
| author |
||||
| time |
S | 1..1 | TS | |
| assignedAuthor |
S | 1..1 | AssignedAuthor | |
| id |
S | 1..* | II | |
| addr |
S | 1..* | AD | |
| telecom |
S | 1..* | TEL | |
| assignedPerson |
S | 0..1 | Person | |
| name |
S | 1..* | PN | |
| representedOrganization |
S | 0..1 | Organization | |
| name |
S | 1..* | ON | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
| should-author | warning | Act | SHOULD contain author |
author.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 Filter: |
|---|---|---|---|---|
| Act |
C | 1..1 | Act | XML Namespace: urn:hl7-org:v3 Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) Constraints: should-text-ref-value, should-author |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 |
S | 2..* | II | Slice: Unordered, Open by value:root, value:extension |
| templateId:comment-activity |
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.1.40 | |
| @extension |
0..1 | st | ||
| templateId:comment-entry |
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: 1.3.6.1.4.1.19376.1.5.3.1.4.2 | |
| @extension |
0..1 | st | ||
| @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: 48767-8 | |
| @codeSystem |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.6.1 | |
| @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 |
S | 1..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 |
SC | 1..1 | TEL | Constraints: value-starts-octothorpe |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @value |
1..1 | url | ||
| useablePeriod |
0..* | |||
| useablePeriod |
IVL_TS | |||
| useablePeriod |
EIVL_TS | |||
| useablePeriod |
PIVL_TS | |||
| useablePeriod |
SXPR_TS | |||
| @use |
0..* | cs | Binding: TelecommunicationAddressUse (2.0.0) (required) | |
| thumbnail |
0..1 | ED | ||
| statusCode |
0..1 | CS | Binding: ActStatus (required) | |
| 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 | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 |
0..1 | cs | Binding: CDAParticipationType (required) Fixed Value: AUT | |
| @contextControlCode |
0..1 | cs | Binding: CDAContextControl (required) Fixed Value: OP | |
| functionCode |
0..1 | CE | ||
| time |
S | 1..1 | TS | |
| assignedAuthor |
S | 1..1 | AssignedAuthor | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: RoleClassAssignedEntity (required) Fixed Value: ASSIGNED | |
| id |
S | 1..* | II | |
| sdtcIdentifiedBy |
0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |
| code |
0..1 | CE | Binding: CDARoleCode (example) | |
| addr |
S | 1..* | AD | |
| telecom |
S | 1..* | TEL | |
| assignedPerson |
S | 0..1 | Person | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: EntityClassLivingSubject (required) Fixed Value: PSN | |
| @determinerCode |
0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
| name |
S | 1..* | PN | |
| sdtcDesc |
0..1 | ED | XML Namespace: urn:hl7-org:sdtc XML: desc (urn:hl7-org:sdtc) | |
| sdtcAsPatientRelationship |
0..* | InfrastructureRoot | XML Namespace: urn:hl7-org:sdtc XML: asPatientRelationship (urn:hl7-org:sdtc) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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 | Fixed Value: PRS | |
| @determinerCode |
0..1 | cs | Fixed Value: INSTANCE | |
| code |
1..1 | CE | XML Namespace: urn:hl7-org:sdtc XML Namespace: urn:hl7-org:sdtc | |
| assignedAuthoringDevice |
0..1 | AuthoringDevice | ||
| representedOrganization |
S | 0..1 | Organization | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
C | 0..1 | II | Constraints: II-1 |
| @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: EntityClassOrganization (required) Fixed Value: ORG | |
| @determinerCode |
0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
| id |
0..* | II | ||
| name |
S | 1..* | ON | |
| telecom |
0..* | TEL | ||
| addr |
0..* | AD | ||
| standardIndustryClassCode |
0..1 | CE | Binding: OrganizationIndustryClassNAICS (example) | |
| asOrganizationPartOf |
0..1 | OrganizationPartOf | ||
| 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 | Status | Usage | ValueSet | Version | Source |
| Act.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.templateId:comment-activity.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.templateId:comment-entry.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.classCode | Base | required | x_ActClassDocumentEntryAct | 📍2.0.0 | THO v5.2 |
| Act.moodCode | Base | required | x_DocumentActMood | 📍2.0.0 | THO v5.2 |
| Act.code | Base | example | v3 Code System ActCode | 📦3.0.0 | THO v6.5 |
| Act.code.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.text.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.text.compression | Base | required | CDACompressionAlgorithm | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.text.integrityCheckAlgorithm | Base | required | IntegrityCheckAlgorithm | 📍2.0.0 | THO v5.2 |
| Act.text.mediaType | Base | example | MediaType | 📦3.0.0 | THO v6.5 |
| Act.text.representation | Base | required | CDABinaryDataEncoding | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.text.reference.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.text.reference.use | Base | required | TelecommunicationAddressUse | 📍2.0.0 | THO v5.2 |
| Act.statusCode | Base | required | ActStatus | 📦3.0.0 | THO v6.5 |
| Act.priorityCode | Base | example | ActPriority | 📦3.0.0 | THO v6.5 |
| Act.languageCode | Base | required | All Languages | 📦5.0.0 | FHIR Std. |
| Act.author.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.author.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.author.typeCode | Base | required | CDAParticipationType | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.author.contextControlCode | Base | required | CDAContextControl | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.author.assignedAuthor.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.author.assignedAuthor.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.author.assignedAuthor.​classCode | Base | required | RoleClassAssignedEntity | 📦3.0.0 | THO v6.5 |
| Act.author.assignedAuthor.​code | Base | example | CDARoleCode | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.author.assignedAuthor.​assignedPerson.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.author.assignedAuthor.​assignedPerson.typeId.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.author.assignedAuthor.​assignedPerson.classCode | Base | required | EntityClassLivingSubject | 📦3.0.0 | THO v6.5 |
| Act.author.assignedAuthor.​assignedPerson.determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
| Act.author.assignedAuthor.​assignedPerson.sdtcAsPatientRelationship.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.author.assignedAuthor.​assignedPerson.sdtcAsPatientRelationship.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.author.assignedAuthor.​representedOrganization.​nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.author.assignedAuthor.​representedOrganization.​typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.author.assignedAuthor.​representedOrganization.​classCode | Base | required | EntityClassOrganization | 📦3.0.0 | THO v6.5 |
| Act.author.assignedAuthor.​representedOrganization.​determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
| Act.author.assignedAuthor.​representedOrganization.​standardIndustryClassCode | Base | example | OrganizationIndustryClassNAICS | 📦3.0.0 | THO v6.5 |
| Id | Grade | Path(s) | Description | Expression |
| II-1 | error | Act.typeId, Act.author.typeId, Act.author.assignedAuthor.typeId, Act.author.assignedAuthor.assignedPerson.typeId, Act.author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.typeId, Act.author.assignedAuthor.representedOrganization.typeId | An II instance must have either a root or an nullFlavor. |
root.exists() or nullFlavor.exists()
|
| should-author | warning | Act | SHOULD contain author |
author.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('#')
|
IG © 2023+ IHE Patient Care Coordination Technical Committee. Package ihe.pcc.pscc#0.0.1-current based on FHIR 5.0.0. Generated 2025-11-04
Links: Table of Contents |
QA Report
| New Issue | Issues
Version History |
|
Propose a change