Consolidated CDA (C-CDA)
3.0.0 - STU
Consolidated CDA (C-CDA)
3.0.0 - STU
Consolidated CDA (C-CDA), published by Health Level Seven. This guide is not an authorized publication; it is the continuous build for version 3.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/MentalStatusOrganizer | Version: 3.0.0 | |||
| Draft as of 2024-05-07 | Computable Name: MentalStatusOrganizer | |||
| Other Identifiers: urn:ietf:rfc:3986#Uniform Resource Identifier (URI)#urn:hl7ii:2.16.840.1.113883.10.20.22.4.75:2015-08-01 | ||||
The Mental Status Organizer template may be used to group related Mental Status Observations (e.g., results of mental tests) and associated Assessment Scale Observations into subcategories and/or groupings by time. Subcategories can be things such as Mood and Affect, Behavior, Thought Process, Perception, Cognition, etc.
Usage:
Description of Template, Differentials, Snapshots and how the different presentations work.
This structure is derived from Organizer
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Organizer |
C | 1..1 | Organizer | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, sdtcText, statusCode, effectiveTime, subject, specimen, performer, author, informant, participant, reference, precondition, sdtcPrecondition2, component Base for all types and resources Instances of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) should-sdtctext-ref-value: SHOULD contain text/reference/@value should-effectiveTime: SHOULD contain effectiveTime |
  Slices for templateId |
1..* | II | Slice: Unordered, Open by value:root, value:extension | |
   templateId:mental-status-org |
1..1 | II | ||
  @root |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.75 | |
  @extension |
1..1 | st | Required Pattern: 2015-08-01 | |
 @classCode |
1..1 | cs | Fixed Value: CLUSTER | |
| @moodCode |
1..1 | cs | ||
| id |
1..* | II | ||
| code |
C | 1..1 | CD | The code selected indicates the category that groups the contained mental status observations (e.g., communication, learning and applying knowledge). 1198-14698: **SHOULD** be selected from ICF (codeSystem 2.16.840.1.113883.6.254) *OR* LOINC (codeSystem 2.16.840.1.113883.6.1) (CONF:1198-14698). |
 @code |
1..1 | cs | ||
| sdtcText |
0..1 | ED | SHOULD reference the portion of section narrative text corresponding to this entry | |
| reference |
C | 0..1 | TEL | value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative |
| statusCode |
1..1 | CS | ||
| @code |
1..1 | cs | Fixed Value: completed | |
| effectiveTime |
0..1 | IVL_TS | The effectiveTime is an interval that spans the effectiveTimes of the contained mental status observations. Because all contained mental status observations have a required time stamp, it is not required that this effectiveTime be populated. | |
 Slices for component |
1..* | OrganizerComponent | Slice: Unordered, Open by profile:observation | |
| component:mentalStatus |
1..* | OrganizerComponent | ||
 observation |
1..1 | MentalStatusObservation | Base for all types and resources | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| 1198-14698 | warning | Organizer.code | **SHOULD** be selected from ICF (codeSystem 2.16.840.1.113883.6.254) *OR* LOINC (codeSystem 2.16.840.1.113883.6.1) (CONF:1198-14698). : codeSystem.exists() implies (codeSystem = '2.16.840.1.113883.6.254' or codeSystem = '2.16.840.1.113883.6.1') | |
| should-effectiveTime | warning | Organizer | SHOULD contain effectiveTime : effectiveTime.exists() | |
| should-sdtctext-ref-value | warning | Organizer | SHOULD contain text/reference/@value : sdtcText.reference.value.exists() | |
| value-starts-octothorpe | error | Organizer.sdtcText.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 |
|---|---|---|---|---|
| Organizer |
C | 1..1 | Organizer | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, sdtcText, statusCode, effectiveTime, subject, specimen, performer, author, informant, participant, reference, precondition, sdtcPrecondition2, component Base for all types and resources Instances of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) should-sdtctext-ref-value: SHOULD contain text/reference/@value should-effectiveTime: SHOULD contain effectiveTime |
| Slices for templateId |
1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:mental-status-org |
1..1 | II | ||
 @root |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.75 | |
