Consolidated CDA (C-CDA)
4.0.0 - STU4
Consolidated CDA (C-CDA)
4.0.0 - STU4
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 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/DrugMonitoringAct | Version: 4.0.0 | |||
| Draft as of 2025-10-02 | Computable Name: DrugMonitoringAct | |||
| Other Identifiers: OID:2.16.840.1.113883.10.20.22.4.123 | ||||
This template represents the act of monitoring the patient's medication and includes a participation to record the person responsible for monitoring the medication. The prescriber of the medication is not necessarily the same person or persons monitoring the drug. The effectiveTime indicates the time when the activity is intended to take place.
For example, a cardiologist may prescribe a patient Warfarin. The patient's primary care provider may monitor the patient's INR and adjust the dosing of the Warfarin based on these laboratory results. Here the person designated to monitor the drug is the primary care provider.
Usages:
You can also check for usages in the FHIR IG Statistics
Changes since version 3.0.0:
Description of Template, Differentials, Snapshots and how the different presentations work.
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 |
  Slices for templateId |
1..* | II | Slice: Unordered, Open by value:root | |
   templateId:drug-monitoring-act |
1..1 | II | ||
  @root |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.123 | |
  @extension |
0..0 | |||
 @classCode |
1..1 | cs | Fixed Value: ACT | |
| @moodCode |
1..1 | cs | Fixed Value: INT | |
| id |
1..* | II | ||
| code |
1..1 | CD | ||
| @code |
1..1 | cs | Required Pattern: 395170001 | |
 @codeSystem |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.6.96 | |
| text |
0..1 | ED | SHOULD reference the portion of section narrative text corresponding to this entry | |
| reference |
C | 0..1 | TEL | Constraints: value-starts-octothorpe |
| statusCode |
1..1 | CS | ||
| @nullFlavor |
0..0 | |||
| @code |
1..1 | cs | Binding: ActStatus (required) | |
| effectiveTime |
1..1 | IVL_TS | ||
 Slices for participant |
1..* | Participant2 | Slice: Unordered, Open by value:typeCode | |
| participant:responsible |
1..* | Participant2 | ||
| @typeCode |
1..1 | cs | Fixed Value: RESP | |
 participantRole |
1..1 | ParticipantRole | ||
| @classCode |
1..1 | cs | Fixed Value: ASSIGNED | |
| id |
1..* | II | ||
| playingEntity |
1..1 | PlayingEntity | ||
| @classCode |
1..1 | cs | Fixed Value: PSN | |
 name |
1..1 | USRealmPersonNamePNUSFIELDED | ||
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Act.statusCode.code | Base | required | ActStatus | 📦3.0.0 | THO v6.5 |
| Id | Grade | Path(s) | Description | Expression |
| 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 |
 @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 |
1..* | II | Slice: Unordered, Open by value:root | |
| templateId:drug-monitoring-act |
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.123 | |
| @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: INT | |
| @negationInd |
0..1 | bl | ||
| id |
1..* | II | ||
| code |
1..1 | CD | Binding: v3 Code System ActCode (example) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @code |
1..1 | cs | Required Pattern: 395170001 | |
| @codeSystem |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.6.96 | |
| @codeSystemName |
0..1 | st | ||
| @codeSystemVersion |
0..1 | st | ||
| @displayName |
0..1 | st | ||
| @sdtcValueSet |
0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
| @sdtcValueSetVersion |
0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
| originalText |
0..1 | ED | ||
| qualifier |
0..* | CR | ||
| translation |
0..* | CD | ||
| text |
0..1 | ED | SHOULD reference the portion of section narrative text corresponding to this entry | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @compression |
0..1 | cs | Binding: CDACompressionAlgorithm (required) | |
| @integrityCheck |
0..1 | bin | ||
| @integrityCheckAlgorithm |
0..1 | cs | Binding: IntegrityCheckAlgorithm (2.0.0) (required) | |
| @language |
0..1 | cs | ||
| @mediaType |
0..1 | cs | Binding: MediaType (example) | |
| @representation |
0..1 | cs | Binding: CDABinaryDataEncoding (required) | |
| xmlText |
0..1 | st | Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string. | |
| reference |
C | 0..1 | TEL | Constraints: value-starts-octothorpe |
| thumbnail |
0..1 | ED | ||
| statusCode |
1..1 | CS | Binding: ActStatus (required) | |
| @code |
1..1 | cs | Binding: ActStatus (required) | |
| @sdtcValueSet |
0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
| @sdtcValueSetVersion |
0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
| effectiveTime |
1..1 | IVL_TS | ||
| 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 | ||
| Slices for participant |
1..* | Participant2 | Slice: Unordered, Open by value:typeCode | |
| participant:responsible |
1..* | Participant2 | ||
| @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 |
1..1 | cs | Binding: CDAParticipationType (required) Fixed Value: RESP | |
| @contextControlCode |
0..1 | cs | Binding: CDAContextControl (required) Fixed Value: OP | |
| sdtcFunctionCode |
0..1 | CE | XML Namespace: urn:hl7-org:sdtc XML: functionCode (urn:hl7-org:sdtc) | |
| time |
0..1 | IVL_TS | ||
| awarenessCode |
0..1 | CE | ||
| participantRole |
1..1 | ParticipantRole | ||
| @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 | Binding: CDARoleClassRoot (required) Fixed Value: ASSIGNED | |
| id |
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 |
0..* | AD | ||
| telecom |
0..* | TEL | ||
| playingDevice |
0..1 | Device | ||
| playingEntity |
1..1 | PlayingEntity | ||
| @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 | Binding: EntityClassRoot (required) Fixed Value: PSN | |
| @determinerCode |
0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
| code |
0..1 | CE | Binding: CDAEntityCode (example) | |
| quantity |
0..* | PQ | ||
| name |
1..1 | USRealmPersonNamePNUSFIELDED | ||
| sdtcBirthTime |
0..1 | TS | XML Namespace: urn:hl7-org:sdtc XML: birthTime (urn:hl7-org:sdtc) | |
| desc |
0..1 | ED | ||
| scopingEntity |
0..1 | Entity | ||
| entryRelationship |
0..* | EntryRelationship | ||
| reference |
0..* | Reference | ||
| precondition |
0..* | Precondition | ||
| sdtcPrecondition2 |
0..* | Precondition2 | XML Namespace: urn:hl7-org:sdtc XML: precondition2 (urn:hl7-org:sdtc) | |
| sdtcInFulfillmentOf1 |
0..* | InFulfillmentOf1 | XML Namespace: urn:hl7-org:sdtc XML: inFulfillmentOf1 (urn:hl7-org:sdtc) | |
| Documentation for this format | ||||
| Path | 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:drug-monitoring-act.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.statusCode | Base | required | ActStatus | 📦3.0.0 | THO v6.5 |
| Act.statusCode.code | 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.participant:responsible.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:responsible.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:responsible.typeCode | Base | required | CDAParticipationType | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:responsible.contextControlCode | Base | required | CDAContextControl | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:responsible.participantRole.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:responsible.participantRole.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:responsible.participantRole.classCode | Base | required | CDARoleClassRoot | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:responsible.participantRole.code | Base | example | CDARoleCode | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:responsible.participantRole.playingEntity.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:responsible.participantRole.playingEntity.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:responsible.participantRole.playingEntity.classCode | Base | required | EntityClassRoot | 📦3.0.0 | THO v6.5 |
| Act.participant:responsible.participantRole.playingEntity.determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
| Act.participant:responsible.participantRole.playingEntity.code | Base | example | CDAEntityCode | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Id | Grade | Path(s) | Description | Expression |
| II-1 | error | Act.typeId, Act.participant:responsible.typeId, Act.participant:responsible.participantRole.typeId, Act.participant:responsible.participantRole.playingEntity.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 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 |
| @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 |
1..* | II | Slice: Unordered, Open by value:root | |
| templateId:drug-monitoring-act |
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.123 | |
| @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: INT | |
| @negationInd |
0..1 | bl | ||
| id |
1..* | II | ||
| code |
1..1 | CD | Binding: v3 Code System ActCode (example) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @code |
1..1 | cs | Required Pattern: 395170001 | |
| @codeSystem |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.6.96 | |
| @codeSystemName |
0..1 | st | ||
| @codeSystemVersion |
0..1 | st | ||
| @displayName |
0..1 | st | ||
| @sdtcValueSet |
0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
| @sdtcValueSetVersion |
0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
| originalText |
0..1 | ED | ||
| qualifier |
0..* | CR | ||
| translation |
0..* | CD | ||
| text |
0..1 | ED | SHOULD reference the portion of section narrative text corresponding to this entry | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @compression |
0..1 | cs | Binding: CDACompressionAlgorithm (required) | |
| @integrityCheck |
0..1 | bin | ||
| @integrityCheckAlgorithm |
0..1 | cs | Binding: IntegrityCheckAlgorithm (2.0.0) (required) | |
| @language |
0..1 | cs | ||
| @mediaType |
0..1 | cs | Binding: MediaType (example) | |
| @representation |
0..1 | cs | Binding: CDABinaryDataEncoding (required) | |
| xmlText |
0..1 | st | Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string. | |
| reference |
C | 0..1 | TEL | Constraints: value-starts-octothorpe |
| thumbnail |
0..1 | ED | ||
| statusCode |
1..1 | CS | Binding: ActStatus (required) | |
| @code |
1..1 | cs | Binding: ActStatus (required) | |
| @sdtcValueSet |
0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
| @sdtcValueSetVersion |
0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
| effectiveTime |
1..1 | IVL_TS | ||
| 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 | ||
| Slices for participant |
1..* | Participant2 | Slice: Unordered, Open by value:typeCode | |
| participant:responsible |
1..* | Participant2 | ||
| @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 |
1..1 | cs | Binding: CDAParticipationType (required) Fixed Value: RESP | |
| @contextControlCode |
0..1 | cs | Binding: CDAContextControl (required) Fixed Value: OP | |
| sdtcFunctionCode |
0..1 | CE | XML Namespace: urn:hl7-org:sdtc XML: functionCode (urn:hl7-org:sdtc) | |
| time |
0..1 | IVL_TS | ||
| awarenessCode |
0..1 | CE | ||
| participantRole |
1..1 | ParticipantRole | ||
| @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 | Binding: CDARoleClassRoot (required) Fixed Value: ASSIGNED | |
| id |
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 |
0..* | AD | ||
| telecom |
0..* | TEL | ||
| playingDevice |
0..1 | Device | ||
| playingEntity |
1..1 | PlayingEntity | ||
| @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 | Binding: EntityClassRoot (required) Fixed Value: PSN | |
| @determinerCode |
0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
| code |
0..1 | CE | Binding: CDAEntityCode (example) | |
| quantity |
0..* | PQ | ||
| name |
1..1 | USRealmPersonNamePNUSFIELDED | ||
| sdtcBirthTime |
0..1 | TS | XML Namespace: urn:hl7-org:sdtc XML: birthTime (urn:hl7-org:sdtc) | |
| desc |
0..1 | ED | ||
| scopingEntity |
0..1 | Entity | ||
| entryRelationship |
0..* | EntryRelationship | ||
| reference |
0..* | Reference | ||
| precondition |
0..* | Precondition | ||
| sdtcPrecondition2 |
0..* | Precondition2 | XML Namespace: urn:hl7-org:sdtc XML: precondition2 (urn:hl7-org:sdtc) | |
| sdtcInFulfillmentOf1 |
0..* | InFulfillmentOf1 | XML Namespace: urn:hl7-org:sdtc XML: inFulfillmentOf1 (urn:hl7-org:sdtc) | |
| Documentation for this format | ||||
| Path | 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:drug-monitoring-act.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.statusCode | Base | required | ActStatus | 📦3.0.0 | THO v6.5 |
| Act.statusCode.code | 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.participant:responsible.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:responsible.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:responsible.typeCode | Base | required | CDAParticipationType | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:responsible.contextControlCode | Base | required | CDAContextControl | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:responsible.participantRole.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:responsible.participantRole.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:responsible.participantRole.classCode | Base | required | CDARoleClassRoot | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:responsible.participantRole.code | Base | example | CDARoleCode | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:responsible.participantRole.playingEntity.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:responsible.participantRole.playingEntity.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:responsible.participantRole.playingEntity.classCode | Base | required | EntityClassRoot | 📦3.0.0 | THO v6.5 |
| Act.participant:responsible.participantRole.playingEntity.determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
| Act.participant:responsible.participantRole.playingEntity.code | Base | example | CDAEntityCode | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Id | Grade | Path(s) | Description | Expression |
| II-1 | error | Act.typeId, Act.participant:responsible.typeId, Act.participant:responsible.participantRole.typeId, Act.participant:responsible.participantRole.playingEntity.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('#')
|
This structure is derived from Act
Summary
Mandatory: 16 elements
Fixed: 5 elements
Prohibited: 2 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Act
| Name | Flags | Card. | Type | Description & Constraints 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 |
| Slices for templateId |
1..* | II | Slice: Unordered, Open by value:root | |
| templateId:drug-monitoring-act |
1..1 | II | ||
| @root |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.123 | |
| @extension |
0..0 | |||
| @classCode |
1..1 | cs | Fixed Value: ACT | |
| @moodCode |
1..1 | cs | Fixed Value: INT | |
| id |
1..* | II | ||
| code |
1..1 | CD | ||
| @code |
1..1 | cs | Required Pattern: 395170001 | |
| @codeSystem |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.6.96 | |
| text |
0..1 | ED | SHOULD reference the portion of section narrative text corresponding to this entry | |
| reference |
C | 0..1 | TEL | Constraints: value-starts-octothorpe |
| statusCode |
1..1 | CS | ||
| @nullFlavor |
0..0 | |||
| @code |
1..1 | cs | Binding: ActStatus (required) | |
| effectiveTime |
1..1 | IVL_TS | ||
| Slices for participant |
1..* | Participant2 | Slice: Unordered, Open by value:typeCode | |
| participant:responsible |
1..* | Participant2 | ||
| @typeCode |
1..1 | cs | Fixed Value: RESP | |
| participantRole |
1..1 | ParticipantRole | ||
| @classCode |
1..1 | cs | Fixed Value: ASSIGNED | |
| id |
1..* | II | ||
| playingEntity |
1..1 | PlayingEntity | ||
| @classCode |
1..1 | cs | Fixed Value: PSN | |
| name |
1..1 | USRealmPersonNamePNUSFIELDED | ||
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Act.statusCode.code | Base | required | ActStatus | 📦3.0.0 | THO v6.5 |
| Id | Grade | Path(s) | Description | Expression |
| 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 |
| @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 |
1..* | II | Slice: Unordered, Open by value:root | |
| templateId:drug-monitoring-act |
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.123 | |
| @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: INT | |
| @negationInd |
0..1 | bl | ||
| id |
1..* | II | ||
| code |
1..1 | CD | Binding: v3 Code System ActCode (example) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @code |
1..1 | cs | Required Pattern: 395170001 | |
| @codeSystem |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.6.96 | |
| @codeSystemName |
0..1 | st | ||
| @codeSystemVersion |
0..1 | st | ||
| @displayName |
0..1 | st | ||
| @sdtcValueSet |
0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
| @sdtcValueSetVersion |
0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
| originalText |
0..1 | ED | ||
| qualifier |
0..* | CR | ||
| translation |
0..* | CD | ||
| text |
0..1 | ED | SHOULD reference the portion of section narrative text corresponding to this entry | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @compression |
0..1 | cs | Binding: CDACompressionAlgorithm (required) | |
| @integrityCheck |
0..1 | bin | ||
| @integrityCheckAlgorithm |
0..1 | cs | Binding: IntegrityCheckAlgorithm (2.0.0) (required) | |
| @language |
0..1 | cs | ||
| @mediaType |
0..1 | cs | Binding: MediaType (example) | |
| @representation |
0..1 | cs | Binding: CDABinaryDataEncoding (required) | |
| xmlText |
0..1 | st | Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string. | |
| reference |
C | 0..1 | TEL | Constraints: value-starts-octothorpe |
| thumbnail |
0..1 | ED | ||
| statusCode |
1..1 | CS | Binding: ActStatus (required) | |
| @code |
1..1 | cs | Binding: ActStatus (required) | |
| @sdtcValueSet |
0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
| @sdtcValueSetVersion |
0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
| effectiveTime |
1..1 | IVL_TS | ||
| 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 | ||
| Slices for participant |
1..* | Participant2 | Slice: Unordered, Open by value:typeCode | |
| participant:responsible |
1..* | Participant2 | ||
| @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 |
1..1 | cs | Binding: CDAParticipationType (required) Fixed Value: RESP | |
| @contextControlCode |
0..1 | cs | Binding: CDAContextControl (required) Fixed Value: OP | |
| sdtcFunctionCode |
0..1 | CE | XML Namespace: urn:hl7-org:sdtc XML: functionCode (urn:hl7-org:sdtc) | |
| time |
0..1 | IVL_TS | ||
| awarenessCode |
0..1 | CE | ||
| participantRole |
1..1 | ParticipantRole | ||
| @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 | Binding: CDARoleClassRoot (required) Fixed Value: ASSIGNED | |
| id |
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 |
0..* | AD | ||
| telecom |
0..* | TEL | ||
| playingDevice |
0..1 | Device | ||
| playingEntity |
1..1 | PlayingEntity | ||
| @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 | Binding: EntityClassRoot (required) Fixed Value: PSN | |
| @determinerCode |
0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
| code |
0..1 | CE | Binding: CDAEntityCode (example) | |
| quantity |
0..* | PQ | ||
| name |
1..1 | USRealmPersonNamePNUSFIELDED | ||
| sdtcBirthTime |
0..1 | TS | XML Namespace: urn:hl7-org:sdtc XML: birthTime (urn:hl7-org:sdtc) | |
| desc |
0..1 | ED | ||
| scopingEntity |
0..1 | Entity | ||
| entryRelationship |
0..* | EntryRelationship | ||
| reference |
0..* | Reference | ||
| precondition |
0..* | Precondition | ||
| sdtcPrecondition2 |
0..* | Precondition2 | XML Namespace: urn:hl7-org:sdtc XML: precondition2 (urn:hl7-org:sdtc) | |
| sdtcInFulfillmentOf1 |
0..* | InFulfillmentOf1 | XML Namespace: urn:hl7-org:sdtc XML: inFulfillmentOf1 (urn:hl7-org:sdtc) | |
| Documentation for this format | ||||
| Path | 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:drug-monitoring-act.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.statusCode | Base | required | ActStatus | 📦3.0.0 | THO v6.5 |
| Act.statusCode.code | 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.participant:responsible.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:responsible.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:responsible.typeCode | Base | required | CDAParticipationType | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:responsible.contextControlCode | Base | required | CDAContextControl | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:responsible.participantRole.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:responsible.participantRole.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:responsible.participantRole.classCode | Base | required | CDARoleClassRoot | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:responsible.participantRole.code | Base | example | CDARoleCode | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:responsible.participantRole.playingEntity.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:responsible.participantRole.playingEntity.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:responsible.participantRole.playingEntity.classCode | Base | required | EntityClassRoot | 📦3.0.0 | THO v6.5 |
| Act.participant:responsible.participantRole.playingEntity.determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
| Act.participant:responsible.participantRole.playingEntity.code | Base | example | CDAEntityCode | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Id | Grade | Path(s) | Description | Expression |
| II-1 | error | Act.typeId, Act.participant:responsible.typeId, Act.participant:responsible.participantRole.typeId, Act.participant:responsible.participantRole.playingEntity.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 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 |
| @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 |
1..* | II | Slice: Unordered, Open by value:root | |
| templateId:drug-monitoring-act |
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.123 | |
| @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: INT | |
| @negationInd |
0..1 | bl | ||
| id |
1..* | II | ||
| code |
1..1 | CD | Binding: v3 Code System ActCode (example) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @code |
1..1 | cs | Required Pattern: 395170001 | |
| @codeSystem |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.6.96 | |
| @codeSystemName |
0..1 | st | ||
| @codeSystemVersion |
0..1 | st | ||
| @displayName |
0..1 | st | ||
| @sdtcValueSet |
0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
| @sdtcValueSetVersion |
0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
| originalText |
0..1 | ED | ||
| qualifier |
0..* | CR | ||
| translation |
0..* | CD | ||
| text |
0..1 | ED | SHOULD reference the portion of section narrative text corresponding to this entry | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @compression |
0..1 | cs | Binding: CDACompressionAlgorithm (required) | |
| @integrityCheck |
0..1 | bin | ||
| @integrityCheckAlgorithm |
0..1 | cs | Binding: IntegrityCheckAlgorithm (2.0.0) (required) | |
| @language |
0..1 | cs | ||
| @mediaType |
0..1 | cs | Binding: MediaType (example) | |
| @representation |
0..1 | cs | Binding: CDABinaryDataEncoding (required) | |
| xmlText |
0..1 | st | Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string. | |
| reference |
C | 0..1 | TEL | Constraints: value-starts-octothorpe |
| thumbnail |
0..1 | ED | ||
| statusCode |
1..1 | CS | Binding: ActStatus (required) | |
| @code |
1..1 | cs | Binding: ActStatus (required) | |
| @sdtcValueSet |
0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
| @sdtcValueSetVersion |
0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
| effectiveTime |
1..1 | IVL_TS | ||
| 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 | ||
| Slices for participant |
1..* | Participant2 | Slice: Unordered, Open by value:typeCode | |
| participant:responsible |
1..* | Participant2 | ||
| @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 |
1..1 | cs | Binding: CDAParticipationType (required) Fixed Value: RESP | |
| @contextControlCode |
0..1 | cs | Binding: CDAContextControl (required) Fixed Value: OP | |
| sdtcFunctionCode |
0..1 | CE | XML Namespace: urn:hl7-org:sdtc XML: functionCode (urn:hl7-org:sdtc) | |
| time |
0..1 | IVL_TS | ||
| awarenessCode |
0..1 | CE | ||
| participantRole |
1..1 | ParticipantRole | ||
| @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 | Binding: CDARoleClassRoot (required) Fixed Value: ASSIGNED | |
| id |
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 |
0..* | AD | ||
| telecom |
0..* | TEL | ||
| playingDevice |
0..1 | Device | ||
| playingEntity |
1..1 | PlayingEntity | ||
| @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 | Binding: EntityClassRoot (required) Fixed Value: PSN | |
| @determinerCode |
0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
| code |
0..1 | CE | Binding: CDAEntityCode (example) | |
| quantity |
0..* | PQ | ||
| name |
1..1 | USRealmPersonNamePNUSFIELDED | ||
| sdtcBirthTime |
0..1 | TS | XML Namespace: urn:hl7-org:sdtc XML: birthTime (urn:hl7-org:sdtc) | |
| desc |
0..1 | ED | ||
| scopingEntity |
0..1 | Entity | ||
| entryRelationship |
0..* | EntryRelationship | ||
| reference |
0..* | Reference | ||
| precondition |
0..* | Precondition | ||
| sdtcPrecondition2 |
0..* | Precondition2 | XML Namespace: urn:hl7-org:sdtc XML: precondition2 (urn:hl7-org:sdtc) | |
| sdtcInFulfillmentOf1 |
0..* | InFulfillmentOf1 | XML Namespace: urn:hl7-org:sdtc XML: inFulfillmentOf1 (urn:hl7-org:sdtc) | |
| Documentation for this format | ||||
| Path | 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:drug-monitoring-act.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.statusCode | Base | required | ActStatus | 📦3.0.0 | THO v6.5 |
| Act.statusCode.code | 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.participant:responsible.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:responsible.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:responsible.typeCode | Base | required | CDAParticipationType | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:responsible.contextControlCode | Base | required | CDAContextControl | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:responsible.participantRole.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:responsible.participantRole.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:responsible.participantRole.classCode | Base | required | CDARoleClassRoot | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:responsible.participantRole.code | Base | example | CDARoleCode | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:responsible.participantRole.playingEntity.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:responsible.participantRole.playingEntity.typeId.nullFlavor | Base | required | CDANullFlavor | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Act.participant:responsible.participantRole.playingEntity.classCode | Base | required | EntityClassRoot | 📦3.0.0 | THO v6.5 |
| Act.participant:responsible.participantRole.playingEntity.determinerCode | Base | required | EntityDeterminer | 📦3.0.0 | THO v6.5 |
| Act.participant:responsible.participantRole.playingEntity.code | Base | example | CDAEntityCode | 📦2.0.1-sd | Clinical Document Architecture v2.0 |
| Id | Grade | Path(s) | Description | Expression |
| II-1 | error | Act.typeId, Act.participant:responsible.typeId, Act.participant:responsible.participantRole.typeId, Act.participant:responsible.participantRole.playingEntity.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('#')
|
This structure is derived from Act
Summary
Mandatory: 16 elements
Fixed: 5 elements
Prohibited: 2 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
IG © 2019+ Health Level Seven. Package hl7.cda.us.ccda#4.0.0 based on FHIR 5.0.0. Generated 2025-10-02
Links: Table of Contents |
QA Report
| Version History 
|
|
Propose a change