| @extension |
1..1 | st | Required Pattern: 2015-08-01 | |
| @classCode |
1..1 | cs | Binding: XActClassDocumentEntryOrganizer (2.0.0) (required) Fixed Value: CLUSTER | |
| @moodCode |
1..1 | cs | Binding: CDAActMood (required) Fixed Value: EVN | |
| id |
1..* | II | ||
| code |
C | 1..1 | CD | The code selected indicates the category that groups the contained mental status observations (e.g., communication, learning and applying knowledge). Binding: v3 Code System ActCode (example) 1198-14698: **SHOULD** be selected from ICF (codeSystem 2.16.840.1.113883.6.254) *OR* LOINC (codeSystem 2.16.840.1.113883.6.1) (CONF:1198-14698). |
| @code |
1..1 | cs | ||
| sdtcText |
0..1 | ED | XML Namespace: urn:hl7-org:sdtc SHOULD reference the portion of section narrative text corresponding to this entry XML: text (urn:hl7-org:sdtc) | |
| reference |
C | 0..1 | TEL | value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative |
| statusCode |
1..1 | CS | Binding: ActStatus (required) | |
| @code |
1..1 | cs | Fixed Value: completed | |
| effectiveTime |
0..1 | IVL_TS | The effectiveTime is an interval that spans the effectiveTimes of the contained mental status observations. Because all contained mental status observations have a required time stamp, it is not required that this effectiveTime be populated. | |
| Slices for component |
1..* | OrganizerComponent | Slice: Unordered, Open by profile:observation | |
| component:mentalStatus |
1..* | OrganizerComponent | ||
| observation |
C | 1..1 | MentalStatusObservation | Base for all types and resources should-text-ref-value: SHOULD contain text/reference/@value should-author: SHOULD contain author |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Organizer.classCode | required | Fixed Value: CLUSTERhttp://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryOrganizer|2.0.0 | |
| Organizer.moodCode | required | Fixed Value: EVNhttp://hl7.org/cda/stds/core/ValueSet/CDAActMood | |
| Organizer.code | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | |
| Organizer.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus |
| Id | Grade | Path(s) | Details | Requirements |
| 1198-14698 | warning | Organizer.code | **SHOULD** be selected from ICF (codeSystem 2.16.840.1.113883.6.254) *OR* LOINC (codeSystem 2.16.840.1.113883.6.1) (CONF:1198-14698). : codeSystem.exists() implies (codeSystem = '2.16.840.1.113883.6.254' or codeSystem = '2.16.840.1.113883.6.1') | |
| should-author | warning | Organizer.component:mentalStatus.observation | SHOULD contain author : author.exists() | |
| should-effectiveTime | warning | Organizer | SHOULD contain effectiveTime : effectiveTime.exists() | |
| should-sdtctext-ref-value | warning | Organizer | SHOULD contain text/reference/@value : sdtcText.reference.value.exists() | |
| should-text-ref-value | warning | Organizer.component:mentalStatus.observation | SHOULD contain text/reference/@value : text.reference.value.exists() | |
| value-starts-octothorpe | error | Organizer.sdtcText.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 |
|---|---|---|---|---|
| Organizer |
C | 1..1 | Organizer | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, sdtcText, statusCode, effectiveTime, subject, specimen, performer, author, informant, participant, reference, precondition, sdtcPrecondition2, component Base for all types and resources Instances of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) should-sdtctext-ref-value: SHOULD contain text/reference/@value should-effectiveTime: SHOULD contain effectiveTime |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
0..1 | II | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| Slices for templateId |
1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:mental-status-org |
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.75 | |
| @extension |
1..1 | st | Required Pattern: 2015-08-01 | |
| @classCode |
1..1 | cs | Binding: XActClassDocumentEntryOrganizer (2.0.0) (required) Fixed Value: CLUSTER | |
| @moodCode |
1..1 | cs | Binding: CDAActMood (required) Fixed Value: EVN | |
| id |
1..* | II | ||
| code |
C | 1..1 | CD | The code selected indicates the category that groups the contained mental status observations (e.g., communication, learning and applying knowledge). Binding: v3 Code System ActCode (example) 1198-14698: **SHOULD** be selected from ICF (codeSystem 2.16.840.1.113883.6.254) *OR* LOINC (codeSystem 2.16.840.1.113883.6.1) (CONF:1198-14698). |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @code |
1..1 | cs | ||
| @codeSystem |
0..1 | oid, uuid, ruid | ||
| @codeSystemName |
0..1 | st | ||
| @codeSystemVersion |
0..1 | st | ||
| @displayName |
0..1 | st | ||
| @sdtcValueSet |
0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
| @sdtcValueSetVersion |
0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
| originalText |
0..1 | ED | ||
| qualifier |
0..* | CR | ||
| translation |
0..* | CD | ||
| sdtcText |
0..1 | ED | XML Namespace: urn:hl7-org:sdtc SHOULD reference the portion of section narrative text corresponding to this entry XML: text (urn:hl7-org:sdtc) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @compression |
0..1 | cs | Binding: CDACompressionAlgorithm (required) | |
| @integrityCheck |
0..1 | bin | ||
| @integrityCheckAlgorithm |
0..1 | cs | Binding: IntegrityCheckAlgorithm (2.0.0) (required) | |
| @language |
0..1 | cs | ||
| @mediaType |
0..1 | cs | Binding: MediaType (example) | |
| @representation |
0..1 | cs | Binding: CDABinaryDataEncoding (required) | |
| xmlText |
0..1 | st | Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string. | |
| reference |
C | 0..1 | TEL | value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative |
| thumbnail |
0..1 | ED | ||
| statusCode |
1..1 | CS | Binding: ActStatus (required) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @code |
1..1 | cs | Fixed Value: completed | |
| @sdtcValueSet |
0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
| @sdtcValueSetVersion |
0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
| effectiveTime |
0..1 | IVL_TS | The effectiveTime is an interval that spans the effectiveTimes of the contained mental status observations. Because all contained mental status observations have a required time stamp, it is not required that this effectiveTime be populated. | |
| subject |
0..1 | Subject | ||
| specimen |
0..* | Specimen | ||
| performer |
0..* | Performer2 | ||
| author |
0..* | Author | ||
| informant |
0..* | Informant | ||
| participant |
0..* | Participant2 | ||
| reference |
0..* | Reference | ||
| precondition |
0..* | Precondition | ||
| sdtcPrecondition2 |
0..* | Precondition2 | XML Namespace: urn:hl7-org:sdtc XML: precondition2 (urn:hl7-org:sdtc) | |
| Slices for component |
1..* | OrganizerComponent | Slice: Unordered, Open by profile:observation | |
| component:mentalStatus |
1..* | OrganizerComponent | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
 typeId |
0..1 | II | ||
 @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @typeCode |
0..1 | cs | Binding: ActRelationshipHasComponent (required) | |
| @contextConductionInd |
0..1 | bl | Fixed Value: true | |
| sequenceNumber |
0..1 | INT | ||
| sdtcPriorityNumber |
0..1 | INT | XML Namespace: urn:hl7-org:sdtc XML: priorityNumber (urn:hl7-org:sdtc) | |
| seperatableInd |
0..1 | BL | ||
| act |
0..1 | Act | ||
| encounter |
0..1 | Encounter | ||
| observation |
C | 1..1 | MentalStatusObservation | Base for all types and resources should-text-ref-value: SHOULD contain text/reference/@value should-author: SHOULD contain author |
| observationMedia |
0..1 | ObservationMedia | ||
| organizer |
0..1 | Organizer | ||
| procedure |
0..1 | Procedure | ||
| regionOfInterest |
0..1 | RegionOfInterest | ||
| substanceAdministration |
0..1 | SubstanceAdministration | ||
| supply |
0..1 | Supply | ||
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Organizer.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Organizer.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Organizer.templateId:mental-status-org.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Organizer.classCode | required | Fixed Value: CLUSTERhttp://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryOrganizer|2.0.0 | |
| Organizer.moodCode | required | Fixed Value: EVNhttp://hl7.org/cda/stds/core/ValueSet/CDAActMood | |
| Organizer.code | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | |
| Organizer.code.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Organizer.sdtcText.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Organizer.sdtcText.compression | required | CDACompressionAlgorithmhttp://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm | |
| Organizer.sdtcText.integrityCheckAlgorithm | required | IntegrityCheckAlgorithmhttp://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0 | |
| Organizer.sdtcText.mediaType | example | MediaTypehttp://terminology.hl7.org/ValueSet/v3-MediaType | |
| Organizer.sdtcText.representation | required | BinaryDataEncodinghttp://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding | |
| Organizer.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
| Organizer.statusCode.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Organizer.component:mentalStatus.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Organizer.component:mentalStatus.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Organizer.component:mentalStatus.typeCode | required | ActRelationshipHasComponenthttp://terminology.hl7.org/ValueSet/v3-ActRelationshipHasComponent |
| Id | Grade | Path(s) | Details | Requirements |
| 1198-14698 | warning | Organizer.code | **SHOULD** be selected from ICF (codeSystem 2.16.840.1.113883.6.254) *OR* LOINC (codeSystem 2.16.840.1.113883.6.1) (CONF:1198-14698). : codeSystem.exists() implies (codeSystem = '2.16.840.1.113883.6.254' or codeSystem = '2.16.840.1.113883.6.1') | |
| should-author | warning | Organizer.component:mentalStatus.observation | SHOULD contain author : author.exists() | |
| should-effectiveTime | warning | Organizer | SHOULD contain effectiveTime : effectiveTime.exists() | |
| should-sdtctext-ref-value | warning | Organizer | SHOULD contain text/reference/@value : sdtcText.reference.value.exists() | |
| should-text-ref-value | warning | Organizer.component:mentalStatus.observation | SHOULD contain text/reference/@value : text.reference.value.exists() | |
| value-starts-octothorpe | error | Organizer.sdtcText.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 Organizer
Summary
Mandatory: 11 elements
Fixed: 2 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Organizer
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Organizer |
C | 1..1 | Organizer | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, sdtcText, statusCode, effectiveTime, subject, specimen, performer, author, informant, participant, reference, precondition, sdtcPrecondition2, component Base for all types and resources Instances of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) should-sdtctext-ref-value: SHOULD contain text/reference/@value should-effectiveTime: SHOULD contain effectiveTime |
| Slices for templateId |
1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:mental-status-org |
1..1 | II | ||
| @root |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.75 | |
| @extension |
1..1 | st | Required Pattern: 2015-08-01 | |
| @classCode |
1..1 | cs | Fixed Value: CLUSTER | |
| @moodCode |
1..1 | cs | ||
| id |
1..* | II | ||
| code |
C | 1..1 | CD | The code selected indicates the category that groups the contained mental status observations (e.g., communication, learning and applying knowledge). 1198-14698: **SHOULD** be selected from ICF (codeSystem 2.16.840.1.113883.6.254) *OR* LOINC (codeSystem 2.16.840.1.113883.6.1) (CONF:1198-14698). |
| @code |
1..1 | cs | ||
| sdtcText |
0..1 | ED | SHOULD reference the portion of section narrative text corresponding to this entry | |
| reference |
C | 0..1 | TEL | value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative |
| statusCode |
1..1 | CS | ||
| @code |
1..1 | cs | Fixed Value: completed | |
| effectiveTime |
0..1 | IVL_TS | The effectiveTime is an interval that spans the effectiveTimes of the contained mental status observations. Because all contained mental status observations have a required time stamp, it is not required that this effectiveTime be populated. | |
| Slices for component |
1..* | OrganizerComponent | Slice: Unordered, Open by profile:observation | |
| component:mentalStatus |
1..* | OrganizerComponent | ||
| observation |
1..1 | MentalStatusObservation | Base for all types and resources | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| 1198-14698 | warning | Organizer.code | **SHOULD** be selected from ICF (codeSystem 2.16.840.1.113883.6.254) *OR* LOINC (codeSystem 2.16.840.1.113883.6.1) (CONF:1198-14698). : codeSystem.exists() implies (codeSystem = '2.16.840.1.113883.6.254' or codeSystem = '2.16.840.1.113883.6.1') | |
| should-effectiveTime | warning | Organizer | SHOULD contain effectiveTime : effectiveTime.exists() | |
| should-sdtctext-ref-value | warning | Organizer | SHOULD contain text/reference/@value : sdtcText.reference.value.exists() | |
| value-starts-octothorpe | error | Organizer.sdtcText.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 |
|---|---|---|---|---|
| Organizer |
C | 1..1 | Organizer | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, sdtcText, statusCode, effectiveTime, subject, specimen, performer, author, informant, participant, reference, precondition, sdtcPrecondition2, component Base for all types and resources Instances of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) should-sdtctext-ref-value: SHOULD contain text/reference/@value should-effectiveTime: SHOULD contain effectiveTime |
| Slices for templateId |
1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:mental-status-org |
1..1 | II | ||
| @root |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.75 | |
| @extension |
1..1 | st | Required Pattern: 2015-08-01 | |
| @classCode |
1..1 | cs | Binding: XActClassDocumentEntryOrganizer (2.0.0) (required) Fixed Value: CLUSTER | |
| @moodCode |
1..1 | cs | Binding: CDAActMood (required) Fixed Value: EVN | |
| id |
1..* | II | ||
| code |
C | 1..1 | CD | The code selected indicates the category that groups the contained mental status observations (e.g., communication, learning and applying knowledge). Binding: v3 Code System ActCode (example) 1198-14698: **SHOULD** be selected from ICF (codeSystem 2.16.840.1.113883.6.254) *OR* LOINC (codeSystem 2.16.840.1.113883.6.1) (CONF:1198-14698). |
| @code |
1..1 | cs | ||
| sdtcText |
0..1 | ED | XML Namespace: urn:hl7-org:sdtc SHOULD reference the portion of section narrative text corresponding to this entry XML: text (urn:hl7-org:sdtc) | |
| reference |
C | 0..1 | TEL | value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative |
| statusCode |
1..1 | CS | Binding: ActStatus (required) | |
| @code |
1..1 | cs | Fixed Value: completed | |
| effectiveTime |
0..1 | IVL_TS | The effectiveTime is an interval that spans the effectiveTimes of the contained mental status observations. Because all contained mental status observations have a required time stamp, it is not required that this effectiveTime be populated. | |
| Slices for component |
1..* | OrganizerComponent | Slice: Unordered, Open by profile:observation | |
| component:mentalStatus |
1..* | OrganizerComponent | ||
| observation |
C | 1..1 | MentalStatusObservation | Base for all types and resources should-text-ref-value: SHOULD contain text/reference/@value should-author: SHOULD contain author |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Organizer.classCode | required | Fixed Value: CLUSTERhttp://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryOrganizer|2.0.0 | |
| Organizer.moodCode | required | Fixed Value: EVNhttp://hl7.org/cda/stds/core/ValueSet/CDAActMood | |
| Organizer.code | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | |
| Organizer.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus |
| Id | Grade | Path(s) | Details | Requirements |
| 1198-14698 | warning | Organizer.code | **SHOULD** be selected from ICF (codeSystem 2.16.840.1.113883.6.254) *OR* LOINC (codeSystem 2.16.840.1.113883.6.1) (CONF:1198-14698). : codeSystem.exists() implies (codeSystem = '2.16.840.1.113883.6.254' or codeSystem = '2.16.840.1.113883.6.1') | |
| should-author | warning | Organizer.component:mentalStatus.observation | SHOULD contain author : author.exists() | |
| should-effectiveTime | warning | Organizer | SHOULD contain effectiveTime : effectiveTime.exists() | |
| should-sdtctext-ref-value | warning | Organizer | SHOULD contain text/reference/@value : sdtcText.reference.value.exists() | |
| should-text-ref-value | warning | Organizer.component:mentalStatus.observation | SHOULD contain text/reference/@value : text.reference.value.exists() | |
| value-starts-octothorpe | error | Organizer.sdtcText.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 |
|---|---|---|---|---|
| Organizer |
C | 1..1 | Organizer | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, sdtcText, statusCode, effectiveTime, subject, specimen, performer, author, informant, participant, reference, precondition, sdtcPrecondition2, component Base for all types and resources Instances of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) should-sdtctext-ref-value: SHOULD contain text/reference/@value should-effectiveTime: SHOULD contain effectiveTime |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
0..1 | II | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| Slices for templateId |
1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:mental-status-org |
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.75 | |
| @extension |
1..1 | st | Required Pattern: 2015-08-01 | |
| @classCode |
1..1 | cs | Binding: XActClassDocumentEntryOrganizer (2.0.0) (required) Fixed Value: CLUSTER | |
| @moodCode |
1..1 | cs | Binding: CDAActMood (required) Fixed Value: EVN | |
| id |
1..* | II | ||
| code |
C | 1..1 | CD | The code selected indicates the category that groups the contained mental status observations (e.g., communication, learning and applying knowledge). Binding: v3 Code System ActCode (example) 1198-14698: **SHOULD** be selected from ICF (codeSystem 2.16.840.1.113883.6.254) *OR* LOINC (codeSystem 2.16.840.1.113883.6.1) (CONF:1198-14698). |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @code |
1..1 | cs | ||
| @codeSystem |
0..1 | oid, uuid, ruid | ||
| @codeSystemName |
0..1 | st | ||
| @codeSystemVersion |
0..1 | st | ||
| @displayName |
0..1 | st | ||
| @sdtcValueSet |
0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
| @sdtcValueSetVersion |
0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
| originalText |
0..1 | ED | ||
| qualifier |
0..* | CR | ||
| translation |
0..* | CD | ||
| sdtcText |
0..1 | ED | XML Namespace: urn:hl7-org:sdtc SHOULD reference the portion of section narrative text corresponding to this entry XML: text (urn:hl7-org:sdtc) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @compression |
0..1 | cs | Binding: CDACompressionAlgorithm (required) | |
| @integrityCheck |
0..1 | bin | ||
| @integrityCheckAlgorithm |
0..1 | cs | Binding: IntegrityCheckAlgorithm (2.0.0) (required) | |
| @language |
0..1 | cs | ||
| @mediaType |
0..1 | cs | Binding: MediaType (example) | |
| @representation |
0..1 | cs | Binding: CDABinaryDataEncoding (required) | |
| xmlText |
0..1 | st | Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string. | |
| reference |
C | 0..1 | TEL | value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative |
| thumbnail |
0..1 | ED | ||
| statusCode |
1..1 | CS | Binding: ActStatus (required) | |
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @code |
1..1 | cs | Fixed Value: completed | |
| @sdtcValueSet |
0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
| @sdtcValueSetVersion |
0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
| effectiveTime |
0..1 | IVL_TS | The effectiveTime is an interval that spans the effectiveTimes of the contained mental status observations. Because all contained mental status observations have a required time stamp, it is not required that this effectiveTime be populated. | |
| subject |
0..1 | Subject | ||
| specimen |
0..* | Specimen | ||
| performer |
0..* | Performer2 | ||
| author |
0..* | Author | ||
| informant |
0..* | Informant | ||
| participant |
0..* | Participant2 | ||
| reference |
0..* | Reference | ||
| precondition |
0..* | Precondition | ||
| sdtcPrecondition2 |
0..* | Precondition2 | XML Namespace: urn:hl7-org:sdtc XML: precondition2 (urn:hl7-org:sdtc) | |
| Slices for component |
1..* | OrganizerComponent | Slice: Unordered, Open by profile:observation | |
| component:mentalStatus |
1..* | OrganizerComponent | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| realmCode |
0..* | CS | ||
| typeId |
0..1 | II | ||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |
| @assigningAuthorityName |
0..1 | st | ||
| @displayable |
0..1 | bl | ||
| @root |
1..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.1.3 | |
| @extension |
1..1 | st | ||
| templateId |
0..* | II | ||
| @typeCode |
0..1 | cs | Binding: ActRelationshipHasComponent (required) | |
| @contextConductionInd |
0..1 | bl | Fixed Value: true | |
| sequenceNumber |
0..1 | INT | ||
| sdtcPriorityNumber |
0..1 | INT | XML Namespace: urn:hl7-org:sdtc XML: priorityNumber (urn:hl7-org:sdtc) | |
| seperatableInd |
0..1 | BL | ||
| act |
0..1 | Act | ||
| encounter |
0..1 | Encounter | ||
| observation |
C | 1..1 | MentalStatusObservation | Base for all types and resources should-text-ref-value: SHOULD contain text/reference/@value should-author: SHOULD contain author |
| observationMedia |
0..1 | ObservationMedia | ||
| organizer |
0..1 | Organizer | ||
| procedure |
0..1 | Procedure | ||
| regionOfInterest |
0..1 | RegionOfInterest | ||
| substanceAdministration |
0..1 | SubstanceAdministration | ||
| supply |
0..1 | Supply | ||
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Organizer.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Organizer.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Organizer.templateId:mental-status-org.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Organizer.classCode | required | Fixed Value: CLUSTERhttp://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryOrganizer|2.0.0 | |
| Organizer.moodCode | required | Fixed Value: EVNhttp://hl7.org/cda/stds/core/ValueSet/CDAActMood | |
| Organizer.code | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | |
| Organizer.code.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Organizer.sdtcText.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Organizer.sdtcText.compression | required | CDACompressionAlgorithmhttp://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm | |
| Organizer.sdtcText.integrityCheckAlgorithm | required | IntegrityCheckAlgorithmhttp://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0 | |
| Organizer.sdtcText.mediaType | example | MediaTypehttp://terminology.hl7.org/ValueSet/v3-MediaType | |
| Organizer.sdtcText.representation | required | BinaryDataEncodinghttp://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding | |
| Organizer.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
| Organizer.statusCode.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Organizer.component:mentalStatus.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Organizer.component:mentalStatus.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Organizer.component:mentalStatus.typeCode | required | ActRelationshipHasComponenthttp://terminology.hl7.org/ValueSet/v3-ActRelationshipHasComponent |
| Id | Grade | Path(s) | Details | Requirements |
| 1198-14698 | warning | Organizer.code | **SHOULD** be selected from ICF (codeSystem 2.16.840.1.113883.6.254) *OR* LOINC (codeSystem 2.16.840.1.113883.6.1) (CONF:1198-14698). : codeSystem.exists() implies (codeSystem = '2.16.840.1.113883.6.254' or codeSystem = '2.16.840.1.113883.6.1') | |
| should-author | warning | Organizer.component:mentalStatus.observation | SHOULD contain author : author.exists() | |
| should-effectiveTime | warning | Organizer | SHOULD contain effectiveTime : effectiveTime.exists() | |
| should-sdtctext-ref-value | warning | Organizer | SHOULD contain text/reference/@value : sdtcText.reference.value.exists() | |
| should-text-ref-value | warning | Organizer.component:mentalStatus.observation | SHOULD contain text/reference/@value : text.reference.value.exists() | |
| value-starts-octothorpe | error | Organizer.sdtcText.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 Organizer
Summary
Mandatory: 11 elements
Fixed: 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#3.0.0 based on FHIR 5.0.0. Generated 2024-05-07
Links: Table of Contents |
QA Report
| Version History 
|
|
Propose a change